PurchaseOrder

The purchase order object returned by the purchase order read endpoints, as a plain JSON object with no data/included envelope. Money fields are JSON numbers, not strings. The internal id, source_system_id, supplier_id, the caller's own idempotency_key, and the raw incoming_sync_details batcher blob are never exposed on this surface.

uuidstring

Example: 9a1e3b7c-1e3d-4a3f-9f2e-9c6b6e2a2b11

sequence_idintegernullable

Example: 1042

namestringnullable

Example: null

statusstring

One of draft, ordered, partial, received, committed, cancelled. These are also the values accepted by filter[status_eq].

Example: ordered

destination_location_idstringnullable

Example: gid://shopify/Location/73986408603

destination_location_namestringnullable

Example: Main Warehouse

payment_termsstringnullable

Example: null

estimated_arrivalstring<date>nullable

Example: null

order_placed_datestring<date>nullable

Example: null

order_shipped_datestring<date>nullable

Example: null

order_cancelled_datestring<date>nullable

Example: null

shipping_carrierstringnullable

Example: null

tracking_numberstringnullable

Example: null

reference_numberstringnullable

Example: null

supplier_order_referencestringnullable

Example: null

supplier_invoice_numberstringnullable

Example: null

notestringnullable

Example: null

tagsstring[]

Example: []

shipping_amountnumber

Example: 0

tax_amountnumber

Example: 0

subtotalnumber

Example: 0

totalnumber

Example: 0

metadataobject

Example: {}

sourcestring

Example: bookkeep

currencystring

Example: USD

is_archivedboolean

Example: false

incoming_sync_statusstring

Example: pending_sync

incoming_sync_errorstringnullable

Example: null

bill_statusstring

Example: unbilled

bills_countinteger

Example: 0

created_atstring<date-time>

Example: 2026-06-01T12:00:00.000Z

updated_atstring<date-time>

Example: 2026-06-01T12:00:00.000Z

line_items object[]

Present only when include=line_items was requested.

Array [

client_line_idstringnullable

Example: null

skustringnullable

Example: WIDGET-1

barcodestringnullable

Example: null

titlestringnullable

Example: Widget

image_urlstringnullable

Example: null

unit_costnumbernullable

Example: 4.5

line_totalnumbernullable

Example: 45

product_idstringnullable

Example: gid://shopify/Product/1

variant_idstringnullable

Example: gid://shopify/ProductVariant/1

location_idstringnullable

Example: gid://shopify/Location/1

location_namestringnullable

Example: Main Warehouse

tax_percentstringnullable

A tax rate, not an amount, so unlike the money fields it is returned as a string rather than a number. Parse it before doing arithmetic with it.

Example: 0.0

supplier_skustringnullable

Example: null

notestringnullable

Example: null

variant_titlestringnullable

Example: Default Title

quantity_orderedinteger

Example: 10

inventory_item_idstringnullable

Example: gid://shopify/InventoryItem/1

positioninteger

Example: 1

added_during_receivingboolean

Example: false

created_atstring<date-time>

Example: 2026-06-01T12:00:00.000Z

updated_atstring<date-time>

Example: 2026-06-01T12:00:00.000Z

]

receipts object[]

Present only when include=receipts was requested (requires purchase_order_receipts:read).

Array [

uuidstring

Example: 3f2a9c1e-2b3d-4c5e-8f6a-1b2c3d4e5f60

namestringnullable

Example: Receipt 1

statusstring

Example: committed

received_atstring<date-time>nullable

Example: 2026-06-03T09:00:00.000Z

invoice_numberstringnullable

Example: null

voided_atstring<date-time>nullable

Example: null

void_reasonstringnullable

Example: null

created_atstring<date-time>

Example: 2026-06-03T09:00:00.000Z

updated_atstring<date-time>

Example: 2026-06-03T09:00:00.000Z

]

supplier objectnullable

Present only when include=supplier was requested.

source_supplier_idstringnullable

Example: null

namestringnullable

Example: Acme Supply

company_namestringnullable

Example: Acme Supply Co.

currency_codestringnullable

Example: USD

websitestringnullable

Example: null

payment_termsstringnullable

Example: null

price_liststringnullable

Example: null

supplier_tax_typestringnullable

Example: null

is_hiddenboolean

Example: false

created_atstring<date-time>

Example: 2026-01-01T00:00:00.000Z

updated_atstring<date-time>

Example: 2026-01-01T00:00:00.000Z

PurchaseOrder

{
  "uuid": "9a1e3b7c-1e3d-4a3f-9f2e-9c6b6e2a2b11",
  "sequence_id": 1042,
  "name": null,
  "status": "ordered",
  "destination_location_id": "gid://shopify/Location/73986408603",
  "destination_location_name": "Main Warehouse",
  "payment_terms": null,
  "estimated_arrival": null,
  "order_placed_date": null,
  "order_shipped_date": null,
  "order_cancelled_date": null,
  "shipping_carrier": null,
  "tracking_number": null,
  "reference_number": null,
  "supplier_order_reference": null,
  "supplier_invoice_number": null,
  "note": null,
  "tags": [],
  "shipping_amount": 0,
  "tax_amount": 0,
  "subtotal": 0,
  "total": 0,
  "metadata": {},
  "source": "bookkeep",
  "currency": "USD",
  "is_archived": false,
  "incoming_sync_status": "pending_sync",
  "incoming_sync_error": null,
  "bill_status": "unbilled",
  "bills_count": 0,
  "created_at": "2026-06-01T12:00:00.000Z",
  "updated_at": "2026-06-01T12:00:00.000Z",
  "line_items": [
    {
      "client_line_id": null,
      "sku": "WIDGET-1",
      "barcode": null,
      "title": "Widget",
      "image_url": null,
      "unit_cost": 4.5,
      "line_total": 45,
      "product_id": "gid://shopify/Product/1",
      "variant_id": "gid://shopify/ProductVariant/1",
      "location_id": "gid://shopify/Location/1",
      "location_name": "Main Warehouse",
      "tax_percent": "0.0",
      "supplier_sku": null,
      "note": null,
      "variant_title": "Default Title",
      "quantity_ordered": 10,
      "inventory_item_id": "gid://shopify/InventoryItem/1",
      "position": 1,
      "added_during_receiving": false,
      "created_at": "2026-06-01T12:00:00.000Z",
      "updated_at": "2026-06-01T12:00:00.000Z"
    }
  ],
  "receipts": [
    {
      "uuid": "3f2a9c1e-2b3d-4c5e-8f6a-1b2c3d4e5f60",
      "name": "Receipt 1",
      "status": "committed",
      "received_at": "2026-06-03T09:00:00.000Z",
      "invoice_number": null,
      "voided_at": null,
      "void_reason": null,
      "created_at": "2026-06-03T09:00:00.000Z",
      "updated_at": "2026-06-03T09:00:00.000Z"
    }
  ],
  "supplier": {
    "source_supplier_id": null,
    "name": "Acme Supply",
    "company_name": "Acme Supply Co.",
    "currency_code": "USD",
    "website": null,
    "payment_terms": null,
    "price_list": null,
    "supplier_tax_type": null,
    "is_hidden": false,
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}