Retrieve Sales Orders
GET
sales-orders
Retrieves a paginated list of all Sales Orders, optionally filtered and sorted. When additional results are available, the pagination object in the response payload provides a “nextUrl” that links to the next page of results.
Resource Information
| Method and URI | GET https://api.aps.autodesk.com/fusion-operations/v2/sales-orders |
| Authentication Context | No security required |
| Required OAuth Scopes | data:read data:write |
| Data Format | JSON |
Request
Headers
| Authorization* string | JWT Access Token |
* Required
Request
Query String Parameters
| filter[id] int | Filter Sales Orders matching the specified id. |
| filter[code] string | Filter Sales Orders matching the specified code. Pass the value as URL‑encoded. |
| filter[status] enum:string | Filter Sales Orders by status. When OPEN, returns open Sales Orders; when CLOSED, returns closed Sales Orders; when ARCHIVED, returns archived Sales Orders. If not provided, returns open Sales Orders. Accepts multiple values.
Possible values: OPEN, CLOSED, ARCHIVED |
| filter[createdAt] string | Filter Sales Orders by creation date. Accepts an ISO-8601 date or an inclusive date range in the format lowerValue..upperValue, lowerValue.., or ..upperValue. Returns Sales Orders created within the specified date or range. |
| filter[shipping.dueDate] string | Filter Sales Orders by shipping dueDate. Accepts an ISO-8601 date time or an inclusive date time range in the format lowerValue..upperValue, lowerValue.., or ..upperValue. Returns Sales Orders with shipping due dates within the specified date time or range. |
| filter[client.id] int | Filter Sales Orders by client id. |
| filter[client.code] string | Filter Sales Orders by client code. Pass the value as URL‑encoded. |
| filter[shipping.id] int | Filter Sales Orders by shipping id. |
| filter[shipping.code] string | Filter Sales Orders by shipping code. Multiple shippings can have the same code. Pass the value as URL‑encoded. |
| filter[product.id] int | Filter Sales Orders where at least one shipping contains the specified Product id. |
| filter[product.code] string | Filter Sales Orders where at least one shipping contains the specified Product code. Pass the value as URL‑encoded. |
| filter[createdBy] string | Filter Sales Orders created by integration name, if the Sales Order was created by an integration. Pass the value as URL‑encoded. |
| filter[withProductionOrders] | Filter Sales Orders by Production Orders created for each shipping.
Possible values: FOR_ALL_SHIPPINGS, FOR_SOME_SHIPPINGS, NO_PRODUCTION_ORDERS |
| limit int | Maximum number of results returned. Defaults to 25. |
| offset int | Page offset. Default value is 0. |
| sort string | Comma separated fields to sort items by. Fields: id, code, createdAt. Default: “createdAt desc”. |
Response
HTTP Status Code Summary
| 200 OK | A list of Sales Orders. |
| 400 Bad Request | Bad request due to invalid data. |
| 401 Unauthorized | The access token is invalid. It may have either expired or may not be a three-legged access token. Please verify the token and retry the request. |
| 403 Forbidden | The request was successfully validated but lacked required permission. Please verify your token permissions and retry the request. |
| 429 Too Many Requests | Rate limit exceeded; wait some time before retrying. |
| 500 Internal Server Error | An unknown server-side error occurred. Please try again later. If the problem persists, please contact support. |
Response
Header (429)
| Retry-After integer | The number of seconds to wait before retrying the request. |
Response
Body Structure (200)
Expand all
| results array: object | List of Sales Orders |
| id int | Unique identifier of the Sales Order. |
| code string | Sales Order code
Max length: 255 |
| client | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| billingAddress | Billing address for the Sales Order. Must be an address linked to the client. If not provided, the default billing address of the client will be used. |
| anyOf | Billing address for the Sales Order. Must be an address linked to the client. If not provided, the default billing address of the client will be used. |
| 0 object | |
| id int | Unique identifier of the address. |
| code string | Address code
Max length: 255 |
| name string | Address name
Max length: 255 |
| city string | Address city
Max length: 255 |
| street string | Address street |
| postalCode string | Address postal code |
| state string | Address state
Max length: 255 |
| country string | Address country (ISO 3166-1 alpha-2 code) |
| default boolean | Is default address |
| 1 all of | |
| 0 | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| createdAt datetime: ISO 8601 | Creation date of the Sales Order (e.g. 2025-06-21T14:07:17Z) |
| createdBy string | Name of the integration if the Sales Order was created by an integration
Max length: 255 |
| carrier string | Code of the carrier handling the shipping
Max length: 255 |
| trackingNumber string | Max length: 255 |
| price number | |
| tax number | |
| observations string | Max length: 4000 |
| notes string | Max length: 5000 |
| externalNotes string | Max length: 5000 |
| status enum:string | Possible values: OPEN, CLOSED, ARCHIVED |
| shipped boolean | |
| shippings array: object | |
| id int | Unique identifier of the shipping. |
| code string | Shipping number
Max length: 255 |
| dueDate datetime: ISO 8601 | Shipping due date (e.g. 2025-06-21T14:07:17Z) |
| requestedDate datetime: ISO 8601 | Shipping requested date (e.g. 2025-06-21T14:07:17Z) |
| deliveryAddress | |
| anyOf | |
| 0 object | |
| id int | Unique identifier of the address. |
| code string | Address code
Max length: 255 |
| name string | Address name
Max length: 255 |
| city string | Address city
Max length: 255 |
| street string | Address street |
| postalCode string | Address postal code |
| state string | Address state
Max length: 255 |
| country string | Address country (ISO 3166-1 alpha-2 code) |
| default boolean | Is default address |
| shippingPrice number | |
| price number | |
| site | Site associated with the Shipping. |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | Site associated with the Shipping. |
| 0 | |
| 1 | |
| products array: object | |
| id int | Unique identifier of the shipping product. |
| product | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| variableParameters array: object | |
| name string | |
| value string | |
| quantityOrdered number | |
| price number | |
| observations string | Max length: 2000 |
| trackingNumber string | Max length: 255 |
| tax number | |
| discount number | |
| quote | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| parameters array: object | |
| name string | |
| value string | |
| pagination object | |
| limit int | Maximum number of results returned in this page. |
| offset int | Number of results skipped before this page. |
| nextUrl string | URL for the next page of results. Null when there are no additional pages. |
Example
A list of Sales Orders.
Request
curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/sales-orders' \
-H 'Authorization: '
Response
{
"results": [
{
"id": 382,
"code": "SO-1001",
"client": {
"id": 12,
"code": "ClientA",
"name": "Client A"
},
"billingAddress": {
"id": 1,
"code": "Address code 1",
"name": "Address name 1",
"city": "City 1",
"street": "Street 1",
"postalCode": "12345",
"state": "State 1",
"country": "PT"
},
"createdAt": "2024-04-01T10:00:00Z",
"createdBy": "MyShopIntegration",
"carrier": "carrier_com",
"trackingNumber": "TRACK123456",
"price": 81.64,
"tax": 5.3,
"observations": "Please deliver between 9 AM and 5 PM.",
"notes": "Handle with care.",
"externalNotes": "Urgent delivery.",
"status": "OPEN",
"shipped": false,
"shippings": [
{
"id": 78,
"code": "Shipping001",
"dueDate": "2024-04-10T10:00:00Z",
"requestedDate": "2024-04-05T10:00:00Z",
"deliveryAddress": {
"id": 1,
"code": "Address code 1",
"name": "Address name 1",
"city": "City 1",
"street": "Street 1",
"postalCode": "12345",
"state": "State 1",
"country": "PT",
"default": true
},
"shippingPrice": 25.24,
"price": 51.1,
"products": [
{
"id": 1,
"product": {
"id": 21,
"code": "ProductA",
"name": "Product A 204"
},
"quantityOrdered": 1,
"price": 50.0,
"observations": "First product observation.",
"trackingNumber": "TRACKPROD1",
"tax": 6.1,
"discount": 5.0
}
],
"site": {
"id": 12,
"code": "SITE-01"
}
}
],
"quote": {
"id": 55,
"code": "QUOTE-2024-001"
},
"parameters": [
{
"name": "Voltage",
"value": "220V"
}
]
},
{
"id": 605,
"code": "SO-1009",
"client": {
"id": 12,
"code": "ClientN",
"name": "Client Name"
},
"billingAddress": {
"id": 1,
"code": "Address code 1",
"name": "Address name 1",
"city": "Rome",
"street": "Street 5",
"postalCode": "9874",
"state": "State 1",
"country": "IT"
},
"createdAt": "2024-04-01T10:00:00Z",
"createdBy": "MyShopIntegration",
"carrier": "carrier_com",
"trackingNumber": "TRACK123456",
"price": 42.6,
"tax": 0,
"observations": "Please deliver between 9 AM and 5 PM.",
"notes": "Handle with care.",
"externalNotes": "Urgent delivery.",
"status": "OPEN",
"shipped": false,
"shippings": [
{
"code": "Shipping001",
"dueDate": "2024-04-10T10:00:00Z",
"requestedDate": "2024-04-05T10:00:00Z",
"deliveryAddress": {
"id": 1,
"code": "Address code 1",
"name": "Address name 1",
"city": "City 1",
"street": "Street 1",
"postalCode": "12345",
"state": "State 1",
"country": "PT",
"default": true
},
"shippingPrice": 2.5,
"price": 40.1,
"products": [
{
"id": 2,
"product": {
"id": 21,
"code": "ProductA",
"name": "Product A 204"
},
"quantityOrdered": 2,
"price": 20.05,
"observations": "First product observation.",
"trackingNumber": "TRACKPROD1",
"tax": 0,
"discount": 0
}
]
}
],
"parameters": []
}
],
"pagination": {
"limit": 20,
"offset": 0,
"nextUrl": null
}
}
Show More