Fluent Commerce Logo
Docs
Sign In

CreateDemoConsignment

Rule

Changed on:

29 Nov 2023

Overview

The creates a demo .

Creates a demo with label {"PROP_LABEL_URL"} and carrier {"PROP_CARRIER_REF"}.

Plugin NameOrder Reference Module
Namespace[[account.id]].order

The is the foundation for order-related implementations. It provides reference workflows for , 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 .

carrierRef

The carrier ref used for the .

Event attributes

This does not directly identify any attributes.

Exceptions

TThis 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}

Version History

2023-08-04

v1.0.0

refers to