Trendsic Platform Service

<back to all web services

CourierBookOrderRequest

The following routes are available for this service:
POST,OPTIONS/v1/book/{Slug}/orders
POST,OPTIONS/v1/book/{Slug}/orders/confirm
CourierBookOrderRequest Parameters:
NameParameterData TypeRequiredDescription
SlugpathstringNo
ProfilebodystringNo
TurnstileTokenbodystringNo
LevelbodystringNo
WindowIdbodystringNo
RecurbodystringNo
AddressbodystringNo
UnitbodystringNo
CitybodystringNo
ZipbodystringNo
Latbodydecimal?No
Lngbodydecimal?No
PickupNamebodystringNo
DropAddressbodystringNo
DropUnitbodystringNo
DropCitybodystringNo
DropZipbodystringNo
DropLatbodydecimal?No
DropLngbodydecimal?No
RecipientNamebodystringNo
UnitsbodyintNo
HandoffbodystringNo
GateCodebodystringNo
NotebodystringNo
NamebodystringNo
PhonebodystringNo
EmailbodystringNo
SmsConsentbodyboolNo
TermsbodyboolNo
PaymentMethodIdbodystringNo
SetupIntentIdbodystringNo
QuotedTotalbodydecimal?No
LangbodystringNo
CourierBookOrderResponse Parameters:
NameParameterData TypeRequiredDescription
DoneformboolNo
NeedsActionformboolNo
ClientSecretformstringNo
SetupIntentIdformstringNo
CodeformstringNo
TrackUrlformstringNo
IcsUrlformstringNo
WindowTextformstringNo
PromiseformstringNo
TotalformdecimalNo
PayTimingformstringNo
CardLast4formstringNo
RepeatsformstringNo
LinkSentByformstringNo
ReopenStepformstringNo
ResponseStatusformResponseStatusNo

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

HTTP + JSV

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

POST /v1/book/{Slug}/orders HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Slug: String,
	Profile: String,
	TurnstileToken: String,
	Level: String,
	WindowId: String,
	Recur: String,
	Address: String,
	Unit: String,
	City: String,
	Zip: String,
	Lat: 0,
	Lng: 0,
	PickupName: String,
	DropAddress: String,
	DropUnit: String,
	DropCity: String,
	DropZip: String,
	DropLat: 0,
	DropLng: 0,
	RecipientName: String,
	Units: 0,
	Handoff: String,
	GateCode: String,
	Note: String,
	Name: String,
	Phone: String,
	Email: String,
	SmsConsent: False,
	Terms: False,
	PaymentMethodId: String,
	SetupIntentId: String,
	QuotedTotal: 0,
	Lang: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Done: False,
	NeedsAction: False,
	ClientSecret: String,
	SetupIntentId: String,
	Code: String,
	TrackUrl: String,
	IcsUrl: String,
	WindowText: String,
	Promise: String,
	Total: 0,
	PayTiming: String,
	CardLast4: String,
	Repeats: String,
	LinkSentBy: String,
	ReopenStep: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}