Trendsic Platform Service

<back to all web services

DispatchPickupBookRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/public/pickup/{SchedulerUrl}
DispatchPickupBookRequest Parameters:
NameParameterData TypeRequiredDescription
SchedulerUrlpathstringNo
AddressbodystringNo
UnitbodystringNo
CitybodystringNo
ZipbodystringNo
ZonebodystringNo
BagsbodyintNo
NeedsbodyList<string>No
NotebodystringNo
CustomerNamebodystringNo
CustomerPhonebodystringNo
PayModebodystringNo
AccountCodebodystringNo
TurnstileTokenbodystringNo
DispatchPickupBookResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
FareformdecimalNo
ZoneformstringNo
BagsformintNo
PayModeformstringNo
PayLineformstringNo
TrackUrlformstringNo
BookTokenformstringNo
ClientSecretformstringNo
PublishableKeyformstringNo
DeliveryformstringNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dispatch/public/pickup/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SchedulerUrl":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Zone":"String","Bags":0,"Needs":["String"],"Note":"String","CustomerName":"String","CustomerPhone":"String","PayMode":"String","AccountCode":"String","TurnstileToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Code":"String","Fare":0,"Zone":"String","Bags":0,"PayMode":"String","PayLine":"String","TrackUrl":"String","BookToken":"String","ClientSecret":"String","PublishableKey":"String","Delivery":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}