Magidoc

updateOrderOption
Mutation

Update an existing order option.

Arguments

#

deprecated

Indicates if the definition is deprecated. Deprecated definitions will be returned to the client and will be considered valid when validating an order, however new order items cannot be added using the definition and existing order items cannot be updated using the definition. This flag is ignored when creating an option definition, however it will always be set and returned once the definition has been created.

description

The description is a longer, human-readable description of the order option type or contents, intended for client display.

form

Contents must conform to ECHO Forms schema. See the ECHO Forms Specification for more information.

name

The name is a shortened name used to distinguish between other option definitions. This field must be unique per provider and is restricted to 30 characters.

nativeId

Non-null

The native ID for the order option.

providerId

Non-null

The provider ID for the order option.

scope

There are two levels of order options, provider and system. Only administrators may add system level options and only providers may add provider level options.

sortKey

The sort key is used to indicate the preferred display order among other definitions

Response

#

Returns OrderOptionMutationResponse .

Example

#

    
  

3

    
  

3

    
  

3