Toast takeout orders

Get all Toast Takeout Orders for a program_membership

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Query parameters

program_membership_idstringRequired

Program membership ID

pagenumberOptional

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

per_pagenumberOptional

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

Responses

200

success

application/json

get

/v2/admin/toast_takeout_orders

HTTPcURLJavaScriptPython

GET /partner-api/v2/admin/toast_takeout_orders?program_membership_id=text HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

success

{
  "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"
      }
    }
  ]
}

Get all Toast Takeout Orders for a program_membership

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

referencestringRequired

Reference id for the Toast Takeout Order.

Responses

200

success

application/json

get

/v2/admin/toast_takeout_orders/{reference}

HTTPcURLJavaScriptPython

GET /partner-api/v2/admin/toast_takeout_orders/{reference} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

success

{
  "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"
    }
  }
}