Trendsic Platform Service

CourierOrderInstructionsRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/courier/orders/{Code}/instructions


export class CourierOrderRuleView
{
    public PingSecs: number;
    public MissedWaitMin: number;
    public MissedFee: number;
    public CancelFee: number;
    public MissedAutoRebook: boolean;
    public MissedRequireContact: boolean;
    public MissedRequirePhoto: boolean;
    public PayTiming: string;
    public FinalPriceAfterCount: boolean;
    public PayPlanName: string;
    public PerPickup: number;
    public PerStop: number;
    public PerMissed: number;
    public PerCancel: number;
    public AcceptedUtc?: string;
    public Proof: { [index:string]: string; } = {};

    public constructor(init?: Partial<CourierOrderRuleView>) { (Object as any).assign(this, init); }
}

export class CourierItemView
{
    public CourierItemID: number;
    public DispatchOdRequestID: number;
    public Seq: number;
    public TagCode: string;
    public Custody: string;
    public IsOpen: boolean;
    public IsMissing: boolean;
    public MissingReason: string;
    public IsManual: boolean;
    public ReTagFlag: boolean;
    public Scanned: boolean;

    public constructor(init?: Partial<CourierItemView>) { (Object as any).assign(this, init); }
}

export class CourierScanView
{
    public TagCode: string;
    public Stage: string;
    public Result: string;
    public AtUtc: string;

    public constructor(init?: Partial<CourierScanView>) { (Object as any).assign(this, init); }
}

export class CourierProofResultView
{
    public Stage: string;
    public StepKey: string;
    public Value: string;
    public AtUtc: string;

    public constructor(init?: Partial<CourierProofResultView>) { (Object as any).assign(this, init); }
}

export class CourierEventView
{
    public Kind: string;
    public Party: string;
    public Body: string;
    public AtUtc: string;

    public constructor(init?: Partial<CourierEventView>) { (Object as any).assign(this, init); }
}

export class CourierPhotoView
{
    public PhotoId: number;
    public Kind: string;
    public FileName: string;
    public Url: string;
    public TakenUtc?: string;

    public constructor(init?: Partial<CourierPhotoView>) { (Object as any).assign(this, init); }
}

export class CourierPayLineView
{
    public DispatchLoadID: number;
    public Kind: string;
    public Label: string;
    public Qty?: number;
    public Rate?: number;
    public Amount: number;

    public constructor(init?: Partial<CourierPayLineView>) { (Object as any).assign(this, init); }
}

export class CourierOrderView
{
    public DispatchOdRequestID: number;
    public Code: string;
    public CourierProfileId: number;
    public ProfileName: string;
    public RouteShape: string;
    public UnitOne: string;
    public UnitMany: string;
    public CourierFacilityId?: number;
    public FacilityName: string;
    public ServiceLevelCode: string;
    public LevelName: string;
    public Source: string;
    public Address: string;
    public Unit: string;
    public City: string;
    public Zip: string;
    public Zone: string;
    public PickupContactName: string;
    public DropoffAddress: string;
    public DropoffUnit: string;
    public DropoffCity: string;
    public DropoffZip: string;
    public DropoffContactName: string;
    public Miles?: number;
    public Units: number;
    public UnitsFound?: number;
    public Stage: string;
    public CourierStep: string;
    public StepLabel: string;
    public DriverCode: string;
    public DriverName: string;
    public DriverContactId?: number;
    public CourierRunId?: number;
    public RunCode: string;
    public StopSequence?: number;
    public QueueSequence?: number;
    public IsAsap: boolean;
    public WindowStartUtc?: string;
    public WindowEndUtc?: string;
    public WindowText: string;
    public DueUtc?: string;
    public DueText: string;
    public PingAfterUtc?: string;
    public PingExpiresUtc?: string;
    public CandidateCode: string;
    public HeldReason: string;
    public HeldUtc?: string;
    public CustomerName: string;
    public CustomerPhone: string;
    public Handoff: string;
    public GateCode: string;
    public Instructions: string;
    public DamageNote: string;
    public DeliveredToName: string;
    public PayMode: string;
    public Fare?: number;
    public FinalPrice?: number;
    public TipAmount?: number;
    public CancelledBy: string;
    public CancelReason: string;
    public CancelFeeApplied?: number;
    public MissedFeeApplied?: number;
    public CaptureMode: string;
    public AuthorizedAmount?: number;
    public CapturedAmount?: number;
    public RefundedAmount: number;
    public ChargeError: string;
    public CreatedAt?: string;
    public ArrivedUtc?: string;
    public PickedUpUtc?: string;
    public IntakeUtc?: string;
    public ReadyUtc?: string;
    public OutForDeliveryUtc?: string;
    public DeliveredUtc?: string;
    public MissedUtc?: string;
    public CancelledUtc?: string;
    public IsClosed: boolean;
    public RebookOfId?: number;
    public RecurrenceId?: number;
    public PickupLoadId?: number;
    public Rule: CourierOrderRuleView;
    public Items: CourierItemView[] = [];
    public Scans: CourierScanView[] = [];
    public Proof: CourierProofResultView[] = [];
    public Events: CourierEventView[] = [];
    public Photos: CourierPhotoView[] = [];
    public PayLines: CourierPayLineView[] = [];

    public constructor(init?: Partial<CourierOrderView>) { (Object as any).assign(this, init); }
}

export class CourierOrderResponse
{
    public Orders: CourierOrderView[] = [];
    public Order: CourierOrderView;
    public Message: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CourierOrderResponse>) { (Object as any).assign(this, init); }
}

export class CourierOrderInstructionsRequest
{
    public Code: string;
    public Instructions: string;
    public GateCode: string;
    public Handoff: string;

    public constructor(init?: Partial<CourierOrderInstructionsRequest>) { (Object as any).assign(this, init); }
}

TypeScript CourierOrderInstructionsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CourierOrderInstructionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Code>String</Code>
  <GateCode>String</GateCode>
  <Handoff>String</Handoff>
  <Instructions>String</Instructions>
</CourierOrderInstructionsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Message>String</Message>
  <Order>
    <Address>String</Address>
    <ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
    <AuthorizedAmount>0</AuthorizedAmount>
    <CancelFeeApplied>0</CancelFeeApplied>
    <CancelReason>String</CancelReason>
    <CancelledBy>String</CancelledBy>
    <CancelledUtc>0001-01-01T00:00:00</CancelledUtc>
    <CandidateCode>String</CandidateCode>
    <CaptureMode>String</CaptureMode>
    <CapturedAmount>0</CapturedAmount>
    <ChargeError>String</ChargeError>
    <City>String</City>
    <Code>String</Code>
    <CourierFacilityId>0</CourierFacilityId>
    <CourierProfileId>0</CourierProfileId>
    <CourierRunId>0</CourierRunId>
    <CourierStep>String</CourierStep>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CustomerName>String</CustomerName>
    <CustomerPhone>String</CustomerPhone>
    <DamageNote>String</DamageNote>
    <DeliveredToName>String</DeliveredToName>
    <DeliveredUtc>0001-01-01T00:00:00</DeliveredUtc>
    <DispatchOdRequestID>0</DispatchOdRequestID>
    <DriverCode>String</DriverCode>
    <DriverContactId>0</DriverContactId>
    <DriverName>String</DriverName>
    <DropoffAddress>String</DropoffAddress>
    <DropoffCity>String</DropoffCity>
    <DropoffContactName>String</DropoffContactName>
    <DropoffUnit>String</DropoffUnit>
    <DropoffZip>String</DropoffZip>
    <DueText>String</DueText>
    <DueUtc>0001-01-01T00:00:00</DueUtc>
    <Events>
      <CourierEventView>
        <AtUtc>0001-01-01T00:00:00</AtUtc>
        <Body>String</Body>
        <Kind>String</Kind>
        <Party>String</Party>
      </CourierEventView>
    </Events>
    <FacilityName>String</FacilityName>
    <Fare>0</Fare>
    <FinalPrice>0</FinalPrice>
    <GateCode>String</GateCode>
    <Handoff>String</Handoff>
    <HeldReason>String</HeldReason>
    <HeldUtc>0001-01-01T00:00:00</HeldUtc>
    <Instructions>String</Instructions>
    <IntakeUtc>0001-01-01T00:00:00</IntakeUtc>
    <IsAsap>false</IsAsap>
    <IsClosed>false</IsClosed>
    <Items>
      <CourierItemView>
        <CourierItemID>0</CourierItemID>
        <Custody>String</Custody>
        <DispatchOdRequestID>0</DispatchOdRequestID>
        <IsManual>false</IsManual>
        <IsMissing>false</IsMissing>
        <IsOpen>false</IsOpen>
        <MissingReason>String</MissingReason>
        <ReTagFlag>false</ReTagFlag>
        <Scanned>false</Scanned>
        <Seq>0</Seq>
        <TagCode>String</TagCode>
      </CourierItemView>
    </Items>
    <LevelName>String</LevelName>
    <Miles>0</Miles>
    <MissedFeeApplied>0</MissedFeeApplied>
    <MissedUtc>0001-01-01T00:00:00</MissedUtc>
    <OutForDeliveryUtc>0001-01-01T00:00:00</OutForDeliveryUtc>
    <PayLines>
      <CourierPayLineView>
        <Amount>0</Amount>
        <DispatchLoadID>0</DispatchLoadID>
        <Kind>String</Kind>
        <Label>String</Label>
        <Qty>0</Qty>
        <Rate>0</Rate>
      </CourierPayLineView>
    </PayLines>
    <PayMode>String</PayMode>
    <Photos>
      <CourierPhotoView>
        <FileName>String</FileName>
        <Kind>String</Kind>
        <PhotoId>0</PhotoId>
        <TakenUtc>0001-01-01T00:00:00</TakenUtc>
        <Url>String</Url>
      </CourierPhotoView>
    </Photos>
    <PickedUpUtc>0001-01-01T00:00:00</PickedUpUtc>
    <PickupContactName>String</PickupContactName>
    <PickupLoadId>0</PickupLoadId>
    <PingAfterUtc>0001-01-01T00:00:00</PingAfterUtc>
    <PingExpiresUtc>0001-01-01T00:00:00</PingExpiresUtc>
    <ProfileName>String</ProfileName>
    <Proof>
      <CourierProofResultView>
        <AtUtc>0001-01-01T00:00:00</AtUtc>
        <Stage>String</Stage>
        <StepKey>String</StepKey>
        <Value>String</Value>
      </CourierProofResultView>
    </Proof>
    <QueueSequence>0</QueueSequence>
    <ReadyUtc>0001-01-01T00:00:00</ReadyUtc>
    <RebookOfId>0</RebookOfId>
    <RecurrenceId>0</RecurrenceId>
    <RefundedAmount>0</RefundedAmount>
    <RouteShape>String</RouteShape>
    <Rule>
      <AcceptedUtc>0001-01-01T00:00:00</AcceptedUtc>
      <CancelFee>0</CancelFee>
      <FinalPriceAfterCount>false</FinalPriceAfterCount>
      <MissedAutoRebook>false</MissedAutoRebook>
      <MissedFee>0</MissedFee>
      <MissedRequireContact>false</MissedRequireContact>
      <MissedRequirePhoto>false</MissedRequirePhoto>
      <MissedWaitMin>0</MissedWaitMin>
      <PayPlanName>String</PayPlanName>
      <PayTiming>String</PayTiming>
      <PerCancel>0</PerCancel>
      <PerMissed>0</PerMissed>
      <PerPickup>0</PerPickup>
      <PerStop>0</PerStop>
      <PingSecs>0</PingSecs>
      <Proof xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Proof>
    </Rule>
    <RunCode>String</RunCode>
    <Scans>
      <CourierScanView>
        <AtUtc>0001-01-01T00:00:00</AtUtc>
        <Result>String</Result>
        <Stage>String</Stage>
        <TagCode>String</TagCode>
      </CourierScanView>
    </Scans>
    <ServiceLevelCode>String</ServiceLevelCode>
    <Source>String</Source>
    <Stage>String</Stage>
    <StepLabel>String</StepLabel>
    <StopSequence>0</StopSequence>
    <TipAmount>0</TipAmount>
    <Unit>String</Unit>
    <UnitMany>String</UnitMany>
    <UnitOne>String</UnitOne>
    <Units>0</Units>
    <UnitsFound>0</UnitsFound>
    <WindowEndUtc>0001-01-01T00:00:00</WindowEndUtc>
    <WindowStartUtc>0001-01-01T00:00:00</WindowStartUtc>
    <WindowText>String</WindowText>
    <Zip>String</Zip>
    <Zone>String</Zone>
  </Order>
  <Orders>
    <CourierOrderView>
      <Address>String</Address>
      <ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
      <AuthorizedAmount>0</AuthorizedAmount>
      <CancelFeeApplied>0</CancelFeeApplied>
      <CancelReason>String</CancelReason>
      <CancelledBy>String</CancelledBy>
      <CancelledUtc>0001-01-01T00:00:00</CancelledUtc>
      <CandidateCode>String</CandidateCode>
      <CaptureMode>String</CaptureMode>
      <CapturedAmount>0</CapturedAmount>
      <ChargeError>String</ChargeError>
      <City>String</City>
      <Code>String</Code>
      <CourierFacilityId>0</CourierFacilityId>
      <CourierProfileId>0</CourierProfileId>
      <CourierRunId>0</CourierRunId>
      <CourierStep>String</CourierStep>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CustomerName>String</CustomerName>
      <CustomerPhone>String</CustomerPhone>
      <DamageNote>String</DamageNote>
      <DeliveredToName>String</DeliveredToName>
      <DeliveredUtc>0001-01-01T00:00:00</DeliveredUtc>
      <DispatchOdRequestID>0</DispatchOdRequestID>
      <DriverCode>String</DriverCode>
      <DriverContactId>0</DriverContactId>
      <DriverName>String</DriverName>
      <DropoffAddress>String</DropoffAddress>
      <DropoffCity>String</DropoffCity>
      <DropoffContactName>String</DropoffContactName>
      <DropoffUnit>String</DropoffUnit>
      <DropoffZip>String</DropoffZip>
      <DueText>String</DueText>
      <DueUtc>0001-01-01T00:00:00</DueUtc>
      <Events>
        <CourierEventView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <Body>String</Body>
          <Kind>String</Kind>
          <Party>String</Party>
        </CourierEventView>
      </Events>
      <FacilityName>String</FacilityName>
      <Fare>0</Fare>
      <FinalPrice>0</FinalPrice>
      <GateCode>String</GateCode>
      <Handoff>String</Handoff>
      <HeldReason>String</HeldReason>
      <HeldUtc>0001-01-01T00:00:00</HeldUtc>
      <Instructions>String</Instructions>
      <IntakeUtc>0001-01-01T00:00:00</IntakeUtc>
      <IsAsap>false</IsAsap>
      <IsClosed>false</IsClosed>
      <Items>
        <CourierItemView>
          <CourierItemID>0</CourierItemID>
          <Custody>String</Custody>
          <DispatchOdRequestID>0</DispatchOdRequestID>
          <IsManual>false</IsManual>
          <IsMissing>false</IsMissing>
          <IsOpen>false</IsOpen>
          <MissingReason>String</MissingReason>
          <ReTagFlag>false</ReTagFlag>
          <Scanned>false</Scanned>
          <Seq>0</Seq>
          <TagCode>String</TagCode>
        </CourierItemView>
      </Items>
      <LevelName>String</LevelName>
      <Miles>0</Miles>
      <MissedFeeApplied>0</MissedFeeApplied>
      <MissedUtc>0001-01-01T00:00:00</MissedUtc>
      <OutForDeliveryUtc>0001-01-01T00:00:00</OutForDeliveryUtc>
      <PayLines>
        <CourierPayLineView>
          <Amount>0</Amount>
          <DispatchLoadID>0</DispatchLoadID>
          <Kind>String</Kind>
          <Label>String</Label>
          <Qty>0</Qty>
          <Rate>0</Rate>
        </CourierPayLineView>
      </PayLines>
      <PayMode>String</PayMode>
      <Photos>
        <CourierPhotoView>
          <FileName>String</FileName>
          <Kind>String</Kind>
          <PhotoId>0</PhotoId>
          <TakenUtc>0001-01-01T00:00:00</TakenUtc>
          <Url>String</Url>
        </CourierPhotoView>
      </Photos>
      <PickedUpUtc>0001-01-01T00:00:00</PickedUpUtc>
      <PickupContactName>String</PickupContactName>
      <PickupLoadId>0</PickupLoadId>
      <PingAfterUtc>0001-01-01T00:00:00</PingAfterUtc>
      <PingExpiresUtc>0001-01-01T00:00:00</PingExpiresUtc>
      <ProfileName>String</ProfileName>
      <Proof>
        <CourierProofResultView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <Stage>String</Stage>
          <StepKey>String</StepKey>
          <Value>String</Value>
        </CourierProofResultView>
      </Proof>
      <QueueSequence>0</QueueSequence>
      <ReadyUtc>0001-01-01T00:00:00</ReadyUtc>
      <RebookOfId>0</RebookOfId>
      <RecurrenceId>0</RecurrenceId>
      <RefundedAmount>0</RefundedAmount>
      <RouteShape>String</RouteShape>
      <Rule>
        <AcceptedUtc>0001-01-01T00:00:00</AcceptedUtc>
        <CancelFee>0</CancelFee>
        <FinalPriceAfterCount>false</FinalPriceAfterCount>
        <MissedAutoRebook>false</MissedAutoRebook>
        <MissedFee>0</MissedFee>
        <MissedRequireContact>false</MissedRequireContact>
        <MissedRequirePhoto>false</MissedRequirePhoto>
        <MissedWaitMin>0</MissedWaitMin>
        <PayPlanName>String</PayPlanName>
        <PayTiming>String</PayTiming>
        <PerCancel>0</PerCancel>
        <PerMissed>0</PerMissed>
        <PerPickup>0</PerPickup>
        <PerStop>0</PerStop>
        <PingSecs>0</PingSecs>
        <Proof xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Proof>
      </Rule>
      <RunCode>String</RunCode>
      <Scans>
        <CourierScanView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <Result>String</Result>
          <Stage>String</Stage>
          <TagCode>String</TagCode>
        </CourierScanView>
      </Scans>
      <ServiceLevelCode>String</ServiceLevelCode>
      <Source>String</Source>
      <Stage>String</Stage>
      <StepLabel>String</StepLabel>
      <StopSequence>0</StopSequence>
      <TipAmount>0</TipAmount>
      <Unit>String</Unit>
      <UnitMany>String</UnitMany>
      <UnitOne>String</UnitOne>
      <Units>0</Units>
      <UnitsFound>0</UnitsFound>
      <WindowEndUtc>0001-01-01T00:00:00</WindowEndUtc>
      <WindowStartUtc>0001-01-01T00:00:00</WindowStartUtc>
      <WindowText>String</WindowText>
      <Zip>String</Zip>
      <Zone>String</Zone>
    </CourierOrderView>
  </Orders>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CourierOrderResponse>