Trendsic Platform Service

DispatchPickupBookRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/public/pickup/{SchedulerUrl}

"use strict";
export class DispatchPickupBookResponse {
    /** @param {{Code?:string,Fare?:number,Zone?:string,Bags?:number,PayMode?:string,PayLine?:string,TrackUrl?:string,BookToken?:string,ClientSecret?:string,PublishableKey?:string,Delivery?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Code;
    /** @type {number} */
    Fare;
    /** @type {string} */
    Zone;
    /** @type {number} */
    Bags;
    /** @type {string} */
    PayMode;
    /** @type {string} */
    PayLine;
    /** @type {string} */
    TrackUrl;
    /** @type {string} */
    BookToken;
    /** @type {string} */
    ClientSecret;
    /** @type {string} */
    PublishableKey;
    /** @type {string} */
    Delivery;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchPickupBookRequest {
    /** @param {{SchedulerUrl?:string,Address?:string,Unit?:string,City?:string,Zip?:string,Zone?:string,Bags?:number,Needs?:string[],Note?:string,CustomerName?:string,CustomerPhone?:string,PayMode?:string,AccountCode?:string,TurnstileToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SchedulerUrl;
    /** @type {string} */
    Address;
    /** @type {string} */
    Unit;
    /** @type {string} */
    City;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Zone;
    /** @type {number} */
    Bags;
    /** @type {string[]} */
    Needs = [];
    /** @type {string} */
    Note;
    /** @type {string} */
    CustomerName;
    /** @type {string} */
    CustomerPhone;
    /** @type {string} */
    PayMode;
    /** @type {string} */
    AccountCode;
    /** @type {string} */
    TurnstileToken;
}

JavaScript DispatchPickupBookRequest DTOs

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/dispatch/public/pickup/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
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
		}
	}
}