PurchaseOrderGET

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

Example: pcs

dataProviderCustomIdstringnullable

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_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

total_costdoublenullable

Cost Amount

packaging_details object[]required

Packaging details information

Array [

oneOf

AssortmentPackagingDetailLine

carton_quantityintegerrequired

Possible values: >= 1

packaging_type stringrequired

Possible values: [assortment, solid]

assortment

solid

item PackagedProductrequired

Custom Identifier for the Item referred

custom_idstringrequired

Custom Identifier for the Product referred

Example: item_123

entity_typestring

Possible values: [item, material]

case_pack_quantityintegerrequired

Number of units in a Carton

Possible values: >= 1

packaging_typestring

Possible values: [solid]

assortment_idstringrequired

items PackagedProduct[]

Array [

custom_idstringrequired

Custom Identifier for the Product referred

Example: item_123

entity_typestring

Possible values: [item, material]

case_pack_quantityintegerrequired

Number of units in a Carton

Possible values: >= 1

]

SolidPackagingDetailLine

carton_quantityintegerrequired

Possible values: >= 1

packaging_type stringrequired

Possible values: [assortment, solid]

assortment

assortment_idstringrequired

items PackagedProduct[]

Array [

custom_idstringrequired

Custom Identifier for the Product referred

Example: item_123

entity_typestring

Possible values: [item, material]

case_pack_quantityintegerrequired

Number of units in a Carton

Possible values: >= 1

]

packaging_typestring

Possible values: [assortment]

solid

item PackagedProductrequired

Custom Identifier for the Item referred

custom_idstringrequired

Custom Identifier for the Product referred

Example: item_123

entity_typestring

Possible values: [item, material]

case_pack_quantityintegerrequired

Number of units in a Carton

Possible values: >= 1

]

lines object[]required

Purchase Order Line information

Possible values: >= 1

Array [

unit_costdouble

Cost Amount

shipment_termShipmentTerm (string)

Shipment terms

Example: DDP

item components-schemas-Productrequired

Full product data

custom_idstringrequired

Custom Identifier for the Product referred

Example: item_123

entity_typestring

Possible values: [item, material]

style_idstring

style_namestring

product_categorystring

custom_id of the product category

product_linestring

custom_id of the product line

departmentstringnullable

custom_id of the department

classstringnullable

custom_id of the class category

brandstring

custom_id of the brand category

colorstring

sizestring

quantityinteger

Possible values: >= 1

]

additionalAttributes object[]

Additional custom attributes associated with the purchase order

fieldTypestring

The type of the attribute (str, num, dte, etc)

Array [

keystringrequired

The identifier of the attribute

value objectrequired

oneOf

MOD1

string

MOD2

number

MOD3

Array [

string

]

]

PurchaseOrderGET

{
  "lines": [
    {
      "item": {
        "custom_id": "item_123",
        "entity_type": "item",
        "style_id": "string",
        "style_name": "string",
        "product_category": "string",
        "product_line": "string",
        "department": "string",
        "class": "string",
        "brand": "string",
        "color": "string",
        "size": "string"
      },
      "quantity": 0,
      "unit_cost": 0,
      "shipment_term": "DDP"
    }
  ],
  "additionalAttributes": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "total_quantity": 100,
  "total_quantity_uom_code": "pcs",
  "dataProviderCustomId": "data_provider_1",
  "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",
  "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
      }
    }
  ]
}