Trendsic Platform Service

<back to all web services

CourierOrdersRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/courier/orders
CourierOrdersRequest Parameters:
NameParameterData TypeRequiredDescription
StatusquerystringNo
ProfileIdqueryint?No
CourierOrderResponse Parameters:
NameParameterData TypeRequiredDescription
OrdersformList<CourierOrderView>No
OrderformCourierOrderViewNo
MessageformstringNo
ResponseStatusformResponseStatusNo
CourierOrderView Parameters:
NameParameterData TypeRequiredDescription
DispatchOdRequestIDformintNo
CodeformstringNo
CourierProfileIdformintNo
ProfileNameformstringNo
RouteShapeformstringNo
UnitOneformstringNo
UnitManyformstringNo
CourierFacilityIdformint?No
FacilityNameformstringNo
ServiceLevelCodeformstringNo
LevelNameformstringNo
SourceformstringNo
AddressformstringNo
UnitformstringNo
CityformstringNo
ZipformstringNo
ZoneformstringNo
PickupContactNameformstringNo
DropoffAddressformstringNo
DropoffUnitformstringNo
DropoffCityformstringNo
DropoffZipformstringNo
DropoffContactNameformstringNo
Milesformdecimal?No
UnitsformintNo
UnitsFoundformint?No
StageformstringNo
CourierStepformstringNo
StepLabelformstringNo
DriverCodeformstringNo
DriverNameformstringNo
DriverContactIdformint?No
CourierRunIdformint?No
RunCodeformstringNo
StopSequenceformint?No
QueueSequenceformint?No
IsAsapformboolNo
WindowStartUtcformDateTime?No
WindowEndUtcformDateTime?No
WindowTextformstringNo
DueUtcformDateTime?No
DueTextformstringNo
PingAfterUtcformDateTime?No
PingExpiresUtcformDateTime?No
CandidateCodeformstringNo
HeldReasonformstringNo
HeldUtcformDateTime?No
CustomerNameformstringNo
CustomerPhoneformstringNo
HandoffformstringNo
GateCodeformstringNo
InstructionsformstringNo
DamageNoteformstringNo
DeliveredToNameformstringNo
PayModeformstringNo
Fareformdecimal?No
FinalPriceformdecimal?No
TipAmountformdecimal?No
CancelledByformstringNo
CancelReasonformstringNo
CancelFeeAppliedformdecimal?No
MissedFeeAppliedformdecimal?No
CaptureModeformstringNo
AuthorizedAmountformdecimal?No
CapturedAmountformdecimal?No
RefundedAmountformdecimalNo
ChargeErrorformstringNo
CreatedAtformDateTime?No
ArrivedUtcformDateTime?No
PickedUpUtcformDateTime?No
IntakeUtcformDateTime?No
ReadyUtcformDateTime?No
OutForDeliveryUtcformDateTime?No
DeliveredUtcformDateTime?No
MissedUtcformDateTime?No
CancelledUtcformDateTime?No
IsClosedformboolNo
RebookOfIdformint?No
RecurrenceIdformint?No
PickupLoadIdformint?No
RuleformCourierOrderRuleViewNo
ItemsformList<CourierItemView>No
ScansformList<CourierScanView>No
ProofformList<CourierProofResultView>No
EventsformList<CourierEventView>No
PhotosformList<CourierPhotoView>No
PayLinesformList<CourierPayLineView>No
CourierOrderRuleView Parameters:
NameParameterData TypeRequiredDescription
PingSecsformintNo
MissedWaitMinformintNo
MissedFeeformdecimalNo
CancelFeeformdecimalNo
MissedAutoRebookformboolNo
MissedRequireContactformboolNo
MissedRequirePhotoformboolNo
PayTimingformstringNo
FinalPriceAfterCountformboolNo
PayPlanNameformstringNo
PerPickupformdecimalNo
PerStopformdecimalNo
PerMissedformdecimalNo
PerCancelformdecimalNo
AcceptedUtcformDateTime?No
ProofformDictionary<string, string>No
CourierItemView Parameters:
NameParameterData TypeRequiredDescription
CourierItemIDformintNo
DispatchOdRequestIDformintNo
SeqformintNo
TagCodeformstringNo
CustodyformstringNo
IsOpenformboolNo
IsMissingformboolNo
MissingReasonformstringNo
IsManualformboolNo
ReTagFlagformboolNo
ScannedformboolNo
CourierScanView Parameters:
NameParameterData TypeRequiredDescription
TagCodeformstringNo
StageformstringNo
ResultformstringNo
AtUtcformDateTimeNo
CourierProofResultView Parameters:
NameParameterData TypeRequiredDescription
StageformstringNo
StepKeyformstringNo
ValueformstringNo
AtUtcformDateTimeNo
CourierEventView Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
PartyformstringNo
BodyformstringNo
AtUtcformDateTimeNo
CourierPhotoView Parameters:
NameParameterData TypeRequiredDescription
PhotoIdformintNo
KindformstringNo
FileNameformstringNo
UrlformstringNo
TakenUtcformDateTime?No
CourierPayLineView Parameters:
NameParameterData TypeRequiredDescription
DispatchLoadIDformintNo
KindformstringNo
LabelformstringNo
Qtyformdecimal?No
Rateformdecimal?No
AmountformdecimalNo

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.

GET /v1/dispatch/courier/orders HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","WindowEndUtc":"0001-01-01T00:00:00.0000000","WindowText":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","PingAfterUtc":"0001-01-01T00:00:00.0000000","PingExpiresUtc":"0001-01-01T00:00:00.0000000","CandidateCode":"String","HeldReason":"String","HeldUtc":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","ArrivedUtc":"0001-01-01T00:00:00.0000000","PickedUpUtc":"0001-01-01T00:00:00.0000000","IntakeUtc":"0001-01-01T00:00:00.0000000","ReadyUtc":"0001-01-01T00:00:00.0000000","OutForDeliveryUtc":"0001-01-01T00:00:00.0000000","DeliveredUtc":"0001-01-01T00:00:00.0000000","MissedUtc":"0001-01-01T00:00:00.0000000","CancelledUtc":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000"}],"Proof":[{"Stage":"String","StepKey":"String","Value":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"Events":[{"Kind":"String","Party":"String","Body":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"Photos":[{"PhotoId":0,"Kind":"String","FileName":"String","Url":"String","TakenUtc":"0001-01-01T00:00:00.0000000"}],"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-01T00:00:00.0000000","WindowEndUtc":"0001-01-01T00:00:00.0000000","WindowText":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","PingAfterUtc":"0001-01-01T00:00:00.0000000","PingExpiresUtc":"0001-01-01T00:00:00.0000000","CandidateCode":"String","HeldReason":"String","HeldUtc":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","ArrivedUtc":"0001-01-01T00:00:00.0000000","PickedUpUtc":"0001-01-01T00:00:00.0000000","IntakeUtc":"0001-01-01T00:00:00.0000000","ReadyUtc":"0001-01-01T00:00:00.0000000","OutForDeliveryUtc":"0001-01-01T00:00:00.0000000","DeliveredUtc":"0001-01-01T00:00:00.0000000","MissedUtc":"0001-01-01T00:00:00.0000000","CancelledUtc":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000"}],"Proof":[{"Stage":"String","StepKey":"String","Value":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"Events":[{"Kind":"String","Party":"String","Body":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"Photos":[{"PhotoId":0,"Kind":"String","FileName":"String","Url":"String","TakenUtc":"0001-01-01T00:00:00.0000000"}],"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"}}}