Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
purchase_order

Purchase Order - Get Single Bulk

Retrieve multiple purchase orders by their IDs in a single request.

post/purchase_order/get_single_bulk

Request body

idstring[] required

Array of purchase order IDs

fieldsobject

Projection fields object, e.g. { "name": 1 }

optionsobject

Additional options

Response

Multiple purchase orders

_idstring required

Unique purchase order identifier

account_idstring

Account ID

numberstring required

PO number

distributor_idstring

Distributor/vendor ID

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

PO status

custom_itemsobject[]

Custom line items

trackingobject[]

Tracking information

subtotalnumber

Subtotal amount

totalnumber

Total amount

taxnumber

Tax amount

tax_pernumber

Tax percentage

shippingnumber

Shipping cost

discountnumber

Discount amount

due_datestring date nullable

Due date

arrival_datestring nullable

Expected arrival date

closed_datestring nullable

Date the PO was closed

metadataobject

Additional metadata

discount_pernumber

Discount percentage

tagsstring[]

Array of tag IDs (ObjectId strings referencing the tag collection)

store_idstring

Associated store ID

warehouse_idstring

Destination warehouse ID

memostring nullable

PO memo

currencystring

Currency code

termsstring nullable

Payment terms

methodstring nullable

Payment method

order_numberstring

Associated order number

dropship_addressobject

Dropship address

dropshippedboolean

Whether this PO is dropshipped

bol_pro_numbersstring[]

BOL/PRO numbers

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "log": [
      {
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "due_date": "2025-01-15",
    "arrival_date": "2025-01-15",
    "closed_date": "2025-01-15",
    "tags": [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012"
    ],
    "store_id": "507f1f77bcf86cd799439011"
  }
]