Returns information about shipping cartons, including contained items, quantity, weight, volume, etc.


TODO: Document front-end example cases


With regards to shipping, shipping cartons can contain many different items. This function is used to display the contents of those cartons as well as any other relevant shipping details. sku is passed as a param, which will give quantity, weight, cubic, length, width, height and barcode.

To change the units those values are displayed in, params like length_unit and weight_unit and their respective values can be passed in.

To return details of each product in a carton, the linear param can be passed in.

item_cartons Parameters

Name Options Description
sku:'' Integer The ID of the target of the function
linear:'' HTML & b@se tags Return details of each product contained in the carton
length_unit:'' HTML & b@se tags Specifies the unit used to display length
weight_unit:'' HTML & b@se tags Specifies the unit used to display weight
header HTML & b@se tags Renders a single usable space above the body
body* HTML & b@se tags Runs an array for result
footer HTML & b@se tags Renders a single usable space below the body
ifempty:'' HTML & b@se tags If the random_products returns no results, it'll load this block instead

item_cartons Data Tags

Name Description
[@quantity@] The quantity of the product(s)/carton(s)
[@weight@] The weight of the carton
[@cubic@], [@length@], [@width@], [@height@] The dimensions of the carton
[@barcode@] Shipping barcode assigned to the carton

Was this article useful?

Be notified when this page is updated. Optional.