Delivery Service

Download OpenAPI specification:Download

Emporix: documentation@emporix.com URL: https://emporix.com

Configure Onfleet as route management system or Veloce as logistics provider.

Key Features:

Deliver orders via Veloce or Onfleet
Synchronize orders with the logistic provider configured for the site
Configure a different logistics provider per site

Key Benefits:

Save time and money for your last mile delivery by optimizing routes with Onfleet
Utilize third party logistics providers (3PLs) like Veloce to orchestrate the delivery of your orders

Note: To configure Veloce or Onfleet delivery provider please contact with Team Emporix

Delivery Orders

Retrieving site orders

Get orders for given site and tenant

SecurityOAuth2

Request

path Parameters

tenant

required

string

query Parameters

siteCode

required

string

Responses

200

Resource successfully retrieved.

400

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

401

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

get/{tenant}/order

Request samples

Response samples

application/json

[{"id": "MPITO1009",
"siteCode": "main",
"contactPhone": "+48519374777",
"orderStatus": "CREATED",
"orderNumber": "MPITO1009",
"deliveryTime": {"deliveryDate": "2020-12-05",
"deliveryTimeFrom": "10:00:00",
"deliveryTimeTo": "12:00:00",
"deliveryCosts": 20,
"pickupSettings": "Fabrikstr. 5."
},
"pickup": false,
"pickupAddress": {"id": "Pickup 1",
"street": "Fabrikstr",
"streetNumber": "5.",
"city": "Cham",
"zipCode": "6033",
"companyName": "Test AG",
"country": "DE",
"addressName": "Fabrikstr. 5.",
"description": "test description for multiple pickup points",
"addressTag": "pickupAddress"
},
"shippingAddress": {"contactName": "John Doe",
"street": "Fritz-Elsas-Straße",
"streetNumber": "20",
"zipCode": "70173",
"city": "Stuttgart-Mitte",
"country": "DE"
}
}
]

Retrieving an order

Get order by given orderId and tenant

SecurityOAuth2

Request

path Parameters

tenant required	string
orderId required	string

Responses

200

Resource successfully retrieved.

400

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

401

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

404

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

get/{tenant}/order/{orderId}

Request samples

Response samples

application/json

{"id": "QAC6GQEF",
"siteCode": "main",
"orderStatus": "CREATED",
"orderNumber": "B7012191",
"deliveryTime": {"deliveryDate": "2020-07-28",
"deliveryTimeFrom": "15:00:00",
"deliveryTimeTo": "22:00:00",
"deliveryCosts": 20,
"pickupSettings": "Fabrikstr. 5."
},
"pickup": false,
"pickupAddress": {"id": "Pickup 1",
"street": "Fabrikstr",
"streetNumber": "5.",
"city": "Cham",
"zipCode": "6033",
"companyName": "Test AG",
"country": "DE",
"addressName": "Fabrikstr. 5.",
"description": "test description for multiple pickup points",
"addressTag": "pickupAddress"
},
"shippingAddress": {"contactName": "Nazim Mohammed",
"street": "Calwer Str",
"streetNumber": "23",
"zipCode": "70173",
"city": "Stuttgart-Mitte",
"country": "DE",
"contactPhone": "+48 519374777"
}
}

Delivery Plan

Creating orders for delivery provider

Push given orders to delivery provider for the given tenant. In case of an unsuccessful route planning for given order (eg. due to invalid address) an email to the Merchant will be send.

SecurityOAuth2

Request

path Parameters

tenant

required

string

Request Body schema: application/json

orderStatus	string (OrderStatus) Enum: "IN_CHECKOUT" "CREATED" "CONFIRMED" "DECLINED" "SHIPPED" "COMPLETED"
siteCode required	string
orderIds	Array of strings (OrderIdList)

Responses

200

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

400

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

401

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

post/{tenant}/planRoute

Request samples

application/json

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

Response samples

application/json

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