Update Purchase Order Item

SecurityAPIKeyHeader
Request
path Parameters
order_item_id
required
string (Order Item Id)
order_id
required
string (Order Id)
Request Body schema: application/json
required
custom_data
object (Custom Data)

Key-value pair of custom data. See the custom_data guide

description
string (Description) <= 128 characters

Human-readable description of this unit

Array of objects (References)
Default: []

References for this order item. If PRODUCT_REF is provided with a valid product value in the request, the product value will populate the item description and shipment_requirements fields, but only if their values are absent or set to null in the request.

object (Shipping Requirements)

Shipping requirements of this item

object (OrderItemAmount)
Responses
200

Successful Response

Response Schema: application/json
custom_data
object (Custom Data)

Key-value pair of custom data. See the custom_data guide

description
string (Description) <= 128 characters

Human-readable description of this unit

Array of objects (References)
Default: []

References for this order item. If PRODUCT_REF is provided with a valid product value in the request, the product value will populate the item description and shipment_requirements fields, but only if their values are absent or set to null in the request.

object (Shipping Requirements)

Shipping requirements of this item

required
object (OrderItemAmount)
id
required
string (Id)

ID of the Purchase Order Item

required
object (Available Amount)

Amount of the item that is left to be released

400

Validation Error

put/purchase-orders/{order_id}/items/{order_item_id}
Request samples
application/json
{
  • "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
  • "description": "string",
  • "references": [ ],
  • "shipping_requirements": {
    },
  • "amount": {
    }
}
Response samples
application/json
{
  • "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
  • "description": "string",
  • "references": [ ],
  • "shipping_requirements": {
    },
  • "amount": {
    },
  • "id": "string",
  • "available_amount": {
    }
}
Copyright © Shipwell 2025. All right reserved.