Delivery Options configuration API (v0)
Download OpenAPI specification:Download
Manage provider rate configurations and getting offers from carriers.
Get customization adapter config
Sets up the base_url, which is a URL prefix of a particular customization adapter (https://...)
used to retrieve provider rates in your business.
Authorizations:
Responses
Response samples
- 200
- 400
- 500
{- "updated_at": "2021-08-23T12:54:10.381Z"
}Set customization adapter config
Sets up the base_url, which is a URL prefix of a particular customization adapter (https://...)
used to retrieve provider rates in your business.
Authorizations:
Request Body schema: application/json
required | object Configuration needed to use an external adapter to fetch customized shipping options. | ||
| |||
Responses
Request samples
- Payload
{
}Response samples
- 400
- 500
{- "messages": [
- "string"
], - "request_id": "string"
}Get packing timer duration
Retrieves the time for which an order that is packed and ready for pickup is not shipped or picked up from the fulfillment location.
This time allows the store to ensure that the order is ready for pickup when the shipping partner or customer arrives at the location.
Authorizations:
Responses
Response samples
- 200
- 500
{- "value": 1085,
- "updated_at": "2021-08-23T12:54:05.174Z"
}Set packing timer duration
Sets the time for which an order that is packed and ready for pickup is not shipped or picked up from the fulfillment location.
This time allows the store to ensure that the order is ready for pickup when the shipping partner or customer arrives at the location.
Authorizations:
Request Body schema: application/json
| value required | integer Time needed to pack an order (seconds). |
Responses
Request samples
- Payload
{- "value": 1085
}Response samples
- 400
- 500
{- "messages": [
- "string"
], - "request_id": "string"
}Get shipping price config for split orders
Retrieves the configuration to charge the price for split shipment orders.
If set to true, for all split shipment orders in your business, only the shipping price
for the most expensive shipment in the order is request is charged to the customer.
The rest of the shipment prices are ignored.
For more information, see this business example.
Authorizations:
Responses
Response samples
- 200
- 500
{- "value": true,
- "updated_at": "2021-08-23T12:54:06.960Z"
}Set shipping price config for split orders
Sets the configuration to charge the price for split shipment orders.
If set to true, for all split shipment orders in your business, only the shipping price
for the most expensive shipment in the order is request is charged to the customer.
The rest of the shipment prices are ignored.
For more information, see this business example.
Authorizations:
Request Body schema: application/json
| value required | boolean If true, for fulfillment from multiple locations, only the fulfillment request with the highest shipment price is charged. The rest of the shipment prices are ignored. |
Responses
Request samples
- Payload
{- "value": true
}Response samples
- 400
- 500
{- "messages": [
- "string"
], - "request_id": "string"
}Get config for customizable provider rates
Retrieves the current configuration to retrieve customizable provider rates from an external customization adapter.
To enable this configuration if it is currently disabled, use the Set config for customizable provider rates method.
Authorizations:
Responses
Response samples
- 200
- 500
{- "value": true,
- "updated_at": "2021-08-23T12:54:05.721Z"
}Set config for customizable provider rates
Sets the configuration to retrieve customizable provider rates from an external customization adapter.
Authorizations:
Request Body schema: application/json
| value required | boolean Toggle to use external adapter to fetch provider rates. |
Responses
Request samples
- Payload
{- "value": true
}Response samples
- 400
- 500
{- "messages": [
- "string"
], - "request_id": "string"
}Get priority of provider rates
Retrieves the current configuration for priority of provider rates.
If set to true, provider rates are selected based on what has been configured in the
fulfillment configuration for your business.
If set to false, provider rates are selected based on what has been configured in the
routes property in the fulfillment configuration for your business.
For more information, see this guide.
Authorizations:
Responses
Response samples
- 200
- 500
{- "value": true,
- "updated_at": "2021-08-23T12:54:05.858Z"
}Set priority of provider rates
Sets the priority of priority of provider rates in your business.
If set to true, provider rates are selected based on what has been configured in the
provider_rates_priority property in the fulfillment configuration for your business.
If set to false, provider rates are selected based on what has been configured in the
routes property in the fulfillment configuration for your business.
For more information, see this guide.
Authorizations:
Request Body schema: application/json
| value required | boolean If true, delivery provider rates will be taken from provider_rates_priority section of the fulfilment config, otherwise from routes section. |
Responses
Request samples
- Payload
{- "value": true
}Response samples
- 400
- 500
{- "messages": [
- "string"
], - "request_id": "string"
}