Get Order Details

Last modified: 15 May 2025
/orders/{order_id}

Fetches an order with all details.

Request parameters

Security

OAuth2Authorization Code
Authorization URL: /oauth/authorize
Token URL: /oauth/token
Scopes

Path

order_idstring uuidrequired

Unique identifying string for an order.

Responses

200
Content type:application/json

Successful operation

application/jsonobject
Child attributes
401
Content type:application/json

Authentication information is missing or invalid.

application/jsonobject
Child attributes
403
Content type:application/json

The client is authenticated, but does not have access rights to the content.

application/jsonobject
Child attributes
404

Order not found

{
  "id": "18ad0215-778d-352d-8f14-959901273e8d",
  "display_id": "example",
  "external_order_id": "example",
  "channel_order_id": "example",
  "current_state": "created",
  "type": "pick_up",
  "store": {
    "name": "example",
    "id": "example",
    "external_store_id": "example",
    "channel_store_id": "example",
    "brand_id": "example",
    "external_brand_id": "example",
    "channel_brand_id": "example",
    "external_data": "example"
  },
  "customer": {
    "first_name": "example",
    "last_name": "example",
    "phone": "example",
    "id": "example",
    "delivery": {
      "location": {
        "type": "street_address",
        "street_address": "example",
        "address_detail": "example",
        "latitude": 16.0,
        "longitude": 16.0,
        "unit_number": "example",
        "business_name": "example"
      },
      "notes": "example"
    }
  },
  "charges": {
    "total": 58,
    "sub_total": 58,
    "tax": 58,
    "delivery_fee": 58,
    "tip": 58,
    "total_amount_due": 58,
    "amount_due_collection_type": "pay in store"
  },
  "discounts": [
    {
      "external_discount_id": "example",
      "value": 58,
      "name": "example"
    }
  ],
  "payments": [
    {
      "id": "example",
      "amount": 58,
      "payment_date": "1971-04-26T12:26:06Z",
      "channel_reference": "example",
      "method": "card",
      "description": "example"
    }
  ],
  "items": [
    {
      "id": "example",
      "instance_id": "example",
      "name": "example",
      "external_data": "example",
      "quantity": 58,
      "price": {
        "unit_price": 58,
        "total_price": 58
      },
      "selected_items": [
        {}
      ],
      "special_instructions": "example"
    }
  ],
  "requested_for_time": "1971-04-26T12:26:06Z",
  "system_instructions": "example",
  "channel": "yumbi-web",
  "created_date": "1971-04-26T12:26:06Z"
}

Examples

Delivery order

Order Summary

  • 2 BBQ CHICKEN

    • Size: Standard (23cm) (R 61.90)

    • Pizza Base: Original

    • Cheese: Single Extra Cheese (R 11.90)

    • Extras: Extra Toppings & Sauces

      • Single Toppings and Sauces: Fresh Avocado (R 8.90)

    • Special Instructions: Edges should be crispy

Order Total: R 165.40

  • Delivery orders have the following:

    • Delivery Address

    • Delivery Instructions

    • Delivery Fee

    • Driver Tip

    • Delivery order type

{
  "id": "0000a9af-0000-0000-0000-000000000000",
  "display_id": "0000a",
  "external_order_id": "43439",
  "channel_order_id": "43439",
  "current_state": "created",
  "type": "delivery_by_restaurant",
  "store": {
    "name": "Test Two",
    "id": "8301",
    "external_store_id": "8301",
    "channel_store_id": "8301",
    "brand_id": "417",
    "external_brand_id": "Debonairs",
    "channel_brand_id": "417"
  },
  "customer": {
    "first_name": "John",
    "last_name": "Smith",
    "phone": "+27821234567",
    "id": "225912",
    "delivery": {
      "location": {
        "type": "street_address",
        "street_address": "1 Test Street",
        "latitude": 0.0,
        "longitude": 0.0,
        "unit_number": ""
      }
    }
  },
  "charges": {
    "total": 8270,
    "sub_total": 8270,
    "tax": 1016,
    "delivery_fee": 0,
    "tip": 0,
    "total_amount_due": 8270,
    "amount_due_collection_type": "card on delivery"
  },
  "discounts": [],
  "payments": [],
  "items": [
    {
      "id": "65226",
      "instance_id": "65226",
      "name": "BBQ CHICKEN",
      "quantity": 1,
      "price": {
        "unit_price": 0,
        "total_price": 0
      },
      "selected_options": [
        {
          "id": "65227",
          "instance_id": "65227",
          "name": "Standard (23cm)",
          "quantity": 1,
          "price": {
            "unit_price": 6190,
            "total_price": 6190
          },
          "selected_options": [
            {
              "id": "65228",
              "instance_id": "65228",
              "name": "Original",
              "quantity": 1,
              "price": {
                "unit_price": 0,
                "total_price": 0
              }
            },
            {
              "id": "65229",
              "instance_id": "65229",
              "name": "Single Extra Cheese",
              "quantity": 1,
              "price": {
                "unit_price": 1190,
                "total_price": 1190
              }
            },
            {
              "id": "65230",
              "instance_id": "65230",
              "name": "Extra Toppings & Sauces",
              "quantity": 1,
              "price": {
                "unit_price": 0,
                "total_price": 0
              },
              "selected_options": [
                {
                  "id": "65231",
                  "instance_id": "65231",
                  "name": "Fresh Avocado",
                  "quantity": 1,
                  "price": {
                    "unit_price": 890,
                    "total_price": 890
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "requested_for_time": "2024-05-07T08:07:31.2470442+02:00",
  "channel": "yumbi-web"
}