Skip to main content

PurchaseOrderPOST

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
uidstringrequired

Also called po_id. Unique identifier of the purchase order

Example: abc-def-123-456
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_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

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

Local Custom ID of the Material Supplier organization of the purchase order. Required when po_type is material.

Possible values: non-empty

Example: material_supplier_1
total_costnumber<double>nullable

Cost Amount

total_cost_currency_codeCostCurrencyCode (string)nullable

Cost Currency Code. Possible values: See full list here

Example: USD
packaging_details object[]required

Packaging details information

  • Array [
    • oneOf
    carton_quantityintegerrequired

    Possible values: >= 1

    packaging_type stringrequired

    Possible values: [assortment, solid]

    assortment_idstringrequired
    items AssortmentPackagedProduct[]
  • Array [
    • custom_idstringrequired

    Custom Identifier for the Product referred

    Example: item_123
    entity_typestringrequired

    Possible values: [item, material]

    case_pack_quantityintegerrequired

    Number of units in a Carton

    Possible values: >= 1

    quantity_uom_codestringnullable

    Unit of measure code for quantity (required when entity_type is material). Possible values: See full list here

    Example: m
  • ]
  • ]
    • lines object[]required

    Purchase Order Line information

    Possible values: >= 1

  • Array [
    • oneOf
    unit_costnumber<double>

    Cost Amount

    unit_cost_currency_codeCostCurrencyCode (string)nullable

    Cost Currency Code. Possible values: See full list here

    Example: USD
    shipment_termShipmentTerm (string)

    Shipment terms

    Example: DDP
    item ProductItemrequired

    Product Item data

    custom_idstringrequired

    Custom Identifier for the Product referred

    Example: item_123
    entity_typestringrequired

    Possible values: [item]

    style_idstring
    style_namestring
    product_categorystring

    The Product Category ID

    product_linestring

    The Product Line ID

    departmentstringnullable

    The Department ID

    classstringnullable

    The Class ID

    brandstring

    The Brand ID

    colorstringrequired

    Color of the product

    sizestringrequired

    Size of the product

  • ]
    • additionalAttributes object[]nullable

    Additional custom attributes associated with the purchase order

  • Array [
    • keystringrequired

    The identifier of the attribute

    value objectrequired
    oneOf
    string
  • ]
    • PurchaseOrderPOST
    {
      "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"
          },
          "unit_cost": 0,
          "unit_cost_currency_code": "USD",
          "shipment_term": "DDP"
        },
        {
          "item": {
            "custom_id": "item_123",
            "entity_type": "material",
            "style_id": "string",
            "style_name": "string",
            "product_category": "string",
            "product_line": "string",
            "department": "string",
            "class": "string",
            "brand": "string",
            "color": "string",
            "size": "string"
          },
          "unit_cost": 0,
          "unit_cost_currency_code": "USD",
          "shipment_term": "DDP"
        },
        {
          "item": {
            "custom_id": "item_123",
            "entity_type": "item"
          },
          "unit_cost": 0,
          "unit_cost_currency_code": "USD",
          "shipment_term": "DDP"
        }
      ],
      "additionalAttributes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "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_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",
      "material_supplier_custom_id": "material_supplier_1",
      "total_cost": 0,
      "total_cost_currency_code": "USD",
      "packaging_details": [
        {
          "carton_quantity": 0,
          "packaging_type": "assortment",
          "assortment_id": "string",
          "items": [
            {
              "custom_id": "item_123",
              "entity_type": "item",
              "case_pack_quantity": 0,
              "quantity_uom_code": "m"
            }
          ]
        },
        {
          "carton_quantity": 0,
          "packaging_type": "solid",
          "item": {
            "custom_id": "item_123",
            "entity_type": "item",
            "case_pack_quantity": 0,
            "quantity_uom_code": "m",
            "quantity": 0
          }
        }
      ]
    }