v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
purchase_order

Purchase Order - Create

August 2023: Now supports item_id, kit_id, sku (SKULabs Kit or Item), mpn (Supplier MPN), or barcode (SKULabs Kit or Item barcode) as lookup fields in the item array.

post/purchase_order/create

Request body

numberstring required

PO number

store_idstring

Store ID

distributor_idstring

Distributor ID

warehouse_idstring

Warehouse ID

subtotalnumber

Subtotal

taxnumber

Tax amount

tax_pernumber

Tax percentage

totalnumber

Total

memostring

Memo

termsstring

Payment terms

shippingnumber

Shipping cost

methodstring

Payment method

discountnumber

Discount amount

discount_pernumber

Discount percentage

dropship_addressobject

Dropship address

status'closed' | 'created' | 'receiving' | 'acknowledged' | 'sent' | 'edited' | 'transit' | 'accepting'

Initial PO status

due_datestring date

Due date

dropshippedboolean

Dropshipped flag

Example request

{
  "store_id": "507f1f77bcf86cd799439011",
  "due_date": "2025-01-15"
}

Response

Purchase order created

successboolean required

Whether the operation succeeded

_idstring

ID of the created purchase order

errorsstring[]

Array of validation error messages

skulabs_warningobject

Non-fatal warning from background operations

Example response

{
  "_id": "507f1f77bcf86cd799439011"
}