Returns a paginated list of a store’s orders with their order lines, invoices (NF-e, Brazil only),
shipping method, delivery tracking and, optionally, the order’s event history. Use it to sync order
status and tracking into your own systems. Filter by status, order type, order number, buyer email
or date ranges.
Results are paginated: page (default 1) and per_page (default 10, capped at 100). The meta
object tells you whether more pages exist.
Filtering status by processing also returns orders in picking and packing, since all three
mean “being prepared in the warehouse”.
order_number accepts a single string or an array of strings (order_number[]=ORD-0001&order_number[]=ORD-0002).
When you filter by order number, stock units of products that use unit codes also expose their
unit_code while the order is packing or shipped.
sort_by accepts any order field (for example created_at, channel_created_at, shipping_date,
updated_at), or shipping_methods.<field> / stores.<field>; an unknown field returns 422
Field not found. sort is desc unless you pass asc. Without sort_by the order of results is not guaranteed.
include_event_history=true adds order_histories to every order (status changes, tracking
updates and incidents).
is_b2b is only present for stores that handle both B2B and D2C orders.
Each order in this list carries the subset of Order fields listed in the response schema
description; the full Order object is returned by the create and update endpoints.
Token returned by POST /auth/token, sent as Authorization: Bearer <token>.
Query Parameters
store_id
integer
required
ID of the store whose orders you want to list.
status
enum<string>[]
Only return orders in these statuses. processing implicitly includes picking and packing.
Fulfillment status of an order. processing, picking and packing all mean the order is being
prepared in the warehouse. holded means the order is on hold. packed is unused.
Available options:
initial,
unpaid,
empty,
pending,
error,
cancelation_window,
entirely_dropshipping,
backorder,
processing,
picking,
packing,
packed,
shipped,
canceled,
holded,
interrupted,
returned,
return_arrived,
returning,
reentered,
awaiting_fulfillment_request,
awaiting_dropoff,
arrived_at_warehouse
order_type
enum<string>[]
Only return orders of these types.
Kind of order. SALE is a regular sale; DONATION ships goods without a sale; REMOVE_STOCK,
REMOVE_DAMAGED_STOCK, REMOVE_EXPIRED_STOCK and REMOVE_LOST_STOCK withdraw stock from the
warehouse; STOCK_TRANSFER_OUT moves stock to another store; C2C is a consumer-to-consumer
shipment created by Cubbo and cannot be created through the API.
Available options:
SALE,
DONATION,
REMOVE_STOCK,
REMOVE_DAMAGED_STOCK,
REMOVE_EXPIRED_STOCK,
REMOVE_LOST_STOCK,
STOCK_TRANSFER_OUT,
C2C
order_number
stringstring[]
Exact order number, or an array of order numbers. Enables unit_code exposure on stock units.
shipping_email
string
Case-insensitive partial match on the buyer's shipping email.
shipping_date[from]
string<date-time>
Lower bound of the shipping date range. Required when shipping_date[to] is sent.
shipping_date[to]
string<date-time>
Upper bound of the shipping date range. Required when shipping_date[from] is sent.
channel_created_at[from]
string<date-time>
Lower bound of the range on the date the order was created in the sales channel. Required when channel_created_at[to] is sent.
channel_created_at[to]
string<date-time>
Upper bound of the range on the date the order was created in the sales channel. Required when channel_created_at[from] is sent.
sort_by
string
Field to sort by. Any order field, or shipping_methods.<field> / stores.<field>. Unknown fields return 422.
sort
enum<string>
default:desc
Sort direction. Any value other than asc sorts descending.
Available options:
asc,
desc
page
integer
default:1
Page number, starting at 1.
per_page
integer
default:10
Orders per page. Values above 100 are capped at 100.
Required range: x <= 100
include_event_history
boolean
default:false
When true, each order includes order_histories with its status and tracking events.
Response
Orders matching the filters, with pagination metadata.
orders
object[]
required
Orders on this page. Each item is an Order limited to: id, store_id, order_number, status,
channel_created_at, order_date, shipping_date, pending_at, shipping_email, shipping_status,
is_paid, channel_order_id, channel_name, is_cod, cod_amount, has_carrier_insurance,
requires_document_return, requires_pickup_on_delivery, currency, total_price, shipping,
billing, delivery_tracking, return_shipping_labels, estimated_time_arrival, delivered_at,
updated_at, is_click_and_collect, click_and_collect_metadata, latest_estimated_time_arrival_range,
channel_shipping_line_code, warehouse_timezone, is_first_time_buyer, is_subscription_renewal,
is_multi_package, is_b2b (mixed B2B/D2C stores only), plus the associations shipping_method
(id, carrier_name, shipping_name, is_cod), order_lines (id, name, sku, quantity,
generated, price_per_item, product, stock_units), invoices, store (id, name),
channel_integration (id, channel_type_name), return, created_by_return and, when
include_event_history=true, order_histories (new_status, incident_description, timestamp, origin).
Show child attributes
meta
object
required
Paging information returned next to list results.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cubbo Developers","description":"Developer documentation for the Cubbo Clients API: orders, inventory, replenishments, returns, shipping and webhooks.","colors":{"primary":"#327cfb","light":"#60a5fa","dark":"#327cfb"},"logo":{"light":"https://mintcdn.com/cubbo/RGfmvgvbM1HVXepF/logo/light.svg?fit=max\u0026auto=format\u0026n=RGfmvgvbM1HVXepF\u0026q=85\u0026s=208df5125f7962b06468c3c835605bd0","dark":"https://mintcdn.com/cubbo/RGfmvgvbM1HVXepF/logo/dark.svg?fit=max\u0026auto=format\u0026n=RGfmvgvbM1HVXepF\u0026q=85\u0026s=11cf015d96268e02f70a44f6d9f5918a"},"favicon":"https://mintcdn.com/cubbo/RGfmvgvbM1HVXepF/favicon.svg?fit=max\u0026auto=format\u0026n=RGfmvgvbM1HVXepF\u0026q=85\u0026s=3e2e823c87894cb7d9090336380478b6","appearance":{"default":"light"},"background":{"color":{"light":"#f3f4f6","dark":"#0b1229"}},"navbar":{"links":[{"href":"https://cubbo.com","label":"Cubbo"}],"primary":{"type":"button","label":"Get credentials","href":"https://app.cubbo.com/stores"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/cubbo"}},"styling":{"codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"es","navbar":{"links":[{"href":"https://cubbo.com","label":"Cubbo"}],"primary":{"type":"button","label":"Obtener credenciales","href":"https://app.cubbo.com/stores"}},"href":"es"},{"language":"pt-BR","navbar":{"links":[{"href":"https://cubbo.com","label":"Cubbo"}],"primary":{"type":"button","label":"Obter credenciais","href":"https://app.cubbo.com/stores"}},"href":"pt-BR"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cubbo","hasAudioNarration":false,"actualSubdomain":"cubbo","customDomains":["developers.cubbo.com"],"gitSource":{"type":"github","owner":"cubboengineering","repo":"developer-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6af32fc22491df72044f2dc3","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API reference","count":54},{"language":"default","tag":"Orders","count":14},{"language":"es","tag":"Guías","count":8},{"language":"en","tag":"Guides","count":8},{"language":"pt-BR","tag":"Guias","count":8},{"language":"default","tag":"Webhooks","count":7},{"language":"default","tag":"Replenishments","count":6},{"language":"default","tag":"Returns","count":6},{"language":"es","tag":"Primeros pasos","count":4},{"language":"en","tag":"Getting started","count":4},{"language":"pt-BR","tag":"Primeiros passos","count":4},{"language":"default","tag":"Lots","count":4},{"language":"default","tag":"Stores","count":4},{"language":"es","tag":"Uso de la API","count":3},{"language":"en","tag":"Working with the API","count":3},{"language":"pt-BR","tag":"Uso da API","count":3},{"language":"default","tag":"Click and collect","count":3},{"language":"default","tag":"Inventory","count":3},{"language":"default","tag":"Shipping methods","count":3},{"language":"es","tag":"Eventos","count":1},{"language":"en","tag":"Events","count":1},{"language":"pt-BR","tag":"Eventos","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--cubbo-navy: #0f2955;--cubbo-navy-hover: #3562b7;--cubbo-on-navy: #ffffff;--cubbo-on-navy-2: #bae6fd;--cubbo-radius: 8px;--cubbo-radius-sm: 6px}:root.dark{--cubbo-navy: #0c2148;--cubbo-navy-hover: #2c5299}body,#navbar,#sidebar,#content-area{font-family:-apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, Oxygen, Ubuntu, Cantarell,\n \"Fira Sans\", \"Droid Sans\", \"Helvetica Neue\", sans-serif}#navbar>div:first-child,#navbar{background-color:var(--cubbo-navy)!important;border-bottom-color:transparent!important}#navbar a,#navbar button,#navbar span,#navbar svg{color:var(--cubbo-on-navy)}#navbar a:hover{color:var(--cubbo-on-navy-2)}#navbar #search-bar-entry,#navbar button[id*=\"search\"]{background-color:rgba(255, 255, 255, 0.12)!important;border-color:rgba(255, 255, 255, 0.2)!important;color:var(--cubbo-on-navy-2)!important}.card,[class*=\"rounded-xl\"],[class*=\"rounded-2xl\"]{border-radius:var(--cubbo-radius)!important}pre,.code-block,[class*=\"code-group\"]{border-radius:var(--cubbo-radius-sm)!important}html:not(.dark) :not(pre)>code{background-color:#e8f0fe!important;color:#1e3a8a!important;border:1px solid #c7dafc!important;border-radius:4px!important;padding:0.1em 0.4em!important}html:not(.dark) a>code,html:not(.dark) a :not(pre)>code{color:#327cfb!important}"}],"page":{"pagePath":"api-reference/orders/list-orders","slug":"/api-reference/orders/list-orders","pageMetadata":{"title":"List orders","description":"Returns a paginated list of a store's orders with their order lines, invoices (NF-e, Brazil only),\nshipping method, delivery tracking and, optionally, the order's event history. Use it to sync order\nstatus and tracking into your own systems. Filter by status, order type, order number, buyer email\nor date ranges.\n\n- Results are paginated: `page` (default 1) and `per_page` (default 10, capped at 100). The `meta`\n object tells you whether more pages exist.\n- Filtering `status` by `processing` also returns orders in `picking` and `packing`, since all three\n mean \"being prepared in the warehouse\".\n- `order_number` accepts a single string or an array of strings (`order_number[]=ORD-0001\u0026order_number[]=ORD-0002`).\n When you filter by order number, stock units of products that use unit codes also expose their\n `unit_code` while the order is `packing` or `shipped`.\n- `sort_by` accepts any order field (for example `created_at`, `channel_created_at`, `shipping_date`,\n `updated_at`), or `shipping_methods.\u003cfield>` / `stores.\u003cfield>`; an unknown field returns 422\n `Field not found`. `sort` is `desc` unless you pass `asc`. Without `sort_by` the order of results is not guaranteed.\n- `include_event_history=true` adds `order_histories` to every order (status changes, tracking\n updates and incidents).\n- `is_b2b` is only present for stores that handle both B2B and D2C orders.\n- Each order in this list carries the subset of `Order` fields listed in the response schema\n description; the full `Order` object is returned by the create and update endpoints.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders","href":"/api-reference/orders/list-orders","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns a paginated list of a store’s orders with their order lines, invoices (NF-e, Brazil only),\\nshipping method, delivery tracking and, optionally, the order’s event history. Use it to sync order\\nstatus and tracking into your own systems. Filter by status, order type, order number, buyer email\\nor date ranges.\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Results are paginated: \", _jsx(_components.code, {\n children: \"page\"\n }), \" (default 1) and \", _jsx(_components.code, {\n children: \"per_page\"\n }), \" (default 10, capped at 100). The \", _jsx(_components.code, {\n children: \"meta\"\n }), \"\\nobject tells you whether more pages exist.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Filtering \", _jsx(_components.code, {\n children: \"status\"\n }), \" by \", _jsx(_components.code, {\n children: \"processing\"\n }), \" also returns orders in \", _jsx(_components.code, {\n children: \"picking\"\n }), \" and \", _jsx(_components.code, {\n children: \"packing\"\n }), \", since all three\\nmean “being prepared in the warehouse”.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"order_number\"\n }), \" accepts a single string or an array of strings (\", _jsx(_components.code, {\n children: \"order_number[]=ORD-0001\u0026order_number[]=ORD-0002\"\n }), \").\\nWhen you filter by order number, stock units of products that use unit codes also expose their\\n\", _jsx(_components.code, {\n children: \"unit_code\"\n }), \" while the order is \", _jsx(_components.code, {\n children: \"packing\"\n }), \" or \", _jsx(_components.code, {\n children: \"shipped\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"sort_by\"\n }), \" accepts any order field (for example \", _jsx(_components.code, {\n children: \"created_at\"\n }), \", \", _jsx(_components.code, {\n children: \"channel_created_at\"\n }), \", \", _jsx(_components.code, {\n children: \"shipping_date\"\n }), \",\\n\", _jsx(_components.code, {\n children: \"updated_at\"\n }), \"), or \", _jsx(_components.code, {\n children: \"shipping_methods.\u003cfield>\"\n }), \" / \", _jsx(_components.code, {\n children: \"stores.\u003cfield>\"\n }), \"; an unknown field returns 422\\n\", _jsx(_components.code, {\n children: \"Field not found\"\n }), \". \", _jsx(_components.code, {\n children: \"sort\"\n }), \" is \", _jsx(_components.code, {\n children: \"desc\"\n }), \" unless you pass \", _jsx(_components.code, {\n children: \"asc\"\n }), \". Without \", _jsx(_components.code, {\n children: \"sort_by\"\n }), \" the order of results is not guaranteed.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"include_event_history=true\"\n }), \" adds \", _jsx(_components.code, {\n children: \"order_histories\"\n }), \" to every order (status changes, tracking\\nupdates and incidents).\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"is_b2b\"\n }), \" is only present for stores that handle both B2B and D2C orders.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Each order in this list carries the subset of \", _jsx(_components.code, {\n children: \"Order\"\n }), \" fields listed in the response schema\\ndescription; the full \", _jsx(_components.code, {\n children: \"Order\"\n }), \" object is returned by the create and update endpoints.\"]\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"List orders","description":"Returns a paginated list of a store's orders with their order lines, invoices (NF-e, Brazil only),\nshipping method, delivery tracking and, optionally, the order's event history. Use it to sync order\nstatus and tracking into your own systems. Filter by status, order type, order number, buyer email\nor date ranges.\n\n- Results are paginated: `page` (default 1) and `per_page` (default 10, capped at 100). The `meta`\n object tells you whether more pages exist.\n- Filtering `status` by `processing` also returns orders in `picking` and `packing`, since all three\n mean \"being prepared in the warehouse\".\n- `order_number` accepts a single string or an array of strings (`order_number[]=ORD-0001\u0026order_number[]=ORD-0002`).\n When you filter by order number, stock units of products that use unit codes also expose their\n `unit_code` while the order is `packing` or `shipped`.\n- `sort_by` accepts any order field (for example `created_at`, `channel_created_at`, `shipping_date`,\n `updated_at`), or `shipping_methods.\u003cfield>` / `stores.\u003cfield>`; an unknown field returns 422\n `Field not found`. `sort` is `desc` unless you pass `asc`. Without `sort_by` the order of results is not guaranteed.\n- `include_event_history=true` adds `order_histories` to every order (status changes, tracking\n updates and incidents).\n- `is_b2b` is only present for stores that handle both B2B and D2C orders.\n- Each order in this list carries the subset of `Order` fields listed in the response schema\n description; the full `Order` object is returned by the create and update endpoints.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders","href":"/api-reference/orders/list-orders","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Orders"],"operationId":"listOrders","summary":"List orders","description":"Returns a paginated list of a store's orders with their order lines, invoices (NF-e, Brazil only),\nshipping method, delivery tracking and, optionally, the order's event history. Use it to sync order\nstatus and tracking into your own systems. Filter by status, order type, order number, buyer email\nor date ranges.\n\n- Results are paginated: `page` (default 1) and `per_page` (default 10, capped at 100). The `meta`\n object tells you whether more pages exist.\n- Filtering `status` by `processing` also returns orders in `picking` and `packing`, since all three\n mean \"being prepared in the warehouse\".\n- `order_number` accepts a single string or an array of strings (`order_number[]=ORD-0001\u0026order_number[]=ORD-0002`).\n When you filter by order number, stock units of products that use unit codes also expose their\n `unit_code` while the order is `packing` or `shipped`.\n- `sort_by` accepts any order field (for example `created_at`, `channel_created_at`, `shipping_date`,\n `updated_at`), or `shipping_methods.\u003cfield>` / `stores.\u003cfield>`; an unknown field returns 422\n `Field not found`. `sort` is `desc` unless you pass `asc`. Without `sort_by` the order of results is not guaranteed.\n- `include_event_history=true` adds `order_histories` to every order (status changes, tracking\n updates and incidents).\n- `is_b2b` is only present for stores that handle both B2B and D2C orders.\n- Each order in this list carries the subset of `Order` fields listed in the response schema\n description; the full `Order` object is returned by the create and update endpoints.\n","security":["4f9f4492-52e1-464c-ba56-912275362082"],"parameters":["6471148e-0969-4f83-8a33-4ff033ccb3e1","70fc0b23-9ab5-4e3f-8b4c-6822f72f26ea","c910ac70-94b5-47e9-a7a1-d978174358d0","3ad01076-3dd5-47bd-a562-db7309bf3a32","897914ce-e852-4b75-a51d-8c1e03ed608b","938bc658-68ae-4ac6-98e1-cb8dc04cc06c","3dfba736-e8a5-467d-a99e-fee629aaa245","73d8a4de-f4b3-4552-87a2-d3f22fc655d3","9193c432-3b92-4d6b-9635-5502e1fd17b5","66fe19c3-3cdc-4ee2-80a3-3034e92b32b0","b8b5710f-0c2a-4280-ad54-47de1779c297","134d8a02-a987-4064-82aa-add658ea3fde","6e8673e7-ce12-4394-9260-7b8f17e97f4b","fa3708a0-4eb2-4900-b6cb-42b25e7d3ed8"],"responses":{"200":"85c474bd-11ee-4e95-bb45-0f019691aa73","401":"32efb378-7973-4050-b755-1986b6c9bb47","422":"88331632-43f8-4dd7-b883-118119b7b113","500":"95aaca37-4224-46de-86b6-eee327e815ae"},"method":"get","type":"path","servers":["30628f1a-73a6-48fb-b75f-22c715a140c8"],"path":"/orders","baseUrlOptions":["https://api.cubbo.com/v1"],"title":"List orders","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6471148e-0969-4f83-8a33-4ff033ccb3e1":{"name":"store_id","in":"query","required":true,"schema":{"type":"integer","isRequired":true,"description":"ID of the store whose orders you want to list.","uniqueKey":"","typeLabel":"integer"},"description":"ID of the store whose orders you want to list.","example":1234},"70fc0b23-9ab5-4e3f-8b4c-6822f72f26ea":{"name":"status","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","description":"Fulfillment status of an order. `processing`, `picking` and `packing` all mean the order is being\nprepared in the warehouse. `holded` means the order is on hold. `packed` is unused.\n","enum":["initial","unpaid","empty","pending","error","cancelation_window","entirely_dropshipping","backorder","processing","picking","packing","packed","shipped","canceled","holded","interrupted","returned","return_arrived","returning","reentered","awaiting_fulfillment_request","awaiting_dropoff","arrived_at_warehouse"],"example":"shipped","uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Only return orders in these statuses. `processing` implicitly includes `picking` and `packing`.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"description":"Only return orders in these statuses. `processing` implicitly includes `picking` and `packing`.","example":["pending","processing"]},"c910ac70-94b5-47e9-a7a1-d978174358d0":{"name":"order_type","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","description":"Kind of order. `SALE` is a regular sale; `DONATION` ships goods without a sale; `REMOVE_STOCK`,\n`REMOVE_DAMAGED_STOCK`, `REMOVE_EXPIRED_STOCK` and `REMOVE_LOST_STOCK` withdraw stock from the\nwarehouse; `STOCK_TRANSFER_OUT` moves stock to another store; `C2C` is a consumer-to-consumer\nshipment created by Cubbo and cannot be created through the API.\n","enum":["SALE","DONATION","REMOVE_STOCK","REMOVE_DAMAGED_STOCK","REMOVE_EXPIRED_STOCK","REMOVE_LOST_STOCK","STOCK_TRANSFER_OUT","C2C"],"example":"SALE","uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Only return orders of these types.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"description":"Only return orders of these types.","example":["SALE"]},"3ad01076-3dd5-47bd-a562-db7309bf3a32":{"name":"order_number","in":"query","required":false,"schema":{"oneOf":[{"type":"string","description":"Exact order number, or an array of order numbers. Enables `unit_code` exposure on stock units.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Exact order number, or an array of order numbers. Enables `unit_code` exposure on stock units.","uniqueKey":"oneOf.1","typeLabel":"string[]"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | string[]"},"description":"Exact order number, or an array of order numbers. Enables `unit_code` exposure on stock units.","example":"ORD-0001"},"897914ce-e852-4b75-a51d-8c1e03ed608b":{"name":"shipping_email","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Case-insensitive partial match on the buyer's shipping email.","uniqueKey":"","typeLabel":"string"},"description":"Case-insensitive partial match on the buyer's shipping email.","example":"buyer@example.com"},"938bc658-68ae-4ac6-98e1-cb8dc04cc06c":{"name":"shipping_date[from]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Lower bound of the shipping date range. Required when `shipping_date[to]` is sent.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Lower bound of the shipping date range. Required when `shipping_date[to]` is sent.","example":"2026-01-01T00:00:00Z"},"3dfba736-e8a5-467d-a99e-fee629aaa245":{"name":"shipping_date[to]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Upper bound of the shipping date range. Required when `shipping_date[from]` is sent.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Upper bound of the shipping date range. Required when `shipping_date[from]` is sent.","example":"2026-01-31T23:59:59Z"},"73d8a4de-f4b3-4552-87a2-d3f22fc655d3":{"name":"channel_created_at[from]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Lower bound of the range on the date the order was created in the sales channel. Required when `channel_created_at[to]` is sent.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Lower bound of the range on the date the order was created in the sales channel. Required when `channel_created_at[to]` is sent.","example":"2026-01-01T00:00:00Z"},"9193c432-3b92-4d6b-9635-5502e1fd17b5":{"name":"channel_created_at[to]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Upper bound of the range on the date the order was created in the sales channel. Required when `channel_created_at[from]` is sent.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Upper bound of the range on the date the order was created in the sales channel. Required when `channel_created_at[from]` is sent.","example":"2026-01-31T23:59:59Z"},"66fe19c3-3cdc-4ee2-80a3-3034e92b32b0":{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Field to sort by. Any order field, or `shipping_methods.\u003cfield>` / `stores.\u003cfield>`. Unknown fields return 422.","uniqueKey":"","typeLabel":"string"},"description":"Field to sort by. Any order field, or `shipping_methods.\u003cfield>` / `stores.\u003cfield>`. Unknown fields return 422.","example":"channel_created_at"},"b8b5710f-0c2a-4280-ad54-47de1779c297":{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc","isRequired":false,"description":"Sort direction. Any value other than `asc` sorts descending.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Sort direction. Any value other than `asc` sorts descending.","example":"desc"},"134d8a02-a987-4064-82aa-add658ea3fde":{"name":"page","in":"query","required":false,"description":"Page number, starting at 1.","schema":{"type":"integer","default":1,"isRequired":false,"description":"Page number, starting at 1.","uniqueKey":"","typeLabel":"integer"},"example":1},"6e8673e7-ce12-4394-9260-7b8f17e97f4b":{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","default":10,"maximum":100,"isRequired":false,"description":"Orders per page. Values above 100 are capped at 100.","uniqueKey":"","typeLabel":"integer"},"description":"Orders per page. Values above 100 are capped at 100.","example":50},"fa3708a0-4eb2-4900-b6cb-42b25e7d3ed8":{"name":"include_event_history","in":"query","required":false,"schema":{"type":"boolean","default":false,"isRequired":false,"description":"When true, each order includes `order_histories` with its status and tracking events.","uniqueKey":"","typeLabel":"boolean"},"description":"When true, each order includes `order_histories` with its status and tracking events.","example":false}},"responses":{"85c474bd-11ee-4e95-bb45-0f019691aa73":{"description":"Orders matching the filters, with pagination metadata.","content":{"application/json":{"schema":{"type":"object","required":["orders","meta"],"properties":{"orders":{"type":"array","description":"Orders on this page. Each item is an `Order` limited to: `id`, `store_id`, `order_number`, `status`,\n`channel_created_at`, `order_date`, `shipping_date`, `pending_at`, `shipping_email`, `shipping_status`,\n`is_paid`, `channel_order_id`, `channel_name`, `is_cod`, `cod_amount`, `has_carrier_insurance`,\n`requires_document_return`, `requires_pickup_on_delivery`, `currency`, `total_price`, `shipping`,\n`billing`, `delivery_tracking`, `return_shipping_labels`, `estimated_time_arrival`, `delivered_at`,\n`updated_at`, `is_click_and_collect`, `click_and_collect_metadata`, `latest_estimated_time_arrival_range`,\n`channel_shipping_line_code`, `warehouse_timezone`, `is_first_time_buyer`, `is_subscription_renewal`,\n`is_multi_package`, `is_b2b` (mixed B2B/D2C stores only), plus the associations `shipping_method`\n(`id`, `carrier_name`, `shipping_name`, `is_cod`), `order_lines` (`id`, `name`, `sku`, `quantity`,\n`generated`, `price_per_item`, `product`, `stock_units`), `invoices`, `store` (`id`, `name`),\n`channel_integration` (`id`, `channel_type_name`), `return`, `created_by_return` and, when\n`include_event_history=true`, `order_histories` (`new_status`, `incident_description`, `timestamp`, `origin`).\n","items":{"type":"object","description":"An order as returned by the Orders endpoints. Scalar fields are always available; associations\n(`shipping_method`, `order_lines`, `invoices`, `store`, `channel_integration`, `return`,\n`created_by_return`, `order_histories`) are present only when the endpoint includes them. Each\nendpoint's response description lists the fields it returns.\n","properties":{"id":{"type":"integer","description":"Cubbo ID of the order. Use it in path parameters.","example":987654,"uniqueKey":"orders.items.[INDEX].id","typeLabel":"integer"},"store_id":{"type":"integer","description":"Store ID.","example":1234,"uniqueKey":"orders.items.[INDEX].store_id","typeLabel":"integer"},"order_number":{"type":"string","description":"Your order number, unique within the store.","example":"ORD-0001","uniqueKey":"orders.items.[INDEX].order_number","typeLabel":"string"},"status":{"type":"string","description":"Fulfillment status of an order. `processing`, `picking` and `packing` all mean the order is being\nprepared in the warehouse. `holded` means the order is on hold. `packed` is unused.\n","enum":["initial","unpaid","empty","pending","error","cancelation_window","entirely_dropshipping","backorder","processing","picking","packing","packed","shipped","canceled","holded","interrupted","returned","return_arrived","returning","reentered","awaiting_fulfillment_request","awaiting_dropoff","arrived_at_warehouse"],"example":"shipped","uniqueKey":"orders.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"channel_created_at":{"type":"string","format":"date-time","description":"When the order was created in the sales channel.","example":"2026-01-10T14:02:11.000Z","uniqueKey":"orders.items.[INDEX].channel_created_at","typeLabel":"string\u003cdate-time>"},"order_date":{"oneOf":[{"type":"string","format":"date-time","description":"Order date.","example":"2026-01-10T14:02:11.000Z","uniqueKey":"orders.items.[INDEX].order_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Order date.","example":"2026-01-10T14:02:11.000Z","uniqueKey":"orders.items.[INDEX].order_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_date","typeLabel":"string\u003cdate-time> | null"},"shipping_date":{"oneOf":[{"type":"string","format":"date-time","description":"When the order was shipped.","example":"2026-01-11T18:30:00.000Z","uniqueKey":"orders.items.[INDEX].shipping_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the order was shipped.","example":"2026-01-11T18:30:00.000Z","uniqueKey":"orders.items.[INDEX].shipping_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping_date","typeLabel":"string\u003cdate-time> | null"},"pending_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the order became ready to be fulfilled.","example":"2026-01-10T14:05:00.000Z","uniqueKey":"orders.items.[INDEX].pending_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the order became ready to be fulfilled.","example":"2026-01-10T14:05:00.000Z","uniqueKey":"orders.items.[INDEX].pending_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].pending_at","typeLabel":"string\u003cdate-time> | null"},"shipping_email":{"oneOf":[{"type":"string","description":"Buyer email.","example":"buyer@example.com","uniqueKey":"orders.items.[INDEX].shipping_email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Buyer email.","example":"buyer@example.com","uniqueKey":"orders.items.[INDEX].shipping_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping_email","typeLabel":"string | null"},"shipping_address_1":{"oneOf":[{"type":"string","description":"Shipping street address line 1 (also inside `shipping`).","example":"Av. Ejemplo 123","uniqueKey":"orders.items.[INDEX].shipping_address_1.oneOf.0","typeLabel":"string"},{"type":"null","description":"Shipping street address line 1 (also inside `shipping`).","example":"Av. Ejemplo 123","uniqueKey":"orders.items.[INDEX].shipping_address_1.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping_address_1","typeLabel":"string | null"},"shipping_status":{"oneOf":[{"type":"string","description":"Carrier-side status of the shipment.","enum":["shipment_created","awaiting_collection","shipment_collected","shipment_in_transit","shipment_out_for_delivery","shipment_delivered","shipment_partially_delivered","shipment_with_incident","shipment_to_be_self_collected","shipment_canceled","shipment_returned","shipment_not_defined"],"example":"shipment_in_transit","uniqueKey":"orders.items.[INDEX].shipping_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Carrier-side status of the shipment.","uniqueKey":"orders.items.[INDEX].shipping_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping_status","typeLabel":"enum\u003cstring> | null"},"is_paid":{"type":"boolean","description":"Whether the order is paid. Unpaid orders are not fulfilled.","example":true,"uniqueKey":"orders.items.[INDEX].is_paid","typeLabel":"boolean"},"is_cod":{"type":"boolean","description":"Whether the order is cash on delivery.","example":false,"uniqueKey":"orders.items.[INDEX].is_cod","typeLabel":"boolean"},"cod_amount":{"oneOf":[{"type":"string","description":"Amount to collect on delivery, as a decimal string.","example":null,"uniqueKey":"orders.items.[INDEX].cod_amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Amount to collect on delivery, as a decimal string.","example":null,"uniqueKey":"orders.items.[INDEX].cod_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].cod_amount","typeLabel":"string | null"},"requires_document_return":{"type":"boolean","description":"Whether the carrier must bring back a signed document.","example":false,"uniqueKey":"orders.items.[INDEX].requires_document_return","typeLabel":"boolean"},"requires_pickup_on_delivery":{"type":"boolean","description":"Whether the carrier must pick something up when delivering.","example":false,"uniqueKey":"orders.items.[INDEX].requires_pickup_on_delivery","typeLabel":"boolean"},"has_carrier_insurance":{"type":"boolean","description":"Whether the shipment is insured with the carrier.","example":false,"uniqueKey":"orders.items.[INDEX].has_carrier_insurance","typeLabel":"boolean"},"has_missing_info":{"type":"boolean","description":"Whether the order is blocked because data is missing.","example":false,"uniqueKey":"orders.items.[INDEX].has_missing_info","typeLabel":"boolean"},"missing_info":{"oneOf":[{"type":"string","description":"Description of the missing data, if any.","example":null,"uniqueKey":"orders.items.[INDEX].missing_info.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description of the missing data, if any.","example":null,"uniqueKey":"orders.items.[INDEX].missing_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].missing_info","typeLabel":"string | null"},"currency":{"oneOf":[{"type":"string","description":"Currency code of the prices.","example":"MXN","uniqueKey":"orders.items.[INDEX].currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency code of the prices.","example":"MXN","uniqueKey":"orders.items.[INDEX].currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].currency","typeLabel":"string | null"},"total_price":{"oneOf":[{"type":"string","description":"Order total as a decimal string.","example":"899.00","uniqueKey":"orders.items.[INDEX].total_price.oneOf.0","typeLabel":"string"},{"type":"null","description":"Order total as a decimal string.","example":"899.00","uniqueKey":"orders.items.[INDEX].total_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].total_price","typeLabel":"string | null"},"discount_price":{"oneOf":[{"type":"string","description":"Total discount as a decimal string.","example":"0.00","uniqueKey":"orders.items.[INDEX].discount_price.oneOf.0","typeLabel":"string"},{"type":"null","description":"Total discount as a decimal string.","example":"0.00","uniqueKey":"orders.items.[INDEX].discount_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].discount_price","typeLabel":"string | null"},"buyer_shipping_price":{"oneOf":[{"type":"string","description":"Shipping price paid by the buyer, as a decimal string.","example":"0.00","uniqueKey":"orders.items.[INDEX].buyer_shipping_price.oneOf.0","typeLabel":"string"},{"type":"null","description":"Shipping price paid by the buyer, as a decimal string.","example":"0.00","uniqueKey":"orders.items.[INDEX].buyer_shipping_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].buyer_shipping_price","typeLabel":"string | null"},"extra_fees_price":{"oneOf":[{"type":"string","description":"Extra fees as a decimal string.","example":"0.0","uniqueKey":"orders.items.[INDEX].extra_fees_price.oneOf.0","typeLabel":"string"},{"type":"null","description":"Extra fees as a decimal string.","example":"0.0","uniqueKey":"orders.items.[INDEX].extra_fees_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].extra_fees_price","typeLabel":"string | null"},"is_pick_and_ship":{"type":"boolean","description":"Whether the order is a pick-and-ship order (you pick it up at the warehouse).","example":false,"uniqueKey":"orders.items.[INDEX].is_pick_and_ship","typeLabel":"boolean"},"pick_n_ship_status":{"oneOf":[{"type":"string","description":"Pick-and-ship status.","enum":["awaiting_pick_up","picked_up","in_warehouse",null],"example":null,"uniqueKey":"orders.items.[INDEX].pick_n_ship_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Pick-and-ship status.","enum":["awaiting_pick_up","picked_up","in_warehouse",null],"example":null,"uniqueKey":"orders.items.[INDEX].pick_n_ship_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].pick_n_ship_status","typeLabel":"enum\u003cstring> | null"},"is_b2b":{"type":"boolean","description":"Whether the order is a B2B order. In `GET /orders` only present for stores that handle both B2B and D2C.","example":false,"uniqueKey":"orders.items.[INDEX].is_b2b","typeLabel":"boolean"},"is_first_time_buyer":{"type":"boolean","description":"Whether this is the buyer's first order in the store.","example":true,"uniqueKey":"orders.items.[INDEX].is_first_time_buyer","typeLabel":"boolean"},"is_subscription_renewal":{"type":"boolean","description":"Whether the order is a subscription renewal.","example":false,"uniqueKey":"orders.items.[INDEX].is_subscription_renewal","typeLabel":"boolean"},"is_click_and_collect":{"type":"boolean","description":"Whether the buyer picks the order up at a pickup point.","example":false,"uniqueKey":"orders.items.[INDEX].is_click_and_collect","typeLabel":"boolean"},"click_and_collect_metadata":{"oneOf":[{"type":"object","description":"Pickup-point details for click-and-collect orders; null otherwise.","properties":{"name":{"type":"string","description":"Pickup point name.","example":"Pickup point name","uniqueKey":"orders.items.[INDEX].click_and_collect_metadata.oneOf.0.name","typeLabel":"string"},"address":{"type":"string","description":"Pickup point address.","example":"Pickup point address","uniqueKey":"orders.items.[INDEX].click_and_collect_metadata.oneOf.0.address","typeLabel":"string"},"zipcode":{"type":"string","description":"Pickup point postal code.","example":"01000","uniqueKey":"orders.items.[INDEX].click_and_collect_metadata.oneOf.0.zipcode","typeLabel":"string"},"description":{"type":"string","description":"Human-readable description of the pickup point.","example":"Punto fisico - Centro","uniqueKey":"orders.items.[INDEX].click_and_collect_metadata.oneOf.0.description","typeLabel":"string"},"carrier_name":{"type":"string","description":"Carrier operating the pickup point.","example":"ESTAFETA","uniqueKey":"orders.items.[INDEX].click_and_collect_metadata.oneOf.0.carrier_name","typeLabel":"string"},"pickup_codes":{"type":"object","description":"Pickup codes per package, keyed by the package tracking number.","additionalProperties":{"type":"object","properties":{"pickup_short":{"type":"string","description":"Short pickup code.","example":"AB12CD","uniqueKey":"orders.items.[INDEX].click_and_collect_metadata.oneOf.0.pickup_codes.additionalProperties.pickup_short","typeLabel":"string"},"pickup_qr_image_url":{"type":"string","description":"URL of the QR image to present at pickup.","example":"https://api.cubbo.com/rails/active_storage/blobs/redirect/example/pickup_qr.png","uniqueKey":"orders.items.[INDEX].click_and_collect_metadata.oneOf.0.pickup_codes.additionalProperties.pickup_qr_image_url","typeLabel":"string"}},"uniqueKey":"orders.items.[INDEX].click_and_collect_metadata.oneOf.0.pickup_codes.additionalProperties","typeLabel":"object"},"uniqueKey":"orders.items.[INDEX].click_and_collect_metadata.oneOf.0.pickup_codes","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"orders.items.[INDEX].click_and_collect_metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Pickup-point details for click-and-collect orders; null otherwise.","uniqueKey":"orders.items.[INDEX].click_and_collect_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].click_and_collect_metadata","typeLabel":"object | null"},"is_multi_package":{"type":"boolean","description":"Whether the shipment has more than one package.","example":false,"uniqueKey":"orders.items.[INDEX].is_multi_package","typeLabel":"boolean"},"shipping":{"type":"object","description":"Shipping contact and address of an order.","properties":{"first_name":{"oneOf":[{"type":"string","description":"Recipient first name.","example":"Ana","uniqueKey":"orders.items.[INDEX].shipping.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Recipient first name.","example":"Ana","uniqueKey":"orders.items.[INDEX].shipping.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"Recipient last name.","example":"Example","uniqueKey":"orders.items.[INDEX].shipping.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Recipient last name.","example":"Example","uniqueKey":"orders.items.[INDEX].shipping.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.last_name","typeLabel":"string | null"},"company":{"oneOf":[{"type":"string","description":"Company name, if any.","example":null,"uniqueKey":"orders.items.[INDEX].shipping.company.oneOf.0","typeLabel":"string"},{"type":"null","description":"Company name, if any.","example":null,"uniqueKey":"orders.items.[INDEX].shipping.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.company","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Recipient phone number.","example":"+525500000000","uniqueKey":"orders.items.[INDEX].shipping.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Recipient phone number.","example":"+525500000000","uniqueKey":"orders.items.[INDEX].shipping.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.phone","typeLabel":"string | null"},"address_1":{"oneOf":[{"type":"string","description":"Street address line 1.","example":"Av. Ejemplo 123","uniqueKey":"orders.items.[INDEX].shipping.address_1.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street address line 1.","example":"Av. Ejemplo 123","uniqueKey":"orders.items.[INDEX].shipping.address_1.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.address_1","typeLabel":"string | null"},"address_2":{"oneOf":[{"type":"string","description":"Street address line 2.","example":null,"uniqueKey":"orders.items.[INDEX].shipping.address_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street address line 2.","example":null,"uniqueKey":"orders.items.[INDEX].shipping.address_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.address_2","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"Recipient email.","example":"buyer@example.com","uniqueKey":"orders.items.[INDEX].shipping.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Recipient email.","example":"buyer@example.com","uniqueKey":"orders.items.[INDEX].shipping.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.email","typeLabel":"string | null"},"zip_code":{"oneOf":[{"type":"string","description":"Postal code.","example":"01000","uniqueKey":"orders.items.[INDEX].shipping.zip_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Postal code.","example":"01000","uniqueKey":"orders.items.[INDEX].shipping.zip_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.zip_code","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Two-letter country code.","example":"MX","uniqueKey":"orders.items.[INDEX].shipping.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Two-letter country code.","example":"MX","uniqueKey":"orders.items.[INDEX].shipping.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.country","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State or province.","example":"CDMX","uniqueKey":"orders.items.[INDEX].shipping.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State or province.","example":"CDMX","uniqueKey":"orders.items.[INDEX].shipping.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.state","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City.","example":"Ciudad de Mexico","uniqueKey":"orders.items.[INDEX].shipping.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City.","example":"Ciudad de Mexico","uniqueKey":"orders.items.[INDEX].shipping.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.city","typeLabel":"string | null"},"city_code":{"oneOf":[{"type":"string","description":"Colombia: the DANE code of the city that decides the destination, as you sent it in `shipping.city_code`; null when the city and province decide.","example":null,"uniqueKey":"orders.items.[INDEX].shipping.city_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Colombia: the DANE code of the city that decides the destination, as you sent it in `shipping.city_code`; null when the city and province decide.","example":null,"uniqueKey":"orders.items.[INDEX].shipping.city_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.city_code","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","description":"Street number.","example":"123","uniqueKey":"orders.items.[INDEX].shipping.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street number.","example":"123","uniqueKey":"orders.items.[INDEX].shipping.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.number","typeLabel":"string | null"},"interior_number":{"oneOf":[{"type":"string","description":"Apartment or interior number.","example":null,"uniqueKey":"orders.items.[INDEX].shipping.interior_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Apartment or interior number.","example":null,"uniqueKey":"orders.items.[INDEX].shipping.interior_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.interior_number","typeLabel":"string | null"},"neighborhood":{"oneOf":[{"type":"string","description":"Neighborhood (colonia / bairro).","example":"Centro","uniqueKey":"orders.items.[INDEX].shipping.neighborhood.oneOf.0","typeLabel":"string"},{"type":"null","description":"Neighborhood (colonia / bairro).","example":"Centro","uniqueKey":"orders.items.[INDEX].shipping.neighborhood.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.neighborhood","typeLabel":"string | null"},"references":{"oneOf":[{"type":"string","description":"Delivery references for the courier.","example":"Blue door","uniqueKey":"orders.items.[INDEX].shipping.references.oneOf.0","typeLabel":"string"},{"type":"null","description":"Delivery references for the courier.","example":"Blue door","uniqueKey":"orders.items.[INDEX].shipping.references.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping.references","typeLabel":"string | null"}},"uniqueKey":"orders.items.[INDEX].shipping","typeLabel":"object"},"billing":{"type":"object","description":"Billing contact, fiscal data and address of an order. Fiscal fields are returned in clear text to the store that owns the order.","properties":{"first_name":{"oneOf":[{"type":"string","description":"Billing first name.","example":"Ana","uniqueKey":"orders.items.[INDEX].billing.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Billing first name.","example":"Ana","uniqueKey":"orders.items.[INDEX].billing.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"Billing last name.","example":"Example","uniqueKey":"orders.items.[INDEX].billing.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Billing last name.","example":"Example","uniqueKey":"orders.items.[INDEX].billing.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.last_name","typeLabel":"string | null"},"company":{"oneOf":[{"type":"string","description":"Company name, if any.","example":null,"uniqueKey":"orders.items.[INDEX].billing.company.oneOf.0","typeLabel":"string"},{"type":"null","description":"Company name, if any.","example":null,"uniqueKey":"orders.items.[INDEX].billing.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.company","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Billing phone number.","example":"+525500000000","uniqueKey":"orders.items.[INDEX].billing.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Billing phone number.","example":"+525500000000","uniqueKey":"orders.items.[INDEX].billing.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.phone","typeLabel":"string | null"},"tax_id":{"oneOf":[{"type":"string","description":"Tax ID of the buyer (CPF or CNPJ in Brazil, RFC in Mexico).","example":"000.000.000-00","uniqueKey":"orders.items.[INDEX].billing.tax_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tax ID of the buyer (CPF or CNPJ in Brazil, RFC in Mexico).","example":"000.000.000-00","uniqueKey":"orders.items.[INDEX].billing.tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.tax_id","typeLabel":"string | null"},"tax_regime":{"oneOf":[{"type":"string","description":"Buyer's tax regime, when provided.","example":null,"uniqueKey":"orders.items.[INDEX].billing.tax_regime.oneOf.0","typeLabel":"string"},{"type":"null","description":"Buyer's tax regime, when provided.","example":null,"uniqueKey":"orders.items.[INDEX].billing.tax_regime.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.tax_regime","typeLabel":"string | null"},"state_registration":{"oneOf":[{"type":"string","description":"State registration (inscricao estadual, Brazil).","example":null,"uniqueKey":"orders.items.[INDEX].billing.state_registration.oneOf.0","typeLabel":"string"},{"type":"null","description":"State registration (inscricao estadual, Brazil).","example":null,"uniqueKey":"orders.items.[INDEX].billing.state_registration.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.state_registration","typeLabel":"string | null"},"address_1":{"oneOf":[{"type":"string","description":"Street address line 1.","example":"Av. Ejemplo 123","uniqueKey":"orders.items.[INDEX].billing.address_1.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street address line 1.","example":"Av. Ejemplo 123","uniqueKey":"orders.items.[INDEX].billing.address_1.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.address_1","typeLabel":"string | null"},"address_2":{"oneOf":[{"type":"string","description":"Street address line 2.","example":null,"uniqueKey":"orders.items.[INDEX].billing.address_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street address line 2.","example":null,"uniqueKey":"orders.items.[INDEX].billing.address_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.address_2","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","description":"Street number.","example":"123","uniqueKey":"orders.items.[INDEX].billing.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street number.","example":"123","uniqueKey":"orders.items.[INDEX].billing.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.number","typeLabel":"string | null"},"interior_number":{"oneOf":[{"type":"string","description":"Apartment or interior number.","example":null,"uniqueKey":"orders.items.[INDEX].billing.interior_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Apartment or interior number.","example":null,"uniqueKey":"orders.items.[INDEX].billing.interior_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.interior_number","typeLabel":"string | null"},"neighborhood":{"oneOf":[{"type":"string","description":"Neighborhood.","example":"Centro","uniqueKey":"orders.items.[INDEX].billing.neighborhood.oneOf.0","typeLabel":"string"},{"type":"null","description":"Neighborhood.","example":"Centro","uniqueKey":"orders.items.[INDEX].billing.neighborhood.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.neighborhood","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"Billing email.","example":"buyer@example.com","uniqueKey":"orders.items.[INDEX].billing.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Billing email.","example":"buyer@example.com","uniqueKey":"orders.items.[INDEX].billing.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.email","typeLabel":"string | null"},"zip_code":{"oneOf":[{"type":"string","description":"Postal code.","example":"01000","uniqueKey":"orders.items.[INDEX].billing.zip_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Postal code.","example":"01000","uniqueKey":"orders.items.[INDEX].billing.zip_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.zip_code","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Two-letter country code.","example":"MX","uniqueKey":"orders.items.[INDEX].billing.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Two-letter country code.","example":"MX","uniqueKey":"orders.items.[INDEX].billing.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.country","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State or province.","example":"CDMX","uniqueKey":"orders.items.[INDEX].billing.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State or province.","example":"CDMX","uniqueKey":"orders.items.[INDEX].billing.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.state","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City.","example":"Ciudad de Mexico","uniqueKey":"orders.items.[INDEX].billing.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City.","example":"Ciudad de Mexico","uniqueKey":"orders.items.[INDEX].billing.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].billing.city","typeLabel":"string | null"}},"uniqueKey":"orders.items.[INDEX].billing","typeLabel":"object"},"delivery_tracking":{"type":"array","description":"Tracking per package. Return labels are excluded.","items":{"type":"object","description":"Tracking information for one package of the order. When no label exists yet, a single entry with null tracking fields is returned.","properties":{"shipping_number":{"oneOf":[{"type":"string","description":"Carrier tracking number of the package.","example":"TRK000000001","uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].shipping_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Carrier tracking number of the package.","example":"TRK000000001","uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].shipping_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].shipping_number","typeLabel":"string | null"},"tracking_url":{"oneOf":[{"type":"string","description":"Carrier tracking page. For Cubbo pickup-point deliveries this is Cubbo's own tracking page.","example":"https://carrier.example.com/track/TRK000000001","uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].tracking_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Carrier tracking page. For Cubbo pickup-point deliveries this is Cubbo's own tracking page.","example":"https://carrier.example.com/track/TRK000000001","uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].tracking_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].tracking_url","typeLabel":"string | null"},"cubbo_tracking_url":{"oneOf":[{"type":"string","description":"Cubbo tracking page for the order.","example":"https://tracking.example.com/orders/abc123","uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].cubbo_tracking_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cubbo tracking page for the order.","example":"https://tracking.example.com/orders/abc123","uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].cubbo_tracking_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].cubbo_tracking_url","typeLabel":"string | null"},"service_id":{"oneOf":[{"type":"string","description":"Carrier service used for the label.","example":"express","uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].service_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Carrier service used for the label.","example":"express","uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].service_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].service_id","typeLabel":"string | null"},"shipping_status":{"oneOf":[{"type":"string","description":"Shipping status of this package (falls back to the order's shipping status).","enum":["shipment_created","awaiting_collection","shipment_collected","shipment_in_transit","shipment_out_for_delivery","shipment_delivered","shipment_partially_delivered","shipment_with_incident","shipment_to_be_self_collected","shipment_canceled","shipment_returned","shipment_not_defined"],"example":"shipment_in_transit","uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].shipping_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Shipping status of this package (falls back to the order's shipping status).","uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].shipping_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].shipping_status","typeLabel":"enum\u003cstring> | null"},"package_index":{"type":"integer","description":"1-based index of this package.","example":1,"uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].package_index","typeLabel":"integer"},"total_packages":{"type":"integer","description":"Total number of packages of the order.","example":1,"uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX].total_packages","typeLabel":"integer"}},"uniqueKey":"orders.items.[INDEX].delivery_tracking.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orders.items.[INDEX].delivery_tracking","typeLabel":"object[]"},"return_shipping_labels":{"oneOf":[{"type":"array","description":"Valid return labels of the order.","items":{"type":"object","description":"A valid return label attached to the order.","properties":{"shipping_number":{"oneOf":[{"type":"string","description":"Tracking number of the return label.","example":"RTN000000001","uniqueKey":"orders.items.[INDEX].return_shipping_labels.oneOf.0.items.[INDEX].shipping_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tracking number of the return label.","example":"RTN000000001","uniqueKey":"orders.items.[INDEX].return_shipping_labels.oneOf.0.items.[INDEX].shipping_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].return_shipping_labels.oneOf.0.items.[INDEX].shipping_number","typeLabel":"string | null"},"tracking_url":{"oneOf":[{"type":"string","description":"Carrier tracking page of the return label.","example":"https://carrier.example.com/track/RTN000000001","uniqueKey":"orders.items.[INDEX].return_shipping_labels.oneOf.0.items.[INDEX].tracking_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Carrier tracking page of the return label.","example":"https://carrier.example.com/track/RTN000000001","uniqueKey":"orders.items.[INDEX].return_shipping_labels.oneOf.0.items.[INDEX].tracking_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].return_shipping_labels.oneOf.0.items.[INDEX].tracking_url","typeLabel":"string | null"}},"uniqueKey":"orders.items.[INDEX].return_shipping_labels.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orders.items.[INDEX].return_shipping_labels.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Valid return labels of the order.","items":{"type":"object","description":"A valid return label attached to the order.","properties":{"shipping_number":{"oneOf":[{"type":"string","description":"Tracking number of the return label.","example":"RTN000000001"},{"type":"null","description":"Tracking number of the return label.","example":"RTN000000001"}]},"tracking_url":{"oneOf":[{"type":"string","description":"Carrier tracking page of the return label.","example":"https://carrier.example.com/track/RTN000000001"},{"type":"null","description":"Carrier tracking page of the return label.","example":"https://carrier.example.com/track/RTN000000001"}]}}},"uniqueKey":"orders.items.[INDEX].return_shipping_labels.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].return_shipping_labels","typeLabel":"object[] | null"},"proof_of_delivery":{"oneOf":[{"type":"object","description":"Proof of delivery, when the carrier provided one for a shipped or returned order.","properties":{"id":{"type":"integer","description":"Proof of delivery ID.","example":3101,"uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.id","typeLabel":"integer"},"recipient_name":{"oneOf":[{"type":"string","description":"Name of the person who received the package.","example":"Ana Example","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.recipient_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the person who received the package.","example":"Ana Example","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.recipient_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.recipient_name","typeLabel":"string | null"},"recipient_relationship":{"oneOf":[{"type":"string","description":"Relationship of the receiver to the buyer, as reported by the carrier.","example":"self","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.recipient_relationship.oneOf.0","typeLabel":"string"},{"type":"null","description":"Relationship of the receiver to the buyer, as reported by the carrier.","example":"self","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.recipient_relationship.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.recipient_relationship","typeLabel":"string | null"},"format":{"oneOf":[{"type":"string","description":"Format of the proof files (for example `image`, `pdf`, `base64`).","example":"image","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.format.oneOf.0","typeLabel":"string"},{"type":"null","description":"Format of the proof files (for example `image`, `pdf`, `base64`).","example":"image","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.format.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.format","typeLabel":"string | null"},"files":{"oneOf":[{"type":"array","description":"Files attached to the proof, or null when there are none.","items":{"type":"object","properties":{"path":{"type":"string","description":"Relative download path.","example":"/rails/active_storage/blobs/redirect/example/pod.jpg","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.files.oneOf.0.items.[INDEX].path","typeLabel":"string"},"filename":{"type":"string","description":"File name.","example":"pod.jpg","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.files.oneOf.0.items.[INDEX].filename","typeLabel":"string"},"byte_size":{"type":"integer","description":"Size in bytes.","example":120340,"uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.files.oneOf.0.items.[INDEX].byte_size","typeLabel":"integer"},"content_type":{"type":"string","description":"MIME type.","example":"image/jpeg","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.files.oneOf.0.items.[INDEX].content_type","typeLabel":"string"},"thumbnail_path":{"oneOf":[{"type":"string","description":"Relative path of a 300x300 thumbnail; only for images.","example":"/rails/active_storage/representations/example/pod.jpg","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.files.oneOf.0.items.[INDEX].thumbnail_path.oneOf.0","typeLabel":"string"},{"type":"null","description":"Relative path of a 300x300 thumbnail; only for images.","example":"/rails/active_storage/representations/example/pod.jpg","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.files.oneOf.0.items.[INDEX].thumbnail_path.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.files.oneOf.0.items.[INDEX].thumbnail_path","typeLabel":"string | null"}},"uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.files.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.files.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Files attached to the proof, or null when there are none.","items":{"type":"object","properties":{"path":{"type":"string","description":"Relative download path.","example":"/rails/active_storage/blobs/redirect/example/pod.jpg"},"filename":{"type":"string","description":"File name.","example":"pod.jpg"},"byte_size":{"type":"integer","description":"Size in bytes.","example":120340},"content_type":{"type":"string","description":"MIME type.","example":"image/jpeg"},"thumbnail_path":{"oneOf":[{"type":"string","description":"Relative path of a 300x300 thumbnail; only for images.","example":"/rails/active_storage/representations/example/pod.jpg"},{"type":"null","description":"Relative path of a 300x300 thumbnail; only for images.","example":"/rails/active_storage/representations/example/pod.jpg"}]}}},"uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.files.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0.files","typeLabel":"object[] | null"}},"uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.0","typeLabel":"object"},{"type":"null","description":"Proof of delivery, when the carrier provided one for a shipped or returned order.","uniqueKey":"orders.items.[INDEX].proof_of_delivery.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].proof_of_delivery","typeLabel":"object | null"},"estimated_time_arrival":{"oneOf":[{"type":"string","format":"date-time","description":"Estimated delivery date.","example":"2026-01-13T00:00:00.000Z","uniqueKey":"orders.items.[INDEX].estimated_time_arrival.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Estimated delivery date.","example":"2026-01-13T00:00:00.000Z","uniqueKey":"orders.items.[INDEX].estimated_time_arrival.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].estimated_time_arrival","typeLabel":"string\u003cdate-time> | null"},"latest_estimated_time_arrival_range":{"oneOf":[{"type":"object","description":"Latest estimated delivery window, or null when no estimate exists.","properties":{"range_begin":{"type":"string","format":"date-time","description":"Start of the estimated delivery window.","example":"2026-01-13T06:00:00.000Z","uniqueKey":"orders.items.[INDEX].latest_estimated_time_arrival_range.oneOf.0.range_begin","typeLabel":"string\u003cdate-time>"},"range_end":{"type":"string","format":"date-time","description":"End of the estimated delivery window.","example":"2026-01-14T05:59:59.000Z","uniqueKey":"orders.items.[INDEX].latest_estimated_time_arrival_range.oneOf.0.range_end","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"orders.items.[INDEX].latest_estimated_time_arrival_range.oneOf.0","typeLabel":"object"},{"type":"null","description":"Latest estimated delivery window, or null when no estimate exists.","uniqueKey":"orders.items.[INDEX].latest_estimated_time_arrival_range.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].latest_estimated_time_arrival_range","typeLabel":"object | null"},"delivered_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the carrier delivered the order.","example":null,"uniqueKey":"orders.items.[INDEX].delivered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the carrier delivered the order.","example":null,"uniqueKey":"orders.items.[INDEX].delivered_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].delivered_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"type":"string","format":"date-time","description":"Last update of the order.","example":"2026-01-11T18:31:00.000Z","uniqueKey":"orders.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"channel_order_id":{"oneOf":[{"type":"string","description":"ID of the order in the sales channel.","example":"5566778899","uniqueKey":"orders.items.[INDEX].channel_order_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the order in the sales channel.","example":"5566778899","uniqueKey":"orders.items.[INDEX].channel_order_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].channel_order_id","typeLabel":"string | null"},"channel_name":{"oneOf":[{"type":"string","description":"Name of the sales channel the order came from.","example":"shopify","uniqueKey":"orders.items.[INDEX].channel_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the sales channel the order came from.","example":"shopify","uniqueKey":"orders.items.[INDEX].channel_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].channel_name","typeLabel":"string | null"},"channel_shipping_line_code":{"oneOf":[{"type":"string","description":"Code of the shipping option chosen at checkout in the sales channel (first shipping line).","example":"standard","uniqueKey":"orders.items.[INDEX].channel_shipping_line_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code of the shipping option chosen at checkout in the sales channel (first shipping line).","example":"standard","uniqueKey":"orders.items.[INDEX].channel_shipping_line_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].channel_shipping_line_code","typeLabel":"string | null"},"warehouse_timezone":{"oneOf":[{"type":"string","description":"IANA time zone of the warehouse fulfilling the order.","example":"America/Mexico_City","uniqueKey":"orders.items.[INDEX].warehouse_timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"IANA time zone of the warehouse fulfilling the order.","example":"America/Mexico_City","uniqueKey":"orders.items.[INDEX].warehouse_timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].warehouse_timezone","typeLabel":"string | null"},"shipping_method":{"oneOf":[{"type":"object","description":"Shipping method assigned to the order.","properties":{"id":{"type":"integer","description":"Shipping method ID.","example":42,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.id","typeLabel":"integer"},"shipping_name":{"type":"string","description":"Name of the shipping service.","example":"DHL Express","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.shipping_name","typeLabel":"string"},"carrier_name":{"type":"string","description":"Carrier name as presented to your customers.","example":"DHL","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.carrier_name","typeLabel":"string"},"capitalized_carrier":{"oneOf":[{"type":"string","description":"Carrier name with the first letter capitalized.","example":"Dhl","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.capitalized_carrier.oneOf.0","typeLabel":"string"},{"type":"null","description":"Carrier name with the first letter capitalized.","example":"Dhl","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.capitalized_carrier.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.capitalized_carrier","typeLabel":"string | null"},"is_active":{"type":"boolean","description":"Whether the method is currently available.","example":true,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.is_active","typeLabel":"boolean"},"shipping_type":{"oneOf":[{"type":"string","description":"Coverage of the method.","enum":["national","international","pickup",null],"example":"national","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.shipping_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Coverage of the method.","enum":["national","international","pickup",null],"example":"national","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.shipping_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.shipping_type","typeLabel":"enum\u003cstring> | null"},"delivery_type":{"oneOf":[{"type":"string","description":"Service level.","enum":["SameDay","NextDay","Ground","Pickup","International",null],"example":"Ground","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.delivery_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Service level.","enum":["SameDay","NextDay","Ground","Pickup","International",null],"example":"Ground","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.delivery_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.delivery_type","typeLabel":"enum\u003cstring> | null"},"country":{"type":"string","description":"Two-letter country code the method operates in.","example":"MX","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.country","typeLabel":"string"},"is_cod":{"type":"boolean","description":"Whether the method supports cash on delivery.","example":false,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.is_cod","typeLabel":"boolean"},"extended_zone":{"type":"boolean","description":"Whether the carrier delivers to extended zones.","example":true,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.extended_zone","typeLabel":"boolean"},"po_box_dropoff":{"type":"boolean","description":"Whether the carrier delivers to PO boxes.","example":true,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.po_box_dropoff","typeLabel":"boolean"},"provides_pod":{"type":"boolean","description":"Whether the carrier provides proof of delivery.","example":false,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.provides_pod","typeLabel":"boolean"},"contract_provider":{"oneOf":[{"type":"string","description":"Carrier contract used.","example":null,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.contract_provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Carrier contract used.","example":null,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.contract_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.contract_provider","typeLabel":"string | null"},"enable_multipackage":{"type":"boolean","description":"Whether multi-package shipments are enabled.","example":false,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.enable_multipackage","typeLabel":"boolean"},"non_working_days":{"type":"array","items":{"type":"integer","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.non_working_days.items.[INDEX]","typeLabel":"integer"},"description":"Weekdays the carrier does not operate (0 = Sunday).","example":[0,6],"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.non_working_days","typeLabel":"integer[]"},"dispatch_carrier_alias":{"oneOf":[{"type":"string","description":"Alias used at dispatch.","example":null,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.dispatch_carrier_alias.oneOf.0","typeLabel":"string"},{"type":"null","description":"Alias used at dispatch.","example":null,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.dispatch_carrier_alias.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.dispatch_carrier_alias","typeLabel":"string | null"},"handles_fragile":{"type":"boolean","description":"Whether the carrier handles fragile goods.","example":false,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.handles_fragile","typeLabel":"boolean"},"multipackage_label_mode":{"type":"string","description":"How multi-package labels are produced.","enum":["per_package","bulk"],"example":"bulk","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.multipackage_label_mode","typeLabel":"enum\u003cstring>"},"generates_label_per_package":{"type":"boolean","description":"Whether one label is generated per package.","example":false,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.generates_label_per_package","typeLabel":"boolean"},"carrier_supports_per_box_label":{"type":"boolean","description":"Whether the carrier mints one label per box at packing. Not in use yet.","example":false,"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0.carrier_supports_per_box_label","typeLabel":"boolean"}},"uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.0","typeLabel":"object"},{"type":"null","description":"Shipping method assigned to the order.","uniqueKey":"orders.items.[INDEX].shipping_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].shipping_method","typeLabel":"object | null"},"order_lines":{"type":"array","description":"Lines of the order.","items":{"type":"object","description":"A line of an order (one SKU and its quantity).","properties":{"id":{"type":"integer","description":"Order line ID.","example":5551,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].id","typeLabel":"integer"},"name":{"oneOf":[{"type":"string","description":"Product name at the time of the order.","example":"Red T-shirt M","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Product name at the time of the order.","example":"Red T-shirt M","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].name","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","description":"SKU ordered.","example":"SKU-RED-M","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"SKU ordered.","example":"SKU-RED-M","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].sku","typeLabel":"string | null"},"quantity":{"type":"integer","description":"Units ordered.","example":2,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].quantity","typeLabel":"integer"},"generated":{"type":"boolean","description":"True when Cubbo generated the line automatically (for example a kit component or a promotional insert).","example":false,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].generated","typeLabel":"boolean"},"price_per_item":{"oneOf":[{"type":"string","description":"Unit price as a decimal string.","example":"449.5","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].price_per_item.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unit price as a decimal string.","example":"449.5","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].price_per_item.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].price_per_item","typeLabel":"string | null"},"discount_per_item":{"oneOf":[{"type":"string","description":"Unit discount as a decimal string.","example":"0.0","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].discount_per_item.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unit discount as a decimal string.","example":"0.0","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].discount_per_item.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].discount_per_item","typeLabel":"string | null"},"product":{"oneOf":[{"type":"object","description":"The product behind the line, when included by the endpoint. `null` while the line's SKU does not exist in the store (an order created with an unknown SKU; see `POST /orders`).","properties":{"id":{"type":"integer","description":"Product ID.","example":777,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","description":"Product name.","example":"Red T-shirt M","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.name","typeLabel":"string"},"billing_name":{"oneOf":[{"type":"string","description":"Name used on invoices.","example":"T-shirt","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.billing_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name used on invoices.","example":"T-shirt","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.billing_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.billing_name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Product description (HTML).","example":null,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Product description (HTML).","example":null,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.description","typeLabel":"string | null"},"has_imei":{"type":"boolean","description":"Whether units of this product carry an IMEI.","example":false,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.has_imei","typeLabel":"boolean"},"is_fragile":{"type":"boolean","description":"Whether the product needs fragile handling.","example":false,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.is_fragile","typeLabel":"boolean"},"is_kit":{"type":"boolean","description":"Whether the product is a kit of other products.","example":false,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.is_kit","typeLabel":"boolean"},"bar_code":{"oneOf":[{"type":"string","description":"Barcode (UPC/EAN).","example":"7500000000001","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.bar_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Barcode (UPC/EAN).","example":"7500000000001","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.bar_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.bar_code","typeLabel":"string | null"},"is_dropshipping":{"type":"boolean","description":"Whether the product is fulfilled by a third party.","example":false,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.is_dropshipping","typeLabel":"boolean"},"is_scannable":{"type":"boolean","description":"Whether units are scanned during picking.","example":true,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.is_scannable","typeLabel":"boolean"},"price":{"oneOf":[{"type":"string","description":"Product price as a decimal string.","example":"449.5","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.price.oneOf.0","typeLabel":"string"},{"type":"null","description":"Product price as a decimal string.","example":"449.5","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.price.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.price","typeLabel":"string | null"},"weight":{"oneOf":[{"type":"number","description":"Product weight.","example":0.3,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.weight.oneOf.0","typeLabel":"number"},{"type":"null","description":"Product weight.","example":0.3,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.weight","typeLabel":"number | null"},"product_codes":{"type":"array","description":"SKUs registered for the product.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Product code ID.","example":9001,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.product_codes.items.[INDEX].id","typeLabel":"integer"},"sku":{"type":"string","description":"SKU.","example":"SKU-RED-M","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.product_codes.items.[INDEX].sku","typeLabel":"string"}},"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.product_codes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0.product_codes","typeLabel":"object[]"}},"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.0","typeLabel":"object"},{"type":"null","description":"The product behind the line, when included by the endpoint. `null` while the line's SKU does not exist in the store (an order created with an unknown SKU; see `POST /orders`).","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].product","typeLabel":"object | null"},"stock_units":{"type":"array","description":"Physical units assigned to the line, when included by the endpoint.","items":{"type":"object","description":"A physical unit assigned to an order line. In `GET /orders` only `id`, `imei` (when the product tracks IMEI) and `unit_code` (when requested by order number, for unit-code products in `packing`/`shipped`) are returned.","properties":{"id":{"type":"integer","description":"Stock unit ID.","example":31001,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].id","typeLabel":"integer"},"status":{"type":"string","description":"Stock unit status.","example":"PICKED","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].status","typeLabel":"string"},"product_id":{"type":"integer","description":"Product ID of the unit.","example":777,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].product_id","typeLabel":"integer"},"picked_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the unit was picked.","example":"2026-01-11T15:00:00.000Z","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].picked_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the unit was picked.","example":"2026-01-11T15:00:00.000Z","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].picked_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].picked_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","description":"Creation time.","example":"2025-12-01T10:00:00.000Z","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Last update time.","example":"2026-01-11T15:00:00.000Z","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"imei":{"type":"object","description":"IMEI of the unit, only for products that track IMEI.","properties":{"id":{"type":"integer","description":"IMEI record ID.","example":12,"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].imei.id","typeLabel":"integer"},"imei":{"type":"string","description":"The IMEI number.","example":"000000000000000","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].imei.imei","typeLabel":"string"}},"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].imei","typeLabel":"object"},"unit_code":{"type":"string","description":"Serial / unit code of the unit, only for products that require unit codes and only when the request filters by `order_number`.","example":"UC-0001","uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX].unit_code","typeLabel":"string"}},"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX].stock_units","typeLabel":"object[]"}},"uniqueKey":"orders.items.[INDEX].order_lines.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orders.items.[INDEX].order_lines","typeLabel":"object[]"},"invoices":{"type":"array","description":"NF-e documents attached to the order (Brazil).","items":{"type":"object","description":"An NF-e (Brazilian electronic invoice) attached to an order. Fiscal events (cancellations, corrections) are not listed; only the documents themselves.","properties":{"id":{"type":"integer","description":"Invoice ID.","example":7801,"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].id","typeLabel":"integer"},"invoice_type":{"oneOf":[{"type":"string","description":"Where the invoice was issued. `WEBMANIA` and `BLING` are issued through Cubbo's fiscal integration; `IOTA` and `EXTERNAL` were issued by the client's own system; `WEBMANIA_CTE` / `WEBMANIA_NFSE` are transport and service documents.","enum":["WEBMANIA","SELIA_BR","WEBMANIA_CTE","WEBMANIA_NFSE","NATURA","BLING","IOTA","EXTERNAL",null],"example":"WEBMANIA","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].invoice_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Where the invoice was issued. `WEBMANIA` and `BLING` are issued through Cubbo's fiscal integration; `IOTA` and `EXTERNAL` were issued by the client's own system; `WEBMANIA_CTE` / `WEBMANIA_NFSE` are transport and service documents.","enum":["WEBMANIA","SELIA_BR","WEBMANIA_CTE","WEBMANIA_NFSE","NATURA","BLING","IOTA","EXTERNAL",null],"example":"WEBMANIA","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].invoice_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].invoice_type","typeLabel":"enum\u003cstring> | null"},"status":{"oneOf":[{"type":"string","description":"Fiscal status. `PREAPPROVED` means registered and awaiting confirmation from the fiscal provider.","enum":["APPROVED","REJECTED","CANCELLED","DENIED","PROCESSING","CONTINGENCY","PREAPPROVED",null],"example":"APPROVED","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Fiscal status. `PREAPPROVED` means registered and awaiting confirmation from the fiscal provider.","enum":["APPROVED","REJECTED","CANCELLED","DENIED","PROCESSING","CONTINGENCY","PREAPPROVED",null],"example":"APPROVED","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].status","typeLabel":"enum\u003cstring> | null"},"invoiceable_id":{"type":"integer","description":"ID of the order the invoice belongs to.","example":987654,"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].invoiceable_id","typeLabel":"integer"},"invoiceable_type":{"type":"string","description":"Type of the document the invoice belongs to; `Order` here.","example":"Order","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].invoiceable_type","typeLabel":"string"},"operation_nature":{"oneOf":[{"type":"string","description":"Nature of the operation (natureza da operacao).","example":"Venda de mercadoria","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].operation_nature.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nature of the operation (natureza da operacao).","example":"Venda de mercadoria","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].operation_nature.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].operation_nature","typeLabel":"string | null"},"operation_type":{"oneOf":[{"type":"string","description":"Direction of the operation, as sent when the invoice was attached: `SAIDA`/`ENTRADA` or `OUTGOING`/`INCOMING`.","example":"OUTGOING","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].operation_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Direction of the operation, as sent when the invoice was attached: `SAIDA`/`ENTRADA` or `OUTGOING`/`INCOMING`.","example":"OUTGOING","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].operation_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].operation_type","typeLabel":"string | null"},"key":{"oneOf":[{"type":"string","description":"The 44-digit NF-e access key.","example":"00000000000000000000000000000000000000000000","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The 44-digit NF-e access key.","example":"00000000000000000000000000000000000000000000","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].key.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].key","typeLabel":"string | null"},"xml_file":{"oneOf":[{"type":"object","description":"The authorized NF-e XML, or null if not yet available.","properties":{"path":{"type":"string","description":"Relative download path.","example":"/rails/active_storage/blobs/redirect/example/nfe.xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].xml_file.oneOf.0.path","typeLabel":"string"},"filename":{"type":"string","description":"File name.","example":"nfe.xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].xml_file.oneOf.0.filename","typeLabel":"string"},"byte_size":{"type":"integer","description":"Size in bytes.","example":10240,"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].xml_file.oneOf.0.byte_size","typeLabel":"integer"},"content_type":{"type":"string","description":"MIME type.","example":"application/xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].xml_file.oneOf.0.content_type","typeLabel":"string"},"url":{"type":"string","description":"Absolute download URL.","example":"https://api.cubbo.com/rails/active_storage/blobs/redirect/example/nfe.xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].xml_file.oneOf.0.url","typeLabel":"string"}},"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].xml_file.oneOf.0","typeLabel":"object"},{"type":"null","description":"The authorized NF-e XML, or null if not yet available.","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].xml_file.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].xml_file","typeLabel":"object | null"},"pdf_file":{"oneOf":[{"type":"object","description":"The DANFE (printable invoice) PDF, or null if not yet available.","properties":{"path":{"type":"string","description":"Relative download path.","example":"/rails/active_storage/blobs/redirect/example/nfe.xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].pdf_file.oneOf.0.path","typeLabel":"string"},"filename":{"type":"string","description":"File name.","example":"nfe.xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].pdf_file.oneOf.0.filename","typeLabel":"string"},"byte_size":{"type":"integer","description":"Size in bytes.","example":10240,"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].pdf_file.oneOf.0.byte_size","typeLabel":"integer"},"content_type":{"type":"string","description":"MIME type.","example":"application/xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].pdf_file.oneOf.0.content_type","typeLabel":"string"},"url":{"type":"string","description":"Absolute download URL.","example":"https://api.cubbo.com/rails/active_storage/blobs/redirect/example/nfe.xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].pdf_file.oneOf.0.url","typeLabel":"string"}},"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].pdf_file.oneOf.0","typeLabel":"object"},{"type":"null","description":"The DANFE (printable invoice) PDF, or null if not yet available.","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].pdf_file.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].pdf_file","typeLabel":"object | null"},"label_pdf_file":{"oneOf":[{"type":"object","description":"The DANFE in label format (DANFE etiqueta) PDF, or null if not available.","properties":{"path":{"type":"string","description":"Relative download path.","example":"/rails/active_storage/blobs/redirect/example/nfe.xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].label_pdf_file.oneOf.0.path","typeLabel":"string"},"filename":{"type":"string","description":"File name.","example":"nfe.xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].label_pdf_file.oneOf.0.filename","typeLabel":"string"},"byte_size":{"type":"integer","description":"Size in bytes.","example":10240,"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].label_pdf_file.oneOf.0.byte_size","typeLabel":"integer"},"content_type":{"type":"string","description":"MIME type.","example":"application/xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].label_pdf_file.oneOf.0.content_type","typeLabel":"string"},"url":{"type":"string","description":"Absolute download URL.","example":"https://api.cubbo.com/rails/active_storage/blobs/redirect/example/nfe.xml","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].label_pdf_file.oneOf.0.url","typeLabel":"string"}},"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].label_pdf_file.oneOf.0","typeLabel":"object"},{"type":"null","description":"The DANFE in label format (DANFE etiqueta) PDF, or null if not available.","uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].label_pdf_file.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX].label_pdf_file","typeLabel":"object | null"}},"uniqueKey":"orders.items.[INDEX].invoices.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orders.items.[INDEX].invoices","typeLabel":"object[]"},"store":{"oneOf":[{"type":"object","description":"Store the order belongs to.","properties":{"id":{"type":"integer","description":"Store ID.","example":1234,"uniqueKey":"orders.items.[INDEX].store.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","description":"Store name.","example":"Example Store","uniqueKey":"orders.items.[INDEX].store.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"orders.items.[INDEX].store.oneOf.0","typeLabel":"object"},{"type":"null","description":"Store the order belongs to.","uniqueKey":"orders.items.[INDEX].store.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].store","typeLabel":"object | null"},"channel_integration":{"oneOf":[{"type":"object","description":"Sales-channel integration the order came from.","properties":{"id":{"type":"integer","description":"Integration ID.","example":55,"uniqueKey":"orders.items.[INDEX].channel_integration.oneOf.0.id","typeLabel":"integer"},"channel_type_name":{"type":"string","description":"Sales channel type (for example `shopify`, `vtex`, `woocommerce`, `meli`, `openapi`).","example":"shopify","uniqueKey":"orders.items.[INDEX].channel_integration.oneOf.0.channel_type_name","typeLabel":"string"}},"uniqueKey":"orders.items.[INDEX].channel_integration.oneOf.0","typeLabel":"object"},{"type":"null","description":"Sales-channel integration the order came from.","uniqueKey":"orders.items.[INDEX].channel_integration.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].channel_integration","typeLabel":"object | null"},"return":{"oneOf":[{"type":"object","description":"The return opened for this order, if any. Use `GET /returns/{return_id}` for the full return.","properties":{"id":{"type":"integer","description":"Return ID.","example":501,"uniqueKey":"orders.items.[INDEX].return.oneOf.0.id","typeLabel":"integer"},"status":{"type":"string","description":"Return status.","example":"pending","uniqueKey":"orders.items.[INDEX].return.oneOf.0.status","typeLabel":"string"},"return_type":{"type":"string","description":"Kind of return (for example a simple return or an exchange).","example":"SIMPLE_RETURN","uniqueKey":"orders.items.[INDEX].return.oneOf.0.return_type","typeLabel":"string"},"notes":{"oneOf":[{"type":"string","description":"Notes attached to the return.","example":null,"uniqueKey":"orders.items.[INDEX].return.oneOf.0.notes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Notes attached to the return.","example":null,"uniqueKey":"orders.items.[INDEX].return.oneOf.0.notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].return.oneOf.0.notes","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","description":"When the return was created.","example":"2026-01-20T10:00:00.000Z","uniqueKey":"orders.items.[INDEX].return.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"expected_products":{"oneOf":[{"type":"array","description":"Products expected back, as product ID and quantity.","items":{"type":"object","properties":{"product_id":{"type":"integer","description":"Product ID.","example":777,"uniqueKey":"orders.items.[INDEX].return.oneOf.0.expected_products.oneOf.0.items.[INDEX].product_id","typeLabel":"integer"},"quantity":{"type":"integer","description":"Units expected.","example":1,"uniqueKey":"orders.items.[INDEX].return.oneOf.0.expected_products.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"orders.items.[INDEX].return.oneOf.0.expected_products.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orders.items.[INDEX].return.oneOf.0.expected_products.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Products expected back, as product ID and quantity.","items":{"type":"object","properties":{"product_id":{"type":"integer","description":"Product ID.","example":777},"quantity":{"type":"integer","description":"Units expected.","example":1}}},"uniqueKey":"orders.items.[INDEX].return.oneOf.0.expected_products.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].return.oneOf.0.expected_products","typeLabel":"object[] | null"}},"additionalProperties":true,"uniqueKey":"orders.items.[INDEX].return.oneOf.0","typeLabel":"object"},{"type":"null","description":"The return opened for this order, if any. Use `GET /returns/{return_id}` for the full return.","uniqueKey":"orders.items.[INDEX].return.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].return","typeLabel":"object | null"},"created_by_return":{"oneOf":[{"type":"object","description":"The return that created this order (for exchanges), if any.","properties":{"id":{"type":"integer","description":"Return ID.","example":501,"uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.id","typeLabel":"integer"},"status":{"type":"string","description":"Return status.","example":"pending","uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.status","typeLabel":"string"},"return_type":{"type":"string","description":"Kind of return (for example a simple return or an exchange).","example":"SIMPLE_RETURN","uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.return_type","typeLabel":"string"},"notes":{"oneOf":[{"type":"string","description":"Notes attached to the return.","example":null,"uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.notes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Notes attached to the return.","example":null,"uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.notes","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","description":"When the return was created.","example":"2026-01-20T10:00:00.000Z","uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"expected_products":{"oneOf":[{"type":"array","description":"Products expected back, as product ID and quantity.","items":{"type":"object","properties":{"product_id":{"type":"integer","description":"Product ID.","example":777,"uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.expected_products.oneOf.0.items.[INDEX].product_id","typeLabel":"integer"},"quantity":{"type":"integer","description":"Units expected.","example":1,"uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.expected_products.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.expected_products.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.expected_products.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Products expected back, as product ID and quantity.","items":{"type":"object","properties":{"product_id":{"type":"integer","description":"Product ID.","example":777},"quantity":{"type":"integer","description":"Units expected.","example":1}}},"uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.expected_products.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0.expected_products","typeLabel":"object[] | null"}},"additionalProperties":true,"uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.0","typeLabel":"object"},{"type":"null","description":"The return that created this order (for exchanges), if any.","uniqueKey":"orders.items.[INDEX].created_by_return.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].created_by_return","typeLabel":"object | null"},"order_histories":{"type":"array","description":"Order timeline. Only returned by `GET /orders` with `include_event_history=true`.","items":{"type":"object","description":"An event in the order timeline (status change, tracking update, incident). `GET /orders` with `include_event_history=true` returns only `new_status`, `incident_description`, `timestamp` and `origin`.","properties":{"id":{"type":"integer","description":"Event ID.","example":120001,"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].id","typeLabel":"integer"},"order_id":{"type":"integer","description":"Order ID.","example":987654,"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].order_id","typeLabel":"integer"},"created_by_id":{"oneOf":[{"type":"integer","description":"ID of the user who triggered the event, if any.","example":null,"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].created_by_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"ID of the user who triggered the event, if any.","example":null,"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].created_by_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].created_by_id","typeLabel":"integer | null"},"previous_status":{"oneOf":[{"type":"string","description":"Status before the event.","example":"packing","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].previous_status.oneOf.0","typeLabel":"string"},{"type":"null","description":"Status before the event.","example":"packing","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].previous_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].previous_status","typeLabel":"string | null"},"new_status":{"oneOf":[{"type":"string","description":"Status after the event (an order status or a shipping status).","example":"shipped","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].new_status.oneOf.0","typeLabel":"string"},{"type":"null","description":"Status after the event (an order status or a shipping status).","example":"shipped","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].new_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].new_status","typeLabel":"string | null"},"action":{"oneOf":[{"type":"string","description":"Kind of event (for example `order_status_update`, `tracking_update`, `cancel`).","example":"order_status_update","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].action.oneOf.0","typeLabel":"string"},{"type":"null","description":"Kind of event (for example `order_status_update`, `tracking_update`, `cancel`).","example":"order_status_update","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].action.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].action","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","description":"Additional event data.","example":{},"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional event data.","example":{},"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].metadata","typeLabel":"object | null"},"origin":{"oneOf":[{"type":"string","description":"Who or what produced the event.","enum":["cubbo","integration_webhook","shipping_webhook","tracking_watcher","cubbo_user","cubbo_user_import","cubbo_user_api","cubbo_business_rule","awaiting_client_invoice","homolog_invoice_precheck","cubbo_automation","tracking_app","system_auto_coverage_retry","zapier","integration_api",null],"example":"shipping_webhook","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].origin.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Who or what produced the event.","enum":["cubbo","integration_webhook","shipping_webhook","tracking_watcher","cubbo_user","cubbo_user_import","cubbo_user_api","cubbo_business_rule","awaiting_client_invoice","homolog_invoice_precheck","cubbo_automation","tracking_app","system_auto_coverage_retry","zapier","integration_api",null],"example":"shipping_webhook","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].origin.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].origin","typeLabel":"enum\u003cstring> | null"},"reference_timestamp":{"oneOf":[{"type":"string","format":"date-time","description":"When the event actually happened (for tracking events, the carrier's timestamp).","example":"2026-01-11T18:30:00.000Z","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].reference_timestamp.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the event actually happened (for tracking events, the carrier's timestamp).","example":"2026-01-11T18:30:00.000Z","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].reference_timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].reference_timestamp","typeLabel":"string\u003cdate-time> | null"},"timestamp":{"oneOf":[{"type":"string","format":"date-time","description":"Same as `reference_timestamp`.","example":"2026-01-11T18:30:00.000Z","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].timestamp.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Same as `reference_timestamp`.","example":"2026-01-11T18:30:00.000Z","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time> | null"},"incident_description":{"oneOf":[{"type":"string","description":"Carrier description of the incident; only when `new_status` is `shipment_with_incident`.","example":null,"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].incident_description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Carrier description of the incident; only when `new_status` is `shipment_with_incident`.","example":null,"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].incident_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].incident_description","typeLabel":"string | null"},"difal_error_description":{"oneOf":[{"type":"string","description":"Error message(s) from the DIFAL guide issuer; only for DIFAL error events (Brazil).","example":null,"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].difal_error_description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Error message(s) from the DIFAL guide issuer; only for DIFAL error events (Brazil).","example":null,"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].difal_error_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].difal_error_description","typeLabel":"string | null"},"created_by_cubbo_user":{"type":"boolean","description":"True when the event was triggered by Cubbo staff rather than a user of your account.","example":false,"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].created_by_cubbo_user","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","description":"When the event was recorded.","example":"2026-01-11T18:31:00.000Z","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Last update of the event record.","example":"2026-01-11T18:31:00.000Z","uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"orders.items.[INDEX].order_histories.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orders.items.[INDEX].order_histories","typeLabel":"object[]"}},"uniqueKey":"orders.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"orders","typeLabel":"object[]"},"meta":{"type":"object","description":"Paging information returned next to list results.","properties":{"current_page":{"type":"integer","example":1,"uniqueKey":"meta.current_page","typeLabel":"integer"},"next_page":{"oneOf":[{"type":"integer","example":2,"uniqueKey":"meta.next_page.oneOf.0","typeLabel":"integer"},{"type":"null","example":2,"uniqueKey":"meta.next_page.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.next_page","typeLabel":"integer | null"},"prev_page":{"oneOf":[{"type":"integer","example":null,"uniqueKey":"meta.prev_page.oneOf.0","typeLabel":"integer"},{"type":"null","example":null,"uniqueKey":"meta.prev_page.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.prev_page","typeLabel":"integer | null"},"total_pages":{"type":"integer","example":7,"uniqueKey":"meta.total_pages","typeLabel":"integer"},"first_page":{"type":"boolean","example":true,"uniqueKey":"meta.first_page","typeLabel":"boolean"},"last_page":{"type":"boolean","example":false,"uniqueKey":"meta.last_page","typeLabel":"boolean"},"per_page":{"type":"integer","example":50,"uniqueKey":"meta.per_page","typeLabel":"integer"},"total_count":{"type":"integer","example":312,"uniqueKey":"meta.total_count","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"orders":[{"id":987654,"store_id":1234,"order_number":"ORD-0001","status":"shipped","channel_created_at":"2026-01-10T14:02:11.000Z","order_date":"2026-01-10T14:02:11.000Z","shipping_date":"2026-01-11T18:30:00.000Z","pending_at":"2026-01-10T14:05:00.000Z","shipping_email":"buyer@example.com","shipping_status":"shipment_in_transit","is_paid":true,"channel_order_id":"5566778899","channel_name":"shopify","is_cod":false,"cod_amount":null,"has_carrier_insurance":false,"requires_document_return":false,"requires_pickup_on_delivery":false,"currency":"MXN","total_price":"899.00","shipping":{"first_name":"Ana","last_name":"Example","company":null,"phone":"+525500000000","address_1":"Av. Ejemplo 123","address_2":null,"email":"buyer@example.com","zip_code":"01000","country":"MX","state":"CDMX","city":"Ciudad de Mexico","number":"123","interior_number":null,"neighborhood":"Centro","references":"Blue door","city_code":null},"billing":{"first_name":"Ana","last_name":"Example","company":null,"phone":"+525500000000","tax_id":null,"tax_regime":null,"state_registration":null,"address_1":"Av. Ejemplo 123","address_2":null,"number":"123","interior_number":null,"neighborhood":"Centro","email":"buyer@example.com","zip_code":"01000","country":"MX","state":"CDMX","city":"Ciudad de Mexico"},"delivery_tracking":[{"shipping_number":"TRK000000001","tracking_url":"https://carrier.example.com/track/TRK000000001","cubbo_tracking_url":"https://tracking.example.com/orders/abc123","service_id":"express","shipping_status":"shipment_in_transit","package_index":1,"total_packages":1}],"return_shipping_labels":[],"estimated_time_arrival":"2026-01-13T00:00:00.000Z","delivered_at":null,"updated_at":"2026-01-11T18:31:00.000Z","is_click_and_collect":false,"click_and_collect_metadata":null,"latest_estimated_time_arrival_range":{"range_begin":"2026-01-13T06:00:00.000Z","range_end":"2026-01-14T05:59:59.000Z"},"channel_shipping_line_code":"standard","warehouse_timezone":"America/Mexico_City","is_first_time_buyer":true,"is_subscription_renewal":false,"is_multi_package":false,"shipping_method":{"id":42,"carrier_name":"DHL","shipping_name":"DHL Express","is_cod":false},"order_lines":[{"id":5551,"name":"Red T-shirt M","sku":"SKU-RED-M","quantity":2,"generated":false,"price_per_item":"449.5","product":{"id":777,"name":"Red T-shirt M","billing_name":"T-shirt","description":null,"has_imei":false,"is_fragile":false,"is_kit":false,"bar_code":"7500000000001","is_dropshipping":false,"is_scannable":true,"price":"449.5","weight":0.3,"product_codes":[{"id":9001,"sku":"SKU-RED-M"}]},"stock_units":[{"id":31001},{"id":31002}]}],"invoices":[],"store":{"id":1234,"name":"Example Store"},"channel_integration":{"id":55,"channel_type_name":"shopify"},"return":null,"created_by_return":null}],"meta":{"current_page":1,"next_page":2,"prev_page":null,"total_pages":7,"first_page":true,"last_page":false,"per_page":10,"total_count":63}},"examples":{"Example":{"title":"Example","value":{"orders":[{"id":987654,"store_id":1234,"order_number":"ORD-0001","status":"shipped","channel_created_at":"2026-01-10T14:02:11.000Z","order_date":"2026-01-10T14:02:11.000Z","shipping_date":"2026-01-11T18:30:00.000Z","pending_at":"2026-01-10T14:05:00.000Z","shipping_email":"buyer@example.com","shipping_status":"shipment_in_transit","is_paid":true,"channel_order_id":"5566778899","channel_name":"shopify","is_cod":false,"cod_amount":null,"has_carrier_insurance":false,"requires_document_return":false,"requires_pickup_on_delivery":false,"currency":"MXN","total_price":"899.00","shipping":{"first_name":"Ana","last_name":"Example","company":null,"phone":"+525500000000","address_1":"Av. Ejemplo 123","address_2":null,"email":"buyer@example.com","zip_code":"01000","country":"MX","state":"CDMX","city":"Ciudad de Mexico","number":"123","interior_number":null,"neighborhood":"Centro","references":"Blue door","city_code":null},"billing":{"first_name":"Ana","last_name":"Example","company":null,"phone":"+525500000000","tax_id":null,"tax_regime":null,"state_registration":null,"address_1":"Av. Ejemplo 123","address_2":null,"number":"123","interior_number":null,"neighborhood":"Centro","email":"buyer@example.com","zip_code":"01000","country":"MX","state":"CDMX","city":"Ciudad de Mexico"},"delivery_tracking":[{"shipping_number":"TRK000000001","tracking_url":"https://carrier.example.com/track/TRK000000001","cubbo_tracking_url":"https://tracking.example.com/orders/abc123","service_id":"express","shipping_status":"shipment_in_transit","package_index":1,"total_packages":1}],"return_shipping_labels":[],"estimated_time_arrival":"2026-01-13T00:00:00.000Z","delivered_at":null,"updated_at":"2026-01-11T18:31:00.000Z","is_click_and_collect":false,"click_and_collect_metadata":null,"latest_estimated_time_arrival_range":{"range_begin":"2026-01-13T06:00:00.000Z","range_end":"2026-01-14T05:59:59.000Z"},"channel_shipping_line_code":"standard","warehouse_timezone":"America/Mexico_City","is_first_time_buyer":true,"is_subscription_renewal":false,"is_multi_package":false,"shipping_method":{"id":42,"carrier_name":"DHL","shipping_name":"DHL Express","is_cod":false},"order_lines":[{"id":5551,"name":"Red T-shirt M","sku":"SKU-RED-M","quantity":2,"generated":false,"price_per_item":"449.5","product":{"id":777,"name":"Red T-shirt M","billing_name":"T-shirt","description":null,"has_imei":false,"is_fragile":false,"is_kit":false,"bar_code":"7500000000001","is_dropshipping":false,"is_scannable":true,"price":"449.5","weight":0.3,"product_codes":[{"id":9001,"sku":"SKU-RED-M"}]},"stock_units":[{"id":31001},{"id":31002}]}],"invoices":[],"store":{"id":1234,"name":"Example Store"},"channel_integration":{"id":55,"channel_type_name":"shopify"},"return":null,"created_by_return":null}],"meta":{"current_page":1,"next_page":2,"prev_page":null,"total_pages":7,"first_page":true,"last_page":false,"per_page":10,"total_count":63}}}},"exampleType":"examples"}},"exampleType":"examples"},"32efb378-7973-4050-b755-1986b6c9bb47":{"description":"Missing or invalid token, wrong credentials, or no access to the requested store.","content":{"application/json":{"schema":{"type":"object","description":"Error body returned by every failed request.","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable description of the failure. For `401` responses it is always `Unauthorized`.","example":"Parameter store_id is required","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Present on `401` responses only; the reason the request was rejected.","example":"invalid token","uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Stable machine-readable code, present on some order, return and replenishment errors.","example":"ORDER_ALREADY_EXISTS","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Stable machine-readable code, present on some order, return and replenishment errors.","example":"ORDER_ALREADY_EXISTS","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"object","description":"Extra data about the failure when available, for example the id of the conflicting order.","additionalProperties":true,"example":{"order_id":987654},"uniqueKey":"context.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra data about the failure when available, for example the id of the conflicting order.","additionalProperties":true,"example":{"order_id":987654},"uniqueKey":"context.oneOf.1","typeLabel":"null"}],"uniqueKey":"context","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalidToken":{"title":"invalidToken","value":{"error":"Unauthorized","message":"invalid token"}},"noHeader":{"title":"noHeader","value":{"error":"Unauthorized","message":"no authorization header found"}},"storeNotAllowed":{"title":"storeNotAllowed","value":{"error":"Unauthorized","message":"not allowed to show? this Store"}}},"exampleType":"examples"}},"exampleType":"examples"},"88331632-43f8-4dd7-b883-118119b7b113":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","description":"Error body returned by every failed request.","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable description of the failure. For `401` responses it is always `Unauthorized`.","example":"Parameter store_id is required","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Present on `401` responses only; the reason the request was rejected.","example":"invalid token","uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Stable machine-readable code, present on some order, return and replenishment errors.","example":"ORDER_ALREADY_EXISTS","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Stable machine-readable code, present on some order, return and replenishment errors.","example":"ORDER_ALREADY_EXISTS","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"object","description":"Extra data about the failure when available, for example the id of the conflicting order.","additionalProperties":true,"example":{"order_id":987654},"uniqueKey":"context.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra data about the failure when available, for example the id of the conflicting order.","additionalProperties":true,"example":{"order_id":987654},"uniqueKey":"context.oneOf.1","typeLabel":"null"}],"uniqueKey":"context","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missingStore":{"title":"missingStore","value":{"error":"Parameter store_id is required"}},"invalidDate":{"title":"invalidDate","value":{"error":"'abc' is not a valid DateTime"}},"unknownSortField":{"title":"unknownSortField","value":{"error":"Field not found: foo"}}},"exampleType":"examples"}},"exampleType":"examples"},"95aaca37-4224-46de-86b6-eee327e815ae":{"description":"Unexpected error. Retry with backoff; if it persists, send the timestamp to Cubbo support.","content":{"application/json":{"schema":{"type":"object","description":"Error body returned by every failed request.","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable description of the failure. For `401` responses it is always `Unauthorized`.","example":"Parameter store_id is required","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Present on `401` responses only; the reason the request was rejected.","example":"invalid token","uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Stable machine-readable code, present on some order, return and replenishment errors.","example":"ORDER_ALREADY_EXISTS","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Stable machine-readable code, present on some order, return and replenishment errors.","example":"ORDER_ALREADY_EXISTS","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"object","description":"Extra data about the failure when available, for example the id of the conflicting order.","additionalProperties":true,"example":{"order_id":987654},"uniqueKey":"context.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra data about the failure when available, for example the id of the conflicting order.","additionalProperties":true,"example":{"order_id":987654},"uniqueKey":"context.oneOf.1","typeLabel":"null"}],"uniqueKey":"context","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"unexpected error, timestamp: 1760000000"},"examples":{"Example":{"title":"Example","value":{"error":"unexpected error, timestamp: 1760000000"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"4f9f4492-52e1-464c-ba56-912275362082":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token returned by `POST /auth/token`, sent as `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"30628f1a-73a6-48fb-b75f-22c715a140c8":{"url":"https://api.cubbo.com/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token returned by `POST /auth/token`, sent as `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Token returned by `POST /auth/token`, sent as `Authorization: Bearer \u003ctoken>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"cubbo","siteName":"Cubbo Developers","title":"List orders - Cubbo Developers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/orders/list-orders","matchLevel":0},"es":{"href":"/api-reference/orders/list-orders","matchLevel":0},"pt-BR":{"href":"/api-reference/orders/list-orders","matchLevel":0}}},"lastModified":"2026-11-10T14:52:57.253Z","originalFileLocation":"api-reference/orders/list-orders.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a paginated list of a store\u0026#x27;s orders with their order lines, invoices (NF-e, Brazil only), shipping method, delivery tracking and, optionally, the order\u0026#x27;s event history. Use it to sync order status and tracking into your own systems. Filter by status, order type, order number, buyer email or date ranges. - Results are paginated: page (default 1) and per_page (default 10, capped at 100). The meta object tells you whether more pages exist. - Filtering status by processing also returns orders in picking and packing, since all three mean \u0026quot;being prepared in the warehouse\u0026quot;. - order_number accepts a single string or an array of strings (order_number[]=ORD-0001\u0026amp;order_number[]=ORD-0002). When you filter by order number, stock units of products that use unit codes also expose their unit_code while the order is packing or shipped. - sort_by accepts any order field (for example created_at, channel_created_at, shipping_date, updated_at), or shipping_methods. / stores.; an unknown field returns 422 Field not found. sort is desc unless you pass asc. Without sort_by the order of results is not guaranteed. - include_event_history=true adds order_histories to every order (status changes, tracking updates and incidents). - is_b2b is only present for stores that handle both B2B and D2C orders. - Each order in this list carries the subset of Order fields listed in the response schema description; the full Order object is returned by the create and update endpoints.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cubbo Developers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cubbo/zT7rg4q7ps_kLhph/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cubbo/zT7rg4q7ps_kLhph/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cubbo/zT7rg4q7ps_kLhph/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cubbo/zT7rg4q7ps_kLhph/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cubbo/zT7rg4q7ps_kLhph/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cubbo/zT7rg4q7ps_kLhph/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cubbo/zT7rg4q7ps_kLhph/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cubbo/zT7rg4q7ps_kLhph/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cubbo/zT7rg4q7ps_kLhph/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List orders - Cubbo Developers\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a paginated list of a store\u0026#x27;s orders with their order lines, invoices (NF-e, Brazil only), shipping method, delivery tracking and, optionally, the order\u0026#x27;s event history. Use it to sync order status and tracking into your own systems. Filter by status, order type, order number, buyer email or date ranges. - Results are paginated: page (default 1) and per_page (default 10, capped at 100). The meta object tells you whether more pages exist. - Filtering status by processing also returns orders in picking and packing, since all three mean \u0026quot;being prepared in the warehouse\u0026quot;. - order_number accepts a single string or an array of strings (order_number[]=ORD-0001\u0026amp;order_number[]=ORD-0002). When you filter by order number, stock units of products that use unit codes also expose their unit_code while the order is packing or shipped. - sort_by accepts any order field (for example created_at, channel_created_at, shipping_date, updated_at), or shipping_methods. / stores.; an unknown field returns 422 Field not found. sort is desc unless you pass asc. Without sort_by the order of results is not guaranteed. - include_event_history=true adds order_histories to every order (status changes, tracking updates and incidents). - is_b2b is only present for stores that handle both B2B and D2C orders. - Each order in this list carries the subset of Order fields listed in the response schema description; the full Order object is returned by the create and update endpoints.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cubbo Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.cubbo.com/api-reference/orders/list-orders\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cubbo.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=List+orders\u0026amp;description=Returns+a+paginated+list+of+a+store%27s+orders+with+their+order+lines%2C+invoices+%28NF-e%2C+Brazil+only%29%2C%0Ashipping+method%2C+delivery+tracking+and%2C+optionally%2C+the+order\u0026amp;theme=43761a2dfbeb2a4d767b8dde\u0026amp;signature=1793f90617e1fdbf250ce11fbaa7f3786a247d8cf692b89ebd87e61edce3eb94\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List orders - Cubbo Developers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a paginated list of a store\u0026#x27;s orders with their order lines, invoices (NF-e, Brazil only), shipping method, delivery tracking and, optionally, the order\u0026#x27;s event history. Use it to sync order status and tracking into your own systems. Filter by status, order type, order number, buyer email or date ranges. - Results are paginated: page (default 1) and per_page (default 10, capped at 100). The meta object tells you whether more pages exist. - Filtering status by processing also returns orders in picking and packing, since all three mean \u0026quot;being prepared in the warehouse\u0026quot;. - order_number accepts a single string or an array of strings (order_number[]=ORD-0001\u0026amp;order_number[]=ORD-0002). When you filter by order number, stock units of products that use unit codes also expose their unit_code while the order is packing or shipped. - sort_by accepts any order field (for example created_at, channel_created_at, shipping_date, updated_at), or shipping_methods. / stores.; an unknown field returns 422 Field not found. sort is desc unless you pass asc. Without sort_by the order of results is not guaranteed. - include_event_history=true adds order_histories to every order (status changes, tracking updates and incidents). - is_b2b is only present for stores that handle both B2B and D2C orders. - Each order in this list carries the subset of Order fields listed in the response schema description; the full Order object is returned by the create and update endpoints.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cubbo.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=List+orders\u0026amp;description=Returns+a+paginated+list+of+a+store%27s+orders+with+their+order+lines%2C+invoices+%28NF-e%2C+Brazil+only%29%2C%0Ashipping+method%2C+delivery+tracking+and%2C+optionally%2C+the+order\u0026amp;theme=43761a2dfbeb2a4d767b8dde\u0026amp;signature=1793f90617e1fdbf250ce11fbaa7f3786a247d8cf692b89ebd87e61edce3eb94\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cubbo/zT7rg4q7ps_kLhph/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cubbo Developers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#327cfb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.cubbo.com/api-reference/orders/list-orders\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/orders/list-orders.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.cubbo.com/#organization\",\"name\":\"Cubbo Developers\",\"url\":\"https://developers.cubbo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cubbo/RGfmvgvbM1HVXepF/logo/light.svg?fit=max\u0026auto=format\u0026n=RGfmvgvbM1HVXepF\u0026q=85\u0026s=208df5125f7962b06468c3c835605bd0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.cubbo.com#website\",\"name\":\"Cubbo Developers\",\"url\":\"https://developers.cubbo.com\",\"publisher\":{\"@id\":\"https://developers.cubbo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.cubbo.com/api-reference/orders/list-orders#webpage\",\"url\":\"https://developers.cubbo.com/api-reference/orders/list-orders\",\"name\":\"List orders\",\"description\":\"Returns a paginated list of a store's orders with their order lines, invoices (NF-e, Brazil only), shipping method, delivery tracking and, optionally, the order's event history. Use it to sync order status and tracking into your own systems. Filter by status, order type, order number, buyer email or date ranges. - Results are paginated: page (default 1) and per_page (default 10, capped at 100). The meta object tells you whether more pages exist. - Filtering status by processing also returns orders in picking and packing, since all three mean \\\"being prepared in the warehouse\\\". - order_number accepts a single string or an array of strings (order_number[]=ORD-0001\u0026order_number[]=ORD-0002). When you filter by order number, stock units of products that use unit codes also expose their unit_code while the order is packing or shipped. - sort_by accepts any order field (for example created_at, channel_created_at, shipping_date, updated_at), or shipping_methods. / stores.; an unknown field returns 422 Field not found. sort is desc unless you pass asc. Without sort_by the order of results is not guaranteed. - include_event_history=true adds order_histories to every order (status changes, tracking updates and incidents). - is_b2b is only present for stores that handle both B2B and D2C orders. - Each order in this list carries the subset of Order fields listed in the response schema description; the full Order object is returned by the create and update endpoints.\",\"dateModified\":\"2026-11-10T14:52:57.253Z\",\"isPartOf\":{\"@id\":\"https://developers.cubbo.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.cubbo.com/api-reference/orders/list-orders#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.cubbo.com/api-reference/orders/list-orders#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Orders\",\"item\":\"https://developers.cubbo.com/api-reference/orders/create-an-order-for-a-brazil-store\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List orders\",\"item\":\"https://developers.cubbo.com/api-reference/orders/list-orders\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.cubbo.com/api-reference/orders/list-orders#apireference\",\"headline\":\"List orders\",\"name\":\"List orders\",\"description\":\"Returns a paginated list of a store's orders with their order lines, invoices (NF-e, Brazil only), shipping method, delivery tracking and, optionally, the order's event history. Use it to sync order status and tracking into your own systems. Filter by status, order type, order number, buyer email or date ranges. - Results are paginated: page (default 1) and per_page (default 10, capped at 100). The meta object tells you whether more pages exist. - Filtering status by processing also returns orders in picking and packing, since all three mean \\\"being prepared in the warehouse\\\". - order_number accepts a single string or an array of strings (order_number[]=ORD-0001\u0026order_number[]=ORD-0002). When you filter by order number, stock units of products that use unit codes also expose their unit_code while the order is packing or shipped. - sort_by accepts any order field (for example created_at, channel_created_at, shipping_date, updated_at), or shipping_methods. / stores.; an unknown field returns 422 Field not found. sort is desc unless you pass asc. Without sort_by the order of results is not guaranteed. - include_event_history=true adds order_histories to every order (status changes, tracking updates and incidents). - is_b2b is only present for stores that handle both B2B and D2C orders. - Each order in this list carries the subset of Order fields listed in the response schema description; the full Order object is returned by the create and update endpoints.\",\"url\":\"https://developers.cubbo.com/api-reference/orders/list-orders\",\"mainEntityOfPage\":{\"@id\":\"https://developers.cubbo.com/api-reference/orders/list-orders#webpage\"},\"dateModified\":\"2026-11-10T14:52:57.253Z\",\"publisher\":{\"@id\":\"https://developers.cubbo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.cubbo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cubbo Developers\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Cubbo Developers\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/orders/list-orders.md","siteName":"Cubbo Developers","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Authentication","pages":[{"title":"Obtain an access token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /auth/token","href":"/api-reference/authentication/obtain-an-access-token"}]},{"group":"Orders","pages":[{"title":"Create an order for a Brazil store","description":"Creates an order for a store served from a Brazil warehouse. Brazil orders carry the fiscal\ndata Cubbo needs to issue the NF-e (Nota Fiscal Eletrônica, the Brazilian electronic\ninvoice): per-line prices, the buyer's shipping cost and a billing block with the buyer's\ntax id (CPF for a natural person, CNPJ for a company). `order_type` selects what kind of\norder you get; it defaults to `SALE`.\n\n- `SALE` and `DONATION` share the full contract: recipient, billing, shipping method,\n `buyer_shipping_price` and a `price_per_item` on every line. A donation is only\n different fiscally (the NF-e is issued with a donation purpose).\n- The four removal types (`REMOVE_STOCK`, `REMOVE_DAMAGED_STOCK`, `REMOVE_EXPIRED_STOCK`,\n `REMOVE_LOST_STOCK`) return stock to you. Cubbo synthesizes the recipient from the\n warehouse, the billing data from your store's fiscal registration and the shipping method\n from the warehouse's pickup method, so `shipping`, `billing`, `shipping_method_id` and\n `shipping_line_code` are optional and ignored. `price_per_item` becomes optional (falls back\n to the product's registered price), `quantity` must be at least 1, and you may hand in your\n own NF-e with `invoice_xml` or `client_invoice`.\n- `REMOVE_LOST_STOCK` is applied synchronously and all-or-nothing: units already recorded\n as lost are written off and the order comes back already `shipped`. It is available only\n to stores that have opted out of Cubbo issuing their removal NF-es (ask Cubbo support).\n- `STOCK_TRANSFER_OUT` is accepted by the parameter check but is reserved for Cubbo's\n stock-transfer feature; do not send it. `C2C` is refused.\n- Sale orders are validated asynchronously (CEP, CPF/CNPJ length, NCM, totals); check\n `status`, `has_missing_info` and `missing_info` on `GET /orders`.\n- Duplicate protection: an existing `order_number` in the store answers 422; a request still\n in progress for the same `order_number` answers 409 `DUPLICATE_REQUEST_IN_FLIGHT`.\n- Error bodies on this endpoint are `{\"error\": \"\u003cmessage>\"}` with no code, except removal\n orders that fail field validation, which return `{\"errors\": [...]}`.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /brazil/orders","href":"/api-reference/orders/create-an-order-for-a-brazil-store"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders","href":"/api-reference/orders/list-orders"},{"title":"Create an order","description":"Creates a sales order for a store whose warehouse is in Mexico, Colombia, Chile or the\nUnited States, and queues it for processing. Use it for every non-Brazil store; a store\nserved from a Brazil warehouse is refused and must use `POST /brazil/orders`. The request\nneeds a store, a unique `order_number` per store, a recipient address, at least one product\nline and a way to pick the carrier:\n\n- `shipping_line_code`: the exact name of a shipping method you created in the Cubbo app\n (**Integrations** > Open API > **Shipping Methods**). Cubbo picks the carrier with the\n configuration assigned to it.\n- `shipping_method_id`: a specific Cubbo shipping method, taken from the `shipping_method_id` of\n an option returned by `GET /shipping-methods/quote`.\n\n- The order is returned immediately in its initial status. Address, coverage, stock and\n carrier validations run asynchronously; poll `GET /orders` and read `status`,\n `has_missing_info` and `missing_info` to learn whether it was accepted.\n- Every product is identified by SKU. Without `channel_name`, an unknown SKU rejects the whole\n request with 422. With `channel_name` (an order relayed from a sales channel), the order is\n created anyway: a line whose SKU is unknown keeps that SKU without a product, and the\n response lists those SKUs in `warnings` with the code `UNIDENTIFIED_PRODUCT`. Processing\n then leaves the order with missing information (`status` `error`; with\n `include_event_history=true`, `GET /orders` shows the code `UNIDENTIFIED_PRODUCT` in the\n error event) until the product exists. Creating the product or adding the SKU to an\n existing product in the Cubbo app processes the order again and the line takes the\n product; creating it with `POST /products` without variants does not trigger that reprocess\n today.\n- A line sent without `price_per_item` takes the product's price. On a line whose SKU is\n unknown there is no product price yet, so the line counts as zero in the order total, and so\n does its discount; once the product exists, the line takes the product's price and the\n order total is recomputed (a kit without its own price is worth its components). A product\n price smaller than the line's discount is not taken. Discounts larger than what the\n products are worth are rejected with 422 `INVALID_PRODUCT_DISCOUNT`.\n- A `unit_code` sent on a line whose SKU is unknown is kept. The line must still have\n `quantity` 1, and one SKU cannot name the same code twice: otherwise the request is\n rejected with 422, as for a known SKU. The rest is checked once the product exists: if the\n line can never be fulfilled (a kit, or a product that does not track unit codes and has no\n unit carrying that code), the order waits with missing information, code\n `INVALID_UNIT_CODE_LINE`; two lines whose SKUs turn out to be the same product and name the\n same code give `DUPLICATE_UNIT_CODE` on the later line. Correct the line by editing the\n order in the Cubbo app; `PUT /orders/{id}` does not replace the products of an order with a\n pinned line.\n- `zip_code` is mandatory when the warehouse is in Mexico (and Brazil); it is optional for\n Chile and Colombia.\n- Chile: when `shipping.city` cannot be identified (a misspelling, or a province instead of a\n city), an order sent with `shipping_method_id` is not refused. It is created and moves to\n `error` until you correct `shipping.city` with `PUT /orders/{id}` or in\n the Cubbo app, where the order shows the reason. An order that ships on your own label (Blue\n Express EX, with the label attached) continues normally. A `shipping.city` that is identified\n but not covered by the method is still refused with 422.\n- Colombia: carriers deliver by the DANE (DIVIPOLA) code of the destination city. Cubbo finds it\n from `shipping.city` and `shipping.province`, or you send it in `shipping.city_code`: when\n present, the code decides the destination and the city and province are not looked up. A\n 5-digit code (a municipality) stands for its main town; an 8-digit code is a populated center;\n a code missing its leading zero (4 or 7 digits) is completed. An order whose\n `shipping.city_code` Cubbo does not know is not refused: the response lists it in `warnings`\n with the code `UNRECOGNIZED_CITY_CODE`, and the order moves to `error` with that code (the\n code you sent is in `additional_info.city_code`) until you correct it with `PUT /orders/{id}`. Without `city_code`, an order sent with\n `shipping_method_id` whose city and province cannot be identified is still refused with 422.\n- Duplicate protection: an `order_number` that already exists in the store answers 422 with\n code `ORDER_ALREADY_EXISTS` and the existing `order_id` in `context`. While another request\n for the same `store_id` + `order_number` is still being processed you get 409\n `DUPLICATE_REQUEST_IN_FLIGHT` with a `Retry-After` header; retry after that delay and you\n will converge on the real outcome (200, 422 or `ORDER_ALREADY_EXISTS`).\n- Complementary carrier services (`has_carrier_insurance`, `cod_amount`,\n `requires_document_return`, `requires_pickup_on_delivery`) are currently honoured only for\n stores with a warehouse in Chile; sending `true` (or a non-zero amount) from any other\n country is refused with a typed error code rather than silently ignored.\n- Click and collect: send `is_click_and_collect: true` and the `click_and_collect_service_code`\n you obtained from `GET /carrier-services/pickup-locations`. Cubbo replaces the shipping\n method you sent with the pickup carrier's method. A full shipping address is still required.\n- `is_b2b` only matters for stores enabled for both B2B and D2C (\"mixed\"); omit it to create a\n consumer (D2C) order. Stores enabled for a single model always get that model.\n- Error bodies on this endpoint carry an `error` message plus a machine-readable `code`\n (empty string or null when the error has no code) and an optional `context` object.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders","href":"/api-reference/orders/create-an-order"},{"title":"Update an order","deprecated":null,"version":null,"openapi":"/openapi.yaml put /orders/{id}","href":"/api-reference/orders/update-an-order"},{"title":"Update shipping contact and address fields","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}","href":"/api-reference/orders/update-shipping-contact-and-address-fields"},{"title":"Put an order on hold","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}/hold","href":"/api-reference/orders/put-an-order-on-hold"},{"title":"Release an order from hold","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}/unhold","href":"/api-reference/orders/release-an-order-from-hold"},{"title":"Upload shipping documents to an order","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}/upload-shipping-documents","href":"/api-reference/orders/upload-shipping-documents-to-an-order"},{"title":"Attach NF-e invoices issued through Cubbo's fiscal integration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{order_id}/attach-invoice","href":"/api-reference/orders/attach-nf-e-invoices-issued-through-cubbos-fiscal-integration"},{"title":"List orders waiting for an NF-e","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/awaiting-invoice","href":"/api-reference/orders/list-orders-waiting-for-an-nf-e"},{"title":"Cancel an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/cancel","href":"/api-reference/orders/cancel-an-order"},{"title":"Create a pick-and-ship order and buy its labels","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/create-and-ship","href":"/api-reference/orders/create-a-pick-and-ship-order-and-buy-its-labels"},{"title":"Delete an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/delete","href":"/api-reference/orders/delete-an-order"},{"title":"List orders with selected fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/with-fields","href":"/api-reference/orders/list-orders-with-selected-fields"}]},{"group":"Click and collect","pages":[{"title":"List pickup locations near a postal code (public)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /carrier-services/pickup-locations","href":"/api-reference/click-and-collect/list-pickup-locations-near-a-postal-code-public"},{"title":"Convert an order to click and collect","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{order_id}/convert-to-click-and-collect","href":"/api-reference/click-and-collect/convert-an-order-to-click-and-collect"},{"title":"List click-and-collect pickup points eligible for an order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{order_id}/pickup-points","href":"/api-reference/click-and-collect/list-click-and-collect-pickup-points-eligible-for-an-order"}]},{"group":"Inventory","pages":[{"title":"List products with stock","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory","href":"/api-reference/inventory/list-products-with-stock"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products","href":"/api-reference/inventory/create-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /products/{id}","href":"/api-reference/inventory/update-a-product"}]},{"group":"Lots","pages":[{"title":"List the lots of a product","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lots","href":"/api-reference/lots/list-the-lots-of-a-product"},{"title":"Put a lot on hold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots/hold/store/{store_id}","href":"/api-reference/lots/put-a-lot-on-hold"},{"title":"Release a lot from hold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots/unhold/store/{store_id}","href":"/api-reference/lots/release-a-lot-from-hold"},{"title":"Create a lot or update its expiration date","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots/upsert","href":"/api-reference/lots/create-a-lot-or-update-its-expiration-date"}]},{"group":"Shipping labels","pages":[{"title":"List an order's shipping labels","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{order_id}/shipping-labels","href":"/api-reference/shipping-labels/list-an-orders-shipping-labels"},{"title":"Get a shipping label","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-labels/{shipping_label_id}","href":"/api-reference/shipping-labels/get-a-shipping-label"}]},{"group":"Replenishments","pages":[{"title":"Create a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /replenishments","href":"/api-reference/replenishments/create-a-replenishment"},{"title":"Get a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /replenishments/{replenishment_id}","href":"/api-reference/replenishments/get-a-replenishment"},{"title":"Update a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /replenishments/{replenishment_id}","href":"/api-reference/replenishments/update-a-replenishment"},{"title":"Attach an NF-e issued through Cubbo's Brazilian invoicing provider","deprecated":null,"version":null,"openapi":"/openapi.yaml post /replenishments/{replenishment_id}/attach-invoice","href":"/api-reference/replenishments/attach-an-nf-e-issued-through-cubbos-brazilian-invoicing-provider"},{"title":"Record or clear an invoice issuing error","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /replenishments/{replenishment_id}/invoice-issuing-error","href":"/api-reference/replenishments/record-or-clear-an-invoice-issuing-error"},{"title":"Get the variance report of a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /replenishments/{replenishment_id}/variance-report","href":"/api-reference/replenishments/get-the-variance-report-of-a-replenishment"}]},{"group":"Reports","pages":[{"title":"Inventory transactions report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/inventory-transactions","href":"/api-reference/reports/inventory-transactions-report"}]},{"group":"Returns","pages":[{"title":"Request a return for a shipped order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns","href":"/api-reference/returns/request-a-return-for-a-shipped-order"},{"title":"Get a return","deprecated":null,"version":null,"openapi":"/openapi.yaml get /returns/{return_id}","href":"/api-reference/returns/get-a-return"},{"title":"Register the inbound NF-e issued for a return (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{return_id}/attach-invoice","href":"/api-reference/returns/register-the-inbound-nf-e-issued-for-a-return-brazil"},{"title":"Cancel a pending return","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /returns/{return_id}/cancel","href":"/api-reference/returns/cancel-a-pending-return"},{"title":"Decide what to do with an order returned by the carrier","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{return_id}/decision","href":"/api-reference/returns/decide-what-to-do-with-an-order-returned-by-the-carrier"},{"title":"List returns that still need an inbound NF-e (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /returns/awaiting-invoice","href":"/api-reference/returns/list-returns-that-still-need-an-inbound-nf-e-brazil"}]},{"group":"Shipping methods","pages":[{"title":"List active shipping methods available to a store","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-methods","href":"/api-reference/shipping-methods/list-active-shipping-methods-available-to-a-store"},{"title":"Check which shipping method a shipping configuration would select for a postcode","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-methods/configuration-coverage","href":"/api-reference/shipping-methods/check-which-shipping-method-a-shipping-configuration-would-select-for-a-postcode"},{"title":"Quote shipping options for a destination and package","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-methods/quote","href":"/api-reference/shipping-methods/quote-shipping-options-for-a-destination-and-package"}]},{"group":"Stores","pages":[{"title":"Update your own store","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /store","href":"/api-reference/stores/update-your-own-store"},{"title":"Upload the store's digital certificate and set NF-e numbering (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /store/digital-certificate","href":"/api-reference/stores/upload-the-stores-digital-certificate-and-set-nf-e-numbering-brazil"},{"title":"Provision the store's fiscal account (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /store/fiscal-account","href":"/api-reference/stores/provision-the-stores-fiscal-account-brazil"},{"title":"Create a store from an existing one","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stores","href":"/api-reference/stores/create-a-store-from-an-existing-one"}]},{"group":"Webhooks","pages":[{"title":"Order status changed","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook orderUpdated","href":"/api-reference/webhooks/order-status-changed"},{"title":"Order shipped fulfilled","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook orderFulfilled","href":"/api-reference/webhooks/order-shipped-fulfilled"},{"title":"Carrier tracking status changed","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook shippingUpdated","href":"/api-reference/webhooks/carrier-tracking-status-changed"},{"title":"Inventory snapshot after a stock movement","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook inventoryMovement","href":"/api-reference/webhooks/inventory-snapshot-after-a-stock-movement"},{"title":"Replenishment announced","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook replenishmentCreated","href":"/api-reference/webhooks/replenishment-announced"},{"title":"Replenishment appointment booked or canceled","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook replenishmentScheduled","href":"/api-reference/webhooks/replenishment-appointment-booked-or-canceled"},{"title":"Replenishment status changed","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook replenishmentStatus","href":"/api-reference/webhooks/replenishment-status-changed"}]}]}]},{"language":"es","navbar":{"links":[{"href":"https://cubbo.com","label":"Cubbo"}],"primary":{"type":"button","label":"Obtener credenciales","href":"https://app.cubbo.com/stores"}},"tabs":[{"tab":"Guías","pages":[{"title":"Guías","href":"/es"}]},{"tab":"Referencia de la API","groups":[{"group":"Authentication","pages":[{"title":"Obtain an access token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /auth/token","href":"/api-reference/authentication/obtain-an-access-token"}]},{"group":"Orders","pages":[{"title":"Create an order for a Brazil store","description":"Creates an order for a store served from a Brazil warehouse. Brazil orders carry the fiscal\ndata Cubbo needs to issue the NF-e (Nota Fiscal Eletrônica, the Brazilian electronic\ninvoice): per-line prices, the buyer's shipping cost and a billing block with the buyer's\ntax id (CPF for a natural person, CNPJ for a company). `order_type` selects what kind of\norder you get; it defaults to `SALE`.\n\n- `SALE` and `DONATION` share the full contract: recipient, billing, shipping method,\n `buyer_shipping_price` and a `price_per_item` on every line. A donation is only\n different fiscally (the NF-e is issued with a donation purpose).\n- The four removal types (`REMOVE_STOCK`, `REMOVE_DAMAGED_STOCK`, `REMOVE_EXPIRED_STOCK`,\n `REMOVE_LOST_STOCK`) return stock to you. Cubbo synthesizes the recipient from the\n warehouse, the billing data from your store's fiscal registration and the shipping method\n from the warehouse's pickup method, so `shipping`, `billing`, `shipping_method_id` and\n `shipping_line_code` are optional and ignored. `price_per_item` becomes optional (falls back\n to the product's registered price), `quantity` must be at least 1, and you may hand in your\n own NF-e with `invoice_xml` or `client_invoice`.\n- `REMOVE_LOST_STOCK` is applied synchronously and all-or-nothing: units already recorded\n as lost are written off and the order comes back already `shipped`. It is available only\n to stores that have opted out of Cubbo issuing their removal NF-es (ask Cubbo support).\n- `STOCK_TRANSFER_OUT` is accepted by the parameter check but is reserved for Cubbo's\n stock-transfer feature; do not send it. `C2C` is refused.\n- Sale orders are validated asynchronously (CEP, CPF/CNPJ length, NCM, totals); check\n `status`, `has_missing_info` and `missing_info` on `GET /orders`.\n- Duplicate protection: an existing `order_number` in the store answers 422; a request still\n in progress for the same `order_number` answers 409 `DUPLICATE_REQUEST_IN_FLIGHT`.\n- Error bodies on this endpoint are `{\"error\": \"\u003cmessage>\"}` with no code, except removal\n orders that fail field validation, which return `{\"errors\": [...]}`.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /brazil/orders","href":"/api-reference/orders/create-an-order-for-a-brazil-store"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders","href":"/api-reference/orders/list-orders"},{"title":"Create an order","description":"Creates a sales order for a store whose warehouse is in Mexico, Colombia, Chile or the\nUnited States, and queues it for processing. Use it for every non-Brazil store; a store\nserved from a Brazil warehouse is refused and must use `POST /brazil/orders`. The request\nneeds a store, a unique `order_number` per store, a recipient address, at least one product\nline and a way to pick the carrier:\n\n- `shipping_line_code`: the exact name of a shipping method you created in the Cubbo app\n (**Integrations** > Open API > **Shipping Methods**). Cubbo picks the carrier with the\n configuration assigned to it.\n- `shipping_method_id`: a specific Cubbo shipping method, taken from the `shipping_method_id` of\n an option returned by `GET /shipping-methods/quote`.\n\n- The order is returned immediately in its initial status. Address, coverage, stock and\n carrier validations run asynchronously; poll `GET /orders` and read `status`,\n `has_missing_info` and `missing_info` to learn whether it was accepted.\n- Every product is identified by SKU. Without `channel_name`, an unknown SKU rejects the whole\n request with 422. With `channel_name` (an order relayed from a sales channel), the order is\n created anyway: a line whose SKU is unknown keeps that SKU without a product, and the\n response lists those SKUs in `warnings` with the code `UNIDENTIFIED_PRODUCT`. Processing\n then leaves the order with missing information (`status` `error`; with\n `include_event_history=true`, `GET /orders` shows the code `UNIDENTIFIED_PRODUCT` in the\n error event) until the product exists. Creating the product or adding the SKU to an\n existing product in the Cubbo app processes the order again and the line takes the\n product; creating it with `POST /products` without variants does not trigger that reprocess\n today.\n- A line sent without `price_per_item` takes the product's price. On a line whose SKU is\n unknown there is no product price yet, so the line counts as zero in the order total, and so\n does its discount; once the product exists, the line takes the product's price and the\n order total is recomputed (a kit without its own price is worth its components). A product\n price smaller than the line's discount is not taken. Discounts larger than what the\n products are worth are rejected with 422 `INVALID_PRODUCT_DISCOUNT`.\n- A `unit_code` sent on a line whose SKU is unknown is kept. The line must still have\n `quantity` 1, and one SKU cannot name the same code twice: otherwise the request is\n rejected with 422, as for a known SKU. The rest is checked once the product exists: if the\n line can never be fulfilled (a kit, or a product that does not track unit codes and has no\n unit carrying that code), the order waits with missing information, code\n `INVALID_UNIT_CODE_LINE`; two lines whose SKUs turn out to be the same product and name the\n same code give `DUPLICATE_UNIT_CODE` on the later line. Correct the line by editing the\n order in the Cubbo app; `PUT /orders/{id}` does not replace the products of an order with a\n pinned line.\n- `zip_code` is mandatory when the warehouse is in Mexico (and Brazil); it is optional for\n Chile and Colombia.\n- Chile: when `shipping.city` cannot be identified (a misspelling, or a province instead of a\n city), an order sent with `shipping_method_id` is not refused. It is created and moves to\n `error` until you correct `shipping.city` with `PUT /orders/{id}` or in\n the Cubbo app, where the order shows the reason. An order that ships on your own label (Blue\n Express EX, with the label attached) continues normally. A `shipping.city` that is identified\n but not covered by the method is still refused with 422.\n- Colombia: carriers deliver by the DANE (DIVIPOLA) code of the destination city. Cubbo finds it\n from `shipping.city` and `shipping.province`, or you send it in `shipping.city_code`: when\n present, the code decides the destination and the city and province are not looked up. A\n 5-digit code (a municipality) stands for its main town; an 8-digit code is a populated center;\n a code missing its leading zero (4 or 7 digits) is completed. An order whose\n `shipping.city_code` Cubbo does not know is not refused: the response lists it in `warnings`\n with the code `UNRECOGNIZED_CITY_CODE`, and the order moves to `error` with that code (the\n code you sent is in `additional_info.city_code`) until you correct it with `PUT /orders/{id}`. Without `city_code`, an order sent with\n `shipping_method_id` whose city and province cannot be identified is still refused with 422.\n- Duplicate protection: an `order_number` that already exists in the store answers 422 with\n code `ORDER_ALREADY_EXISTS` and the existing `order_id` in `context`. While another request\n for the same `store_id` + `order_number` is still being processed you get 409\n `DUPLICATE_REQUEST_IN_FLIGHT` with a `Retry-After` header; retry after that delay and you\n will converge on the real outcome (200, 422 or `ORDER_ALREADY_EXISTS`).\n- Complementary carrier services (`has_carrier_insurance`, `cod_amount`,\n `requires_document_return`, `requires_pickup_on_delivery`) are currently honoured only for\n stores with a warehouse in Chile; sending `true` (or a non-zero amount) from any other\n country is refused with a typed error code rather than silently ignored.\n- Click and collect: send `is_click_and_collect: true` and the `click_and_collect_service_code`\n you obtained from `GET /carrier-services/pickup-locations`. Cubbo replaces the shipping\n method you sent with the pickup carrier's method. A full shipping address is still required.\n- `is_b2b` only matters for stores enabled for both B2B and D2C (\"mixed\"); omit it to create a\n consumer (D2C) order. Stores enabled for a single model always get that model.\n- Error bodies on this endpoint carry an `error` message plus a machine-readable `code`\n (empty string or null when the error has no code) and an optional `context` object.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders","href":"/api-reference/orders/create-an-order"},{"title":"Update an order","deprecated":null,"version":null,"openapi":"/openapi.yaml put /orders/{id}","href":"/api-reference/orders/update-an-order"},{"title":"Update shipping contact and address fields","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}","href":"/api-reference/orders/update-shipping-contact-and-address-fields"},{"title":"Put an order on hold","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}/hold","href":"/api-reference/orders/put-an-order-on-hold"},{"title":"Release an order from hold","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}/unhold","href":"/api-reference/orders/release-an-order-from-hold"},{"title":"Upload shipping documents to an order","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}/upload-shipping-documents","href":"/api-reference/orders/upload-shipping-documents-to-an-order"},{"title":"Attach NF-e invoices issued through Cubbo's fiscal integration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{order_id}/attach-invoice","href":"/api-reference/orders/attach-nf-e-invoices-issued-through-cubbos-fiscal-integration"},{"title":"List orders waiting for an NF-e","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/awaiting-invoice","href":"/api-reference/orders/list-orders-waiting-for-an-nf-e"},{"title":"Cancel an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/cancel","href":"/api-reference/orders/cancel-an-order"},{"title":"Create a pick-and-ship order and buy its labels","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/create-and-ship","href":"/api-reference/orders/create-a-pick-and-ship-order-and-buy-its-labels"},{"title":"Delete an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/delete","href":"/api-reference/orders/delete-an-order"},{"title":"List orders with selected fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/with-fields","href":"/api-reference/orders/list-orders-with-selected-fields"}]},{"group":"Click and collect","pages":[{"title":"List pickup locations near a postal code (public)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /carrier-services/pickup-locations","href":"/api-reference/click-and-collect/list-pickup-locations-near-a-postal-code-public"},{"title":"Convert an order to click and collect","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{order_id}/convert-to-click-and-collect","href":"/api-reference/click-and-collect/convert-an-order-to-click-and-collect"},{"title":"List click-and-collect pickup points eligible for an order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{order_id}/pickup-points","href":"/api-reference/click-and-collect/list-click-and-collect-pickup-points-eligible-for-an-order"}]},{"group":"Inventory","pages":[{"title":"List products with stock","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory","href":"/api-reference/inventory/list-products-with-stock"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products","href":"/api-reference/inventory/create-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /products/{id}","href":"/api-reference/inventory/update-a-product"}]},{"group":"Lots","pages":[{"title":"List the lots of a product","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lots","href":"/api-reference/lots/list-the-lots-of-a-product"},{"title":"Put a lot on hold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots/hold/store/{store_id}","href":"/api-reference/lots/put-a-lot-on-hold"},{"title":"Release a lot from hold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots/unhold/store/{store_id}","href":"/api-reference/lots/release-a-lot-from-hold"},{"title":"Create a lot or update its expiration date","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots/upsert","href":"/api-reference/lots/create-a-lot-or-update-its-expiration-date"}]},{"group":"Shipping labels","pages":[{"title":"List an order's shipping labels","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{order_id}/shipping-labels","href":"/api-reference/shipping-labels/list-an-orders-shipping-labels"},{"title":"Get a shipping label","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-labels/{shipping_label_id}","href":"/api-reference/shipping-labels/get-a-shipping-label"}]},{"group":"Replenishments","pages":[{"title":"Create a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /replenishments","href":"/api-reference/replenishments/create-a-replenishment"},{"title":"Get a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /replenishments/{replenishment_id}","href":"/api-reference/replenishments/get-a-replenishment"},{"title":"Update a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /replenishments/{replenishment_id}","href":"/api-reference/replenishments/update-a-replenishment"},{"title":"Attach an NF-e issued through Cubbo's Brazilian invoicing provider","deprecated":null,"version":null,"openapi":"/openapi.yaml post /replenishments/{replenishment_id}/attach-invoice","href":"/api-reference/replenishments/attach-an-nf-e-issued-through-cubbos-brazilian-invoicing-provider"},{"title":"Record or clear an invoice issuing error","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /replenishments/{replenishment_id}/invoice-issuing-error","href":"/api-reference/replenishments/record-or-clear-an-invoice-issuing-error"},{"title":"Get the variance report of a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /replenishments/{replenishment_id}/variance-report","href":"/api-reference/replenishments/get-the-variance-report-of-a-replenishment"}]},{"group":"Reports","pages":[{"title":"Inventory transactions report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/inventory-transactions","href":"/api-reference/reports/inventory-transactions-report"}]},{"group":"Returns","pages":[{"title":"Request a return for a shipped order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns","href":"/api-reference/returns/request-a-return-for-a-shipped-order"},{"title":"Get a return","deprecated":null,"version":null,"openapi":"/openapi.yaml get /returns/{return_id}","href":"/api-reference/returns/get-a-return"},{"title":"Register the inbound NF-e issued for a return (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{return_id}/attach-invoice","href":"/api-reference/returns/register-the-inbound-nf-e-issued-for-a-return-brazil"},{"title":"Cancel a pending return","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /returns/{return_id}/cancel","href":"/api-reference/returns/cancel-a-pending-return"},{"title":"Decide what to do with an order returned by the carrier","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{return_id}/decision","href":"/api-reference/returns/decide-what-to-do-with-an-order-returned-by-the-carrier"},{"title":"List returns that still need an inbound NF-e (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /returns/awaiting-invoice","href":"/api-reference/returns/list-returns-that-still-need-an-inbound-nf-e-brazil"}]},{"group":"Shipping methods","pages":[{"title":"List active shipping methods available to a store","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-methods","href":"/api-reference/shipping-methods/list-active-shipping-methods-available-to-a-store"},{"title":"Check which shipping method a shipping configuration would select for a postcode","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-methods/configuration-coverage","href":"/api-reference/shipping-methods/check-which-shipping-method-a-shipping-configuration-would-select-for-a-postcode"},{"title":"Quote shipping options for a destination and package","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-methods/quote","href":"/api-reference/shipping-methods/quote-shipping-options-for-a-destination-and-package"}]},{"group":"Stores","pages":[{"title":"Update your own store","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /store","href":"/api-reference/stores/update-your-own-store"},{"title":"Upload the store's digital certificate and set NF-e numbering (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /store/digital-certificate","href":"/api-reference/stores/upload-the-stores-digital-certificate-and-set-nf-e-numbering-brazil"},{"title":"Provision the store's fiscal account (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /store/fiscal-account","href":"/api-reference/stores/provision-the-stores-fiscal-account-brazil"},{"title":"Create a store from an existing one","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stores","href":"/api-reference/stores/create-a-store-from-an-existing-one"}]},{"group":"Webhooks","pages":[{"title":"Order status changed","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook orderUpdated","href":"/api-reference/webhooks/order-status-changed"},{"title":"Order shipped fulfilled","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook orderFulfilled","href":"/api-reference/webhooks/order-shipped-fulfilled"},{"title":"Carrier tracking status changed","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook shippingUpdated","href":"/api-reference/webhooks/carrier-tracking-status-changed"},{"title":"Inventory snapshot after a stock movement","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook inventoryMovement","href":"/api-reference/webhooks/inventory-snapshot-after-a-stock-movement"},{"title":"Replenishment announced","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook replenishmentCreated","href":"/api-reference/webhooks/replenishment-announced"},{"title":"Replenishment appointment booked or canceled","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook replenishmentScheduled","href":"/api-reference/webhooks/replenishment-appointment-booked-or-canceled"},{"title":"Replenishment status changed","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook replenishmentStatus","href":"/api-reference/webhooks/replenishment-status-changed"}]}]}]},{"language":"pt-BR","navbar":{"links":[{"href":"https://cubbo.com","label":"Cubbo"}],"primary":{"type":"button","label":"Obter credenciais","href":"https://app.cubbo.com/stores"}},"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/pt-BR"}]},{"tab":"Referência da API","groups":[{"group":"Authentication","pages":[{"title":"Obtain an access token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /auth/token","href":"/api-reference/authentication/obtain-an-access-token"}]},{"group":"Orders","pages":[{"title":"Create an order for a Brazil store","description":"Creates an order for a store served from a Brazil warehouse. Brazil orders carry the fiscal\ndata Cubbo needs to issue the NF-e (Nota Fiscal Eletrônica, the Brazilian electronic\ninvoice): per-line prices, the buyer's shipping cost and a billing block with the buyer's\ntax id (CPF for a natural person, CNPJ for a company). `order_type` selects what kind of\norder you get; it defaults to `SALE`.\n\n- `SALE` and `DONATION` share the full contract: recipient, billing, shipping method,\n `buyer_shipping_price` and a `price_per_item` on every line. A donation is only\n different fiscally (the NF-e is issued with a donation purpose).\n- The four removal types (`REMOVE_STOCK`, `REMOVE_DAMAGED_STOCK`, `REMOVE_EXPIRED_STOCK`,\n `REMOVE_LOST_STOCK`) return stock to you. Cubbo synthesizes the recipient from the\n warehouse, the billing data from your store's fiscal registration and the shipping method\n from the warehouse's pickup method, so `shipping`, `billing`, `shipping_method_id` and\n `shipping_line_code` are optional and ignored. `price_per_item` becomes optional (falls back\n to the product's registered price), `quantity` must be at least 1, and you may hand in your\n own NF-e with `invoice_xml` or `client_invoice`.\n- `REMOVE_LOST_STOCK` is applied synchronously and all-or-nothing: units already recorded\n as lost are written off and the order comes back already `shipped`. It is available only\n to stores that have opted out of Cubbo issuing their removal NF-es (ask Cubbo support).\n- `STOCK_TRANSFER_OUT` is accepted by the parameter check but is reserved for Cubbo's\n stock-transfer feature; do not send it. `C2C` is refused.\n- Sale orders are validated asynchronously (CEP, CPF/CNPJ length, NCM, totals); check\n `status`, `has_missing_info` and `missing_info` on `GET /orders`.\n- Duplicate protection: an existing `order_number` in the store answers 422; a request still\n in progress for the same `order_number` answers 409 `DUPLICATE_REQUEST_IN_FLIGHT`.\n- Error bodies on this endpoint are `{\"error\": \"\u003cmessage>\"}` with no code, except removal\n orders that fail field validation, which return `{\"errors\": [...]}`.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /brazil/orders","href":"/api-reference/orders/create-an-order-for-a-brazil-store"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders","href":"/api-reference/orders/list-orders"},{"title":"Create an order","description":"Creates a sales order for a store whose warehouse is in Mexico, Colombia, Chile or the\nUnited States, and queues it for processing. Use it for every non-Brazil store; a store\nserved from a Brazil warehouse is refused and must use `POST /brazil/orders`. The request\nneeds a store, a unique `order_number` per store, a recipient address, at least one product\nline and a way to pick the carrier:\n\n- `shipping_line_code`: the exact name of a shipping method you created in the Cubbo app\n (**Integrations** > Open API > **Shipping Methods**). Cubbo picks the carrier with the\n configuration assigned to it.\n- `shipping_method_id`: a specific Cubbo shipping method, taken from the `shipping_method_id` of\n an option returned by `GET /shipping-methods/quote`.\n\n- The order is returned immediately in its initial status. Address, coverage, stock and\n carrier validations run asynchronously; poll `GET /orders` and read `status`,\n `has_missing_info` and `missing_info` to learn whether it was accepted.\n- Every product is identified by SKU. Without `channel_name`, an unknown SKU rejects the whole\n request with 422. With `channel_name` (an order relayed from a sales channel), the order is\n created anyway: a line whose SKU is unknown keeps that SKU without a product, and the\n response lists those SKUs in `warnings` with the code `UNIDENTIFIED_PRODUCT`. Processing\n then leaves the order with missing information (`status` `error`; with\n `include_event_history=true`, `GET /orders` shows the code `UNIDENTIFIED_PRODUCT` in the\n error event) until the product exists. Creating the product or adding the SKU to an\n existing product in the Cubbo app processes the order again and the line takes the\n product; creating it with `POST /products` without variants does not trigger that reprocess\n today.\n- A line sent without `price_per_item` takes the product's price. On a line whose SKU is\n unknown there is no product price yet, so the line counts as zero in the order total, and so\n does its discount; once the product exists, the line takes the product's price and the\n order total is recomputed (a kit without its own price is worth its components). A product\n price smaller than the line's discount is not taken. Discounts larger than what the\n products are worth are rejected with 422 `INVALID_PRODUCT_DISCOUNT`.\n- A `unit_code` sent on a line whose SKU is unknown is kept. The line must still have\n `quantity` 1, and one SKU cannot name the same code twice: otherwise the request is\n rejected with 422, as for a known SKU. The rest is checked once the product exists: if the\n line can never be fulfilled (a kit, or a product that does not track unit codes and has no\n unit carrying that code), the order waits with missing information, code\n `INVALID_UNIT_CODE_LINE`; two lines whose SKUs turn out to be the same product and name the\n same code give `DUPLICATE_UNIT_CODE` on the later line. Correct the line by editing the\n order in the Cubbo app; `PUT /orders/{id}` does not replace the products of an order with a\n pinned line.\n- `zip_code` is mandatory when the warehouse is in Mexico (and Brazil); it is optional for\n Chile and Colombia.\n- Chile: when `shipping.city` cannot be identified (a misspelling, or a province instead of a\n city), an order sent with `shipping_method_id` is not refused. It is created and moves to\n `error` until you correct `shipping.city` with `PUT /orders/{id}` or in\n the Cubbo app, where the order shows the reason. An order that ships on your own label (Blue\n Express EX, with the label attached) continues normally. A `shipping.city` that is identified\n but not covered by the method is still refused with 422.\n- Colombia: carriers deliver by the DANE (DIVIPOLA) code of the destination city. Cubbo finds it\n from `shipping.city` and `shipping.province`, or you send it in `shipping.city_code`: when\n present, the code decides the destination and the city and province are not looked up. A\n 5-digit code (a municipality) stands for its main town; an 8-digit code is a populated center;\n a code missing its leading zero (4 or 7 digits) is completed. An order whose\n `shipping.city_code` Cubbo does not know is not refused: the response lists it in `warnings`\n with the code `UNRECOGNIZED_CITY_CODE`, and the order moves to `error` with that code (the\n code you sent is in `additional_info.city_code`) until you correct it with `PUT /orders/{id}`. Without `city_code`, an order sent with\n `shipping_method_id` whose city and province cannot be identified is still refused with 422.\n- Duplicate protection: an `order_number` that already exists in the store answers 422 with\n code `ORDER_ALREADY_EXISTS` and the existing `order_id` in `context`. While another request\n for the same `store_id` + `order_number` is still being processed you get 409\n `DUPLICATE_REQUEST_IN_FLIGHT` with a `Retry-After` header; retry after that delay and you\n will converge on the real outcome (200, 422 or `ORDER_ALREADY_EXISTS`).\n- Complementary carrier services (`has_carrier_insurance`, `cod_amount`,\n `requires_document_return`, `requires_pickup_on_delivery`) are currently honoured only for\n stores with a warehouse in Chile; sending `true` (or a non-zero amount) from any other\n country is refused with a typed error code rather than silently ignored.\n- Click and collect: send `is_click_and_collect: true` and the `click_and_collect_service_code`\n you obtained from `GET /carrier-services/pickup-locations`. Cubbo replaces the shipping\n method you sent with the pickup carrier's method. A full shipping address is still required.\n- `is_b2b` only matters for stores enabled for both B2B and D2C (\"mixed\"); omit it to create a\n consumer (D2C) order. Stores enabled for a single model always get that model.\n- Error bodies on this endpoint carry an `error` message plus a machine-readable `code`\n (empty string or null when the error has no code) and an optional `context` object.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders","href":"/api-reference/orders/create-an-order"},{"title":"Update an order","deprecated":null,"version":null,"openapi":"/openapi.yaml put /orders/{id}","href":"/api-reference/orders/update-an-order"},{"title":"Update shipping contact and address fields","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}","href":"/api-reference/orders/update-shipping-contact-and-address-fields"},{"title":"Put an order on hold","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}/hold","href":"/api-reference/orders/put-an-order-on-hold"},{"title":"Release an order from hold","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}/unhold","href":"/api-reference/orders/release-an-order-from-hold"},{"title":"Upload shipping documents to an order","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}/upload-shipping-documents","href":"/api-reference/orders/upload-shipping-documents-to-an-order"},{"title":"Attach NF-e invoices issued through Cubbo's fiscal integration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{order_id}/attach-invoice","href":"/api-reference/orders/attach-nf-e-invoices-issued-through-cubbos-fiscal-integration"},{"title":"List orders waiting for an NF-e","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/awaiting-invoice","href":"/api-reference/orders/list-orders-waiting-for-an-nf-e"},{"title":"Cancel an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/cancel","href":"/api-reference/orders/cancel-an-order"},{"title":"Create a pick-and-ship order and buy its labels","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/create-and-ship","href":"/api-reference/orders/create-a-pick-and-ship-order-and-buy-its-labels"},{"title":"Delete an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/delete","href":"/api-reference/orders/delete-an-order"},{"title":"List orders with selected fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/with-fields","href":"/api-reference/orders/list-orders-with-selected-fields"}]},{"group":"Click and collect","pages":[{"title":"List pickup locations near a postal code (public)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /carrier-services/pickup-locations","href":"/api-reference/click-and-collect/list-pickup-locations-near-a-postal-code-public"},{"title":"Convert an order to click and collect","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{order_id}/convert-to-click-and-collect","href":"/api-reference/click-and-collect/convert-an-order-to-click-and-collect"},{"title":"List click-and-collect pickup points eligible for an order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{order_id}/pickup-points","href":"/api-reference/click-and-collect/list-click-and-collect-pickup-points-eligible-for-an-order"}]},{"group":"Inventory","pages":[{"title":"List products with stock","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory","href":"/api-reference/inventory/list-products-with-stock"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products","href":"/api-reference/inventory/create-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /products/{id}","href":"/api-reference/inventory/update-a-product"}]},{"group":"Lots","pages":[{"title":"List the lots of a product","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lots","href":"/api-reference/lots/list-the-lots-of-a-product"},{"title":"Put a lot on hold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots/hold/store/{store_id}","href":"/api-reference/lots/put-a-lot-on-hold"},{"title":"Release a lot from hold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots/unhold/store/{store_id}","href":"/api-reference/lots/release-a-lot-from-hold"},{"title":"Create a lot or update its expiration date","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots/upsert","href":"/api-reference/lots/create-a-lot-or-update-its-expiration-date"}]},{"group":"Shipping labels","pages":[{"title":"List an order's shipping labels","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{order_id}/shipping-labels","href":"/api-reference/shipping-labels/list-an-orders-shipping-labels"},{"title":"Get a shipping label","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-labels/{shipping_label_id}","href":"/api-reference/shipping-labels/get-a-shipping-label"}]},{"group":"Replenishments","pages":[{"title":"Create a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /replenishments","href":"/api-reference/replenishments/create-a-replenishment"},{"title":"Get a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /replenishments/{replenishment_id}","href":"/api-reference/replenishments/get-a-replenishment"},{"title":"Update a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /replenishments/{replenishment_id}","href":"/api-reference/replenishments/update-a-replenishment"},{"title":"Attach an NF-e issued through Cubbo's Brazilian invoicing provider","deprecated":null,"version":null,"openapi":"/openapi.yaml post /replenishments/{replenishment_id}/attach-invoice","href":"/api-reference/replenishments/attach-an-nf-e-issued-through-cubbos-brazilian-invoicing-provider"},{"title":"Record or clear an invoice issuing error","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /replenishments/{replenishment_id}/invoice-issuing-error","href":"/api-reference/replenishments/record-or-clear-an-invoice-issuing-error"},{"title":"Get the variance report of a replenishment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /replenishments/{replenishment_id}/variance-report","href":"/api-reference/replenishments/get-the-variance-report-of-a-replenishment"}]},{"group":"Reports","pages":[{"title":"Inventory transactions report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/inventory-transactions","href":"/api-reference/reports/inventory-transactions-report"}]},{"group":"Returns","pages":[{"title":"Request a return for a shipped order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns","href":"/api-reference/returns/request-a-return-for-a-shipped-order"},{"title":"Get a return","deprecated":null,"version":null,"openapi":"/openapi.yaml get /returns/{return_id}","href":"/api-reference/returns/get-a-return"},{"title":"Register the inbound NF-e issued for a return (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{return_id}/attach-invoice","href":"/api-reference/returns/register-the-inbound-nf-e-issued-for-a-return-brazil"},{"title":"Cancel a pending return","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /returns/{return_id}/cancel","href":"/api-reference/returns/cancel-a-pending-return"},{"title":"Decide what to do with an order returned by the carrier","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{return_id}/decision","href":"/api-reference/returns/decide-what-to-do-with-an-order-returned-by-the-carrier"},{"title":"List returns that still need an inbound NF-e (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /returns/awaiting-invoice","href":"/api-reference/returns/list-returns-that-still-need-an-inbound-nf-e-brazil"}]},{"group":"Shipping methods","pages":[{"title":"List active shipping methods available to a store","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-methods","href":"/api-reference/shipping-methods/list-active-shipping-methods-available-to-a-store"},{"title":"Check which shipping method a shipping configuration would select for a postcode","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-methods/configuration-coverage","href":"/api-reference/shipping-methods/check-which-shipping-method-a-shipping-configuration-would-select-for-a-postcode"},{"title":"Quote shipping options for a destination and package","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-methods/quote","href":"/api-reference/shipping-methods/quote-shipping-options-for-a-destination-and-package"}]},{"group":"Stores","pages":[{"title":"Update your own store","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /store","href":"/api-reference/stores/update-your-own-store"},{"title":"Upload the store's digital certificate and set NF-e numbering (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /store/digital-certificate","href":"/api-reference/stores/upload-the-stores-digital-certificate-and-set-nf-e-numbering-brazil"},{"title":"Provision the store's fiscal account (Brazil)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /store/fiscal-account","href":"/api-reference/stores/provision-the-stores-fiscal-account-brazil"},{"title":"Create a store from an existing one","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stores","href":"/api-reference/stores/create-a-store-from-an-existing-one"}]},{"group":"Webhooks","pages":[{"title":"Order status changed","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook orderUpdated","href":"/api-reference/webhooks/order-status-changed"},{"title":"Order shipped fulfilled","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook orderFulfilled","href":"/api-reference/webhooks/order-shipped-fulfilled"},{"title":"Carrier tracking status changed","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook shippingUpdated","href":"/api-reference/webhooks/carrier-tracking-status-changed"},{"title":"Inventory snapshot after a stock movement","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook inventoryMovement","href":"/api-reference/webhooks/inventory-snapshot-after-a-stock-movement"},{"title":"Replenishment announced","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook replenishmentCreated","href":"/api-reference/webhooks/replenishment-announced"},{"title":"Replenishment appointment booked or canceled","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook replenishmentScheduled","href":"/api-reference/webhooks/replenishment-appointment-booked-or-canceled"},{"title":"Replenishment status changed","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook replenishmentStatus","href":"/api-reference/webhooks/replenishment-status-changed"}]}]}]}]},"basePath":"","title":"List orders - Cubbo Developers","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}