List Purchase Orders
GET/api/v1/purchase-orders
List Purchase Orders
Request​
Query Parameters
Purchase order number to be stored in Inspectorio
Original purchase order number stored in the client's system
Possible values: >= 1
and <= 100
Default value: 10
Limit result of list
Default value: 0
Purchase order delivery date to
Purchase order delivery date from
Responses​
- 200
- 400
- 401
- 422
- 429
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
Array [
]
]
Array [
]
]
]
data
object[]
List of purchase orders
The creation date from the client system of the Purchase Order
Global Custom ID of the Brand/Retailer organization of the purchase order
Name of the Brand or Retailer of the purchase order
The last updated date from the client system of the Purchase Order
Commit ID of the purchase order
Commit PO sequence of the purchase order
Creation date of the purchase order
Delivery date of the purchase order
Name of the corresponding event in the client’s system
Global Custom ID of the Factory organization of the purchase order
Name of the Factory of the purchase order
The date the purchase order will be delivered to stores
Local Custom ID of the Brand/Retailer organization of the purchase order that is inputted from the request body
The list of all connected Local Custom IDs of the Brand/Retailer organization
Local Custom ID of the Factory organization of the purchase order that is inputted from the request body
The list of all connected Local Custom IDs of the Factory organization
Local Custom ID of the Supplier organization of the purchase order that is inputted from the request body
The list of all connected Local Custom IDs of the Supplier organization
Original Purchase Order number
Purchase Order number
Indicate the source of materials (produced by domestic vendors or imported from vendors outside the country)
Status of the purchase order
Purchase order type in a pre-configured list in configuration
Unique identifier of the Product Line
Name of the product line
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
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)
The last date of the shipment window
styles
object[]
List of styles of items in the purchase order
assortments
object[]
nullable
Possible values: non-empty
items
object[]
required
Possible values: >= 1
Precondition: must be configured in your Inspectorio's account.
Possible values: non-empty
Possible values: non-empty
Possible values: >= 1
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
solids
object[]
nullable
Precondition: must be configured in your Inspectorio's account.
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
Possible values: >= 1
Possible values: non-empty
Possible values: non-empty
Unique identifier of the PO stored in the system
Last updated date of the purchase order
Global Custom ID of the Supplier organization of the purchase order
Name of the Vendor or Supplier of the purchase order
Possible values: >= 1
and <= 100
{
"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
}
Bad request
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Bad Request"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Cannot retrieve session data because of expired token"
}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"errors": {
"type": [
"Input type is not valid"
]
},
"message": "Validation error"
}
Rate-limiting Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Too many requests"
}
Internal Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"errors": {
"system": [
"Internal error detail message"
]
},
"message": "Internal server error"
}