CLcloudkitchens
direct_orders_endpoints

query eater's related history orders

Provide an external eater ID to get a list of order related to that eater.

post/v1/eater/order-history

Request

Request body application/x-www-form-urlencoded

limitnumber required

Max number of orders to retrieve per page

pageTokenstring

Opaque token used for paging. Query parameters must be URL encoded.

eaterIdstring required

External eater's Id

sourcestring

Order placed from which source

Example request

{
  "limit": 10,
  "pageToken": "CgwI09+kjQYQwOvF2AM=/(urlencoded:CgwI09%2BkjQYQwOvF2AM%3D)",
  "eaterId": "eater-12345",
  "source": "venmo"
}

Response

Eater order history response.

nextPageTokenstring

Opaque token used to fetch the following page. If not set, no more orders are available.

Example response

{
  "orders": [
    {
      "id": "69f60a06-c335-46d9-b5a1-97f1a211c514",
      "items": [
        {
          "quantity": 1,
          "id": "33e0418f-3d56-4360-ba03-18fc5f8844a3",
          "name": "Juicy Cheeseburger"
        }
      ],
      "orderedAt": "2007-12-03T09:15:30.000Z",
      "orderTotal": 19.07,
      "currencyCode": "USD",
      "pickupTime": "2007-12-03T09:15:30.000Z",
      "store": {
        "id": "9208071e-5f7a-444a-b3a7-4a57ff3f614e",
        "name": "Store name 1",
        "logoUrl": "https://blob-storage.com/photos/storefront-photos/228da7b3-a254-47f4-b82f-5cf29e89b2b9.jpeg",
        "bannerUrl": "https://blob-storage.com/photos/storefront-photos/4abd6b2e-e0f1-467c-a60b-c2e33922573f.jpeg",
        "address": {
          "fullAddress": "123 Sample Street Ste 100, San Francisco, CA 94103",
          "postalCode": "20500",
          "city": "Washington",
          "state": "DC",
          "countryCode": "US",
          "addressLines": [
            "1600 Pennsylvania Avenue NW",
            "123 Sample Street Ste 100, San Francisco, CA 94103"
          ],
          "linesOfAddress": [
            "1600 Pennsylvania Avenue NW",
            "123 Sample Street Ste 100, San Francisco, CA 94103"
          ],
          "location": {
            "latitude": 38.8977,
            "longitude": 77.0365
          }
        }
      },
      "orderAgainUrl": "/store/0179860e-8a89-39c2-b9b1-7276683d09f1"
    }
  ],
  "nextPageToken": "H12MAF2fFaFFFa"
}

Changes

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