Get the customer-facing progress of an order

The order’s state, its history and the last comment for the customer. The state is the order tag that starts with the shop setting website.track_state_tag_prefix (e.g. prefix estado:, tag estado:Visita agendada, state “Visita agendada”). Without that setting state is null and timeline empty. comment is the latest external admin message (never an internal note). Needs the full orders.read scope; the _own scopes get 403.

GET/orders/{order_id}/progress

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

order_idstringrequired

Responses

200

Order progress

stateobject | null

Current state tag minus the prefix (the most recently added if several). null without a prefix setting or state tag.

Show properties

labelstring

sincestring<date-time>

When the tag was added (the order's updated_at if no event shows it).

commentobject | null

Latest external admin message of the order.

Show properties

bodystring

created_onstring<date-time>

timelineobject[]

State changes, oldest first, from the order's tag events.

Show properties

Array of object

statestring

atstring<date-time>

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

order_idpath*

Request

curl -X GET 'https://api.onbolder.com/v2/orders/string/progress' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/orders/string/progress", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/orders/string/progress",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "state": {
    "label": "Visita agendada",
    "since": "2019-08-24T14:15:22Z"
  },
  "comment": {
    "body": "string",
    "created_on": "2019-08-24T14:15:22Z"
  },
  "timeline": [
    {
      "state": "string",
      "at": "2019-08-24T14:15:22Z"
    }
  ]
}