updateCarrier

Input fields

input (UpdateCarrierInput)

Return fields

id (ID!)

ID of the object

createdOn (DateTime)

Time of creation

updatedOn (DateTime)

Time of last update

ref (String!)

The reference identifier used to identify an entity

type (String!)

Type of the Carrier, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform.
The type field can be used to differentiate between Inventory Position workflows

status (String)

The current status of the Carrier.
By default, the initial value will be CREATED, however no other status values are enforced by the platform.
The status field is also used within ruleset selection during orchestration. For more info, see Orchestration

workflowRef (String!)

The reference used for workflow identification. This is defined by a combination of the entity name and the type, in the format [EntityName]::[Type]. For example, an Order of type CC will have the workflowRef "ORDER::CC".
The reference used for workflow identification

workflowVersion (Int!)

The version of the workflow assigned to the entity and used for workflow identification. It comprises a major version and minor version number.
The version of the workflow

attributes ([Attribute])

A list of attributes associated with this Carrier. This can be used to extend the existing data structure with additional data for use in orchestration rules, etc.

name (String!)

The carrier name

retailer (Retailer)

The retailer

manifests ([Manifest])

A list of manifests associated with this Carrier.