Trendsic Platform Service

CourierOrdersRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/courier/orders

**CourierOrdersRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Status	query	string	No
ProfileId	query	int?	No

**CourierOrderResponse** Parameters:
Name	Parameter	Data Type	Required
Orders	form	List<CourierOrderView>	No
Order	form	CourierOrderView	No
Message	form	string	No
ResponseStatus	form	ResponseStatus	No

**CourierOrderView** Parameters:
Name	Parameter	Data Type	Required
DispatchOdRequestID	form	int	No
Code	form	string	No
CourierProfileId	form	int	No
ProfileName	form	string	No
RouteShape	form	string	No
UnitOne	form	string	No
UnitMany	form	string	No
CourierFacilityId	form	int?	No
FacilityName	form	string	No
ServiceLevelCode	form	string	No
LevelName	form	string	No
Source	form	string	No
Address	form	string	No
Unit	form	string	No
City	form	string	No
Zip	form	string	No
Zone	form	string	No
PickupContactName	form	string	No
DropoffAddress	form	string	No
DropoffUnit	form	string	No
DropoffCity	form	string	No
DropoffZip	form	string	No
DropoffContactName	form	string	No
Miles	form	decimal?	No
Units	form	int	No
UnitsFound	form	int?	No
Stage	form	string	No
CourierStep	form	string	No
StepLabel	form	string	No
DriverCode	form	string	No
DriverName	form	string	No
DriverContactId	form	int?	No
CourierRunId	form	int?	No
RunCode	form	string	No
StopSequence	form	int?	No
QueueSequence	form	int?	No
IsAsap	form	bool	No
WindowStartUtc	form	DateTime?	No
WindowEndUtc	form	DateTime?	No
WindowText	form	string	No
DueUtc	form	DateTime?	No
DueText	form	string	No
PingAfterUtc	form	DateTime?	No
PingExpiresUtc	form	DateTime?	No
CandidateCode	form	string	No
HeldReason	form	string	No
HeldUtc	form	DateTime?	No
CustomerName	form	string	No
CustomerPhone	form	string	No
Handoff	form	string	No
GateCode	form	string	No
Instructions	form	string	No
DamageNote	form	string	No
DeliveredToName	form	string	No
PayMode	form	string	No
Fare	form	decimal?	No
FinalPrice	form	decimal?	No
TipAmount	form	decimal?	No
CancelledBy	form	string	No
CancelReason	form	string	No
CancelFeeApplied	form	decimal?	No
MissedFeeApplied	form	decimal?	No
CaptureMode	form	string	No
AuthorizedAmount	form	decimal?	No
CapturedAmount	form	decimal?	No
RefundedAmount	form	decimal	No
ChargeError	form	string	No
CreatedAt	form	DateTime?	No
ArrivedUtc	form	DateTime?	No
PickedUpUtc	form	DateTime?	No
IntakeUtc	form	DateTime?	No
ReadyUtc	form	DateTime?	No
OutForDeliveryUtc	form	DateTime?	No
DeliveredUtc	form	DateTime?	No
MissedUtc	form	DateTime?	No
CancelledUtc	form	DateTime?	No
IsClosed	form	bool	No
RebookOfId	form	int?	No
RecurrenceId	form	int?	No
PickupLoadId	form	int?	No
Rule	form	CourierOrderRuleView	No
Items	form	List<CourierItemView>	No
Scans	form	List<CourierScanView>	No
Proof	form	List<CourierProofResultView>	No
Events	form	List<CourierEventView>	No
Photos	form	List<CourierPhotoView>	No
PayLines	form	List<CourierPayLineView>	No

**CourierOrderRuleView** Parameters:
Name	Parameter	Data Type	Required
PingSecs	form	int	No
MissedWaitMin	form	int	No
MissedFee	form	decimal	No
CancelFee	form	decimal	No
MissedAutoRebook	form	bool	No
MissedRequireContact	form	bool	No
MissedRequirePhoto	form	bool	No
PayTiming	form	string	No
FinalPriceAfterCount	form	bool	No
PayPlanName	form	string	No
PerPickup	form	decimal	No
PerStop	form	decimal	No
PerMissed	form	decimal	No
PerCancel	form	decimal	No
AcceptedUtc	form	DateTime?	No
Proof	form	Dictionary<string, string>	No

**CourierItemView** Parameters:
Name	Parameter	Data Type	Required
CourierItemID	form	int	No
DispatchOdRequestID	form	int	No
Seq	form	int	No
TagCode	form	string	No
Custody	form	string	No
IsOpen	form	bool	No
IsMissing	form	bool	No
MissingReason	form	string	No
IsManual	form	bool	No
ReTagFlag	form	bool	No
Scanned	form	bool	No

**CourierScanView** Parameters:
Name	Parameter	Data Type	Required
TagCode	form	string	No
Stage	form	string	No
Result	form	string	No
AtUtc	form	DateTime	No

**CourierProofResultView** Parameters:
Name	Parameter	Data Type	Required
Stage	form	string	No
StepKey	form	string	No
Value	form	string	No
AtUtc	form	DateTime	No

**CourierEventView** Parameters:
Name	Parameter	Data Type	Required
Kind	form	string	No
Party	form	string	No
Body	form	string	No
AtUtc	form	DateTime	No

**CourierPhotoView** Parameters:
Name	Parameter	Data Type	Required
PhotoId	form	int	No
Kind	form	string	No
FileName	form	string	No
Url	form	string	No
TakenUtc	form	DateTime?	No

**CourierPayLineView** Parameters:
Name	Parameter	Data Type	Required
DispatchLoadID	form	int	No
Kind	form	string	No
Label	form	string	No
Qty	form	decimal?	No
Rate	form	decimal?	No
Amount	form	decimal	No

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.

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

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
		}
	}
}