The Purchase Order Status resource provides read-only access to purchase order status records filtered by PO number, supplier/OEM order ID, or date range.
The following are the endpoints that return Purchase Order Status Payload items:
Endpoints
Purchase Order Status by PO Number
GET https://api.withordersync.com/api/v2/orders/by-po/:po_number
Authentication Header
"X-API-Key: pk_live_your_api_key"
Note: The API key ensures the returned records only belong to the retailer under which the key was created.
Parameters
Name | Type | Description |
po_number | string | PO Number of the purchase order fulfilled by OrderSync. |
Returns
Returns one Purchase Order Status Payload record belonging to the retailer that match the provided PO number. This record will contain multiple Purchase Order Line Status items, one for each item ordered under the same PO number.
Examples
Request
curl "https://api.withordersync.com/api/v2/orders/by-po/AB12345" \
-H "X-API-Key: pk_live_..."
Response
{
"data": [
{
"po_number": "XXXXXX",
"order_date": "2026-00-00T00:00:00.000+00:00",
"request_date": "2026-00-00T00:00:00.000+00:00",
"status": "in transit",
"customer_name": "Tom Thomas",
"shipping_address": "1600 Glen Road, Town, USA",
"suppliers": [
"Taylormade Golf"
],
"total": 850.00,
"quantity": 1,
"items": [
{
"supplier_order_id": "12548686",
"product_name": "Qi Max Iron Irons",
"product_details": {
"description": "Custom.Qi Max Iron"
...
},
"quantity": 1,
"status": "in transit",
"supplier_name": "Taylormade Golf",
"total": 850.00,
"estimated_delivery_date": "00/00/2026",
"tracking": {
"tracking_number": "11111111111",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=US&language=English&tracknumbers=11111111111",
"carrier": "fedex",
"shipped_date": "2026-00-00T00:00:00.000000+00:00",
"latest_checkpoint": {
"message": "Shipment arriving On-Time",
"location": "PLACE, US, United States",
"timestamp": "2026-00-00T00:00:00-00:00"
}
}
}
],
"fulfilled_items": [
{
"product_name": "QI MAX",
"supplier_name": "Taylormade Golf"
}
],
"drop_ship": false
}
],
"meta": {
"total": 1,
"page": 1,
"limit": 1,
"has_more": false
}
}
Order Status by PO Number (Bulk)
POST https://api.withordersync.com/api/v2/orders/by-po-numbers
Authentication Header
"X-API-Key: pk_live_your_api_key"
Note: The API key ensures the returned records only belong to the retailer under which the key was created.
Body
The request body must be a JSON object with the following property:
Name | Type | Description |
po_numbers | string array | An array of PO Numbers of orders fulfilled by OrderSync.
Limit: 100 PO Numbers per request |
Returns
Returns one or more Purchase Order Status Payload records belonging to the retailer that match the provided PO numbers.
Examples
Request
curl -X POST https://api.withordersync.com/api/v2/orders/by-po-numbers \
-H "X-API-Key: pk_live_..." \
-H "Content-Type: application/json" \
-d '{
"po_numbers": [
"PO123",
"PO456",
"PO789"
]
}'
Response
{
"data": [
{
"po_number": "XXXXXX",
"order_date": "2026-00-00T00:00:00.000+00:00",
"request_date": "2026-00-00T00:00:00.000+00:00",
"status": "in transit",
"customer_name": "Tom Thomas",
"shipping_address": "1600 Glen Road, Town, USA",
"suppliers": [
"Taylormade Golf"
],
"total": 850.00,
"quantity": 1,
"items": [
{
"supplier_order_id": "12548686",
"product_name": "Qi Max Iron Irons",
"product_details": {
"description": "Custom.Qi Max Iron"
...
},
"quantity": 1,
"status": "in transit",
"supplier_name": "Taylormade Golf",
"total": 850.00,
"estimated_delivery_date": "00/00/2026",
"tracking": {
"tracking_number": "11111111111",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=US&language=English&tracknumbers=11111111111",
"carrier": "fedex",
"shipped_date": "2026-00-00T00:00:00.000000+00:00",
"latest_checkpoint": {
"message": "Shipment arriving On-Time",
"location": "PLACE, US, United States",
"timestamp": "2026-00-00T00:00:00-00:00"
}
}
}
],
"fulfilled_items": [
{
"product_name": "QI MAX",
"supplier_name": "Taylormade Golf"
}
],
"drop_ship": false
},
{
"po_number": "YYYYYY",
"order_date": "2026-00-00T00:00:00.000+00:00",
"request_date": "2026-00-00T00:00:00.000+00:00",
"status": "in transit",
"customer_name": "Tom Thomas",
"shipping_address": "1600 Glen Road, Town, USA",
"suppliers": [
"Taylormade Golf"
],
"total": 850.00,
"quantity": 1,
"items": [
{
"supplier_order_id": "12548686",
"product_name": "Qi Max Iron Irons",
"product_details": {
"description": "Custom.Qi Max Iron"
...
},
"quantity": 1,
"status": "in transit",
"supplier_name": "Taylormade Golf",
"total": 850.00,
"estimated_delivery_date": "00/00/2026",
"tracking": {
"tracking_number": "11111111111",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=US&language=English&tracknumbers=11111111111",
"carrier": "fedex",
"shipped_date": "2026-00-00T00:00:00.000000+00:00",
"latest_checkpoint": {
"message": "Shipment arriving On-Time",
"location": "PLACE, US, United States",
"timestamp": "2026-00-00T00:00:00-00:00"
}
}
}
],
"fulfilled_items": [
{
"product_name": "QI MAX",
"supplier_name": "Taylormade Golf"
}
],
"drop_ship": false
},
...
],
"meta": {
"total": 10,
"page": 1,
"limit": 10,
"has_more": false
}
}Note: Since the limit of the number of PO numbers that can be requested in the Order Status by PO Number (Bulk) endpoint is 100, this endpoint will always return all requested Purchase Order Status records in one page. In other words, for this endpoint, "has_more" will always be false.
Order Status by Supplier Order ID
GET https://api.withordersync.com/api/v2/orders/by-supplier-order/:supplier_order_id
Authentication Header
"X-API-Key: pk_live_your_api_key"
Note: The API key ensures the returned records only belong to the retailer under which the key was created.
Parameters
Name | Type | Description |
supplier_order_id | string | Order ID assigned by the supplier/OEM to this order. |
Returns
Returns one or more Purchase Order Status Payload records belonging to the retailer that match the provided supplier order ID.
Examples
Request
curl "https://api.withordersync.com/api/v2/orders/by-supplier-order/FD123456" \
-H "X-API-Key: pk_live_..."
Response
{
"data": [
{
"po_number": "XXXXXX",
"order_date": "2026-00-00T00:00:00.000+00:00",
"request_date": "2026-00-00T00:00:00.000+00:00",
"status": "in transit",
"customer_name": "Tom Thomas",
"shipping_address": "1600 Glen Road, Town, USA",
"suppliers": [
"Taylormade Golf"
],
"total": 850.00,
"quantity": 1,
"items": [
{
"supplier_order_id": "12548686",
"product_name": "Qi Max Iron Irons",
"product_details": {
"description": "Custom.Qi Max Iron"
...
},
"quantity": 1,
"status": "in transit",
"supplier_name": "Taylormade Golf",
"total": 850.00,
"estimated_delivery_date": "00/00/2026",
"tracking": {
"tracking_number": "11111111111",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=US&language=English&tracknumbers=11111111111",
"carrier": "fedex",
"shipped_date": "2026-00-00T00:00:00.000000+00:00",
"latest_checkpoint": {
"message": "Shipment arriving On-Time",
"location": "PLACE, US, United States",
"timestamp": "2026-00-00T00:00:00-00:00"
}
}
}
],
"fulfilled_items": [
{
"product_name": "QI MAX",
"supplier_name": "Taylormade Golf"
}
],
"drop_ship": false
}
],
"meta": {
"total": 1,
"page": 1,
"limit": 1,
"has_more": false
}
}
Note: A single Purchase Order (PO number) may contain items from different suppliers (and therefore different supplier order IDs), as well as have lines with different supplier order IDs under the same PO number.
Order Status by Date Range
GET https://api.withordersync.com/api/v2/orders/by-date?start_date=:start_date&end_date=:end_date&page=:page&limit=:limit
Authentication Header
"X-API-Key: pk_live_your_api_key"
Note: The API key ensures the returned records only belong to the retailer under which the key was created.
Query Parameters
Name | Type | Description |
start_date | string | Start date string to load orders from, in the format: "YYYY-MM-DD"
|
end_date | string (optional) | End date string to load orders to, in the format: "YYYY-MM-DD" If the end date it omitted, it will default to be the start date, which will load orders for one day.
Default value: start_date |
page | number (optional) | Page number of order records to load.
Default value: 1 |
limit | number (optional) | Limit the number of results in this request to this number.
Default value: 50 Max value: 100 |
Returns
Returns all Purchase Order Status Payload records that have order dates within the provided date range. If only a start date is provided, returns all Purchase Order Status Payload records for that day.
Examples
Request
curl "https://api.withordersync.com/api/v2/orders/by-date?start_date=2025-12-05&end_date=2025-12-06&limit=10&page=2" \
-H "X-API-Key: pk_live_..."
Response
{
"data": [
{
"po_number": "XXXXXX",
"order_date": "2026-00-00T00:00:00.000+00:00",
"request_date": "2026-00-00T00:00:00.000+00:00",
"status": "in transit",
"customer_name": "Tom Thomas",
"shipping_address": "1600 Glen Road, Town, USA",
"suppliers": [
"Taylormade Golf"
],
"total": 850.00,
"quantity": 1,
"items": [
{
"supplier_order_id": "12548686",
"product_name": "Qi Max Iron Irons",
"product_details": {
"description": "Custom.Qi Max Iron"
...
},
"quantity": 1,
"status": "in transit",
"supplier_name": "Taylormade Golf",
"total": 850.00,
"estimated_delivery_date": "00/00/2026",
"tracking": {
"tracking_number": "11111111111",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=US&language=English&tracknumbers=11111111111",
"carrier": "fedex",
"shipped_date": "2026-00-00T00:00:00.000000+00:00",
"latest_checkpoint": {
"message": "Shipment arriving On-Time",
"location": "PLACE, US, United States",
"timestamp": "2026-00-00T00:00:00-00:00"
}
}
}
],
"fulfilled_items": [
{
"product_name": "QI MAX",
"supplier_name": "Taylormade Golf"
}
],
"drop_ship": false
},
{
"po_number": "YYYYYY",
"order_date": "2026-00-00T00:00:00.000+00:00",
"request_date": "2026-00-00T00:00:00.000+00:00",
"status": "in transit",
"customer_name": "Tom Thomas",
"shipping_address": "1600 Glen Road, Town, USA",
"suppliers": [
"Taylormade Golf"
],
"total": 850.00,
"quantity": 1,
"items": [
{
"supplier_order_id": "12548686",
"product_name": "Qi Max Iron Irons",
"product_details": {
"description": "Custom.Qi Max Iron"
...
},
"quantity": 1,
"status": "in transit",
"supplier_name": "Taylormade Golf",
"total": 850.00,
"estimated_delivery_date": "00/00/2026",
"tracking": {
"tracking_number": "11111111111",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=US&language=English&tracknumbers=11111111111",
"carrier": "fedex",
"shipped_date": "2026-00-00T00:00:00.000000+00:00",
"latest_checkpoint": {
"message": "Shipment arriving On-Time",
"location": "PLACE, US, United States",
"timestamp": "2026-00-00T00:00:00-00:00"
}
}
}
],
"fulfilled_items": [
{
"product_name": "QI MAX",
"supplier_name": "Taylormade Golf"
}
],
"drop_ship": false
},
...
],
"meta": {
"total": 50,
"page": 2,
"limit": 50,
"has_more": true
}
}