Create a new purchase order
Changed onCreate a new purchase order with products from a supplier.
Request
- Base URLhttps://api.shipstation.com
- URLhttps://api.shipstation.com/v2/purchase_orders
- AuthAPI key in header api-key
Request body
Example request
{
"supplier_id": "se-567",
"order_date": "2025-01-15T00:00:00Z",
"expected_delivery_date": "2025-02-01T00:00:00Z",
"payment_terms": "net_30",
"payment_status": "unpaid",
"currency_code": "USD",
"shipping_carrier": "UPS",
"tracking_number": "1Z12345E1234567890",
"reference_number": "REF-12345",
"warehouse_id": "se-123456",
"note_to_supplier": "Please expedite delivery",
"products": [
{
"sku": "WIDGET-001",
"supplier_sku": "SUPP-WIDGET-001",
"quantity": 100,
"cost": 9.99
}
]
}Response
Purchase order created successfully
Example response
{
"purchase_order_id": "se-234",
"order_number": "02162026-02",
"supplier_id": "se-567",
"status": "draft",
"order_date": "2025-01-15T00:00:00Z",
"expected_delivery_date": "2025-02-01T00:00:00Z",
"create_date": "2025-01-14T10:30:00Z",
"modify_date": "2025-01-14T10:30:00Z",
"payment_terms": "net_30",
"payment_status": "unpaid",
"currency_code": "USD",
"shipping_carrier": "UPS",
"tracking_number": "1Z12345E1234567890",
"reference_number": "REF-12345",
"warehouse_id": "se-123456",
"note_to_supplier": "Please expedite delivery",
"products": [
{
"sku": "WIDGET-001",
"supplier_sku": "SUPP-WIDGET-001",
"quantity": 100,
"cost": 9.99
}
]
}Changes
- warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status
- warning
- breaking
the
/response's property type changed from no type toobjectfor status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
removed from the
/response propertyallOflist for the response status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status
- breaking