Update a PurchaseOrderLineItem (v2/Legacy)

SecurityAuthToken

Request

path Parameters

purchaseOrderId required	string <uuid> The id of the purchase order
purchaseOrderLineItemId required	string <uuid> The id of the purchase order line item

Request Body schema: application/json

Create/Update a PurchaseOrderLineItem

Line items are a list of products associated with the order. The product_ref field is used to link the line item to products in either the Shipwell system or your ERP system, but it is not required. This body also includes product-related options, such as description, length, and length_unit. You can add multiple line items to an order.

country_of_manufacture	string or null
description	string or null
freight_class	string (FreightClass) Enum: "50" "55" "60" "65" "70" "77.5" "85" "92.5" "100" "110" "125" "150" "175" "200" "250" "300" "400" "500"
hazmat_hazard_class	string or null
hazmat_identification_number	string or null
hazmat_packing_group	string or null Enum: "I" "II" "III"
hazmat_proper_shipping_name	string or null
height	number or null <float>
id	string <uuid> Ignored in requests, returns id of the line-item
length	number or null <float>
length_unit	string Default "IN" Enum: "CM" "IN" "FT" "M"
nmfc_item_code	string or null
nmfc_sub_code	string or null Maximum of 2 characters
package_weight	number or null <float>
piece_type	string (ProductPieceType) Enum: "BAG" "BALE" "BOTTLE" "BOX" "BUCKET" "BUNDLE" "CAN" "CARTON" "CASE" "COIL" "CRATE" "CYLINDER" "DRUM" "JERRICAN" "PACKAGE" "PAIL" "PIECES" "REEL" "ROLL" "SKID" "TUBE"
product_category	string or null
product_ref	string or null Alphanumeric value used for product lookup
provider_specific_packaging	string or null Provider-specific type of packaging used for the product
refrigeration_max_temp	number or null <float>
refrigeration_min_temp	number or null <float>
refrigeration_required	boolean
stackable	boolean Default value false
temp_unit	string Default "F" Enum: "F" "C"
value_per_piece	number or null <float>
value_per_piece_currency	string or null Enum: "CAD" "USD"
weight_unit	string Default "LB" Enum: "KG" "LB"
width	number or null <float>
	object (PurchaseOrderLineItemCustomData) Custom data for PurchaseOrderLineItem
package_type	string (ProductPackageType) Enum: "BAG" "BALE" "BIN" "BOTTLE" "BOX" "BUCKET" "BUNDLE" "CAN" "CARTON" "CASE" "COIL" "CRATE" "CYLINDER" "DRUM" "FLOOR_LOADED" "JERRICAN" "OTHER" "PAIL" "PIECES" "PKG" "PLT" "REEL" "ROLL" "SKID" "TOTE_BIN" "TOTE_CAN" "TUBE" "UNIT"
purchase_order	string or null <uuid>
total_line_item_weight	number <float> Read-only calculated field (package_weight * total_packages) of the PurchaseOrderLineItem
total_packages	integer or null <int32>
total_pieces	integer or null <int32>

Responses

200

Successfully returned a PurchaseOrderLineItem

Response Schema: application/json

country_of_manufacture	string or null
description	string or null
freight_class	string (FreightClass) Enum: "50" "55" "60" "65" "70" "77.5" "85" "92.5" "100" "110" "125" "150" "175" "200" "250" "300" "400" "500"
hazmat_hazard_class	string or null
hazmat_identification_number	string or null
hazmat_packing_group	string or null Enum: "I" "II" "III"
hazmat_proper_shipping_name	string or null
height	number or null <float>
id	string <uuid> Ignored in requests, returns id of the line-item
length	number or null <float>
length_unit	string Default "IN" Enum: "CM" "IN" "FT" "M"
nmfc_item_code	string or null
nmfc_sub_code	string or null Maximum of 2 characters
package_weight	number or null <float>
piece_type	string (ProductPieceType) Enum: "BAG" "BALE" "BOTTLE" "BOX" "BUCKET" "BUNDLE" "CAN" "CARTON" "CASE" "COIL" "CRATE" "CYLINDER" "DRUM" "JERRICAN" "PACKAGE" "PAIL" "PIECES" "REEL" "ROLL" "SKID" "TUBE"
product_category	string or null
product_ref	string or null Alphanumeric value used for product lookup
provider_specific_packaging	string or null Provider-specific type of packaging used for the product
refrigeration_max_temp	number or null <float>
refrigeration_min_temp	number or null <float>
refrigeration_required	boolean
stackable	boolean Default value false
temp_unit	string Default "F" Enum: "F" "C"
value_per_piece	number or null <float>
value_per_piece_currency	string or null Enum: "CAD" "USD"
weight_unit	string Default "LB" Enum: "KG" "LB"
width	number or null <float>
	object (PurchaseOrderLineItemCustomData) Custom data for PurchaseOrderLineItem
package_type	string (ProductPackageType) Enum: "BAG" "BALE" "BIN" "BOTTLE" "BOX" "BUCKET" "BUNDLE" "CAN" "CARTON" "CASE" "COIL" "CRATE" "CYLINDER" "DRUM" "FLOOR_LOADED" "JERRICAN" "OTHER" "PAIL" "PIECES" "PKG" "PLT" "REEL" "ROLL" "SKID" "TOTE_BIN" "TOTE_CAN" "TUBE" "UNIT"
purchase_order	string or null <uuid>
total_line_item_weight	number <float> Read-only calculated field (package_weight * total_packages) of the PurchaseOrderLineItem
total_packages	integer or null <int32>
total_pieces	integer or null <int32>

default

Default error response

put/purchase-orders/{purchaseOrderId}/line-items/{purchaseOrderLineItemId}/

Request samples

application/json

{"country_of_manufacture": "US",
"description": "string",
"freight_class": "50",
"hazmat_hazard_class": "string",
"hazmat_identification_number": "string",
"hazmat_packing_group": "I",
"hazmat_proper_shipping_name": "string",
"height": 0.1,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"length": 0.1,
"length_unit": "CM",
"nmfc_item_code": "string",
"nmfc_sub_code": "string",
"package_weight": 0.1,
"piece_type": "BAG",
"product_category": "string",
"product_ref": "string",
"provider_specific_packaging": "string",
"refrigeration_max_temp": 0.1,
"refrigeration_min_temp": 0.1,
"refrigeration_required": true,
"stackable": true,
"temp_unit": "F",
"value_per_piece": 0.1,
"value_per_piece_currency": "CAD",
"weight_unit": "KG",
"width": 0.1,
"custom_data": {"property1": null,
"property2": null
},
"package_type": "BAG",
"purchase_order": "94a9570d-82e2-4a81-b165-8cff67d9c735",
"total_line_item_weight": 0.1,
"total_packages": 0,
"total_pieces": 0
}

Response samples

200
default

application/json

{"country_of_manufacture": "US",
"description": "string",
"freight_class": "50",
"hazmat_hazard_class": "string",
"hazmat_identification_number": "string",
"hazmat_packing_group": "I",
"hazmat_proper_shipping_name": "string",
"height": 0.1,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"length": 0.1,
"length_unit": "CM",
"nmfc_item_code": "string",
"nmfc_sub_code": "string",
"package_weight": 0.1,
"piece_type": "BAG",
"product_category": "string",
"product_ref": "string",
"provider_specific_packaging": "string",
"refrigeration_max_temp": 0.1,
"refrigeration_min_temp": 0.1,
"refrigeration_required": true,
"stackable": true,
"temp_unit": "F",
"value_per_piece": 0.1,
"value_per_piece_currency": "CAD",
"weight_unit": "KG",
"width": 0.1,
"custom_data": {"property1": null,
"property2": null
},
"package_type": "BAG",
"purchase_order": "94a9570d-82e2-4a81-b165-8cff67d9c735",
"total_line_item_weight": 0.1,
"total_packages": 0,
"total_pieces": 0
}