| POST,OPTIONS | /v1/book/{Slug}/orders | ||
|---|---|---|---|
| POST,OPTIONS | /v1/book/{Slug}/orders/confirm |
export class CourierBookOrderResponse
{
public Done: boolean;
public NeedsAction: boolean;
public ClientSecret: string;
public SetupIntentId: string;
public Code: string;
public TrackUrl: string;
public IcsUrl: string;
public WindowText: string;
public Promise: string;
public Total: number;
public PayTiming: string;
public CardLast4: string;
public Repeats: string;
public LinkSentBy: string;
public ReopenStep: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<CourierBookOrderResponse>) { (Object as any).assign(this, init); }
}
export class CourierBookOrderRequest
{
public Slug: string;
public Profile: string;
public TurnstileToken: string;
public Level: string;
public WindowId: string;
public Recur: string;
public Address: string;
public Unit: string;
public City: string;
public Zip: string;
public Lat?: number;
public Lng?: number;
public PickupName: string;
public DropAddress: string;
public DropUnit: string;
public DropCity: string;
public DropZip: string;
public DropLat?: number;
public DropLng?: number;
public RecipientName: string;
public Units: number;
public Handoff: string;
public GateCode: string;
public Note: string;
public Name: string;
public Phone: string;
public Email: string;
public SmsConsent: boolean;
public Terms: boolean;
public PaymentMethodId: string;
public SetupIntentId: string;
public QuotedTotal?: number;
public Lang: string;
public constructor(init?: Partial<CourierBookOrderRequest>) { (Object as any).assign(this, init); }
}
TypeScript CourierBookOrderRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<CourierBookOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Address>String</Address>
<City>String</City>
<DropAddress>String</DropAddress>
<DropCity>String</DropCity>
<DropLat>0</DropLat>
<DropLng>0</DropLng>
<DropUnit>String</DropUnit>
<DropZip>String</DropZip>
<Email>String</Email>
<GateCode>String</GateCode>
<Handoff>String</Handoff>
<Lang>String</Lang>
<Lat>0</Lat>
<Level>String</Level>
<Lng>0</Lng>
<Name>String</Name>
<Note>String</Note>
<PaymentMethodId>String</PaymentMethodId>
<Phone>String</Phone>
<PickupName>String</PickupName>
<Profile>String</Profile>
<QuotedTotal>0</QuotedTotal>
<RecipientName>String</RecipientName>
<Recur>String</Recur>
<SetupIntentId>String</SetupIntentId>
<Slug>String</Slug>
<SmsConsent>false</SmsConsent>
<Terms>false</Terms>
<TurnstileToken>String</TurnstileToken>
<Unit>String</Unit>
<Units>0</Units>
<WindowId>String</WindowId>
<Zip>String</Zip>
</CourierBookOrderRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CourierBookOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<CardLast4>String</CardLast4>
<ClientSecret>String</ClientSecret>
<Code>String</Code>
<Done>false</Done>
<IcsUrl>String</IcsUrl>
<LinkSentBy>String</LinkSentBy>
<NeedsAction>false</NeedsAction>
<PayTiming>String</PayTiming>
<Promise>String</Promise>
<ReopenStep>String</ReopenStep>
<Repeats>String</Repeats>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<SetupIntentId>String</SetupIntentId>
<Total>0</Total>
<TrackUrl>String</TrackUrl>
<WindowText>String</WindowText>
</CourierBookOrderResponse>