API ReferenceTutorialsSupport
API Reference

Assign

post
https://api.shipday.com/on-demand/assign

Assign to a specific 3rd party delivery service provider. Usually, after getting an estimate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to null

Name of the 3rd party service provider

int32
required
Defaults to null

Order id of the order to be assigned

double
Defaults to null

Tip amount for the order

string
Defaults to null

Reference id of the estimate

boolean
Defaults to false

Boolean value indicating contactless delivery or not

string
enum
Defaults to null

Enum values ("PHOTO", "SIGNATURE", "PIN", "NONE") indicating proof of delivery type

Allowed:
podTypes
array of strings
Defaults to null

If multiple POD types are applicable, then it can be sent in this property as an array of enum POD types like ["PHOTO", "PIN"]

podTypes
Headers
string
required
Defaults to Basic BgxsDwd00n.LNNn90QydrjgZ1K9dS13

Replace the BgxsDwd00n.LNNn90QydrjgZ1K9dS13 part with your own API_KEY from Shipday for authentication.

string
required
Defaults to application/json
Responses

Updated 10 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 months ago