Order Lines

Part of the Sales API. Base URL https://your-domain.com/admin/api/v1 — replace the host with your own installation and the token placeholder with a real Bearer token (see Authentication).

List order lines

GET /admin/api/v1/sales/orders/{order_id}/lines

Retrieve a paginated list of line items for a specific order

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`order_id`	integer	Yes	The order ID

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include. Available options: product, linkedSaleOrderSale, uom, productPackaging, currency, orderPartner, salesman, warehouse, route, company, order	`product`
`filter[id]`	string	No	Comma-separated list of line IDs to filter by
`filter[product_id]`	string	No	Comma-separated list of product IDs to filter by
`sort`	string	Yes	Sort field	`-id`
`page`	integer	Yes	Page number	`1`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/sales/orders/{order_id}/lines?include=product&sort=-id&page=1" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/sales/orders/{order_id}/lines?include=product&sort=-id&page=1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/sales/orders/{order_id}/lines?include=product&sort=-id&page=1', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/sales/orders/{order_id}/lines?include=product&sort=-id&page=1"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": [
    {
      "id": null,
      "sort": 50,
      "name": "Qui commodi incidunt.",
      "display_type": null,
      "product_uom_qty": 1.2,
      "product_qty": 1.2,
      "qty_delivered": 0,
      "qty_invoiced": 0,
      "qty_to_invoice": 1.2,
      "product_packaging_qty": 0,
      "price_unit": 973.9302,
      "technical_price_unit": 973.9302,
      "discount": 0,
      "price_subtotal": 1168.71624,
      "price_tax": 175.307436,
      "price_total": 1344.023676,
      "price_reduce_taxexcl": 973.9302,
      "price_reduce_taxinc": 1120.01973,
      "purchase_price": 584.35812,
      "margin": 467.486496,
      "margin_percent": 40,
      "untaxed_amount_invoiced": 0,
      "untaxed_amount_to_invoice": 1168.71624,
      "state": "draft",
      "invoice_status": null,
      "qty_delivered_method": "stock_move",
      "virtual_id": null,
      "linked_virtual_id": null,
      "is_downpayment": false,
      "is_expense": false,
      "customer_lead": 13,
      "analytic_distribution": null,
      "order_id": 1,
      "product_id": 24,
      "linked_sale_order_sale_id": null,
      "product_uom_id": 73,
      "product_packaging_id": null,
      "currency_id": 211,
      "order_partner_id": 1,
      "salesman_id": 1,
      "warehouse_id": null,
      "route_id": null,
      "company_id": 1,
      "created_at": null,
      "updated_at": null
    },
    {
      "id": null,
      "sort": 100,
      "name": "Odit doloribus repellat officiis corporis.",
      "display_type": null,
      "product_uom_qty": 65.97,
      "product_qty": 65.97,
      "qty_delivered": 0,
      "qty_invoiced": 0,
      "qty_to_invoice": 65.97,
      "product_packaging_qty": 0,
      "price_unit": 826.0033,
      "technical_price_unit": 826.0033,
      "discount": 0,
      "price_subtotal": 54491.437700999995,
      "price_tax": 8173.715655149999,
      "price_total": 62665.15335615,
      "price_reduce_taxexcl": 826.0033,
      "price_reduce_taxinc": 949.903795,
      "purchase_price": 495.60197999999997,
      "margin": 21796.575080399998,
      "margin_percent": 40,
      "untaxed_amount_invoiced": 0,
      "untaxed_amount_to_invoice": 54491.437700999995,
      "state": "draft",
      "invoice_status": null,
      "qty_delivered_method": "stock_move",
      "virtual_id": null,
      "linked_virtual_id": null,
      "is_downpayment": false,
      "is_expense": false,
      "customer_lead": 28,
      "analytic_distribution": null,
      "order_id": 2,
      "product_id": 25,
      "linked_sale_order_sale_id": null,
      "product_uom_id": 76,
      "product_packaging_id": null,
      "currency_id": 213,
      "order_partner_id": 1,
      "salesman_id": 1,
      "warehouse_id": null,
      "route_id": null,
      "company_id": 1,
      "created_at": null,
      "updated_at": null
    }
  ]
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Show order line

GET /admin/api/v1/sales/orders/{order_id}/lines/{id}

Retrieve a specific line item from an order

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`order_id`	integer	Yes	The order ID
`id`	integer	Yes	The order line ID

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include. Available options: product, linkedSaleOrderSale, uom, productPackaging, currency, orderPartner, salesman, warehouse, route, company, order	`product`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/sales/orders/{order_id}/lines/{id}?include=product" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/sales/orders/{order_id}/lines/{id}?include=product", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/sales/orders/{order_id}/lines/{id}?include=product', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/sales/orders/{order_id}/lines/{id}?include=product"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "sort": 50,
    "name": "Qui commodi incidunt.",
    "display_type": null,
    "product_uom_qty": 1.2,
    "product_qty": 1.2,
    "qty_delivered": 0,
    "qty_invoiced": 0,
    "qty_to_invoice": 1.2,
    "product_packaging_qty": 0,
    "price_unit": 973.9302,
    "technical_price_unit": 973.9302,
    "discount": 0,
    "price_subtotal": 1168.71624,
    "price_tax": 175.307436,
    "price_total": 1344.023676,
    "price_reduce_taxexcl": 973.9302,
    "price_reduce_taxinc": 1120.01973,
    "purchase_price": 584.35812,
    "margin": 467.486496,
    "margin_percent": 40,
    "untaxed_amount_invoiced": 0,
    "untaxed_amount_to_invoice": 1168.71624,
    "state": "draft",
    "invoice_status": null,
    "qty_delivered_method": "stock_move",
    "virtual_id": null,
    "linked_virtual_id": null,
    "is_downpayment": false,
    "is_expense": false,
    "customer_lead": 13,
    "analytic_distribution": null,
    "order_id": 3,
    "product_id": 26,
    "linked_sale_order_sale_id": null,
    "product_uom_id": 79,
    "product_packaging_id": null,
    "currency_id": 215,
    "order_partner_id": 1,
    "salesman_id": 1,
    "warehouse_id": null,
    "route_id": null,
    "company_id": 1,
    "created_at": null,
    "updated_at": null
  }
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Order Lines ​

List order lines ​

Show order line ​

Order Lines

List order lines

Show order line