POST api/public/v2/deliveries/update

Request Information

URI Parameters

None.

Body Parameters

UpdateBooking
NameDescriptionTypeAdditional information
ApiKey

Your merchant API key

 globally unique identifier

Required
Identifier

The identifier of the updating booking.

 globally unique identifier

None.
DeliveryInstructions

string

Max length: 2000
PickupDetail

If provided, will update the pickup details with any provided fields.

 UpdateDeliveryBookingLocationModel

None.
DropoffDetail

If provided, will update the dropoff details with any provided fields.

 UpdateDeliveryBookingLocationModel

None.
DropoffWindow

If provided, will update the dropoff delivery window with any provided fields.

 TimeFrameModel

None.
Items

If provided it will update items of delivery.

 Collection of DeliveryBookingItemModel

None.
Metadatas

If provided it will update delivery editable metadata

 Dictionary of string [key] and Object [value]

None.
Payments

If provided it will update all payment methods for that delivery

 Collection of OrderPaymentModel

None.
Capacities

Collection of JobCapacityModel

None.
Tip

decimal number

None.
JobCapacities

JobCapacities

None.

Request Formats

application/json, text/json

Sample: 
{
  "apiKey": "fa538948-3576-44fb-a320-c0aba3873bcf",
  "identifier": "a6e19bd8-cced-46ef-b13d-c4e997f19ea6",
  "deliveryInstructions": "sample string 3",
  "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
    }
  },
  "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
    }
  },
  "dropoffWindow": {
    "earliestTime": "2023-03-27T03:38:59.1931712+00:00",
    "latestTime": "2023-03-27T03:38:59.1931712+00:00"
  },
  "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
    }
  ],
  "metadatas": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "payments": [
    {
      "method": "CashOnDelivery",
      "amount": 1.0
    },
    {
      "method": "CashOnDelivery",
      "amount": 1.0
    }
  ],
  "capacities": [
    {
      "name": "sample string 1",
      "size": 2.1
    },
    {
      "name": "sample string 1",
      "size": 2.1
    }
  ],
  "tip": 1.0,
  "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: 
<UpdateBooking xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Swift.DeliveryAPI2">
  <ApiKey>fa538948-3576-44fb-a320-c0aba3873bcf</ApiKey>
  <Capacities>
    <JobCapacityModel>
      <Name>sample string 1</Name>
      <Size>2.1</Size>
    </JobCapacityModel>
    <JobCapacityModel>
      <Name>sample string 1</Name>
      <Size>2.1</Size>
    </JobCapacityModel>
  </Capacities>
  <DeliveryInstructions>sample string 3</DeliveryInstructions>
  <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>2023-03-27T03:38:59.1931712+00:00</EarliestTime>
    <LatestTime>2023-03-27T03:38:59.1931712+00:00</LatestTime>
  </DropoffWindow>
  <Identifier>a6e19bd8-cced-46ef-b13d-c4e997f19ea6</Identifier>
  <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>
  <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>
  <Metadatas xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Metadatas>
  <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>
  <Tip>1</Tip>
</UpdateBooking>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/xml

Sample:

Sample not available.