Guides
Expandable Fields
Many endpoints accept an expand query parameter that embeds related resources inline, saving you extra API calls.
Usage
Pass a comma-separated list of expansion names:
Code
Available Expansions
| Resource | Endpoint | Supported Expansions |
|---|---|---|
| Items | /v1/items, /v1/items/{id} | stock |
| Sales Orders | /v1/sales-orders, /v1/sales-orders/{id} | line_items |
| Shipments | /v1/shipments, /v1/shipments/{id} | packages, line_items, invoices |
| Packages | /v1/packages, /v1/packages/{id} | line_items, shipment |
| Invoices | /v1/invoices, /v1/invoices/{id} | — |
| Stock | /v1/stock, /v1/stock/{id} | — |
| Warehouses | /v1/warehouses, /v1/warehouses/{id} | — |
Behavior
- Expanded fields are nested objects (or arrays) within the response
- If no
expandparameter is provided, related fields are omitted or returned as IDs only - You can combine multiple expansions:
?expand=packages,line_items - Invalid expansion names are ignored
Last modified on