Cancel order

Element details

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

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
context	Send context data with this component's event.	○	○	{}	dict
sensitive		○	○	true	bool
triggers	Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.	○	○	[]	list
order_id	Order ID	◉	○		int
notify	Notify user by email	○	○	false	bool
reason	Cancel reason	○	○	null	CancelReason
integration		◉	○		ShopifyIntegrationRef

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