object PurchaseOrder

Fields

Field Type Description

id

String

Public API ID for this identifiable.

legacy_id

BigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

po_number

String

Po number for this purchase order.

account_id

String

Public API account ID that identifies the related record.

warehouse_id

String

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

vendor_id

String

Public API vendor ID that identifies the related record.

created_at

ISODateTime

Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

po_date

ISODateTime

The expected date to arrive at the warehouse.

date_closed

ISODateTime

Date closed as an ISO-8601 datetime, returned in UTC unless otherwise noted.

arrived_at

ISODateTime

Arrived at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

packing_note

String

Packing note for this purchase order.

fulfillment_status

String

Current fulfillment status; use the API status values returned by this field when filtering or updating.

po_note

String

Po 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.

subtotal

String

Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value.

discount

String

Monetary amount as a decimal value in the record currency; not cents.

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.

tax

String

Monetary amount as a decimal value in the record currency; not cents.

shipping_method

String

Carrier service or shipping method code.

shipping_carrier

String

Carrier name or carrier code used for shipping.

shipping_name

String

Shipping name for this purchase order.

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.

tracking_number

String

Carrier tracking number for the shipment or label.

pdf

String

Pdf for this purchase order.

images

String

List of images associated with this purchase order.

payment_method

String

Payment method for this purchase order.

payment_due_by

String

Payment due by for this purchase order.

payment_note

String

Payment note for this purchase order.

locking

String

Locking for this purchase order.

locked_by_user_id

String

Public API locked by user ID that identifies the related record.

line_items

PurchaseOrderLineItemConnection

List of line items associated with this purchase order.

Argument	Type	Required
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

attachments

PurchaseOrderAttachmentConnection

List of attachments associated with this purchase order.

Argument	Type	Required
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

vendor

Vendor

Vendor associated with this purchase order.

warehouse

Warehouse

Warehouse display value or nested warehouse object for this record. Use warehouse_id when passing a warehouse reference.

origin_of_shipment

String

ISO country code for origin of shipment.

tracking_numbers

PurchaseOrderTrackingNumberConnection

Tracking numbers for this purchase order.

Argument	Type	Required
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

ship_date

DateTime

Ship date in ISO-8601 date or datetime format, returned in UTC when time is included.

Referenced By

CancelPurchaseOrderOutput Type
ClosePurchaseOrderOutput Type
CreatePurchaseOrderOutput Type
PurchaseOrderEdge Type
PurchaseOrderQueryResult Type
SetPurchaseOrderFulfillmentStatusOutput Type
UpdatePurchaseOrderOutput Type

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "po_number": "PO-100045",
  "account_id": "UHVyY2hhc2VPcmRlcjoxMjM0",
  "warehouse_id": "UHVyY2hhc2VPcmRlcjoxMjM0",
  "vendor_id": "UHVyY2hhc2VPcmRlcjoxMjM0",
  "created_at": "2026-07-09T15:30:00Z",
  "po_date": "2026-07-09T15:30:00Z",
  "date_closed": "2026-07-09T15:30:00Z",
  "arrived_at": "2026-07-09T15:30:00Z",
  "packing_note": "Customer requested expedited handling.",
  "fulfillment_status": "pending",
  "po_note": "Customer requested expedited handling.",
  "description": "Customer requested expedited handling.",
  "partner_order_number": "SO-100045",
  "subtotal": "19.99",
  "discount": "19.99",
  "total_price": "19.99",
  "tax": "19.99",
  "shipping_method": "ups_ground",
  "shipping_carrier": "ups",
  "shipping_name": "PO-100045",
  "shipping_price": "19.99",
  "tracking_number": "1Z999AA10123456784",
  "pdf": "https://example.com/labels/SHIP-1001.pdf",
  "images": "https://example.com/images/blue-tee.jpg",
  "payment_method": "credit_card",
  "payment_due_by": "2026-07-15",
  "payment_note": "Customer requested expedited handling.",
  "locking": "locked",
  "locked_by_user_id": "UHVyY2hhc2VPcmRlcjoxMjM0",
  "line_items": [{sku: "BLUE-TEE-M", quantity: 2}],
  "attachments": [{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}],
  "vendor": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"},
  "warehouse": {id: "V2FyZWhvdXNlOjEyMzQ=", identifier: "Primary Warehouse"},
  "origin_of_shipment": "US",
  "tracking_numbers": [{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}],
  "ship_date": "2026-07-09T15:30:00Z"
}