Skip to main content
Get order
curl --request GET \
  --url https://api.maple.inc/v1/orders/{orderId} \
  --header 'Authorization: Bearer <token>'
{
  "object": "order",
  "id": "<string>",
  "livemode": true,
  "created": 123,
  "status": "<string>",
  "payment_status": "<string>",
  "location_id": "<string>",
  "fulfillment_type": "<string>",
  "customer": {
    "name": "<string>",
    "phone_last_four": "<string>"
  },
  "line_items": [
    {
      "name": "<string>",
      "menu_entity_id": "<string>",
      "quantity": 123,
      "base_price": 123,
      "tax": 123,
      "modifiers": [
        {
          "name": "<string>",
          "menu_entity_id": "<string>",
          "quantity": 123,
          "price": 123
        }
      ]
    }
  ],
  "totals": {
    "currency": "<string>",
    "subtotal": 123,
    "tax": 123,
    "surcharge": 123,
    "tip": 123,
    "delivery_fee": 123,
    "delivery_tip": 123,
    "total": 123
  },
  "external_id": "<string>",
  "payment": {
    "provider": "<string>",
    "status": "<string>",
    "payment_link_url": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API key — mpk_test_… for the sandbox, mpk_live_… for production. Issued by Maple during partner onboarding.

Path Parameters

​
orderId
string
required

Response

Success

​
object
enum<string>
required
Available options:
order
​
id
string
required
​
livemode
boolean
required

True when the order belongs to the live environment; false for test-mode data.

​
created
required
​
status
string
required
​
payment_status
string | null
required
​
location_id
string | null
required
​
fulfillment_type
string
required
​
customer
object
required
​
line_items
object[]
required
​
totals
object
required

All amounts in integer USD cents. total = subtotal + tax + surcharge + tip + delivery fees.

​
external_id
string | null
required
​
payment
object
required