Starting Feb 1st, 2023, new prices for SMS will be introduced
Details can be found on the Alerts page
No action is required, this change will be automatic
None.
Name | Description | Type | Additional information |
---|---|---|---|
ApiKey |
Your merchant API key |
globally unique identifier |
Required |
Booking | DeliveryBookingModel |
Required |
{ "apiKey": "618f9e9a-4f08-4caf-a78c-b0be722a84c8", "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": "2023-03-27T03:36:54.8762736+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": "2023-03-27T03:36:54.8762736+00:00", "latestTime": "2023-03-27T03:36:54.8762736+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 } ] } } }
<MerchantDeliveryBookingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Swift.DeliveryAPI2"> <ApiKey>618f9e9a-4f08-4caf-a78c-b0be722a84c8</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>2023-03-27T03:36:54.8762736+00:00</EarliestTime> <LatestTime>2023-03-27T03:36:54.8762736+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>2023-03-27T03:36:54.8762736+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>
Sample not available.
Name | Description | Type | Additional information |
---|---|---|---|
Quote | Quote |
None. |
|
Request | DeliveryBookingModel |
None. |
{ "quote": { "created": "2023-03-27T03:36:54.8762736+00:00", "start": "2023-03-27T03:36:54.8762736+00:00", "distanceKm": 3.1, "fee": { "cost": 1.0, "costCents": 100 }, "pickup": { "time": { "average": "2023-03-27T03:36:54.8762736+00:00", "earliest": "2023-03-27T03:36:54.8762736+00:00", "latest": "2023-03-27T03:36:54.8762736+00:00" }, "address": "sample string 1" }, "dropoff": { "time": { "average": "2023-03-27T03:36:54.8762736+00:00", "earliest": "2023-03-27T03:36:54.8762736+00:00", "latest": "2023-03-27T03:36:54.8762736+00:00" }, "address": "sample string 1" } }, "request": { "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": "2023-03-27T03:36:54.8762736+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": "2023-03-27T03:36:54.8762736+00:00", "latestTime": "2023-03-27T03:36:54.8762736+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 } ] } } }
<QuoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Swift.DeliveryAPI2"> <Quote> <Created>2023-03-27T03:36:54.8762736+00:00</Created> <DistanceKm>3.1</DistanceKm> <Dropoff> <Address>sample string 1</Address> <Time> <Average>2023-03-27T03:36:54.8762736+00:00</Average> <Earliest>2023-03-27T03:36:54.8762736+00:00</Earliest> <Latest>2023-03-27T03:36:54.8762736+00:00</Latest> </Time> </Dropoff> <Fee> <Cost>1</Cost> </Fee> <Pickup> <Address>sample string 1</Address> <Time> <Average>2023-03-27T03:36:54.8762736+00:00</Average> <Earliest>2023-03-27T03:36:54.8762736+00:00</Earliest> <Latest>2023-03-27T03:36:54.8762736+00:00</Latest> </Time> </Pickup> <Start>2023-03-27T03:36:54.8762736+00:00</Start> </Quote> <Request> <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>2023-03-27T03:36:54.8762736+00:00</EarliestTime> <LatestTime>2023-03-27T03:36:54.8762736+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>2023-03-27T03:36:54.8762736+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> </Request> </QuoteResponse>