Delivery Plan

Creating orders for delivery provider

post

Pushes the specified orders to the delivery provider for the given tenant. If route planning fails for an order (e.g., due to an invalid address), an email is sent to the merchant.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Body

application/json

orderStatusstring · enumOptionalPossible values:

siteCodestringRequired

orderIdsstring[]Optional

Responses

200

Route planning executed. Returned body only for unsuccessfully planned orders (QAC6GQEF in this example). Returned empty body for successfully planned orders (B7016709).

application/json

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

post

/delivery-v2/{tenant}/planRoute

HTTPcURLJavaScriptPython

POST /delivery-v2/{tenant}/planRoute HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "orderStatus": "CREATED",
  "siteCode": "main",
  "orderIds": [
    "B7016709",
    "QAC6GQEF"
  ]
}

{
  "orderId": "QAC6GQEF",
  "deliveryProvider": "ONFLEET",
  "errorMessage": "completeBefore must not be before creation time"
}