DocsDocsReference

Get order history

Retrieves a chronological list of all changes made to an order, including status transitions, address updates, and line modifications.

GET/api/v1/{team_slug}/{app_slug}/orders/{order_id}/history
API
Management
Updated
Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/orders/{order_id}/history

Retrieves a chronological list of all changes made to an order, including status transitions, address updates, and line modifications.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/orders/\{order_id\}/history
  • Summary: Get order history
  • Description: Retrieves a chronological list of all changes made to an order, including status transitions, address updates, and line modifications.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
order_idpathYesstringOrder ID (UUID)
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses5 statuses
StatusDescriptionContent
200Order history retrieved successfullyapplication/json (object)
400Invalid order ID formatapplication/json (object)
401Unauthorized accessapplication/json (object)
404Order not foundapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Order History List

PropertyTypeRequiredDetails
dataobject[]No-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Order History
PropertyTypeRequiredDetails
change_typestringNo-
from_statusstringNo-
happened_atstringNo-
linesobject[]No-
order_idstringNo-
to_statusstringNo-
Order History Line
PropertyTypeRequiredDetails
deletedbooleanNo-
from_quantityintegerNo-
history_idstringNo-
order_line_idstringNo-
product_variant_idstringNo-
to_quantityintegerNo-

Generated example (synthetic):

{
  "data": [
    {
      "change_type": "string",
      "from_status": "string",
      "happened_at": "string",
      "lines": [
        {
          "deleted": null,
          "from_quantity": null,
          "history_id": null,
          "order_line_id": null,
          "product_variant_id": null,
          "to_quantity": null
        }
      ],
      "order_id": "string",
      "to_status": "string"
    }
  ],
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

404 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/orders/\{order_id\}/history
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Orders
  • OpenAPI summary: Get order history

Get order history

# Get order history Retrieves a chronological list of all changes made to an order, including status transitions, address updates, and line modifications.
GET /api/v1/{team_slug}/{app_slug}/orders/{order_id}/history
Purpose

Retrieves a chronological list of all changes made to an order, including status transitions, address updates, and line modifications.

Required inputs

app_slug path team_slug path order_id path

Primary response

200 ยท Order history retrieved successfully

Operation key

management-api:GET:/api/v1/{team_slug}/{app_slug}/orders/{order_id}/history

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/orders/{order_id}/history` - Summary: Get order history - Description: Retrieves a chronological list of all changes made to an order, including status transitions, address updates, and line modifications. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/orders/{order_id}/history` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | order_id | path | Yes | string | Order ID (UUID) | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Order history retrieved successfully | application/json (object) | | 400 | Invalid order ID format | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 404 | Order not found | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Order History List | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object[] | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Order History | Property | Type | Required | Details | | --- | --- | --- | --- | | `change_type` | string | No | - | | `from_status` | string | No | - | | `happened_at` | string | No | - | | `lines` | object[] | No | - | | `order_id` | string | No | - | | `to_status` | string | No | - | ##### Order History Line | Property | Type | Required | Details | | --- | --- | --- | --- | | `deleted` | boolean | No | - | | `from_quantity` | integer | No | - | | `history_id` | string | No | - | | `order_line_id` | string | No | - | | `product_variant_id` | string | No | - | | `to_quantity` | integer | No | - | **Generated example (synthetic):** ```json { "data": [ { "change_type": "string", "from_status": "string", "happened_at": "string", "lines": [ { "deleted": null, "from_quantity": null, "history_id": null, "order_line_id": null, "product_variant_id": null, "to_quantity": null } ], "order_id": "string", "to_status": "string" } ], "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 404 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/orders/{order_id}/history` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/orders/{order_id}/history` - OpenAPI tag: Orders - OpenAPI summary: Get order history