STstuut
sales-orders

Get Sales Orders

List Sales Orders

Retrieve a paginated list of sales orders with filtering and sorting.

get/v2/sales-orders

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, 0 indexed.

limitinteger

Number of records per page.

sort_by'default' | 'total_amount' | 'issue_date' | 'requested_delivery_date' | 'number'
sort_order'asc' | 'desc'
status__inSalesOrderStatus[] nullable

Filter by sales order status

customer_idstring nullable

Filter by exact customer (obligor) ID

partner_id__instring[] nullable

Filter by partner ID (any of)

assignee_idstring nullable

Filter by the customer's assignee ID. Pass an empty string to filter for customers with no assignee.

assignee_id__instring[] nullable

Filter by customer assignee ID (any of)

assignee_id__ninstring[] nullable

Exclude customer assignee ID (any of)

number
OR
string decimal
number
OR
string decimal
issue_date_gtestring date nullable

Issued on or after

issue_date_ltestring date nullable

Issued on or before

searchstring nullable

Search in sales order number, customer name, and customer account number

Response

Successful Response

current_pageinteger required

The current page.

total_recordsinteger nullable required

Total number of records.

next_pageinteger nullable required

The next page number, if one exists.

Changes

No recorded changes to this operation across all 1 revision of this API.