Skip to main content

PurchaseOrderListResponse

data object[]

List of purchase orders

  • Array [
  • clientCreatedDate datenullable

    The creation date from the client system of the Purchase Order

    Example: 2023-02-10
    clientId string

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

    Example: client_1
    clientName string

    Name of the Brand or Retailer of the purchase order

    Example: Lex Corp
    clientUpdatedDate date-time

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

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

    Commit ID of the purchase order

    Example: commit_id_1
    commitPoSequence stringnullable

    Commit PO sequence of the purchase order

    Example: commit_po_sequence_1
    createdDate date-time

    Creation date of the purchase order

    Example: 2021-06-03T04:30:22.726000+00:00
    deliveryDate date-timenullable

    Delivery date of the purchase order

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

    Name of the corresponding event in the client’s system

    Example: Event 1
    factoryId string

    Global Custom ID of the Factory organization of the purchase order

    Example: factory_1
    factoryName string

    Name of the Factory of the purchase order

    Example: Padme Corp
    inStoreDate date-timenullable

    The date the purchase order will be delivered to stores

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

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

    Example: client_1
    localClientIds string[]nullable

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

    Example: ["sub_org_1"]
    localFactoryId string

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

    Example: factory_1
    localFactoryIds string[]nullable

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

    Example: ["sub_org_1"]
    localSupplierId string

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

    Example: supplier_1
    localSupplierIds string[]nullable

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

    Example: ["sub_org_1"]
    opoNumber string

    Original Purchase Order number

    Example: opo_1
    poNumber stringrequired

    Purchase Order number

    Example: po_1
    poSource stringnullable

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

    Example: domestic
    poStatus stringnullable

    Status of the purchase order

    Example: canceled
    poType string

    Purchase order type in a pre-configured list in configuration

    Example: po_type_1
    productLineId stringrequired

    Unique identifier of the Product Line

    Example: product_line_1
    productLineName string

    Name of the product line

    Example: Apparel
    shareToIds string[]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"]
    shareToLocalIds string[]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"]
    shipEndDate date-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 [
  • assortmentId stringrequired

    Possible values: non-empty

    cartonQuantity integerrequired
    items object[]required

    Possible values: >= 1

  • Array [
  • brandId stringnullable

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

    Example: brand_1
    brandName string

    Possible values: non-empty

    classId stringnullable
    Example: class_id_1
    color stringrequired

    Possible values: non-empty

    configuration integerrequired

    Possible values: >= 1

    departmentId stringnullable
    Example: department_id_1
    id stringnullable
    itemId stringrequired

    Possible values: non-empty

    productCategoryId string
    Example: product_category_1
    productCategoryName string

    Possible values: non-empty

    productLineId string

    Possible values: non-empty

    Example: product_line_1
    productLineName string
    quantity integer
    shipmentTerm stringnullable
    Example: shipment_term_1
    size stringrequired

    Possible values: non-empty

  • ]
  • ]
  • productCategoryId stringrequired
    Example: product_category_1
    productCategoryName string

    Possible values: non-empty

    solids object[]nullable
  • Array [
  • brandId stringnullable

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

    Example: brand_1
    brandName string

    Possible values: non-empty

    cartonQuantity integernullable
    casePackQuantity integernullable
    classId stringnullable
    Example: class_id_1
    color stringrequired

    Possible values: non-empty

    departmentId stringnullable
    Example: department_id_1
    id stringnullable
    itemId stringrequired

    Possible values: non-empty

    productCategoryId string
    Example: product_category_1
    productCategoryName string

    Possible values: non-empty

    productLineId string

    Possible values: non-empty

    Example: product_line_1
    productLineName string
    quantity integerrequired

    Possible values: >= 1

    shipmentTerm stringnullable
    Example: shipment_term_1
    size stringrequired

    Possible values: non-empty

  • ]
  • styleId stringrequired

    Possible values: non-empty

    Example: style_1
    styleName stringnullable
  • ]
  • uid string

    Unique identifier of the PO stored in the system

    Example: uid
    updatedDate date-time

    Last updated date of the purchase order

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

    Global Custom ID of the Supplier organization of the purchase order

    Example: vendor_1
    vendorName string

    Name of the Vendor or Supplier of the purchase order

    Example: Acme Corp
  • ]
  • limit integerrequired

    Possible values: >= 1 and <= 100

    offset integerrequired
    total integerrequired
    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
    }