v1

latestOpenAPI 3.1.02026-07-1342112262.5 KB

Orders

Fetch an order

Required scope: business/orders:read

get/v1/orders/{order_id}

Path parameters

order_idstring required

The unique identifier of the order.

Response

Successful Response

idstring required

The unique identifier of the order.

display_namestring required

A human-friendly label for the order.

order_numberstring nullable required

A human-friendly identifier for the order.

namestring nullable required

A human-friendly identifier (customer name, table number, order number, etc) representing the order.

currencystring required

The currency code in ISO 4217 format.

notestring nullable required

An optional note attached to the order.

location_idstring nullable required

The location at which the sale took place.

staff_idstring nullable

The unique identifier of the staff member who created the order. Matches the id returned by the Staff API. null when no staff member is associated with the order.

created_atstring date-time required

The order creation date and time in ISO 8601 format.

updated_atstring date-time nullable required

The date and time the order was last modified in ISO 8601 format.

closed_atstring date-time nullable required

The date and time the order was closed in ISO 8601 format.

status'cancelled' | 'completed' | 'open' required

An order transitions through various states throughout its lifecycle.

An order is always created in a open state. From there, it will move to a terminal state which will be one of either completed or cancelled.

The following transitions are possible:

open -> completed
open -> cancelled

Example response

{
  "amounts": {
    "discount_amount": {
      "amount": 2780,
      "currency": "ZAR"
    },
    "gross_amount": {
      "amount": 16680,
      "currency": "ZAR"
    },
    "net_amount": {
      "amount": 13900,
      "currency": "ZAR"
    },
    "tax_amount": {
      "amount": 32263,
      "currency": "ZAR"
    },
    "tip_amount": {
      "amount": 0,
      "currency": "ZAR"
    }
  },
  "applied_discounts": [
    {
      "discount_amount": {
        "amount": 3000,
        "currency": "ZAR"
      },
      "name": "Item Discount",
      "percentage": "10.00",
      "scope": "order",
      "type": "fixed_percentage"
    }
  ],
  "closed_at": "2024-11-19T16:27:23+00:00",
  "created_at": "2024-11-19T15:27:02+00:00",
  "currency": "ZAR",
  "display_name": "Order #10542623",
  "id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
  "line_items": [
    {
      "applied_discounts": [
        {
          "discount_amount": {
            "amount": 3000,
            "currency": "ZAR"
          },
          "name": "Item Discount",
          "percentage": "10.00",
          "scope": "order",
          "type": "fixed_percentage"
        }
      ],
      "applied_taxes": [
        {
          "name": "VAT",
          "percentage": "15.00",
          "scope": "line_item",
          "tax_amount": {
            "amount": 3000,
            "currency": "ZAR"
          },
          "type": "inclusive"
        }
      ],
      "discount_amount": {
        "amount": 2780,
        "currency": "ZAR"
      },
      "id": "1585232943683-bc402745-df17-486e-b583-3dfedcbc8b53",
      "item_type": "product",
      "modifiers": [
        {
          "group_name": "Side Orders",
          "group_ordinal": 1,
          "id": "1729101234567-bem-aa11-4bbb-9ccc-112233445566",
          "modifier_id": "1729001234890-cc33dd44-9876-4123-aabb-2233445566ff",
          "name": "Chips",
          "ordinal": 1,
          "price": {
            "amount": 500,
            "currency": "ZAR"
          },
          "variant_id": "1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small"
        }
      ],
      "name": "Men's Funky Blue T-Shirt - Medium",
      "net_amount": {
        "amount": 25020,
        "currency": "ZAR"
      },
      "note": "This is an optional note related to this item in the order.",
      "quantity": "1.00",
      "total_price": {
        "amount": 13900,
        "currency": "ZAR"
      },
      "unit_price": {
        "amount": 13900,
        "currency": "ZAR"
      },
      "variant_id": "1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6"
    }
  ],
  "location_id": "93e230af-afc5-4839-a471-ba52f71f9447",
  "name": "Table 42",
  "note": "This is a very important table.",
  "order_number": "10542623",
  "payments": [
    {
      "amount_excl_tip": {
        "amount": 25000,
        "currency": "ZAR"
      },
      "card_machine_id": "1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4",
      "checkout_id": "ch_J2xYWl4m7B6DsKAPCM9SRDEd",
      "client_transaction_id": "5f29b4cf-5650-4c71-b7e5-f70eb892e55f",
      "created_at": "2024-11-19T15:27:02+00:00",
      "currency": "ZAR",
      "display_name": "Payment receipt #491352",
      "external_id": "order-123",
      "id": "1732194482873-c777dc85-035e-40de-9820-765fde5ded7b",
      "note": "This is a note on this payment.",
      "order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
      "payment_method": "card",
      "payment_source": "payment_link",
      "receipt_number": "491352",
      "refunded_amount": {
        "amount": 0,
        "currency": "ZAR"
      },
      "refunds": [
        {
          "client_transaction_id": "rfd_765fde5ded7bxd",
          "created_at": "2024-11-19T15:27:02+00:00",
          "currency": "ZAR",
          "display_name": "Refund receipt #491352",
          "id": "1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3",
          "note": "This is a note on this refund.",
          "order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
          "original_order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
          "original_order_number": "10542623",
          "payment_id": "1732194482873-c777dc85-035e-40de-9820-765fde5ded7b",
          "payment_method": "card",
          "processed_at": "2024-11-20T16:27:23+00:00",
          "processing_fees": [
            {
              "amount": {
                "amount": 27800,
                "currency": "ZAR"
              },
              "type": "initial"
            }
          ],
          "receipt_number": "491352",
          "refund_type": "auth_reversal",
          "refunded_processing_fees": [
            {
              "amount": {
                "amount": 27800,
                "currency": "ZAR"
              },
              "type": "initial"
            }
          ],
          "staff_id": "1739522553-a7769044-ff8c-410d-b660-84e6727c70b9",
          "status": "approved",
          "total_amount": {
            "amount": 4500,
            "currency": "ZAR"
          },
          "updated_at": "2024-11-19T16:27:23+00:00"
        }
      ],
      "staff_id": "1739522553-a7769044-ff8c-410d-b660-84e6727c70b9",
      "status": "approved",
      "tip_amount": {
        "amount": 2500,
        "currency": "ZAR"
      },
      "total_amount": {
        "amount": 27500,
        "currency": "ZAR"
      },
      "updated_at": "2024-11-19T16:27:23+00:00"
    }
  ],
  "refunds": [
    {
      "client_transaction_id": "rfd_765fde5ded7bxd",
      "created_at": "2024-11-19T15:27:02+00:00",
      "currency": "ZAR",
      "display_name": "Refund receipt #491352",
      "id": "1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3",
      "note": "This is a note on this refund.",
      "order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
      "original_order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
      "original_order_number": "10542623",
      "payment_id": "1732194482873-c777dc85-035e-40de-9820-765fde5ded7b",
      "payment_method": "card",
      "processed_at": "2024-11-20T16:27:23+00:00",
      "processing_fees": [
        {
          "amount": {
            "amount": 27800,
            "currency": "ZAR"
          },
          "type": "initial"
        }
      ],
      "receipt_number": "491352",
      "refund_type": "auth_reversal",
      "refunded_processing_fees": [
        {
          "amount": {
            "amount": 27800,
            "currency": "ZAR"
          },
          "type": "initial"
        }
      ],
      "staff_id": "1739522553-a7769044-ff8c-410d-b660-84e6727c70b9",
      "status": "approved",
      "total_amount": {
        "amount": 4500,
        "currency": "ZAR"
      },
      "updated_at": "2024-11-19T16:27:23+00:00"
    }
  ],
  "returns": [
    {
      "amounts": {
        "discount_amount": {
          "amount": 2780,
          "currency": "ZAR"
        },
        "gross_amount": {
          "amount": 16680,
          "currency": "ZAR"
        },
        "net_amount": {
          "amount": 13900,
          "currency": "ZAR"
        },
        "tax_amount": {
          "amount": 32263,
          "currency": "ZAR"
        },
        "tip_amount": {
          "amount": 0,
          "currency": "ZAR"
        }
      },
      "returned_applied_discounts": [
        {
          "discount_amount": {
            "amount": 3000,
            "currency": "ZAR"
          },
          "name": "Item Discount",
          "percentage": "10.00",
          "scope": "order",
          "type": "fixed_percentage"
        }
      ],
      "returned_line_items": [
        {
          "applied_discounts": [
            {
              "discount_amount": {
                "amount": 3000,
                "currency": "ZAR"
              },
              "name": "Item Discount",
              "percentage": "10.00",
              "scope": "order",
              "type": "fixed_percentage"
            }
          ],
          "applied_taxes": [
            {
              "name": "VAT",
              "percentage": "15.00",
              "scope": "line_item",
              "tax_amount": {
                "amount": 3000,
                "currency": "ZAR"
              },
              "type": "inclusive"
            }
          ],
          "discount_amount": {
            "amount": 2780,
            "currency": "ZAR"
          },
          "id": "1585232943683-bc402745-df17-486e-b583-3dfedcbc8b53",
          "item_type": "product",
          "modifiers": [
            {
              "group_name": "Side Orders",
              "group_ordinal": 1,
              "id": "1729101234567-bem-aa11-4bbb-9ccc-112233445566",
              "modifier_id": "1729001234890-cc33dd44-9876-4123-aabb-2233445566ff",
              "name": "Chips",
              "ordinal": 1,
              "price": {
                "amount": 500,
                "currency": "ZAR"
              },
              "variant_id": "1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small"
            }
          ],
          "name": "Men's Funky Blue T-Shirt - Medium",
          "net_amount": {
            "amount": 25020,
            "currency": "ZAR"
          },
          "note": "This is an optional note related to this item in the order.",
          "quantity": "1.00",
          "total_price": {
            "amount": 13900,
            "currency": "ZAR"
          },
          "unit_price": {
            "amount": 13900,
            "currency": "ZAR"
          },
          "variant_id": "1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6"
        }
      ],
      "returned_total_taxes": [
        {
          "name": "VAT",
          "percentage": "15.00",
          "scope": "line_item",
          "tax_amount": {
            "amount": 3000,
            "currency": "ZAR"
          },
          "type": "inclusive"
        }
      ],
      "source_order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d"
    }
  ],
  "staff_id": "1739522553-a7769044-ff8c-410d-b660-84e6727c70b9",
  "status": "completed",
  "total_taxes": [
    {
      "name": "VAT",
      "percentage": "15.00",
      "scope": "line_item",
      "tax_amount": {
        "amount": 3000,
        "currency": "ZAR"
      },
      "type": "inclusive"
    }
  ],
  "updated_at": "2024-11-19T16:27:23+00:00"
}