PurchaseOrderListResponse

data object[]

List of purchase orders

Array [

clientCreatedDatedatenullable

The creation date from the client system of the Purchase Order

Example: 2023-02-10

clientIdstring

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

Example: client_1

clientNamestring

Name of the Brand or Retailer of the purchase order

Example: Lex Corp

clientUpdatedDatedate-time

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

Example: 2019-02-20T06:37:18.048000+00:00

commitIdstringnullable

Commit ID of the purchase order

Example: commit_id_1

commitPoSequencestringnullable

Commit PO sequence of the purchase order

Example: commit_po_sequence_1

createdDatedate-time

Creation date of the purchase order

Example: 2021-06-03T04:30:22.726000+00:00

deliveryDatedate-timenullable

Delivery date of the purchase order

Example: 2021-09-14T00:00:00+00:00

eventNamestringnullable

Name of the corresponding event in the client's system

Example: Event 1

factoryIdstring

Global Custom ID of the Factory organization of the purchase order

Example: factory_1

factoryNamestring

Name of the Factory of the purchase order

Example: Padme Corp

inStoreDatedate-timenullable

The date the purchase order will be delivered to stores

Example: 2021-09-19T00:00:00+00:00

localClientIdstring

Local Custom ID of the Brand/Retailer organization of the purchase order that is inputted from the request body

Example: client_1

localClientIdsstring[]nullable

The list of all connected Local Custom IDs of the Brand/Retailer organization

Example: ["sub_org_1"]

localFactoryIdstring

Local Custom ID of the Factory organization of the purchase order that is inputted from the request body

Example: factory_1

localFactoryIdsstring[]nullable

The list of all connected Local Custom IDs of the Factory organization

Example: ["sub_org_1"]

localSupplierIdstring

Local Custom ID of the Supplier organization of the purchase order that is inputted from the request body

Example: supplier_1

localSupplierIdsstring[]nullable

The list of all connected Local Custom IDs of the Supplier organization

Example: ["sub_org_1"]

opoNumberstring

Original Purchase Order number

Example: opo_1

poNumberstringrequired

Purchase Order number

Example: po_1

poSourcestringnullable

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

Example: domestic

poStatusstringnullable

Status of the purchase order

Example: canceled

poTypestring

Purchase order type in a pre-configured list in configuration

Example: po_type_1

productLineIdstringrequired

Unique identifier of the Product Line

Example: product_line_1

productLineNamestring

Name of the product line

Example: Apparel

shareToIdsstring[]nullable

Global Custom IDs of the shared organizations of the purchase order. By default, it always returns the Global Custom IDs of the Supplier, Factory, and Brand/Retailer (if have) of the purchase order

Possible values: non-empty

Example: ["sub_org_1"]

shareToLocalIdsstring[]nullable

The list of all connected Local Custom IDs of the shared Global organizations of the purchase order. By default, it always returns the Local Custom IDs of the Supplier, Factory, and Brand/Retailer (if have)

Example: ["sub_org_1"]

shipEndDatedate-timenullable

The last date of the shipment window

Example: 2021-09-19T00:00:00+00:00

styles object[]

List of styles of items in the purchase order

Array [

assortments object[]nullable

Array [

assortmentIdstringrequired

Possible values: non-empty

cartonQuantityintegerrequired

items object[]required

Possible values: >= 1

Array [

brandIdstringnullable

Precondition: must be configured in your Inspectorio's account.

Example: brand_1

brandNamestring

Possible values: non-empty

classIdstringnullable

Example: class_id_1

colorstringrequired

Possible values: non-empty

configurationintegerrequired

Possible values: >= 1

departmentIdstringnullable

Example: department_id_1

idstringnullable

itemIdstringrequired

Possible values: non-empty

productCategoryIdstring

Example: product_category_1

productCategoryNamestring

Possible values: non-empty

productLineIdstring

Possible values: non-empty

Example: product_line_1

productLineNamestring

quantityinteger

shipmentTermstringnullable

Example: shipment_term_1

sizestringrequired

Possible values: non-empty

]

]

productCategoryIdstringrequired

Example: product_category_1

productCategoryNamestring

Possible values: non-empty

solids object[]nullable

Array [

brandIdstringnullable

Precondition: must be configured in your Inspectorio's account.

Example: brand_1

brandNamestring

Possible values: non-empty

cartonQuantityintegernullable

casePackQuantityintegernullable

classIdstringnullable

Example: class_id_1

colorstringrequired

Possible values: non-empty

departmentIdstringnullable

Example: department_id_1

idstringnullable

itemIdstringrequired

Possible values: non-empty

productCategoryIdstring

Example: product_category_1

productCategoryNamestring

Possible values: non-empty

productLineIdstring

Possible values: non-empty

Example: product_line_1

productLineNamestring

quantityintegerrequired

Possible values: >= 1

shipmentTermstringnullable

Example: shipment_term_1

sizestringrequired

Possible values: non-empty

]

styleIdstringrequired

Possible values: non-empty

Example: style_1

styleNamestringnullable

]

uidstring

Unique identifier of the PO stored in the system

Example: uid

updatedDatedate-time

Last updated date of the purchase order

Example: 2021-06-03T04:30:22.726000+00:00

vendorIdstringrequired

Global Custom ID of the Supplier organization of the purchase order

Example: vendor_1

vendorNamestring

Name of the Vendor or Supplier of the purchase order

Example: Acme Corp

]

limitintegerrequired

Possible values: >= 1 and <= 100

offsetintegerrequired

totalintegerrequired

PurchaseOrderListResponse

{
  "data": [
    {
      "clientCreatedDate": "2023-02-10",
      "clientId": "client_1",
      "clientName": "Lex Corp",
      "clientUpdatedDate": "2019-02-20T06:37:18.048000+00:00",
      "commitId": "commit_id_1",
      "commitPoSequence": "commit_po_sequence_1",
      "createdDate": "2021-06-03T04:30:22.726000+00:00",
      "deliveryDate": "2021-09-14T00:00:00+00:00",
      "eventName": "Event 1",
      "factoryId": "factory_1",
      "factoryName": "Padme Corp",
      "inStoreDate": "2021-09-19T00:00:00+00:00",
      "localClientId": "client_1",
      "localClientIds": [
        "sub_org_1"
      ],
      "localFactoryId": "factory_1",
      "localFactoryIds": [
        "sub_org_1"
      ],
      "localSupplierId": "supplier_1",
      "localSupplierIds": [
        "sub_org_1"
      ],
      "opoNumber": "opo_1",
      "poNumber": "po_1",
      "poSource": "domestic",
      "poStatus": "canceled",
      "poType": "po_type_1",
      "productLineId": "product_line_1",
      "productLineName": "Apparel",
      "shareToIds": [
        "sub_org_1"
      ],
      "shareToLocalIds": [
        "sub_org_1"
      ],
      "shipEndDate": "2021-09-19T00:00:00+00:00",
      "styles": [
        {
          "assortments": [
            {
              "assortmentId": "string",
              "cartonQuantity": 0,
              "items": [
                {
                  "brandId": "brand_1",
                  "brandName": "string",
                  "classId": "class_id_1",
                  "color": "string",
                  "configuration": 0,
                  "departmentId": "department_id_1",
                  "id": "string",
                  "itemId": "string",
                  "productCategoryId": "product_category_1",
                  "productCategoryName": "string",
                  "productLineId": "product_line_1",
                  "productLineName": "string",
                  "quantity": 0,
                  "shipmentTerm": "shipment_term_1",
                  "size": "string"
                }
              ]
            }
          ],
          "productCategoryId": "product_category_1",
          "productCategoryName": "string",
          "solids": [
            {
              "brandId": "brand_1",
              "brandName": "string",
              "cartonQuantity": 0,
              "casePackQuantity": 0,
              "classId": "class_id_1",
              "color": "string",
              "departmentId": "department_id_1",
              "id": "string",
              "itemId": "string",
              "productCategoryId": "product_category_1",
              "productCategoryName": "string",
              "productLineId": "product_line_1",
              "productLineName": "string",
              "quantity": 0,
              "shipmentTerm": "shipment_term_1",
              "size": "string"
            }
          ],
          "styleId": "style_1",
          "styleName": "string"
        }
      ],
      "uid": "uid",
      "updatedDate": "2021-06-03T04:30:22.726000+00:00",
      "vendorId": "vendor_1",
      "vendorName": "Acme Corp"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}