POST api/public/v2/dispatch

Request Information

URI Parameters

None.

Body Parameters

DriverJobRequestModel
NameDescriptionTypeAdditional information
ApiKey

Your merchant API key

 globally unique identifier

Required
DriverIdentifier

Driver identifier

 globally unique identifier

None.
JobId

Job Id

 integer

None.
JobIdentifier

Job identifier. This can be used in place of JobId

 globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "apiKey": "f1e941ea-aa17-4604-8252-453fb1967c51",
  "driverIdentifier": "bd6c792d-9327-4b51-a1c7-1ab26ea7a06a",
  "jobId": 3,
  "jobIdentifier": "8bc7d58c-77ef-41f3-b500-1b6f1a697284"
}

text/xml

Sample: 
<DriverJobRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Swift.DeliveryAPI2">
  <ApiKey>f1e941ea-aa17-4604-8252-453fb1967c51</ApiKey>
  <DriverIdentifier>bd6c792d-9327-4b51-a1c7-1ab26ea7a06a</DriverIdentifier>
  <JobId>3</JobId>
  <JobIdentifier>8bc7d58c-77ef-41f3-b500-1b6f1a697284</JobIdentifier>
</DriverJobRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample: 
"sample string 1"

text/xml

Sample: 
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>