item_cartons

item_cartons

Returns information about shipping dimensions, weight and barcode for one product

Example

[%item_cartons sku:'[@sku@]' length_unit:'m' weight_unit:'kg' linear:'1'%]
    [%param *header%]
        <h4>Shipping Details</h4>
        <ul>
    [%/param%]
    [%param *body%]
        <li>Barcode: [@carton_1_barcode@]</li>
        <li>Cubic: [@carton_1_cubic@]</li>
        <li>Height: [@carton_1_height@]</li>
        <li>Length: [@carton_1_length@]</li>
        <li>Quantity: [@carton_1_quantity@]</li>
        <li>Weight: [@carton_1_weight@]</li>
        <li>Width: [@carton_1_width@]</li>
        <li>Number of Cartons: [@total_cartons@]</li>
    [%/param%]
    [%param *footer%]
        </ul>
    [%/param%]
[%/item_cartons%]

Usage

The item_cartons function is used for products that uses the Carton Breakdown feature. If a product is made up of several cartons you can define these cartons. Separate article labels will be created and printed for each carton automatically.

The Carton Breakdown settings are under the Shipping section of the product details.

With the parameter linear:'1' set, this function will return the carton details for each pre-defined carton on the product card.

Parameters

Name Options Description
sku:'' String The ID of the target of the function
linear:'' 0/1 Return more details on each carton including the dimensions, cubic and weight
length_unit:'' m, cm Specifies the unit used to display length. m - metres, cm - centimetres
weight_unit:'' kg, g Specifies the unit used to display weight. kg - kilograms, g - grams
*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
Name Example Description
[@total_cartons@] 1 The quantity of the product(s)/carton(s)

Data Tags (body)

If linear:'1' is set, the body only appears once in the result, but contains the details for each carton. When linear:'0' is used or is omitted, the body is returned for every carton with only two tags - [@count@] and [@total_cartons@].

Name Example Description
[@carton_#_barcode@] 9300675031302 Barcode (UPC/EAN) of the product. Only returned if linear:'1' is set. # is the carton number
[@carton_#_cubic@] 0.008000 The weight of the carton. Only returned if linear:'1' is set. # is the carton number
[@carton_#_height@] 0.25 Height of the carton using the setting in length_unit:''. Only returned if linear:'1' is set. # is the carton number
[@carton_#_length@] 0.25 Length of the carton using the setting in length_unit:''. Only returned if linear:'1' is set. # is the carton number
[@carton_#_quantity@] 1 Quantity of the product in the carton. Only returned if linear:'1' is set. # is the carton number
[@carton_#_weight@] 1 Weight of the carton based on the setting weight_unit:''. Only returned if linear:'1' is set. # is the carton number
[@carton_#_width@] 0.25 Width of the carton using the setting in length_unit:''. Only returned if linear:'1' is set. # is the carton number
[@count@] 0 Count of the carton starting at 0. Not returned if linear:'1' is set
[@total_cartons@] 1 The number of cartons

Was this article useful?

Be notified when this page is updated. Optional.