Attach Packaging Features to Orders

Updated 3 months ago by Kevin

Summary

Packaging Features can be attached to an Order during Order creation which allows much more advanced logic to be applied than the broader configuration settings. Some exmples of when you would want to attach a Packaging Feature to a specific order would be:

  • An Order shipping to a remote location needs extra padding for safer Product arrival
  • Certain orders need a special promotional flier added to them, but not all orders

Attaching Packaging Features to an Order

Admin or Client UI

During Order creation you can add properly formatted JSON to the Other Shipping Options field.

API order.create

You can attach Packaging Features to an order using the order.create or order.edit API endpoints using the other_shipping_options field.

Scripts

Scripts can set the order other_shipping_options field to attach Packaging Features.

JSON Format

Whether set through the UI or the API the "Other Shipping Options" field must contain a packaging key which has details about which Packaging Features to apply to the order. Either the sku or product_id may be used to specify the Packaging Features you wish to attach.

If an items key is specified it is an array of SKUs to which the Packaging Feature will be applied.

  • A Packaging Feature with One Scan Per: "Order" or "Package" must not have an items key
  • A Packaging Feature with One Scan Per: "Item" or "Each" must have an items key

The example JSON text below is specifying:

  • a Packaging Feature by its product_id — this Packaging Feature is either a one scan per Order or Package
  • a Packaging Feature by its SKU — this Packaging Feature is also either a one scan per Order or Package
  • a Packaging Feature by its SKU that is attached to specific Order Items — this Packaging Feature is either a one scan per Item or Each
{  
    "packaging": [
        { "product_id": 62},
        { "sku": "TapeLid"},
        { "sku": "BubbleWrap", "items": ["34-737-8757", "29-329-5002"]}
    ]
}

How did we do?