Toast takeout orders

Get all Toast Takeout Orders for a program_membership

get

Authorizations

Query parameters

program_membership_idanyrequired

Program membership ID

pageanyoptional

Number of the page for Toast Takeout Orders (default is 1)

per_pageanyoptional

Limit of toast takeout orders per page (default is 25)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v2/admin/toast_takeout_orders' \
  --header 'X-API-Key: YOUR_API_KEY'

200

200

{
  "toast_takeout_orders": [
    {
      "id": "text",
      "tip_amount_cents": 1,
      "tax_amount_cents": 1,
      "order_amount_cents": 1,
      "status": "text",
      "reference": "text",
      "order_guid": "text",
      "created_at": 1,
      "service_charge_amount_cents": 1,
      "total_amount_cents": 1,
      "toast_restaurant_id": "text",
      "application_fee_cents": 1,
      "refunded_at": 1,
      "stripe_session_data": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "refund_data": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

success

Get all Toast Takeout Orders for a program_membership

get

Authorizations

Path parameters

referenceanyrequired

Reference id for the Toast Takeout Order.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v2/admin/toast_takeout_orders/{reference}' \
  --header 'X-API-Key: YOUR_API_KEY'

200

200

{
  "toast_takeout_order": {
    "id": "text",
    "tip_amount_cents": 1,
    "tax_amount_cents": 1,
    "order_amount_cents": 1,
    "status": "text",
    "reference": "text",
    "order_guid": "text",
    "created_at": 1,
    "service_charge_amount_cents": 1,
    "total_amount_cents": 1,
    "toast_restaurant_id": "text",
    "application_fee_cents": 1,
    "refunded_at": 1,
    "stripe_session_data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "refund_data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

success