CreateDemoConsignment
Rule
Changed on:
8 Aug 2025
Overview
The rule creates a demo consignment.
Creates a demo consignment with label {"PROP_LABEL_URL"} and carrier {"PROP_CARRIER_REF"}.
| Plugin Name | Order Reference Module |
|---|---|
| Namespace | [[account.id]].order |
The Order Reference Module is the foundation for order-related implementations. It provides reference workflows for click & collect, home delivery and mixed baskets and those needed to build your own. Extensible by design, use this Module as a base to build a solution to your customers' needs.
UI Description
Creates a demo consignment with label {"PROP_LABEL_URL"} and carrier {"PROP_CARRIER_REF"}.
Accepts
- ARTICLE
Actions
- This rule performs a CreateConsignment mutation
Rule parameters
Parameter | Description |
labelUrl | The label of the consignment. |
carrierRef | The carrier ref used for the consignment. |
Event attributes
This rule does not directly identify any event attributes.
Exceptions
TThis rule will throw an RubixException: 400
- if couldn't find any articles for
`fulfilmentId` - if couldn't find any carrier for
`carrierRef` - if attempted against unsupported entities
Configuration example
1{
2 "name": "<ACCOUNTID>.order.CreateDemoConsignment",
3 "props": {
4 "labelUrl":"{{labelUrl}}",
5 "carrierRef":"{{carrierRef}}"
6 }
7}