input CreatePurchaseOrderInput
Fields
| Field | Type | Description |
|---|---|---|
customer_account_id | String | Use this when you are a 3PL acting on behalf of one of your customers. |
po_number | String! | Po number for this purchase order. |
subtotal | String! | Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value. |
shipping_price | String! | Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value. |
total_price | String! | Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value. |
warehouse_id | String! | Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects. |
line_items | [CreatePurchaseOrderLineItemInput]! | List of line items associated with this purchase order. |
po_date | ISODateTime | PO date in ISO-8601 date or datetime format, returned in UTC when time is included. |
po_note | String | Po note for this purchase order. |
fulfillment_status | String | Current fulfillment status; use the API status values returned by this field when filtering or updating. |
discount | String | Monetary amount as a decimal value in the record currency; not cents. |
vendor_id | String | Public API vendor ID that identifies the related record. |
warehouse | String | Warehouse display value or nested warehouse object for this record. Use warehouse_id when passing a warehouse reference. |
packing_note | String | Packing note for this purchase order. |
description | String | Human-readable description for this purchase order. |
partner_order_number | String | Partner order number for this purchase order. |
tax | String | Monetary amount as a decimal value in the record currency; not cents. |
tracking_number | String | Carrier tracking number for the shipment or label. |
attachments | [CreatePurchaseOrderAttachmentInput] | List of attachments associated with this purchase order. |
origin_of_shipment | String | ISO country code for origin of shipment. |
Referenced By
- purchase_order_create Mutation
Example
{
"customer_account_id": "QWNjb3VudDoxMjM0",
"po_number": "PO-100045",
"subtotal": "19.99",
"shipping_price": "19.99",
"total_price": "19.99",
"warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
"line_items": [[{sku: "BLUE-TEE-M", quantity: 2}]],
"po_date": "2026-07-09T15:30:00Z",
"po_note": "Customer requested expedited handling.",
"fulfillment_status": "pending",
"discount": "19.99",
"vendor_id": "VmVuZG9yOjEyMzQ=",
"warehouse": "Primary Warehouse",
"packing_note": "Customer requested expedited handling.",
"description": "Customer requested expedited handling.",
"partner_order_number": "SO-100045",
"tax": "19.99",
"tracking_number": "1Z999AA10123456784",
"attachments": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
"origin_of_shipment": "US"
}