| POST,OPTIONS | /v1/dispatch/courier/orders/{Code}/instructions |
|---|
"use strict";
export class CourierOrderRuleView {
/** @param {{PingSecs?:number,MissedWaitMin?:number,MissedFee?:number,CancelFee?:number,MissedAutoRebook?:boolean,MissedRequireContact?:boolean,MissedRequirePhoto?:boolean,PayTiming?:string,FinalPriceAfterCount?:boolean,PayPlanName?:string,PerPickup?:number,PerStop?:number,PerMissed?:number,PerCancel?:number,AcceptedUtc?:string,Proof?:{ [index:string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
PingSecs;
/** @type {number} */
MissedWaitMin;
/** @type {number} */
MissedFee;
/** @type {number} */
CancelFee;
/** @type {boolean} */
MissedAutoRebook;
/** @type {boolean} */
MissedRequireContact;
/** @type {boolean} */
MissedRequirePhoto;
/** @type {string} */
PayTiming;
/** @type {boolean} */
FinalPriceAfterCount;
/** @type {string} */
PayPlanName;
/** @type {number} */
PerPickup;
/** @type {number} */
PerStop;
/** @type {number} */
PerMissed;
/** @type {number} */
PerCancel;
/** @type {?string} */
AcceptedUtc;
/** @type {{ [index:string]: string; }} */
Proof = {};
}
export class CourierItemView {
/** @param {{CourierItemID?:number,DispatchOdRequestID?:number,Seq?:number,TagCode?:string,Custody?:string,IsOpen?:boolean,IsMissing?:boolean,MissingReason?:string,IsManual?:boolean,ReTagFlag?:boolean,Scanned?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CourierItemID;
/** @type {number} */
DispatchOdRequestID;
/** @type {number} */
Seq;
/** @type {string} */
TagCode;
/** @type {string} */
Custody;
/** @type {boolean} */
IsOpen;
/** @type {boolean} */
IsMissing;
/** @type {string} */
MissingReason;
/** @type {boolean} */
IsManual;
/** @type {boolean} */
ReTagFlag;
/** @type {boolean} */
Scanned;
}
export class CourierScanView {
/** @param {{TagCode?:string,Stage?:string,Result?:string,AtUtc?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
TagCode;
/** @type {string} */
Stage;
/** @type {string} */
Result;
/** @type {string} */
AtUtc;
}
export class CourierProofResultView {
/** @param {{Stage?:string,StepKey?:string,Value?:string,AtUtc?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Stage;
/** @type {string} */
StepKey;
/** @type {string} */
Value;
/** @type {string} */
AtUtc;
}
export class CourierEventView {
/** @param {{Kind?:string,Party?:string,Body?:string,AtUtc?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Kind;
/** @type {string} */
Party;
/** @type {string} */
Body;
/** @type {string} */
AtUtc;
}
export class CourierPhotoView {
/** @param {{PhotoId?:number,Kind?:string,FileName?:string,Url?:string,TakenUtc?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
PhotoId;
/** @type {string} */
Kind;
/** @type {string} */
FileName;
/** @type {string} */
Url;
/** @type {?string} */
TakenUtc;
}
export class CourierPayLineView {
/** @param {{DispatchLoadID?:number,Kind?:string,Label?:string,Qty?:number,Rate?:number,Amount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DispatchLoadID;
/** @type {string} */
Kind;
/** @type {string} */
Label;
/** @type {?number} */
Qty;
/** @type {?number} */
Rate;
/** @type {number} */
Amount;
}
export class CourierOrderView {
/** @param {{DispatchOdRequestID?:number,Code?:string,CourierProfileId?:number,ProfileName?:string,RouteShape?:string,UnitOne?:string,UnitMany?:string,CourierFacilityId?:number,FacilityName?:string,ServiceLevelCode?:string,LevelName?:string,Source?:string,Address?:string,Unit?:string,City?:string,Zip?:string,Zone?:string,PickupContactName?:string,DropoffAddress?:string,DropoffUnit?:string,DropoffCity?:string,DropoffZip?:string,DropoffContactName?:string,Miles?:number,Units?:number,UnitsFound?:number,Stage?:string,CourierStep?:string,StepLabel?:string,DriverCode?:string,DriverName?:string,DriverContactId?:number,CourierRunId?:number,RunCode?:string,StopSequence?:number,QueueSequence?:number,IsAsap?:boolean,WindowStartUtc?:string,WindowEndUtc?:string,WindowText?:string,DueUtc?:string,DueText?:string,PingAfterUtc?:string,PingExpiresUtc?:string,CandidateCode?:string,HeldReason?:string,HeldUtc?:string,CustomerName?:string,CustomerPhone?:string,Handoff?:string,GateCode?:string,Instructions?:string,DamageNote?:string,DeliveredToName?:string,PayMode?:string,Fare?:number,FinalPrice?:number,TipAmount?:number,CancelledBy?:string,CancelReason?:string,CancelFeeApplied?:number,MissedFeeApplied?:number,CaptureMode?:string,AuthorizedAmount?:number,CapturedAmount?:number,RefundedAmount?:number,ChargeError?:string,CreatedAt?:string,ArrivedUtc?:string,PickedUpUtc?:string,IntakeUtc?:string,ReadyUtc?:string,OutForDeliveryUtc?:string,DeliveredUtc?:string,MissedUtc?:string,CancelledUtc?:string,IsClosed?:boolean,RebookOfId?:number,RecurrenceId?:number,PickupLoadId?:number,Rule?:CourierOrderRuleView,Items?:CourierItemView[],Scans?:CourierScanView[],Proof?:CourierProofResultView[],Events?:CourierEventView[],Photos?:CourierPhotoView[],PayLines?:CourierPayLineView[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DispatchOdRequestID;
/** @type {string} */
Code;
/** @type {number} */
CourierProfileId;
/** @type {string} */
ProfileName;
/** @type {string} */
RouteShape;
/** @type {string} */
UnitOne;
/** @type {string} */
UnitMany;
/** @type {?number} */
CourierFacilityId;
/** @type {string} */
FacilityName;
/** @type {string} */
ServiceLevelCode;
/** @type {string} */
LevelName;
/** @type {string} */
Source;
/** @type {string} */
Address;
/** @type {string} */
Unit;
/** @type {string} */
City;
/** @type {string} */
Zip;
/** @type {string} */
Zone;
/** @type {string} */
PickupContactName;
/** @type {string} */
DropoffAddress;
/** @type {string} */
DropoffUnit;
/** @type {string} */
DropoffCity;
/** @type {string} */
DropoffZip;
/** @type {string} */
DropoffContactName;
/** @type {?number} */
Miles;
/** @type {number} */
Units;
/** @type {?number} */
UnitsFound;
/** @type {string} */
Stage;
/** @type {string} */
CourierStep;
/** @type {string} */
StepLabel;
/** @type {string} */
DriverCode;
/** @type {string} */
DriverName;
/** @type {?number} */
DriverContactId;
/** @type {?number} */
CourierRunId;
/** @type {string} */
RunCode;
/** @type {?number} */
StopSequence;
/** @type {?number} */
QueueSequence;
/** @type {boolean} */
IsAsap;
/** @type {?string} */
WindowStartUtc;
/** @type {?string} */
WindowEndUtc;
/** @type {string} */
WindowText;
/** @type {?string} */
DueUtc;
/** @type {string} */
DueText;
/** @type {?string} */
PingAfterUtc;
/** @type {?string} */
PingExpiresUtc;
/** @type {string} */
CandidateCode;
/** @type {string} */
HeldReason;
/** @type {?string} */
HeldUtc;
/** @type {string} */
CustomerName;
/** @type {string} */
CustomerPhone;
/** @type {string} */
Handoff;
/** @type {string} */
GateCode;
/** @type {string} */
Instructions;
/** @type {string} */
DamageNote;
/** @type {string} */
DeliveredToName;
/** @type {string} */
PayMode;
/** @type {?number} */
Fare;
/** @type {?number} */
FinalPrice;
/** @type {?number} */
TipAmount;
/** @type {string} */
CancelledBy;
/** @type {string} */
CancelReason;
/** @type {?number} */
CancelFeeApplied;
/** @type {?number} */
MissedFeeApplied;
/** @type {string} */
CaptureMode;
/** @type {?number} */
AuthorizedAmount;
/** @type {?number} */
CapturedAmount;
/** @type {number} */
RefundedAmount;
/** @type {string} */
ChargeError;
/** @type {?string} */
CreatedAt;
/** @type {?string} */
ArrivedUtc;
/** @type {?string} */
PickedUpUtc;
/** @type {?string} */
IntakeUtc;
/** @type {?string} */
ReadyUtc;
/** @type {?string} */
OutForDeliveryUtc;
/** @type {?string} */
DeliveredUtc;
/** @type {?string} */
MissedUtc;
/** @type {?string} */
CancelledUtc;
/** @type {boolean} */
IsClosed;
/** @type {?number} */
RebookOfId;
/** @type {?number} */
RecurrenceId;
/** @type {?number} */
PickupLoadId;
/** @type {CourierOrderRuleView} */
Rule;
/** @type {CourierItemView[]} */
Items = [];
/** @type {CourierScanView[]} */
Scans = [];
/** @type {CourierProofResultView[]} */
Proof = [];
/** @type {CourierEventView[]} */
Events = [];
/** @type {CourierPhotoView[]} */
Photos = [];
/** @type {CourierPayLineView[]} */
PayLines = [];
}
export class CourierOrderResponse {
/** @param {{Orders?:CourierOrderView[],Order?:CourierOrderView,Message?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CourierOrderView[]} */
Orders = [];
/** @type {CourierOrderView} */
Order;
/** @type {string} */
Message;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class CourierOrderInstructionsRequest {
/** @param {{Code?:string,Instructions?:string,GateCode?:string,Handoff?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Code;
/** @type {string} */
Instructions;
/** @type {string} */
GateCode;
/** @type {string} */
Handoff;
}
JavaScript CourierOrderInstructionsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/dispatch/courier/orders/{Code}/instructions HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Code: String,
Instructions: String,
GateCode: String,
Handoff: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Orders:
[
{
DispatchOdRequestID: 0,
Code: String,
CourierProfileId: 0,
ProfileName: String,
RouteShape: String,
UnitOne: String,
UnitMany: String,
CourierFacilityId: 0,
FacilityName: String,
ServiceLevelCode: String,
LevelName: String,
Source: String,
Address: String,
Unit: String,
City: String,
Zip: String,
Zone: String,
PickupContactName: String,
DropoffAddress: String,
DropoffUnit: String,
DropoffCity: String,
DropoffZip: String,
DropoffContactName: String,
Miles: 0,
Units: 0,
UnitsFound: 0,
Stage: String,
CourierStep: String,
StepLabel: String,
DriverCode: String,
DriverName: String,
DriverContactId: 0,
CourierRunId: 0,
RunCode: String,
StopSequence: 0,
QueueSequence: 0,
IsAsap: False,
WindowStartUtc: 0001-01-01,
WindowEndUtc: 0001-01-01,
WindowText: String,
DueUtc: 0001-01-01,
DueText: String,
PingAfterUtc: 0001-01-01,
PingExpiresUtc: 0001-01-01,
CandidateCode: String,
HeldReason: String,
HeldUtc: 0001-01-01,
CustomerName: String,
CustomerPhone: String,
Handoff: String,
GateCode: String,
Instructions: String,
DamageNote: String,
DeliveredToName: String,
PayMode: String,
Fare: 0,
FinalPrice: 0,
TipAmount: 0,
CancelledBy: String,
CancelReason: String,
CancelFeeApplied: 0,
MissedFeeApplied: 0,
CaptureMode: String,
AuthorizedAmount: 0,
CapturedAmount: 0,
RefundedAmount: 0,
ChargeError: String,
CreatedAt: 0001-01-01,
ArrivedUtc: 0001-01-01,
PickedUpUtc: 0001-01-01,
IntakeUtc: 0001-01-01,
ReadyUtc: 0001-01-01,
OutForDeliveryUtc: 0001-01-01,
DeliveredUtc: 0001-01-01,
MissedUtc: 0001-01-01,
CancelledUtc: 0001-01-01,
IsClosed: False,
RebookOfId: 0,
RecurrenceId: 0,
PickupLoadId: 0,
Rule:
{
PingSecs: 0,
MissedWaitMin: 0,
MissedFee: 0,
CancelFee: 0,
MissedAutoRebook: False,
MissedRequireContact: False,
MissedRequirePhoto: False,
PayTiming: String,
FinalPriceAfterCount: False,
PayPlanName: String,
PerPickup: 0,
PerStop: 0,
PerMissed: 0,
PerCancel: 0,
AcceptedUtc: 0001-01-01,
Proof:
{
String: String
}
},
Items:
[
{
CourierItemID: 0,
DispatchOdRequestID: 0,
Seq: 0,
TagCode: String,
Custody: String,
IsOpen: False,
IsMissing: False,
MissingReason: String,
IsManual: False,
ReTagFlag: False,
Scanned: False
}
],
Scans:
[
{
TagCode: String,
Stage: String,
Result: String,
AtUtc: 0001-01-01
}
],
Proof:
[
{
Stage: String,
StepKey: String,
Value: String,
AtUtc: 0001-01-01
}
],
Events:
[
{
Kind: String,
Party: String,
Body: String,
AtUtc: 0001-01-01
}
],
Photos:
[
{
PhotoId: 0,
Kind: String,
FileName: String,
Url: String,
TakenUtc: 0001-01-01
}
],
PayLines:
[
{
DispatchLoadID: 0,
Kind: String,
Label: String,
Qty: 0,
Rate: 0,
Amount: 0
}
]
}
],
Order:
{
DispatchOdRequestID: 0,
Code: String,
CourierProfileId: 0,
ProfileName: String,
RouteShape: String,
UnitOne: String,
UnitMany: String,
CourierFacilityId: 0,
FacilityName: String,
ServiceLevelCode: String,
LevelName: String,
Source: String,
Address: String,
Unit: String,
City: String,
Zip: String,
Zone: String,
PickupContactName: String,
DropoffAddress: String,
DropoffUnit: String,
DropoffCity: String,
DropoffZip: String,
DropoffContactName: String,
Miles: 0,
Units: 0,
UnitsFound: 0,
Stage: String,
CourierStep: String,
StepLabel: String,
DriverCode: String,
DriverName: String,
DriverContactId: 0,
CourierRunId: 0,
RunCode: String,
StopSequence: 0,
QueueSequence: 0,
IsAsap: False,
WindowStartUtc: 0001-01-01,
WindowEndUtc: 0001-01-01,
WindowText: String,
DueUtc: 0001-01-01,
DueText: String,
PingAfterUtc: 0001-01-01,
PingExpiresUtc: 0001-01-01,
CandidateCode: String,
HeldReason: String,
HeldUtc: 0001-01-01,
CustomerName: String,
CustomerPhone: String,
Handoff: String,
GateCode: String,
Instructions: String,
DamageNote: String,
DeliveredToName: String,
PayMode: String,
Fare: 0,
FinalPrice: 0,
TipAmount: 0,
CancelledBy: String,
CancelReason: String,
CancelFeeApplied: 0,
MissedFeeApplied: 0,
CaptureMode: String,
AuthorizedAmount: 0,
CapturedAmount: 0,
RefundedAmount: 0,
ChargeError: String,
CreatedAt: 0001-01-01,
ArrivedUtc: 0001-01-01,
PickedUpUtc: 0001-01-01,
IntakeUtc: 0001-01-01,
ReadyUtc: 0001-01-01,
OutForDeliveryUtc: 0001-01-01,
DeliveredUtc: 0001-01-01,
MissedUtc: 0001-01-01,
CancelledUtc: 0001-01-01,
IsClosed: False,
RebookOfId: 0,
RecurrenceId: 0,
PickupLoadId: 0,
Rule:
{
PingSecs: 0,
MissedWaitMin: 0,
MissedFee: 0,
CancelFee: 0,
MissedAutoRebook: False,
MissedRequireContact: False,
MissedRequirePhoto: False,
PayTiming: String,
FinalPriceAfterCount: False,
PayPlanName: String,
PerPickup: 0,
PerStop: 0,
PerMissed: 0,
PerCancel: 0,
AcceptedUtc: 0001-01-01,
Proof:
{
String: String
}
},
Items:
[
{
CourierItemID: 0,
DispatchOdRequestID: 0,
Seq: 0,
TagCode: String,
Custody: String,
IsOpen: False,
IsMissing: False,
MissingReason: String,
IsManual: False,
ReTagFlag: False,
Scanned: False
}
],
Scans:
[
{
TagCode: String,
Stage: String,
Result: String,
AtUtc: 0001-01-01
}
],
Proof:
[
{
Stage: String,
StepKey: String,
Value: String,
AtUtc: 0001-01-01
}
],
Events:
[
{
Kind: String,
Party: String,
Body: String,
AtUtc: 0001-01-01
}
],
Photos:
[
{
PhotoId: 0,
Kind: String,
FileName: String,
Url: String,
TakenUtc: 0001-01-01
}
],
PayLines:
[
{
DispatchLoadID: 0,
Kind: String,
Label: String,
Qty: 0,
Rate: 0,
Amount: 0
}
]
},
Message: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}