Sales Management

Update sale delivery status

Records a delivery status transition for an existing sale so Flipdish stays in sync with the real-world fulfilment progress of the order. Set the status to SALE_DISPATCHED when the order leaves the kitchen with a driver, and to SALE_DELIVERED once the customer has received it. Updates surface in operational dashboards and downstream reporting, and are intended to be sent in order as the sale progresses through fulfilment.

post/salesManagement/orgs/{orgId}/sales/{saleId}/deliveryStatus

Request

  • Base URL: https://api.flipdish.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.flipdish.co/salesManagement/orgs/{orgId}/sales/{saleId}/deliveryStatus
  • Auth: HTTP bearer

Path parameters

orgIdstring required

Organization ID in standard format

Example:org123
saleIdstring required

Sale ID - a unique identifier for the sale

Example:AF34FV

Request body

salesChannelIdstring required

Sales Channel ID in standard format

status'SALE_DISPATCHED' | 'SALE_DELIVERED' required

The delivery status to update. SALE_DISPATCHED marks the sale as dispatched, SALE_DELIVERED marks it as delivered.

Example request

{
  "salesChannelId": "sc123",
  "status": "SALE_DISPATCHED"
}

Response

Delivery status updated successfully

Changes

No recorded changes to this operation across all 1 revision of this API.