POST api/Dispatch

Add or update Dispatch

Request Information

URI Parameters

None.

Body Parameters

Dispatch message

Name	Type	Additional information
Header	MessageHeader	None.
Dispatches	Collection of Dispatch	None.
Footer	MessageFooter	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "Dispatches": [
    {
      "DispatchType": "Inbound",
      "WarehouseIdentifier": "string 1",
      "DispatchIdentifier": "string 2",
      "RideNumber": "string 3",
      "CarNumber": "string 4",
      "DriverNumber": "string 5",
      "DispatchTime": "2025-12-06T03:58:02.9837851+01:00",
      "DispatchTimeSpecified": true
    },
    {
      "DispatchType": "Inbound",
      "WarehouseIdentifier": "string 1",
      "DispatchIdentifier": "string 2",
      "RideNumber": "string 3",
      "CarNumber": "string 4",
      "DriverNumber": "string 5",
      "DispatchTime": "2025-12-06T03:58:02.9837851+01:00",
      "DispatchTimeSpecified": true
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<PutDispatchMessageRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <Dispatches>
    <Dispatch>
      <DispatchIdentifier>string 2</DispatchIdentifier>
      <RideNumber>string 3</RideNumber>
      <CarNumber>string 4</CarNumber>
      <DriverNumber>string 5</DriverNumber>
      <DispatchTime>2025-12-06T03:58:02.9837851+01:00</DispatchTime>
      <DispatchTimeSpecified>true</DispatchTimeSpecified>
      <DispatchType>Inbound</DispatchType>
      <WarehouseIdentifier>string 1</WarehouseIdentifier>
    </Dispatch>
    <Dispatch>
      <DispatchIdentifier>string 2</DispatchIdentifier>
      <RideNumber>string 3</RideNumber>
      <CarNumber>string 4</CarNumber>
      <DriverNumber>string 5</DriverNumber>
      <DispatchTime>2025-12-06T03:58:02.9837851+01:00</DispatchTime>
      <DispatchTimeSpecified>true</DispatchTimeSpecified>
      <DispatchType>Inbound</DispatchType>
      <WarehouseIdentifier>string 1</WarehouseIdentifier>
    </Dispatch>
  </Dispatches>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</PutDispatchMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Ok: Message with result. Invalid APIKey: HttpStatusCode.Conflict

PutDispatchMessageResponse

Name	Type	Additional information
Header	MessageHeader	None.
DispatchResult	Collection of DispatchResult	None.
Footer	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "DispatchResult": [
    {
      "DispatchIdentifier": "string 1",
      "ProcessingStatus": "P",
      "DispatchImportResult": "string 2"
    },
    {
      "DispatchIdentifier": "string 1",
      "ProcessingStatus": "P",
      "DispatchImportResult": "string 2"
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<PutDispatchMessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <DispatchResult>
    <DispatchResult>
      <DispatchIdentifier>string 1</DispatchIdentifier>
      <ProcessingStatus>P</ProcessingStatus>
      <DispatchImportResult>string 2</DispatchImportResult>
    </DispatchResult>
    <DispatchResult>
      <DispatchIdentifier>string 1</DispatchIdentifier>
      <ProcessingStatus>P</ProcessingStatus>
      <DispatchImportResult>string 2</DispatchImportResult>
    </DispatchResult>
  </DispatchResult>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</PutDispatchMessageResponse>