Get Order By Id | Analog

{
  "id": "1234",
  "store": {
    "created_at": "2024-01-15T09:30:00Z",
    "id": "5678",
    "name": {
      "translations": {
        "en": "Downtown Store",
        "es": "Tienda del Centro"
      }
    },
    "external_id": "store_ext_123"
  },
  "customer": {
    "name": "John Doe",
    "phone": "+1234567890"
  },
  "status": "ACCEPTED",
  "price": 2995,
  "tax": 245,
  "items": [
    {
      "name": "Burger Combo",
      "quantity": 2,
      "price": 1495,
      "tax": 123,
      "selected_modifier_groups": [
        {
          "name": "Toppings",
          "selected_items": [
            {
              "name": "Extra Cheese",
              "price_change": 100,
              "tax_change": 8
            }
          ]
        }
      ]
    }
  ],
  "ready_by": "2024-01-15T12:30:00Z",
  "created_at": "2024-01-15T09:30:00Z",
  "is_read": true,
  "in_pos": true,
  "object": "Order",
  "customer_comments": "No onions please",
  "ready_at": "2024-01-15T12:25:00Z",
  "completed_at": "2024-01-15T12:35:00Z",
  "payment_status": "paid",
  "payment_method": "PAY_BY_LINK"
}

Retrieves the details of a specific order by its unique identifier (order_id).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

order_idstringRequired

Response

Successful Response

idstring

Unique identifier for the order

storeobject

Store information associated with the order

customerobject

Customer who placed the order

statusenum

Current status of the order

priceinteger

Total price of the order in cents

taxinteger

Total tax amount in cents

itemslist of maps from strings to any

List of items in the order

ready_bydatetime

Requested ready time for the order

created_atdatetime

Time when the order was created

is_readboolean

Whether the order has been read

in_posboolean

Whether the order has been synced to POS

objectstring

Usually "Order" for an order object

customer_commentsstringOptional

Optional comments from the customer

ready_atdatetimeOptional

Actual time when order was marked ready

completed_atdatetimeOptional

Time when the order was completed

payment_statusenumOptional

Current status of the payment

payment_methodenumOptional

Method used for payment

Errors

422

Unprocessable Entity Error