Create bundle of deliveries
What is a Bundle?
A bundle is a set of deliveries which should be picked up at the same time and from the same place.
Route optimization
A bundle of deliveries represents one route of deliveries or can be set to be optimized to number of routes. Contact us to set the optimization parameters for your integration.
If a bundle of deliveries is set to be optimized, a webhook event "routes_optimization_ended" will be triggered when the optimization completes. The optimization process may take several minutes, according to the size of the bundle.
Resource
POST /v1/delivery/bundles
Authorization
OAuth 2.0 bearer token with Delivery scope.
Query Parameters
Name | Type | Description |
---|---|---|
business_id | string | Unique identifier representing a Business. (ex: IL-7436) (equivalent to company_id in response body) |
Body Parameters - raw data
Name | Type | Description |
---|---|---|
product_id | string | Product ID obtained from products endpoint (product_id will be supply by Gett) |
scheduled_at optional | timestamp | Timestamp when the deliveries should be picked up, if scheduled_at not specified, or it is within the next 20 minutes, the order will become an ASAP order. format |
display_identifier optional | string | A custom identifier for the bundle. |
avoid_aggregation (optional) | boolean | When the boolean value is true, the order will be created as Point to Point order, without aggregation. Default value = false |
external_identifier (optional) | string | Any identifier to help you map bundles created with your entities |
Request
{
"product_id": "86c31386-f596-48ff-9458-c70634414c9b",
"scheduled_at": "2020-10-10T11:54:29+00:00",
"display_identifier": "Test",
"avoid_aggregation": false,
"external_identifier": "Test"
}
Response
{
"company_id": "IL-7348",
"bundle_id": "B-7595074048cc4dc09519feede1fe981b",
"created_at": "2020-10-04T08:47:36.759122248Z",
"scheduled_at": "2020-10-10T11:54:29Z",
"return_mode": "if_not_delivered",
"deliveries": null,
"display_identifier": "Test",
"process_type": "only_optimize",
"external_identifier": "Test"
}
Sandbox
Resource:
POST /v1/delivery_sandbox/bundles
More info can be found here
Updated almost 3 years ago