Sales Management

List sales by business date

⚠️ Deprecated: This endpoint is deprecated and hidden from the public API reference. Use the org-wide GET /sales/orgs/{orgId}/sales endpoint instead — it lists sales across the whole org without requiring a salesChannelId.

Returns sale headers for the specified sales channel that fall within an inclusive business date range (YYYY-MM-DD). Use this endpoint to reconcile the sales you have ingested via this API against your own records, or to retrieve a list of sale identifiers for further processing. Only sales originally created through this API are returned, and results are limited to those that still have a stored sourcePayload.

get/salesManagement/orgs/{orgId}/salesChannels/{salesChannelId}/sales

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}/salesChannels/{salesChannelId}/sales
  • Auth: HTTP bearer

Path parameters

orgIdstring required

Organization ID in standard format

Example:org123
salesChannelIdstring required

Sales Channel ID in standard format

Example:sc123

Query parameters

fromDatestring required

Date in YYYY-MM-DD format

Example:2025-10-28
toDatestring required

Date in YYYY-MM-DD format

Example:2025-10-28

Response

Public sale headers retrieved successfully

Example response

{
  "data": [
    {
      "saleId": "AF34FV",
      "dateTime": "2025-10-28T14:30:00Z",
      "salesChannelId": "sc123",
      "source": "App",
      "requestedFulfilmentTime": "2025-10-28T14:30:00Z",
      "requestedFulfillmentTime": "2025-10-28T14:30:00Z",
      "desiredAsap": true,
      "dispatchType": "Delivery",
      "externalId": "bd1ed236-ee79-11ed-a05b-0242ac12A003",
      "displayId": "2A003",
      "menuId": "123e4567-e89b-12d3-a456-426614174000",
      "menuRevisionId": "123",
      "notes": "please keep the spices minimum",
      "metadata": "{\"key\": \"value\"}",
      "currency": "EUR",
      "totalCharges": 3.5,
      "totalDiscounts": 2,
      "totalSaleAmount": 21.5,
      "totalPaidAmount": 18.5
    }
  ]
}

Changes

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