Storefront

Storefront Orders

When a customer places an order on your public Vylot storefront, it is recorded as a Storefront Order. This API allows you to pull those orders into your custom fulfillment or ERP system.

GET/v1/store/orders

List storefront orders

Returns incoming storefront orders. Enforces your plan limits.

curl -X GET https://api.vylot.workers.dev/v1/store/orders -H "Authorization: Bearer vk_live_abc123..."

Response

{
  "success": true,
  "data": [
    {
      "id": "ord_xyz789",
      "status": "PENDING",\n      "total_amount": 1416.00
    }
  ]
}

GET/v1/store/orders/:id

Retrieve an order

Retrieves the details of an existing storefront order, including its ordered items.

curl -X GET https://api.vylot.workers.dev/v1/store/orders/ord_xyz789 -H "Authorization: Bearer vk_live_abc123..."

Response

{
  "success": true,
  "data": { "id": "ord_xyz789", "items": [...] }
}

PATCH/v1/store/orders/:id/status

Update order status

Updates the order status. If marked as DELIVERED, an invoice is automatically generated.

Parameters

statusstringRequired

Allowed values: 'PENDING', 'PROCESSING', 'SHIPPED', 'DELIVERED', 'CANCELLED'.

curl -X PATCH https://api.vylot.workers.dev/v1/store/orders/ord_xyz789/status -H "Authorization: Bearer vk_live_abc123..." -H "Content-Type: application/json" -d '{"status": "SHIPPED"}'

Response

{
  "success": true
}