Trendsic Platform Service

<back to all web services

CourierOrderReadyRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/courier/orders/{Code}/ready
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CourierOrderRuleView() = 
        member val PingSecs:Int32 = new Int32() with get,set
        member val MissedWaitMin:Int32 = new Int32() with get,set
        member val MissedFee:Decimal = new Decimal() with get,set
        member val CancelFee:Decimal = new Decimal() with get,set
        member val MissedAutoRebook:Boolean = new Boolean() with get,set
        member val MissedRequireContact:Boolean = new Boolean() with get,set
        member val MissedRequirePhoto:Boolean = new Boolean() with get,set
        member val PayTiming:String = null with get,set
        member val FinalPriceAfterCount:Boolean = new Boolean() with get,set
        member val PayPlanName:String = null with get,set
        member val PerPickup:Decimal = new Decimal() with get,set
        member val PerStop:Decimal = new Decimal() with get,set
        member val PerMissed:Decimal = new Decimal() with get,set
        member val PerCancel:Decimal = new Decimal() with get,set
        member val AcceptedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Proof:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type CourierItemView() = 
        member val CourierItemID:Int32 = new Int32() with get,set
        member val DispatchOdRequestID:Int32 = new Int32() with get,set
        member val Seq:Int32 = new Int32() with get,set
        member val TagCode:String = null with get,set
        member val Custody:String = null with get,set
        member val IsOpen:Boolean = new Boolean() with get,set
        member val IsMissing:Boolean = new Boolean() with get,set
        member val MissingReason:String = null with get,set
        member val IsManual:Boolean = new Boolean() with get,set
        member val ReTagFlag:Boolean = new Boolean() with get,set
        member val Scanned:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CourierScanView() = 
        member val TagCode:String = null with get,set
        member val Stage:String = null with get,set
        member val Result:String = null with get,set
        member val AtUtc:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type CourierProofResultView() = 
        member val Stage:String = null with get,set
        member val StepKey:String = null with get,set
        member val Value:String = null with get,set
        member val AtUtc:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type CourierEventView() = 
        member val Kind:String = null with get,set
        member val Party:String = null with get,set
        member val Body:String = null with get,set
        member val AtUtc:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type CourierPhotoView() = 
        member val PhotoId:Int32 = new Int32() with get,set
        member val Kind:String = null with get,set
        member val FileName:String = null with get,set
        member val Url:String = null with get,set
        member val TakenUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type CourierPayLineView() = 
        member val DispatchLoadID:Int32 = new Int32() with get,set
        member val Kind:String = null with get,set
        member val Label:String = null with get,set
        member val Qty:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Rate:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Amount:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type CourierOrderView() = 
        member val DispatchOdRequestID:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val CourierProfileId:Int32 = new Int32() with get,set
        member val ProfileName:String = null with get,set
        member val RouteShape:String = null with get,set
        member val UnitOne:String = null with get,set
        member val UnitMany:String = null with get,set
        member val CourierFacilityId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val FacilityName:String = null with get,set
        member val ServiceLevelCode:String = null with get,set
        member val LevelName:String = null with get,set
        member val Source:String = null with get,set
        member val Address:String = null with get,set
        member val Unit:String = null with get,set
        member val City:String = null with get,set
        member val Zip:String = null with get,set
        member val Zone:String = null with get,set
        member val PickupContactName:String = null with get,set
        member val DropoffAddress:String = null with get,set
        member val DropoffUnit:String = null with get,set
        member val DropoffCity:String = null with get,set
        member val DropoffZip:String = null with get,set
        member val DropoffContactName:String = null with get,set
        member val Miles:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Units:Int32 = new Int32() with get,set
        member val UnitsFound:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Stage:String = null with get,set
        member val CourierStep:String = null with get,set
        member val StepLabel:String = null with get,set
        member val DriverCode:String = null with get,set
        member val DriverName:String = null with get,set
        member val DriverContactId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CourierRunId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RunCode:String = null with get,set
        member val StopSequence:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val QueueSequence:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsAsap:Boolean = new Boolean() with get,set
        member val WindowStartUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val WindowEndUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val WindowText:String = null with get,set
        member val DueUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DueText:String = null with get,set
        member val PingAfterUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PingExpiresUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CandidateCode:String = null with get,set
        member val HeldReason:String = null with get,set
        member val HeldUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CustomerName:String = null with get,set
        member val CustomerPhone:String = null with get,set
        member val Handoff:String = null with get,set
        member val GateCode:String = null with get,set
        member val Instructions:String = null with get,set
        member val DamageNote:String = null with get,set
        member val DeliveredToName:String = null with get,set
        member val PayMode:String = null with get,set
        member val Fare:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val FinalPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TipAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CancelledBy:String = null with get,set
        member val CancelReason:String = null with get,set
        member val CancelFeeApplied:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val MissedFeeApplied:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CaptureMode:String = null with get,set
        member val AuthorizedAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CapturedAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val RefundedAmount:Decimal = new Decimal() with get,set
        member val ChargeError:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ArrivedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PickedUpUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IntakeUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ReadyUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val OutForDeliveryUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeliveredUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val MissedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CancelledUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IsClosed:Boolean = new Boolean() with get,set
        member val RebookOfId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RecurrenceId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PickupLoadId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Rule:CourierOrderRuleView = null with get,set
        member val Items:ResizeArray<CourierItemView> = new ResizeArray<CourierItemView>() with get,set
        member val Scans:ResizeArray<CourierScanView> = new ResizeArray<CourierScanView>() with get,set
        member val Proof:ResizeArray<CourierProofResultView> = new ResizeArray<CourierProofResultView>() with get,set
        member val Events:ResizeArray<CourierEventView> = new ResizeArray<CourierEventView>() with get,set
        member val Photos:ResizeArray<CourierPhotoView> = new ResizeArray<CourierPhotoView>() with get,set
        member val PayLines:ResizeArray<CourierPayLineView> = new ResizeArray<CourierPayLineView>() with get,set

    [<AllowNullLiteral>]
    type CourierOrderResponse() = 
        member val Orders:ResizeArray<CourierOrderView> = new ResizeArray<CourierOrderView>() with get,set
        member val Order:CourierOrderView = null with get,set
        member val Message:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CourierOrderReadyRequest() = 
        member val Code:String = null with get,set

F# CourierOrderReadyRequest 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/courier/orders/{Code}/ready HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Code: 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
		}
	}
}