shopify.order.cancel

Cancel order

Element details

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

Fields

fielddescription               requiredsignaturedefaulttype
specOverride the original spec for this element.nullSpec
contextSend context data with this component's event.{}
dict
sensitivetruebool
triggersActivate these dynamic triggers when the component runs. Check the component triggers guide for more info.[]list
order_idOrder IDint
notifyNotify user by emailfalsebool
reasonCancel reasonnullCancelReason
integrationShopifyIntegrationRef

Usage reference

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:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    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