Ir al contenido
Maple

    Orders

    Get order

    Returns a single order if it belongs to a location the app is connected to.

    Esta página aún no está disponible en tu idioma.

    GEThttps://api.maple.inc/v1/orders/{orderId}API key

    Authorization

    Send your API key as Authorization: Bearer <key>: mpk_test_… against the sandbox (https://api.staging.maple.inc/v1), mpk_live_… against production. See Authentication. The samples read the key from MAPLE_KEY and the base URL from MAPLE_BASE, as set up in the Quickstart.

    Parameters

    • orderId string path required

    Responses

    200 OK

    • object string required

      Always order.

    • id string required

    • livemode boolean required

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

    • created number required

    • status string required

    • payment_status string or null required

    • location_id string or null required

    • fulfillment_type string required

    • scheduled_for string or null required

      Customer-selected completion time (ISO 8601, UTC) for scheduled orders; null for ASAP orders. Prepare the order for this time, not on receipt.

    • delivery_address object or null required

      The delivery address for delivery orders, including delivery instructions; null for pickup orders or when no stored address is available.

    • delivery_address.street string required

    • delivery_address.unit string or null required

    • delivery_address.city string required

    • delivery_address.state string required

    • delivery_address.zip string required

    • delivery_address.notes string or null required

    • customer object required

    • customer.name string required

    • customer.phone string or null required

      Customer phone number in E.164 format (e.g. +14155552671); null when the customer provided none.

    • customer.phone_last_four string or null required

      Last four digits of the customer phone number.

    • line_items object[] required

    • line_items[].name string required

    • line_items[].menu_entity_id string or null required

    • line_items[].quantity number required

    • line_items[].base_price number required

    • line_items[].tax number required

    • line_items[].modifiers object[] required

    • line_items[].modifiers[].name string required

    • line_items[].modifiers[].menu_entity_id string or null required

    • line_items[].modifiers[].quantity number required

    • line_items[].modifiers[].price number required

    • totals object required

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

    • totals.currency string required

    • totals.subtotal number required

    • totals.tax number required

    • totals.surcharge number required

    • totals.tip number required

    • totals.delivery_fee number required

    • totals.delivery_tip number required

    • totals.total number required

    • external_id string or null required

    • payment object required

    • payment.provider string or null required

    • payment.status string or null required

    • payment.payment_link_url string or null required

    Errors

    • 400 Bad request DeveloperApiBadRequest

    • 401 Unauthorized DeveloperApiUnauthorized

    • 403 Forbidden DeveloperApiForbidden

    • 404 Not found DeveloperApiNotFound

    • 429 Too many requests DeveloperApiRateLimited

    Every error body names the error in _tag, explains it in message, and says where to report it in feedback. See Errors.

    A 429 also sends Retry-After: Seconds to wait before retrying; also returned as retry_after in the body.