shopify.order.cancel

type: meya.shopify.component.order.cancel
class: ShopifyOrderCancelComponent
path: /meya/shopify/component/order/cancel.py
signature: -

Cancel order

Fields

field

signature

required

type

default

description               

spec

ForwardRef('Spec')

null

Override the original spec for this element

context

dict

{}

Send context data with this component's event

sensitive

bool

true

triggers

list

[]

Activate these dynamic triggers when the component runs

order_id

int

Order ID

notify

bool

false

Notify user by email

reason

CancelReason

null

Cancel reason

integration

ShopifyIntegrationRef

Examples

Basic

triggers:
  - keyword: meya.shopify.component.order.cancel
steps:
  - type: meya.shopify.component.order.cancel
    order_id: 123
    integration: integration.shopify

Full

triggers:
  - keyword: meya.shopify.component.order.cancel
steps:
  - type: meya.shopify.component.order.cancel
    spec: '?'
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    order_id: 123
    notify: false
    reason: customer|fraud|inventory|declined|other
    integration: integration.shopify