API docs by Redocly

cloud-gateway additional internal endpoints

The endpoints listed here are "internal" or "hidden" API endpoints meant to be used only from the admin console.

They should be seen as additions to the API endpoints provided under the cloud-gateway-public spec (Xpand Autonomous Store Management API).

Refer to the cloud-gateway-public for base descriptions of the API standards and idioms.

Orders

Order operations

Create order

Create a new order for fulfillment.

Request Body schema: application/json
required
siteId
integer or null

Site ID of the site where the order should be fulfilled

systemId
integer or null

System ID of the system where the order should be fulfilled

required
Array of objects non-empty

Array of products to include in the order

priority
integer [ 1 .. 5 ]
Default: 1

Order priority (1=lowest, 5=highest)

object (OrderUser)

Information about the user who placed the order

Responses

Request samples

Content type
application/json
{
  • "siteId": 0,
  • "systemId": 0,
  • "products": [
    • {
      • "productId": 0,
      • "quantity": 1
      }
    ],
  • "priority": 1,
  • "user": {
    • "locale": "en_US",
    • "phoneNumber": "+11111111"
    }
}

Response samples

Content type
application/json
{
  • "id": 18734,
  • "status": "payment",
  • "siteId": 1,
  • "systemId": 1,
  • "products": [
    • {
      • "productId": 349,
      • "quantity": 3,
      • "fulfilledQuantity": 0
      },
    • {
      • "productId": 1017,
      • "quantity": 1,
      • "fulfilledQuantity": 0,
      • "integratedProductStatus": "pending",
      • "modifiers": {
        • "strength": "strong",
        • "milk": "with milk"
        }
      }
    ],
  • "deliveryDate": "2024-03-03",
  • "deliveryTime": "14:15",
  • "priority": 1,
  • "displayCode": 7465,
  • "pinCode": 5364,
  • "user": {
    • "locale": "en_US",
    • "phoneNumber": "+11111111"
    },
  • "events": [
    • {
      • "id": 53283,
      • "eventType": "Created",
      • "eventData": {
        • "source": "shelf",
        • "digitalShelfId": 1,
        • "deliveryDate": "2024-03-03",
        • "deliveryTime": "14:15"
        },
      • "isError": false,
      • "eventTime": "2024-03-03T14:15:22Z"
      }
    ],
  • "createdAt": "2024-03-03T14:15:22Z",
  • "updatedAt": "2024-03-04T12:12:53Z"
}

Update order status

Modifies the status of an existing order, effectively manually transitioning it along its lifecycle.

Only a strict set of status transitions are allowed, as not every order status can be manually transitioned from or to.

Allowed status transitions table

From Status To Status Description
pending queued Queue order for fulfillment now
ready delivering Deliver a ready order to the kiosk for pickup
error pending Retry order according to regular scheduling logic
error queued Retry order now
* cancelled Cancel order

Any other attempt at status transition will result in a 400 response.

path Parameters
id
required
string
Request Body schema: application/json
required
status
required
string
Enum: "pending" "queued" "delivering"

Responses

Request samples

Content type
application/json
{
  • "status": "pending"
}

Response samples

Content type
application/json
{
  • "id": 18734,
  • "status": "payment",
  • "siteId": 1,
  • "systemId": 1,
  • "products": [
    • {
      • "productId": 349,
      • "quantity": 3,
      • "fulfilledQuantity": 0
      },
    • {
      • "productId": 1017,
      • "quantity": 1,
      • "fulfilledQuantity": 0,
      • "integratedProductStatus": "pending",
      • "modifiers": {
        • "strength": "strong",
        • "milk": "with milk"
        }
      }
    ],
  • "deliveryDate": "2024-03-03",
  • "deliveryTime": "14:15",
  • "priority": 1,
  • "displayCode": 7465,
  • "pinCode": 5364,
  • "user": {
    • "locale": "en_US",
    • "phoneNumber": "+11111111"
    },
  • "events": [
    • {
      • "id": 53283,
      • "eventType": "Created",
      • "eventData": {
        • "source": "shelf",
        • "digitalShelfId": 1,
        • "deliveryDate": "2024-03-03",
        • "deliveryTime": "14:15"
        },
      • "isError": false,
      • "eventTime": "2024-03-03T14:15:22Z"
      }
    ],
  • "createdAt": "2024-03-03T14:15:22Z",
  • "updatedAt": "2024-03-04T12:12:53Z"
}