Skip to main content
POST
Create a purchase order item

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
purchase_order_id
integer
required

The ID of the purchase order to add this item to

quantity
required

The quantity to order (must be greater than 0)

Required range: x > 0
inventory_id
integer | null

The inventory id identifying the item to order. Must provide exactly one of inventory_shortcode or inventory_id, not both

Required range: x > 0
inventory_shortcode
string | null

The inventory shortcode (human-readable code) identifying the item to order. Must provide exactly one of inventory_shortcode or inventory_id, not both. Inventory shortcodes are deprecated for new integrations; supported during a deprecation window for existing callers.

sku
string
default:""

An optional SKU identifier for this item

total_price
integer
default:0

The total price for this line item, in cents

Required range: x >= 0

Response

201 - application/json

Created

created
string<date-time>
required

The datetime this object was created.

id
integer
required

The unique identifier for the purchase order item

inventory_id
integer | null
required

The inventory id for this item

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

quantity
required

The quantity ordered

sku
string
required

The SKU identifier for this item

total_price
integer
required

The total price for this line item, in cents

unit_of_measure
string
required

The unit of measure for this item

inventory_shortcode
string
default:""

The inventory shortcode (human-readable code) for this item