Use the following endpoints to retrieve all or filtered purchase orders.
Note:
If your purchase order is created from an integrated supplier then you will get an integrated_supplier_id
instead of a supplier_id
in the response payload. The integrated_supplier_id
actually maps to another Site rather than a Supplier.
GET /v1/companies/1234/purchase_orders |
|
GET /v1/companies/1234/purchase_orders/received |
|
GET /v1/companies/1234/purchase_orders/placed |
|
GET /v1/companies/1234/sites/456/purchase_orders |
|
GET /v1/companies/1234/suppliers/789/purchase_orders |
|
GET /v1/companies/1234/purchase_orders ?created_gte=2017-04-05T10:00:00 |
|
GET /v1/companies/1234/purchase_orders ?created_lte=2017-04-05T10:00:00 |
|
GET /v1/companies/1234/purchase_orders ?received_gte=2017-04-05T10:00:00 |
|
GET /v1/companies/1234/purchase_orders ?received_lte=2017-04-05T10:00:00 |
created_gte
,
created_lte
, placed_lte
,
placed_gte
, received_lte
or
received_gte
the date must be in ISO 8601 format.
created_gte
,
created_lte
, placed_lte
,
placed_gte
, received_lte
and
received_gte
are accepted.
Note:
If your purchase order is created from an integrated supplier then you will get an integrated_supplier_id
instead of a supplier_id
in the supplier object. The integrated_supplier_id
actually maps to another Site rather than a Supplier.
GET /v1/companies/123/sites/456/purchase_orders/78 |
Here is a list of the supported webhook topics.
When a purchase order is marked as cancelled. You will receive the complete purchase order.
When a purchase order is deleted. You will receive the
complete purchase order.
Note that you will receive the last state of the purchase order with "deleted": true
.
When a purchase order is marked as delivered. You will receive the complete purchase order.
When a purchase order is created as a draft. You will receive the complete purchase order.
When a purchase order is marked as placed. You will receive the complete purchase order.
When a purchase order is marked as received. You will receive the complete purchase order.