Skip to main content

Update Purchase Order

PUT 

https://sight.inspectorio.com/api/v2-rc-1/purchase-orders/:po_number

Update Purchase Order

Request​

Path Parameters

    po_number stringrequired

Body

    clientCreatedDatedatenullable

    The creation date from the client system of the Purchase Order

    Example: 2023-02-10
    clientIdstringnullable

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

    Example: client_1
    clientUpdatedDatedate-timenullable

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

    Example: 2019-02-20T06:37:18Z
    commitIdstringnullable

    Commit ID of the purchase order

    Example: commit_id_1
    commitPoSequencestringnullable

    Commit PO sequence of the purchase order

    Example: commit_po_sequence_1
    deliveryDatedate-timenullable

    Delivery date or shipment start date of the purchase order

    Example: 2021-05-23T00:00:00Z
    eventNamestringnullable

    Name of the corresponding event in the client’s system

    Example: Event 1
    factoryIdstringnullable

    Local Custom ID of the Factory organization of the purchase order

    Example: factory_1
    inStoreDatedate-timenullable

    In store date of the purchase order

    Example: 2021-06-01T00:00:00Z
    opoNumberstringnullable

    Original purchase order number stored in client's system

    Example: opo_1
    poNumberstringrequired

    Purchase order number to be stored in Inspectorio

    Possible values: non-empty

    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

    Possible values: [canceled]

    Example: canceled
    poTypestringnullable

    Purchase order type in a pre-configured list

    Possible values: non-empty

    Example: po_type_1
    shareToIdsstring[]nullable

    Local Custom IDs of the shared organizations of the purchase order

    Possible values: non-empty

    Example: ["sub_org_1"]
    shipEndDatedate-timenullable

    Shipment end date of the purchase order

    Example: 2021-05-30T00:00:00Z
    styles object[]required

    Possible values: >= 1

  • Array [
  • assortments object[]nullable
  • Array [
  • assortmentIdstringrequired

    Possible values: non-empty

    cartonQuantityintegerrequired

    Possible values: >= 0

    items object[]required

    Possible values: >= 1

  • Array [
  • brandIdstringnullable

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

    Example: brand_1
    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

    productCategoryIdstringrequired
    Example: product_category_1
    productLineIdstringrequired

    Possible values: non-empty

    Example: product_line_1
    shipmentTermstringnullable
    Example: shipment_term_1
    sizestringrequired

    Possible values: non-empty

  • ]
  • ]
  • solids object[]nullable
  • Array [
  • brandIdstringnullable

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

    Example: brand_2
    cartonQuantityintegernullable

    Possible values: >= 0

    casePackQuantityintegernullable

    Possible values: >= 0

    classIdstringnullable
    Example: class_id_1
    colorstringrequired

    Possible values: non-empty

    departmentIdstringnullable
    Example: department_id_1
    idstringnullable
    itemIdstringrequired

    Possible values: non-empty

    productCategoryIdstringrequired
    Example: product_category_1
    productLineIdstringrequired

    Possible values: non-empty

    Example: product_line_1
    quantityintegerrequired

    Possible values: >= 1

    shipmentTermstringnullable
    Example: shipment_term_1
    sizestringrequired

    Possible values: non-empty

  • ]
  • styleIdstringrequired

    Possible values: non-empty

    Example: style_1
  • ]
  • uidstringnullable

    Unique identifier of the purchase order

    Example: abc-def-123-456
    vendorIdstringrequired

    Local Custom ID of the Supplier organization of the purchase order

    Possible values: non-empty

    Example: vendor_1

Responses​

OK

Schema
    data object
    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
    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 in purchase orders

  • Array [
  • assortments object[]nullable
  • Array [
  • assortmentIdstringrequired

    Possible values: non-empty

    cartonQuantityintegerrequired

    Possible values: >= 0

    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

    productCategoryIdstringrequired
    Example: product_category_1
    productCategoryNamestring

    Possible values: non-empty

    productLineIdstringrequired

    Possible values: non-empty

    Example: product_line_1
    productLineNamestring
    quantityinteger
    shipmentTermstringnullable
    Example: shipment_term_1
    sizestringrequired

    Possible values: non-empty

  • ]
  • ]
  • solids object[]nullable
  • Array [
  • brandIdstringnullable

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

    Example: brand_2
    brandNamestring

    Possible values: non-empty

    cartonQuantityintegernullable

    Possible values: >= 0

    casePackQuantityintegernullable

    Possible values: >= 0

    classIdstringnullable
    Example: class_id_1
    colorstringrequired

    Possible values: non-empty

    departmentIdstringnullable
    Example: department_id_1
    idstringnullable
    itemIdstringrequired

    Possible values: non-empty

    productCategoryIdstringrequired
    Example: product_category_1
    productCategoryNamestring

    Possible values: non-empty

    productLineIdstringrequired

    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
  • ]
  • 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

Authorization: apiKey

name: apiKeytype: apiKeyin: header
curl -L -X PUT 'https://sight.inspectorio.com/api/v2-rc-1/purchase-orders/:po_number' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'apiKey: <apiKey>' \
-d '{
"clientCreatedDate": "2023-02-10",
"clientId": "client_1",
"clientUpdatedDate": "2019-02-20T06:37:18Z",
"commitId": "commit_id_1",
"commitPoSequence": "commit_po_sequence_1",
"deliveryDate": "2021-05-23T00:00:00Z",
"eventName": "Event 1",
"factoryId": "factory_1",
"inStoreDate": "2021-06-01T00:00:00Z",
"opoNumber": "opo_1",
"poNumber": "po_1",
"poSource": "domestic",
"poStatus": "canceled",
"poType": "po_type_1",
"shareToIds": [
"sub_org_1"
],
"shipEndDate": "2021-05-30T00:00:00Z",
"styles": [
{
"assortments": [
{
"assortmentId": "string",
"cartonQuantity": 0,
"items": [
{
"brandId": "brand_1",
"classId": "class_id_1",
"color": "string",
"configuration": 0,
"departmentId": "department_id_1",
"id": "string",
"itemId": "string",
"productCategoryId": "product_category_1",
"productLineId": "product_line_1",
"shipmentTerm": "shipment_term_1",
"size": "string"
}
]
}
],
"solids": [
{
"brandId": "brand_2",
"cartonQuantity": 0,
"casePackQuantity": 0,
"classId": "class_id_1",
"color": "string",
"departmentId": "department_id_1",
"id": "string",
"itemId": "string",
"productCategoryId": "product_category_1",
"productLineId": "product_line_1",
"quantity": 0,
"shipmentTerm": "shipment_term_1",
"size": "string"
}
],
"styleId": "style_1"
}
],
"uid": "abc-def-123-456",
"vendorId": "vendor_1"
}'
Request Collapse all
Base URL
https://sight.inspectorio.com
Auth
Parameters
— pathrequired
Body
{
  "clientCreatedDate": "2023-02-10",
  "clientId": "client_1",
  "clientUpdatedDate": "2019-02-20T06:37:18Z",
  "commitId": "commit_id_1",
  "commitPoSequence": "commit_po_sequence_1",
  "deliveryDate": "2021-05-23T00:00:00Z",
  "eventName": "Event 1",
  "factoryId": "factory_1",
  "inStoreDate": "2021-06-01T00:00:00Z",
  "opoNumber": "opo_1",
  "poNumber": "po_1",
  "poSource": "domestic",
  "poStatus": "canceled",
  "poType": "po_type_1",
  "shareToIds": [
    "sub_org_1"
  ],
  "shipEndDate": "2021-05-30T00:00:00Z",
  "styles": [
    {
      "assortments": [
        {
          "assortmentId": "string",
          "cartonQuantity": 0,
          "items": [
            {
              "brandId": "brand_1",
              "classId": "class_id_1",
              "color": "string",
              "configuration": 0,
              "departmentId": "department_id_1",
              "id": "string",
              "itemId": "string",
              "productCategoryId": "product_category_1",
              "productLineId": "product_line_1",
              "shipmentTerm": "shipment_term_1",
              "size": "string"
            }
          ]
        }
      ],
      "solids": [
        {
          "brandId": "brand_2",
          "cartonQuantity": 0,
          "casePackQuantity": 0,
          "classId": "class_id_1",
          "color": "string",
          "departmentId": "department_id_1",
          "id": "string",
          "itemId": "string",
          "productCategoryId": "product_category_1",
          "productLineId": "product_line_1",
          "quantity": 0,
          "shipmentTerm": "shipment_term_1",
          "size": "string"
        }
      ],
      "styleId": "style_1"
    }
  ],
  "uid": "abc-def-123-456",
  "vendorId": "vendor_1"
}
ResponseClear

Click the Send API Request button above and see the response here!