PurchaseOrderBase

total_quantityintegernullable

Total quantity of the purchase order, must be non negative

Example: 100

total_quantity_uom_codestringnullable

Unit of measure code for the total quantity. Possible values: See full list here

Example: pcs

data_provider_custom_idstringnullable

Local Custom ID of the organization that owns item references in this PO

Example: data_provider_1

custom_idstringnullable

Original purchase order number stored in client's system

Example: opo_1

uidstring

Also called po_id. Unique identifier of the purchase order

Example: abc-def-123-456

created_atstring<date-time>required

Creation date of the purchase order

Example: 2025-12-15T10:01:10.693888Z

created_datestring<date>nullable

The creation date from the client system of the Purchase Order

Example: 2023-02-10

client_idstringnullable

Local Custom ID of the Brand/Retailer organization of the purchase order

Example: client_1

updated_atstring<date-time>required

Last updated date of the purchase order

Example: 2025-12-15T10:01:10.693897Z

updated_datestring<date-time>nullable

The last updated date from the client system of the Purchase Order

Example: 2019-02-20T06:37:18Z

commit_idstringnullable

Commit ID of the purchase order

Example: commit_id_1

commit_po_sequencestringnullable

Commit PO sequence of the purchase order

Example: commit_po_sequence_1

delivery_datestring<date>nullable

Delivery date or shipment start date of the purchase order

Example: 2021-05-23

event_namestringnullable

Name of the corresponding event in the client's system

Example: Event 1

factory_custom_idstringnullable

Local Custom ID of the Factory organization of the purchase order

Example: factory_1

in_store_datestring<date-time>nullable

In store date of the purchase order

Example: 2021-06-01T00:00:00Z

po_numberstringrequired

Purchase order number to be stored in Inspectorio

Possible values: non-empty

Example: po_1

po_sourcestringnullable

Indicate the source of materials (produced by domestic vendors or imported from vendors outside the country)

Example: domestic

po_statusstringnullable

Status of the purchase order. Accepts the string value "canceled" or a JSON null value to clear the status.

Possible values: [canceled, null]

Example: canceled

po_typestringnullable

Purchase order type in a pre-configured list

Possible values: non-empty

Example: po_type_1

share_to_idsstring[]nullable

Local Custom IDs of the shared organizations of the purchase order

Example: ["sub_org_1"]

ship_end_datestring<date-time>nullable

Shipment end date of the purchase order

Example: 2021-05-30T00:00:00Z

vendor_custom_idstringrequired

Local Custom ID of the Supplier organization of the purchase order

Possible values: non-empty

Example: vendor_1

total_costnumber<double>nullable

Cost Amount

total_cost_currency_codeCostCurrencyCode (string)nullable

Cost Currency Code. Possible values: See full list here

Example: USD

PurchaseOrderBase

{
  "total_quantity": 100,
  "total_quantity_uom_code": "pcs",
  "data_provider_custom_id": "data_provider_1",
  "custom_id": "opo_1",
  "uid": "abc-def-123-456",
  "created_at": "2025-12-15T10:01:10.693888Z",
  "created_date": "2023-02-10",
  "client_id": "client_1",
  "updated_at": "2025-12-15T10:01:10.693897Z",
  "updated_date": "2019-02-20T06:37:18Z",
  "commit_id": "commit_id_1",
  "commit_po_sequence": "commit_po_sequence_1",
  "delivery_date": "2021-05-23",
  "event_name": "Event 1",
  "factory_custom_id": "factory_1",
  "in_store_date": "2021-06-01T00:00:00Z",
  "po_number": "po_1",
  "po_source": "domestic",
  "po_status": "canceled",
  "po_type": "po_type_1",
  "share_to_ids": [
    "sub_org_1"
  ],
  "ship_end_date": "2021-05-30T00:00:00Z",
  "vendor_custom_id": "vendor_1",
  "total_cost": 0,
  "total_cost_currency_code": "USD"
}