consignment_breakdown

consignment_breakdown

consignment_breakdown is most commonly used to return and display the quantity and SKU of products within individual articles/consignments/orders.

Example

In the below example, the order_id, article_id and cngmt_id params are passed in with their respective data tags as values, which lists out each item SKU and it's quantity in the target consignment.

[%consignment_breakdown order_id:'[@order_id@]' article_id:'[@art_id@]' cngmt_id:'[@cngmt_id@]'%]
    [%param *body%]
        <p>SKU: [@SKU@] Qty: [@quantity@]</p>
    [%/param%]
[%/consignment_breakdown%]

Usage

A single order, depending on it's size, can have multiple consignments. These in turn can have their own articles/packages and the individual products within. The consignment_breakdown function displays the relevant information breakdown of it's consignment. This is then most commonly used to create consignment labels for shipping.

consignment_breakdown Parameters

Name Options Description
order_id:'' HTML & B@SE tags The ID of the order the consignment is part of
cngmt_id:'' HTML & B@SE tags The ID of a consignment
article_id:'' HTML & B@SE tags The ID of the article within a consignment
warehouse_id:'' HTML & B@SE tags The ID of the warehouse where a consignment is located
article_item_notes:'' HTML & B@SE tags Notes belonging to an item within an article
article_notes:'' HTML & B@SE tags Notes belonging to an article
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 product_history returns no results, it'll load this block instead

consignment_breakdown Data Tags

Name Description
[@SKU@] The SKU of a item
[@quantity@] The quantity of an item
[@order_id@] The ID of the order the consignment is part of
[@cngmt_id@] The ID of a consignment
[@article_id@] The ID of the article within a consignment
[@warehouse_id@] The ID of the warehouse where a consignment is located
[@article_item_notes@] Notes belonging to an item within an article
[@article_notes@] Notes belonging to an article

Was this article useful?

Be notified when this page is updated. Optional.