Get order lines

Retrieves all order lines for a specific order, including enriched product and variant information such as names, numbers, descriptions, and images.

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

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

Retrieves all order lines for a specific order, including enriched product and variant information such as names, numbers, descriptions, and images.

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\}/lines
  • Summary: Get order lines
  • Description: Retrieves all order lines for a specific order, including enriched product and variant information such as names, numbers, descriptions, and images.
  • 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 lines 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 Line 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 Line
PropertyTypeRequiredDetails
base_price_amountnumberNo-
created_atstringNo-
currency_codestringNo-
first_image_pathstringNo-
idstringNo-
order_idstringNo-
product_idstringNo-
product_namestringNo-
product_numberstringNo-
quantityintegerNo-
short_descriptionstringNo-
tax_group_idstringNo-
total_discount_amountnumberNo-
total_price_amountnumberNo-
total_sale_pricenumberNo-
total_tax_amountnumberNo-
updated_atstringNo-
variant_idstringNo-
variant_namestringNo-
variant_numberstringNo-

Generated example (synthetic):

{
  "data": [
    {
      "base_price_amount": 0,
      "created_at": "string",
      "currency_code": "string",
      "first_image_path": "string",
      "id": "string",
      "order_id": "string",
      "product_id": "string",
      "product_name": "string",
      "product_number": "string",
      "quantity": 0,
      "short_description": "string",
      "tax_group_id": "string",
      "total_discount_amount": 0,
      "total_price_amount": 0,
      "total_sale_price": 0,
      "total_tax_amount": 0,
      "updated_at": "string",
      "variant_id": "string",
      "variant_name": "string",
      "variant_number": "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\}/lines
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Orders
  • OpenAPI summary: Get order lines

Get order lines

# Get order lines Retrieves all order lines for a specific order, including enriched product and variant information such as names, numbers, descriptions, and images.
GET /api/v1/{team_slug}/{app_slug}/orders/{order_id}/lines
Purpose

Retrieves all order lines for a specific order, including enriched product and variant information such as names, numbers, descriptions, and images.

Required inputs

app_slug path team_slug path order_id path

Primary response

200 ยท Order lines retrieved successfully

Operation key

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

## 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}/lines` - Summary: Get order lines - Description: Retrieves all order lines for a specific order, including enriched product and variant information such as names, numbers, descriptions, and images. - 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}/lines` 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 lines 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 Line 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 Line | Property | Type | Required | Details | | --- | --- | --- | --- | | `base_price_amount` | number | No | - | | `created_at` | string | No | - | | `currency_code` | string | No | - | | `first_image_path` | string | No | - | | `id` | string | No | - | | `order_id` | string | No | - | | `product_id` | string | No | - | | `product_name` | string | No | - | | `product_number` | string | No | - | | `quantity` | integer | No | - | | `short_description` | string | No | - | | `tax_group_id` | string | No | - | | `total_discount_amount` | number | No | - | | `total_price_amount` | number | No | - | | `total_sale_price` | number | No | - | | `total_tax_amount` | number | No | - | | `updated_at` | string | No | - | | `variant_id` | string | No | - | | `variant_name` | string | No | - | | `variant_number` | string | No | - | **Generated example (synthetic):** ```json { "data": [ { "base_price_amount": 0, "created_at": "string", "currency_code": "string", "first_image_path": "string", "id": "string", "order_id": "string", "product_id": "string", "product_name": "string", "product_number": "string", "quantity": 0, "short_description": "string", "tax_group_id": "string", "total_discount_amount": 0, "total_price_amount": 0, "total_sale_price": 0, "total_tax_amount": 0, "updated_at": "string", "variant_id": "string", "variant_name": "string", "variant_number": "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}/lines` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/orders/{order_id}/lines` - OpenAPI tag: Orders - OpenAPI summary: Get order lines