Retrieve Purchase Orders
GET
purchase-orders
Retrieves a paginated list of all Purchase 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/purchase-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 Purchase Orders matching the specified id. |
| filter[code] string | Filter Purchase Orders matching the specified code. Pass the value as URL‑encoded. |
| filter[createdAt] string | Filter Purchase Orders by creation date. Accepts an ISO-8601 date or an inclusive date range in the format lowerValue..upperValue, lowerValue.., or ..upperValue. Returns Purchase Orders created within the specified date or range. |
| filter[receiving.dueDate] string | Filter Purchase Orders by receiving dueDate. Accepts an ISO-8601 date time or an inclusive date time range in the format lowerValue..upperValue, lowerValue.., or ..upperValue. Returns Purchase Orders with receiving due dates within the specified date time or range. |
| filter[receiving.requestedDate] string | Filter Purchase Orders by receiving requestedDate. Accepts an ISO-8601 date time or an inclusive date time range in the format lowerValue..upperValue, lowerValue.., or ..upperValue. Returns Purchase Orders with receiving requested dates within the specified date time or range. |
| filter[supplier.id] int | Filter Purchase Orders by the Supplier id. |
| filter[supplier.code] string | Filter Purchase Orders by Supplier code. Pass the value as URL‑encoded. |
| filter[receiving.id] int | Filter Purchase Orders by receiving id. |
| filter[receiving.code] string | Filter Purchase Orders by receiving code. Pass the value as URL‑encoded. |
| filter[deliveryAddress.id] int | Filter Purchase Orders by delivery address id. |
| filter[deliveryAddress.code] string | Filter Purchase Orders by delivery address code. Pass the value as URL‑encoded. |
| filter[product.id] int | Filter Purchase Orders where at least one receiving contains the specified Product id. |
| filter[product.code] string | Filter Purchase Orders where at least one receiving contains the specified Product code. Pass the value as URL‑encoded. |
| filter[productFamily.id] int | Filter Purchase Orders where at least one receiving contains a Product of the specified Product Family id. |
| filter[productFamily.code] string | Filter Purchase Orders where at least one receiving contains a Product of the specified Product Family code. Pass the value as URL‑encoded. |
| filter[approvalStatus] | Filter Purchase Orders by approval status.
Possible values: PENDING, APPROVED, REJECTED |
| filter[status] enum:string | Filter Purchase Orders by status. When OPEN, returns open Purchase Orders; when CLOSED, returns closed Purchase Orders; when ARCHIVED, returns archived Purchase Orders. If not provided, returns open Purchase Orders. Accepts multiple values.
Possible values: OPEN, CLOSED, ARCHIVED |
| filter[active] boolean | Filters active Purchase Orders in the tablet. When true, it returns active Purchase Orders; when false, it returns inactive Purchase Orders; when null, it returns all Purchase 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 Purchase 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 Purchase Orders |
| id int | Unique identifier of the Purchase Order. |
| code string | Purchase Order code
Max length: 255 |
| supplier | |
| 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 Purchase Order. Must be one of the company addresses. If not provided, the default company address will be used. |
| anyOf | Billing address for the Purchase Order. Must be one of the company addresses. If not provided, the default company address 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 Purchase Order (e.g. 2025-06-21T14:07:17Z) |
| cost number | |
| approvalStatus enum:string | Possible values: DRAFT, IN_REVIEW, APPROVED, CONFIRMED, REJECTED |
| documentStatus enum:string | Possible values: NONE, INQUIRE, ORDER, RECEIPT, INVOICE |
| observations string | Max length: 4000 |
| parameters array: object | |
| name string | |
| value string | |
| notes string | Max length: 5000 |
| externalNotes string | Max length: 5000 |
| status enum:string | Possible values: OPEN, CLOSED, ARCHIVED |
| active boolean | Indicates if the Purchase Order is visible in the tablet |
| receivings array: object | |
| id int | Unique identifier of the receiving. |
| code string | Receiving number
Max length: 255 |
| dueDate datetime: ISO 8601 | Receiving due date (e.g. 2025-06-21T14:07:17Z) |
| requestedDate datetime: ISO 8601 | Receiving 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 |
| shippingCost number | |
| cost number | |
| tax number | |
| products array: object | |
| id int | Unique identifier of the receiving 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 | |
| unitOfMeasurement | |
| 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 | |
| cost number | |
| observations string | Max length: 2000 |
| tax number | |
| 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 Purchase Orders.
Request
curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/purchase-orders' \
-H 'Authorization: '
Response
{
"results": [
{
"id": 382,
"code": "PO-1001",
"supplier": {
"id": 12,
"code": "SupplierA",
"name": "Supplier 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",
"cost": 81.64,
"approvalStatus": "IN_REVIEW",
"documentStatus": "INQUIRE",
"observations": "Please deliver between 9 AM and 5 PM.",
"parameters": [
{
"name": "Voltage",
"value": "220V"
}
],
"notes": "Handle with care.",
"externalNotes": "Urgent delivery.",
"status": "OPEN",
"active": false,
"receivings": [
{
"id": 5,
"code": "Receiving001",
"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
},
"shippingCost": 25.24,
"cost": 51.1,
"tax": 5.3,
"products": [
{
"id": 1,
"product": {
"id": 21,
"code": "ProductA",
"name": "Product A 204"
},
"parameters": [
{
"name": "Color",
"value": "Red"
}
],
"quantityOrdered": 1,
"unitOfMeasurement": {
"id": 4,
"code": "pcs",
"name": "pieces"
},
"cost": 50.0,
"observations": "First product observation.",
"tax": 6.1
}
]
}
]
},
{
"id": 424,
"code": "PO-1002",
"supplier": {
"id": 12,
"code": "SupplierA",
"name": "Supplier 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",
"cost": 10.64,
"approvalStatus": "CONFIRMED",
"documentStatus": "INVOICE",
"observations": "Please deliver between 9 AM and 5 PM.",
"parameters": [
{
"name": "Voltage",
"value": "220V"
}
],
"notes": "Handle with care.",
"externalNotes": "Urgent delivery.",
"status": "OPEN",
"active": false,
"receivings": [
{
"id": 5,
"code": "Receiving001",
"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
},
"shippingCost": 25.24,
"cost": 51.1,
"tax": 5.3,
"products": [
{
"id": 1,
"product": {
"id": 21,
"code": "ProductA",
"name": "Product A 204"
},
"parameters": [
{
"name": "Color",
"value": "Red"
}
],
"quantityOrdered": 1,
"unitOfMeasurement": {
"id": 4,
"code": "pcs",
"name": "pieces"
},
"cost": 50.0,
"observations": "First product observation.",
"tax": 6.1
}
]
}
]
}
],
"pagination": {
"limit": 20,
"offset": 0,
"nextUrl": null
}
}
Show More