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

    clientId string

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

    clientName string

    Name of the Brand or Retailer of the purchase order

    clientUpdatedDate date-time

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

    commitId stringnullable

    Commit ID of the purchase order

    commitPoSequence stringnullable

    Commit PO sequence of the purchase order

    createdDate date-time

    Creation date of the purchase order

    deliveryDate date-timenullable

    Delivery date of the purchase order

    eventName stringnullable

    Name of the corresponding event in the client’s system

    factoryId string

    Global Custom ID of the Factory organization of the purchase order

    factoryName string

    Name of the Factory of the purchase order

    inStoreDate date-timenullable

    The date the purchase order will be delivered to stores

    localClientId string

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

    localClientIds string[]nullable

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

    localFactoryId string

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

    localFactoryIds string[]nullable

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

    localSupplierId string

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

    localSupplierIds string[]nullable

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

    opoNumber string

    Original Purchase Order number

    poNumber stringrequired

    Purchase Order number

    poSource stringnullable

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

    poStatus stringnullable

    Status of the purchase order

    poType string

    Purchase order type in a pre-configured list in configuration

    productLineId stringrequired

    Unique identifier of the Product Line

    productLineName string

    Name of the product line

    shareToIds string[]nullable

    Possible values: non-empty

    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

    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)

    shipEndDate date-timenullable

    The last date of the shipment window

    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.

    brandName string

    Possible values: non-empty

    classId stringnullable
    color stringrequired

    Possible values: non-empty

    configuration integerrequired

    Possible values: >= 1

    departmentId stringnullable
    id stringnullable
    itemId stringrequired

    Possible values: non-empty

    productCategoryId string
    productCategoryName string

    Possible values: non-empty

    productLineId string

    Possible values: non-empty

    productLineName string
    quantity integer
    shipmentTerm stringnullable
    size stringrequired

    Possible values: non-empty

  • ]

  • ]

  • productCategoryId stringrequired
    productCategoryName string

    Possible values: non-empty

    solids

    object[]

    nullable

  • Array [

  • brandId stringnullable

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

    brandName string

    Possible values: non-empty

    cartonQuantity integernullable
    casePackQuantity integernullable
    classId stringnullable
    color stringrequired

    Possible values: non-empty

    departmentId stringnullable
    id stringnullable
    itemId stringrequired

    Possible values: non-empty

    productCategoryId string
    productCategoryName string

    Possible values: non-empty

    productLineId string

    Possible values: non-empty

    productLineName string
    quantity integerrequired

    Possible values: >= 1

    shipmentTerm stringnullable
    size stringrequired

    Possible values: non-empty

  • ]

  • styleId stringrequired

    Possible values: non-empty

    styleName stringnullable
  • ]

  • uid string

    Unique identifier of the PO stored in the system

    updatedDate date-time

    Last updated date of the purchase order

    vendorId stringrequired

    Global Custom ID of the Supplier organization of the purchase order

    vendorName string

    Name of the Vendor or Supplier of the purchase order

  • ]

  • limit integerrequired

    Possible values: >= 1 and <= 100

    offset integerrequired
    total integerrequired