Delivery Orders

Retrieving site orders

get

Get orders for given site and tenant

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Query parameters

siteCodestringRequired

Responses

200

Resource successfully retrieved.

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

get

/delivery-v2/{tenant}/order

HTTPcURLJavaScriptPython

GET /delivery-v2/{tenant}/order?siteCode=text HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "MPITO1009",
    "siteCode": "main",
    "contactPhone": "[phone]",
    "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

Get order by a given orderId and tenant.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

orderIdstringRequired

Responses

200

Resource successfully retrieved.

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

404

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

application/json

get

/delivery-v2/{tenant}/order/{orderId}

HTTPcURLJavaScriptPython

GET /delivery-v2/{tenant}/order/{orderId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "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": "[phone]"
  }
}