POST api/public/v2/deliveries/async

Request Information

URI Parameters

None.

Body Parameters

MerchantDeliveryBookingModel
NameDescriptionTypeAdditional information
ApiKey

Your merchant API key

globally unique identifier

Required

Booking

DeliveryBookingModel

Required

Request Formats

application/json, text/json

Sample:
{
  "apiKey": "cfd7353a-f605-4162-9550-e38d3ec826bc",
  "booking": {
    "reference": "sample string 1",
    "deliveryInstructions": "sample string 2",
    "itemsRequirePurchase": false,
    "items": [
      {
        "quantity": 1,
        "sku": "sample string 2",
        "description": "sample string 3",
        "price": 4.0
      },
      {
        "quantity": 1,
        "sku": "sample string 2",
        "description": "sample string 3",
        "price": 4.0
      }
    ],
    "capacities": [
      {
        "name": "sample string 1",
        "size": 2.1
      },
      {
        "name": "sample string 1",
        "size": 2.1
      }
    ],
    "pickupTime": "2022-10-01T02:47:02.4944786+00:00",
    "pickupDetail": {
      "name": "sample string 1",
      "phone": "sample string 2",
      "email": "sample string 3",
      "description": "sample string 4",
      "address": "sample string 5",
      "additionalAddressDetails": {
        "stateProvince": "sample string 1",
        "country": "sample string 2",
        "suburbLocality": "sample string 3",
        "postcode": "sample string 4",
        "latitude": 5.1,
        "longitude": 6.1
      }
    },
    "dropoffWindow": {
      "earliestTime": "2022-10-01T02:47:02.4944786+00:00",
      "latestTime": "2022-10-01T02:47:02.4944786+00:00"
    },
    "dropoffDetail": {
      "name": "sample string 1",
      "phone": "sample string 2",
      "email": "sample string 3",
      "description": "sample string 4",
      "address": "sample string 5",
      "additionalAddressDetails": {
        "stateProvince": "sample string 1",
        "country": "sample string 2",
        "suburbLocality": "sample string 3",
        "postcode": "sample string 4",
        "latitude": 5.1,
        "longitude": 6.1
      }
    },
    "customerFee": 4.0,
    "customerReference": "sample string 5",
    "customerId": "sample string 6",
    "tax": 1.0,
    "taxInclusivePrice": false,
    "tip": 1.0,
    "driverFeePercentage": 7.0,
    "driverMatchCode": "sample string 8",
    "deliverySequence": 9,
    "autoAcceptMatchCode": false,
    "constraints": [
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "deliveryRouteIdentifier": "sample string 11",
    "webhooks": [
      {
        "eventName": "sample string 1",
        "url": "sample string 2"
      },
      {
        "eventName": "sample string 1",
        "url": "sample string 2"
      }
    ],
    "template": "sample string 12",
    "orderPrice": 1.0,
    "payments": [
      {
        "method": "CashOnDelivery",
        "amount": 1.0
      },
      {
        "method": "CashOnDelivery",
        "amount": 1.0
      }
    ],
    "metadata": [
      {
        "type": "sample string 1",
        "value": {}
      },
      {
        "type": "sample string 1",
        "value": {}
      }
    ],
    "jobCapacities": {
      "width": {
        "capacityId": 1,
        "capacityName": "sample string 2",
        "capacityValue": 1.0
      },
      "length": {
        "capacityId": 1,
        "capacityName": "sample string 2",
        "capacityValue": 1.0
      },
      "height": {
        "capacityId": 1,
        "capacityName": "sample string 2",
        "capacityValue": 1.0
      },
      "volume": {
        "capacityId": 1,
        "capacityName": "sample string 2",
        "capacityValue": 1.0
      },
      "weight": {
        "capacityId": 1,
        "capacityName": "sample string 2",
        "capacityValue": 1.0
      },
      "customCapacities": [
        {
          "capacityId": 1,
          "capacityName": "sample string 2",
          "capacityValue": 1.0
        },
        {
          "capacityId": 1,
          "capacityName": "sample string 2",
          "capacityValue": 1.0
        }
      ]
    }
  }
}

text/xml

Sample:
<MerchantDeliveryBookingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Swift.DeliveryAPI2">
  <ApiKey>cfd7353a-f605-4162-9550-e38d3ec826bc</ApiKey>
  <Booking>
    <AutoAcceptMatchCode>false</AutoAcceptMatchCode>
    <Capacities>
      <JobCapacityModel>
        <Name>sample string 1</Name>
        <Size>2.1</Size>
      </JobCapacityModel>
      <JobCapacityModel>
        <Name>sample string 1</Name>
        <Size>2.1</Size>
      </JobCapacityModel>
    </Capacities>
    <Constraints>
      <JobConstraintModel>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </JobConstraintModel>
      <JobConstraintModel>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </JobConstraintModel>
    </Constraints>
    <CustomerFee>4</CustomerFee>
    <CustomerId>sample string 6</CustomerId>
    <CustomerReference>sample string 5</CustomerReference>
    <DeliveryInstructions>sample string 2</DeliveryInstructions>
    <DeliveryRouteIdentifier>sample string 11</DeliveryRouteIdentifier>
    <DeliverySequence>9</DeliverySequence>
    <DriverFeePercentage>7</DriverFeePercentage>
    <DriverMatchCode>sample string 8</DriverMatchCode>
    <DropoffDetail>
      <AdditionalAddressDetails>
        <Country>sample string 2</Country>
        <Latitude>5.1</Latitude>
        <Longitude>6.1</Longitude>
        <Postcode>sample string 4</Postcode>
        <StateProvince>sample string 1</StateProvince>
        <SuburbLocality>sample string 3</SuburbLocality>
      </AdditionalAddressDetails>
      <Address>sample string 5</Address>
      <Description>sample string 4</Description>
      <Email>sample string 3</Email>
      <Name>sample string 1</Name>
      <Phone>sample string 2</Phone>
    </DropoffDetail>
    <DropoffWindow>
      <EarliestTime>2022-10-01T02:47:02.4944786+00:00</EarliestTime>
      <LatestTime>2022-10-01T02:47:02.4944786+00:00</LatestTime>
    </DropoffWindow>
    <Items>
      <DeliveryBookingItemModel>
        <Description>sample string 3</Description>
        <Price>4</Price>
        <Quantity>1</Quantity>
        <Sku>sample string 2</Sku>
      </DeliveryBookingItemModel>
      <DeliveryBookingItemModel>
        <Description>sample string 3</Description>
        <Price>4</Price>
        <Quantity>1</Quantity>
        <Sku>sample string 2</Sku>
      </DeliveryBookingItemModel>
    </Items>
    <ItemsRequirePurchase>false</ItemsRequirePurchase>
    <JobCapacities>
      <CustomCapacities>
        <JobCapacityViewModel>
          <CapacityId>1</CapacityId>
          <CapacityName>sample string 2</CapacityName>
          <CapacityValue>1</CapacityValue>
        </JobCapacityViewModel>
        <JobCapacityViewModel>
          <CapacityId>1</CapacityId>
          <CapacityName>sample string 2</CapacityName>
          <CapacityValue>1</CapacityValue>
        </JobCapacityViewModel>
      </CustomCapacities>
      <Height>
        <CapacityId>1</CapacityId>
        <CapacityName>sample string 2</CapacityName>
        <CapacityValue>1</CapacityValue>
      </Height>
      <Length>
        <CapacityId>1</CapacityId>
        <CapacityName>sample string 2</CapacityName>
        <CapacityValue>1</CapacityValue>
      </Length>
      <Volume>
        <CapacityId>1</CapacityId>
        <CapacityName>sample string 2</CapacityName>
        <CapacityValue>1</CapacityValue>
      </Volume>
      <Weight>
        <CapacityId>1</CapacityId>
        <CapacityName>sample string 2</CapacityName>
        <CapacityValue>1</CapacityValue>
      </Weight>
      <Width>
        <CapacityId>1</CapacityId>
        <CapacityName>sample string 2</CapacityName>
        <CapacityValue>1</CapacityValue>
      </Width>
    </JobCapacities>
    <Metadata>
      <JobMetadataModel>
        <Type>sample string 1</Type>
        <Value />
      </JobMetadataModel>
      <JobMetadataModel>
        <Type>sample string 1</Type>
        <Value />
      </JobMetadataModel>
    </Metadata>
    <OrderPrice>1</OrderPrice>
    <Payments>
      <OrderPaymentModel>
        <Amount>1</Amount>
        <Method>CashOnDelivery</Method>
      </OrderPaymentModel>
      <OrderPaymentModel>
        <Amount>1</Amount>
        <Method>CashOnDelivery</Method>
      </OrderPaymentModel>
    </Payments>
    <PickupDetail>
      <AdditionalAddressDetails>
        <Country>sample string 2</Country>
        <Latitude>5.1</Latitude>
        <Longitude>6.1</Longitude>
        <Postcode>sample string 4</Postcode>
        <StateProvince>sample string 1</StateProvince>
        <SuburbLocality>sample string 3</SuburbLocality>
      </AdditionalAddressDetails>
      <Address>sample string 5</Address>
      <Description>sample string 4</Description>
      <Email>sample string 3</Email>
      <Name>sample string 1</Name>
      <Phone>sample string 2</Phone>
    </PickupDetail>
    <PickupTime>2022-10-01T02:47:02.4944786+00:00</PickupTime>
    <Reference>sample string 1</Reference>
    <Tax>1</Tax>
    <TaxInclusivePrice>false</TaxInclusivePrice>
    <Template>sample string 12</Template>
    <Tip>1</Tip>
    <Webhooks>
      <DeliveryEventWebhookModel>
        <EventName>sample string 1</EventName>
        <Url>sample string 2</Url>
      </DeliveryEventWebhookModel>
      <DeliveryEventWebhookModel>
        <EventName>sample string 1</EventName>
        <Url>sample string 2</Url>
      </DeliveryEventWebhookModel>
    </Webhooks>
  </Booking>
</MerchantDeliveryBookingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:
"8d6a1827-b247-4a34-a98f-181191ca0013"

text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8d6a1827-b247-4a34-a98f-181191ca0013</guid>