Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

An API token from Sign in, sent as Authorization: Bearer <token>. Tokens last 30 days.

Query Parameters

include
string

Comma-separated list of relationships to include.

Available options: partner, partnerInvoice, partnerShipping, user, team, company, currency, paymentTerm, fiscalPosition, journal, campaign, utmSource, medium, warehouse, lines, lines.product, lines.linkedSaleOrderSale, lines.uom, lines.productPackaging, lines.currency, lines.orderPartner, lines.salesman, lines.warehouse, lines.route, lines.company

Example:

"partner,lines"

filter[id]
string

Comma-separated list of IDs to filter by

filter[state]
enum<string>

Filter by state

Available options:
draft,
sent,
sale,
cancel
filter[partner_id]
string

Comma-separated list of partner IDs to filter by

filter[trashed]
string

Filter by trashed status.

Available options: with, only

Example:

"with"

sort
string
required

Sort field

Example:

"-created_at"

page
integer
required

Page number

Example:

1

Response

Success