Skip to main content

PurchaseOrderBase

custom_idstringrequired

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_datedatenullable

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_datedate-timenullable

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_datedatenullable

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_datedate-timenullable

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

Possible values: [canceled]

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_datedate-timenullable

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
additional_attributes object

(not yet implemented)

property name*string
total_costdouble

Cost Amount

packaging_detailsobject[]required

Packaging details information

PurchaseOrderBase
{
"custom_id": "opo_1",
"uid": "abc-def-123-456",
"created_date": "2023-02-10",
"client_id": "client_1",
"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",
"additional_attributes": {
"event_name": "named_event"
},
"total_cost": 0,
"packaging_details": [
{
"carton_quantity": 0,
"packaging_type": "assortment",
"assortment_id": "string",
"items": [
{
"custom_id": "item_123",
"entity_type": "item",
"case_pack_quantity": 0
}
]
},
{
"carton_quantity": 0,
"packaging_type": "solid",
"item": {
"custom_id": "item_123",
"entity_type": "item",
"case_pack_quantity": 0
}
}
]
}