Fetch order details

Retrieve the order by type and ID, where the ID can be either a UUID or a base64-encoded UUID

GET/v1/orders/{id}

Authorization

authorization<token>

To get an API key, please contact us. We'll be happy to help you.

In: header

Path Parameters

idstring

The id can take the format of an order uuid, or it may correspond to a QR code encoded as a base64 string (representing the order id)

Query Parameters

typestring

Type of payment; Currently supports the two values mentioned above

Value in"table" | "regular"

Response Body

application/json

curl -X GET "http://localhost:4006/v1/orders/string?type=table"

curl -X GET "http://localhost:4006/v1/orders/string?type=table"

{
  "order": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "total": 5500,
    "leftToPay": 5420
  },
  "metadata": {
    "location": {
      "id": "5822da78-9eb2-404a-a2eb-2f9a80803522",
      "name": "Restaurant",
      "configs": {
        "tips": null,
        "paymentServices": [
          {
            "name": "payxpert",
            "cards": [
              "visa",
              "mastercard",
              "american_express",
              "apple_pay"
            ]
          }
        ]
      }
    },
    "table": {
      "number": "12",
      "guests": 2
    },
    "items": [
      {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "name": "Product example",
        "description": "",
        "unitPrice": 1000,
        "quantity": 2,
        "isMenu": false,
        "menuItems": []
      },
      {
        "id": "d290f1ee-6c54-4b01-90e6-d661348f0853",
        "name": "Menu Example",
        "description": "(-3,00 €)",
        "unitPrice": 3500,
        "quantity": 1,
        "isMenu": true,
        "menuItems": [
          {
            "name": "Item 1",
            "unitPrice": 1000,
            "quantity": 1
          },
          {
            "name": "Item 2",
            "unitPrice": 1000,
            "quantity": 1
          },
          {
            "name": "Item 3",
            "unitPrice": 500,
            "quantity": 1
          }
        ]
      }
    ],
    "employee": "Matt"
  }
}