Sales Management

Get a sale

⚠️ Deprecated: This endpoint is deprecated and hidden from the public API reference. Use the org-wide GET /sales/orgs/{orgId}/sales/{saleId} endpoint instead — it does not require a salesChannelId.

Returns the full payload for a previously ingested sale on the specified sales channel. The response shape matches the body originally supplied to the create-sale endpoint, allowing you to round-trip a sale and verify what Flipdish has on record. Only sales originally ingested via this API can be returned, and only while the original sourcePayload is still stored against the sale.

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

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

Path parameters

orgIdstring required

Organization ID in standard format

Example:org123
salesChannelIdstring required

Sales Channel ID in standard format

Example:sc123
saleIdstring required

Sale ID - a unique identifier for the sale

Example:AF34FV

Response

Public sale retrieved successfully

Example response

{
  "data": {
    "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",
    "customer": {
      "externalId": "customer_123",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "John Smith",
      "maskingCode": "024755255",
      "contactMaskingCode": "024755255",
      "phoneNumber": "+1234567890",
      "contactPhoneNumber": "+35312345678",
      "emailAddress": "john.smith@flipdish.com"
    },
    "delivery": {
      "notes": "Leave at door, don't ring the bell",
      "deliveredBy": "Client",
      "location": {
        "addressFields": {
          "line1": "Apartment 5",
          "line2": "123 Main Street",
          "line3": "State",
          "postCode": "12345"
        },
        "countryCode": "GB",
        "coordinates": {
          "latitude": 24.867762,
          "longitude": 67.057387
        }
      }
    },
    "dineIn": {
      "tableId": "3",
      "guests": 10
    },
    "notes": "please keep the spices minimum",
    "charges": [
      {
        "menuItemId": "123e4567-e89b-12d3-a456-426614174000",
        "itemId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "Delivery",
        "amount": 2.5,
        "vat": 0.47
      }
    ],
    "discounts": [
      {
        "type": "Voucher",
        "code": "FIRST10",
        "amount": 10
      }
    ],
    "items": [
      {
        "menuItemId": "123e4567-e89b-12d3-a456-426614174000",
        "menuItemName": "Margherita Pizza",
        "quantity": 2,
        "unitPrice": 15,
        "notes": "No onions please",
        "modifierItems": [
          {
            "menuItemId": "123e4567-e89b-12d3-a456-426614174000",
            "menuItemName": "Extra Cheese",
            "quantity": 1,
            "unitPrice": 2.5,
            "notes": "Extra cheese",
            "modifierItems": []
          }
        ]
      }
    ],
    "payments": [
      {
        "type": "Sale",
        "paymentMethod": "Cash",
        "amount": 15.69,
        "description1": "Visa ****4921",
        "description2": "VM278412312",
        "paidAt": "2025-10-28T14:30:00Z"
      }
    ],
    "metadata": "{\"key\": \"value\"}"
  }
}

Changes

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