input UpdatePurchaseOrderInput

Fields

FieldTypeDescription
customer_account_idString

Use this when you are a 3PL acting on behalf of one of your customers.

po_idString!

Public API PO ID that identifies the related record.

packing_noteString

Packing note for this purchase order.

po_noteString

Po note for this purchase order.

descriptionString

Human-readable description for this purchase order.

partner_order_numberString

Partner order number for this purchase order.

discountString

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

taxString

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

line_items[UpdatePurchaseOrderLineItemInput]

List of line items associated with this purchase order.

shipping_methodString

Carrier service or shipping method code.

shipping_carrierString

Carrier name or carrier code used for shipping.

shipping_nameString

Shipping name for this purchase order.

shipping_priceString

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

tracking_numberString

Carrier tracking number for the shipment or label.

pdfString

Pdf for this purchase order.

payment_methodString

Payment method for this purchase order.

payment_due_byString

Payment due by for this purchase order.

payment_noteString

Payment note for this purchase order.

po_dateISODateTime

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

clear_po_dateBoolean

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

Referenced By

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "po_id": "UHVyY2hhc2VPcmRlcjoxMjM0",
  "packing_note": "Customer requested expedited handling.",
  "po_note": "Customer requested expedited handling.",
  "description": "Customer requested expedited handling.",
  "partner_order_number": "SO-100045",
  "discount": "19.99",
  "tax": "19.99",
  "line_items": [[{sku: "BLUE-TEE-M", quantity: 2}]],
  "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",
  "payment_method": "credit_card",
  "payment_due_by": "2026-07-15",
  "payment_note": "Customer requested expedited handling.",
  "po_date": "2026-07-09T15:30:00Z",
  "clear_po_date": true
}