The Order Status resource provides read-only access to order status records filtered by PO number, supplier/OEM order ID, or date range.
The following are the endpoints that return Order Status Payload items:
Endpoints
Order Status by PO Number
GET https://api.withordersync.com/api/v1/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 order fulfilled by OrderSync. |
Returns
Returns one or more Order Status Payload records belonging to the retailer that match the provided PO number.
Examples
Request
curl "https://api.withordersync.com/api/v1/orders/by-po/AB12345" \
-H "X-API-Key: pk_live_..."
Response
{
"data": [
{
"order_id": "abcd12345678",
"order_status_id": "aabbccdd12345678",
"supplier_order_id": "FD123456",
"order_date": "2025-12-03T09:35:23.961116+00:00",
"po_number": "AB12345",
"item": "Cobra DS Adapt",
"customer": "Tom Thomas",
"supplier": "cobra puma golf",
"status": "delivered",
"customer_email": "tt@gmail.com",
"tracking_number": "12345678",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=12345678&cntry_code=US",
"carrier": "fedex",
"delivery_date": "2025-12-09T13:05:00-08:00"
},
{
"order_id": "xyz12345678",
"order_status_id": "xxyyzz12345678",
"supplier_order_id": "FD123456",
"order_date": "2025-12-03T09:35:23.961116+00:00",
"po_number": "AB12345",
"item": "2025 Cobra DS Adapt 7",
"customer": "Tom Thomas",
"supplier": "cobra puma golf",
"status": "delivered",
"customer_email": "tt@gmail.com",
"tracking_number": "12345678",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=12345678&cntry_code=US",
"carrier": "fedex",
"delivery_date": "2025-12-09T13:05:00-08:00"
},
...
],
"meta": {
"total": 8,
"page": 1,
"limit": 8,
"has_more": false
}
}
Order Status by PO Number (Bulk)
POST https://api.withordersync.com/api/v1/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 Order Status Payload records belonging to the retailer that match the provided PO numbers.
Examples
Request
curl -X POST https://api.withordersync.com/api/v1/orders/by-po-numbers \
-H "X-API-Key: pk_live_..." \
-H "Content-Type: application/json" \
-d '{
"po_numbers": [
"PO123",
"PO456",
"PO789"
]
}'
Response
{
"data": [
{
"order_id": "abcd12345678",
"order_status_id": "aabbccdd12345678",
"supplier_order_id": "FD123456",
"order_date": "2025-12-03T09:35:23.961116+00:00",
"po_number": "AB12345",
"item": "Cobra DS Adapt",
"customer": "Tom Thomas",
"supplier": "cobra puma golf",
"status": "delivered",
"customer_email": "tt@gmail.com",
"tracking_number": "12345678",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=12345678&cntry_code=US",
"carrier": "fedex",
"delivery_date": "2025-12-09T13:05:00-08:00"
},
{
"order_id": "xyz12345678",
"order_status_id": "xxyyzz12345678",
"supplier_order_id": "FD123456",
"order_date": "2025-12-03T09:35:23.961116+00:00",
"po_number": "AB12345",
"item": "2025 Cobra DS Adapt 7",
"customer": "Tom Thomas",
"supplier": "cobra puma golf",
"status": "delivered",
"customer_email": "tt@gmail.com",
"tracking_number": "12345678",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=12345678&cntry_code=US",
"carrier": "fedex",
"delivery_date": "2025-12-09T13:05:00-08:00"
},
...
],
"meta": {
"total": 8,
"page": 1,
"limit": 8,
"has_more": false
}
}
Order Status by Supplier Order ID
GET https://api.withordersync.com/api/v1/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 Order Status Payload records belonging to the retailer that match the provided supplier order ID.
Examples
Request
curl "https://api.withordersync.com/api/v1/orders/by-supplier-order/FD123456" \
-H "X-API-Key: pk_live_..."
Response
{
"data": [
{
"order_id": "abcd12345678",
"order_status_id": "aabbccdd12345678",
"supplier_order_id": "FD123456",
"order_date": "2025-12-03T09:35:23.961116+00:00",
"po_number": "AB12345",
"item": "Cobra DS Adapt",
"customer": "Tom Thomas",
"supplier": "cobra puma golf",
"status": "delivered",
"customer_email": "tt@gmail.com",
"tracking_number": "12345678",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=12345678&cntry_code=US",
"carrier": "fedex",
"delivery_date": "2025-12-09T13:05:00-08:00"
},
{
"order_id": "xyz12345678",
"order_status_id": "xxyyzz12345678",
"supplier_order_id": "FD123456",
"order_date": "2025-12-03T09:35:23.961116+00:00",
"po_number": "AB12345",
"item": "2025 Cobra DS Adapt 7",
"customer": "Tom Thomas",
"supplier": "cobra puma golf",
"status": "delivered",
"customer_email": "tt@gmail.com",
"tracking_number": "12345678",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=12345678&cntry_code=US",
"carrier": "fedex",
"delivery_date": "2025-12-09T13:05:00-08:00"
},
...
],
"meta": {
"total": 8,
"page": 1,
"limit": 8,
"has_more": false
}
}
Order Status by Date Range
GET https://api.withordersync.com/api/v1/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 Order Status Payload records that have order dates within the provided date range. If only a start date is provided, returns all Order Status Payload records for that day.
Examples
Request
curl "https://api.withordersync.com/api/v1/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": [
{
"order_id": "abcd12345678",
"order_status_id": "aabbccdd12345678",
"supplier_order_id": "FD123456",
"order_date": "2025-12-05T09:35:23.961116+00:00",
"po_number": "AB12345",
"item": "Cobra DS Adapt",
"customer": "Tom Thomas",
"supplier": "cobra puma golf",
"status": "delivered",
"customer_email": "tt@gmail.com",
"tracking_number": "12345678",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=12345678&cntry_code=US",
"carrier": "fedex",
"delivery_date": "2025-12-09T13:05:00-08:00"
},
{
"order_id": "xyz12345678",
"order_status_id": "xxyyzz12345678",
"supplier_order_id": "FD123456",
"order_date": "2025-12-05T09:35:23.961116+00:00",
"po_number": "AB12345",
"item": "2025 Cobra DS Adapt 7",
"customer": "Tom Thomas",
"supplier": "cobra puma golf",
"status": "delivered",
"customer_email": "tt@gmail.com",
"tracking_number": "12345678",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=12345678&cntry_code=US",
"carrier": "fedex",
"delivery_date": "2025-12-09T13:05:00-08:00"
},
...
],
"meta": {
"total": 47,
"page": 2,
"limit": 10,
"has_more": true
}
}