Refund order

Element details

type: meya.shopify.component.order.refund
class: ShopifyOrderRefundComponent
path: /meya/shopify/component/order/refund.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	Order element	◉	○		Order
integration		◉	○		ShopifyIntegrationRef

Usage reference

Basic

triggers:
  - keyword: meya.shopify.component.order.refund
steps:
  - type: meya.shopify.component.order.refund
    order:
      app_id: 123
      line_items:
        - id: 123
          title: STRING
          vendor: STRING
          sku: STRING
          name: STRING
          grams: 123
          duties:
            - item1
            - item2
          taxable: false
          quantity: 123
          gift_card: false
          price: STRING
          tax_lines:
            - foo: bar
          properties:
            - item1
            - item2
          variant_id: 123
          product_exists: false
          total_discount: STRING
          requires_shipping: false
          fulfillment_service: STRING
          admin_graphql_api_id: STRING
          discount_allocations:
            - item1
            - item2
          fulfillable_quantity: 123
          variant_inventory_management: STRING
      buyer_accepts_marketing: false
      created_at: STRING
      currency: STRING
      customer:
        id: 123
        accepts_marketing: false
        created_at: STRING
        updated_at: STRING
        first_name: STRING
        last_name: STRING
        orders_count: 123
        state: disabled|invited|enabled
        total_spent: STRING
        verified_email: false
        currency: STRING
        accepts_marketing_updated_at: STRING
        admin_graphql_api_id: STRING
      email: STRING
      financial_status: authorized|pending|paid|partially_paid|refunded|voided|partially_refunded
      id: 123
      name: STRING
      note: STRING
      note_attributes:
        - foo: bar
      number: 123
      order_number: 123
      payment_gateway_names:
        - STRING
      presentment_currency: STRING
      processed_at: STRING
      processing_method: checkout|direct|manual|offsite|express|free
      refunds:
        - foo: bar
      subtotal_price: STRING
      tax_lines:
        - foo: bar
      taxes_included: false
      test: false
      token: STRING
      total_discounts: STRING
      total_line_items_price: STRING
      total_price: STRING
      total_tax: STRING
      total_tip_received: STRING
      total_weight: 123
      updated_at: STRING
      user_id: 123
      order_status_url: STRING
      total_price_usd: STRING
      admin_graphql_api_id: STRING
    integration: integration.shopify

Full

triggers:
  - keyword: meya.shopify.component.order.refund
steps:
  - type: meya.shopify.component.order.refund
    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:
      app_id: 123
      line_items:
        - id: 123
          title: STRING
          vendor: STRING
          product_id: 123
          sku: STRING
          name: STRING
          grams: 123
          duties:
            - item1
            - item2
          taxable: false
          quantity: 123
          gift_card: false
          price: STRING
          tax_lines:
            - foo: bar
          properties:
            - item1
            - item2
          variant_id: 123
          product_exists: false
          total_discount: STRING
          requires_shipping: false
          fulfillment_service: STRING
          admin_graphql_api_id: STRING
          discount_allocations:
            - item1
            - item2
          fulfillable_quantity: 123
          variant_inventory_management: STRING
          total_discount_set:
            foo: bar
          fulfillment_status: STRING
          variant_title: STRING
          price_set:
            foo: bar
          origin_location:
            foo: bar
      buyer_accepts_marketing: false
      created_at: STRING
      currency: STRING
      customer:
        id: 123
        accepts_marketing: false
        created_at: STRING
        updated_at: STRING
        first_name: STRING
        last_name: STRING
        orders_count: 123
        state: disabled|invited|enabled
        total_spent: STRING
        verified_email: false
        currency: STRING
        accepts_marketing_updated_at: STRING
        admin_graphql_api_id: STRING
        tax_exempt: false
        default_address:
          address1: STRING
          city: STRING
          province: STRING
          country: STRING
          last_name: STRING
          country_code: STRING
          province_code: STRING
          zip: STRING
          first_name: STRING
          phone: STRING
          company: STRING
          address2: STRING
          latitude: 1.0
          longitude: 1.0
          name: STRING
        tags: STRING
        addresses:
          - address1: STRING
            city: STRING
            province: STRING
            country: STRING
            last_name: STRING
            country_code: STRING
            province_code: STRING
            zip: STRING
            first_name: STRING
            phone: STRING
            company: STRING
            address2: STRING
            latitude: 1.0
            longitude: 1.0
            name: STRING
        last_order_name: STRING
        tax_exemptions:
          - item1
          - item2
        multipass_identifier: STRING
        note: STRING
        email: STRING
        phone: STRING
        last_order_id: 123
        marketing_opt_in_level: single_opt_in|confirmed_opt_in|unknown
      email: STRING
      financial_status: authorized|pending|paid|partially_paid|refunded|voided|partially_refunded
      id: 123
      name: STRING
      note: STRING
      note_attributes:
        - foo: bar
      number: 123
      order_number: 123
      payment_gateway_names:
        - STRING
      presentment_currency: STRING
      processed_at: STRING
      processing_method: checkout|direct|manual|offsite|express|free
      refunds:
        - foo: bar
      subtotal_price: STRING
      tax_lines:
        - foo: bar
      taxes_included: false
      test: false
      token: STRING
      total_discounts: STRING
      total_line_items_price: STRING
      total_price: STRING
      total_tax: STRING
      total_tip_received: STRING
      total_weight: 123
      updated_at: STRING
      user_id: 123
      order_status_url: STRING
      total_price_usd: STRING
      admin_graphql_api_id: STRING
      payment_details:
        foo: bar
      total_line_items_price_set:
        foo: bar
      total_price_set:
        foo: bar
      total_shipping_price_set:
        foo: bar
      total_discounts_set:
        foo: bar
      total_tax_set:
        foo: bar
      subtotal_price_set:
        foo: bar
      client_details:
        foo: bar
      checkout_token: STRING
      cart_token: STRING
      browser_ip: STRING
      current_total_price: STRING
      current_subtotal_price: STRING
      current_total_tax: STRING
      total_outstanding: STRING
      source_identifier: STRING
      source_url: STRING
      reference: STRING
      device_id: 123
      fulfillments:
        - id: 123
          order_id: 123
          created_at: STRING
          service: STRING
          updated_at: STRING
          location_id: 123
          line_items:
            - id: 123
              title: STRING
              vendor: STRING
              product_id: 123
              sku: STRING
              name: STRING
              grams: 123
              duties:
                - item1
                - item2
              taxable: false
              quantity: 123
              gift_card: false
              price: STRING
              tax_lines:
                - foo: bar
              properties:
                - item1
                - item2
              variant_id: 123
              product_exists: false
              total_discount: STRING
              requires_shipping: false
              fulfillment_service: STRING
              admin_graphql_api_id: STRING
              discount_allocations:
                - item1
                - item2
              fulfillable_quantity: 123
              variant_inventory_management: STRING
              total_discount_set:
                foo: bar
              fulfillment_status: STRING
              variant_title: STRING
              price_set:
                foo: bar
              origin_location:
                foo: bar
          tracking_company: STRING
          shipment_status: 
            label_printed|label_purchased|attempted_delivery|ready_for_pickup|confirmed|in_transit|out_for_delivery|delivered|failure
          status: pending|open|success|cancelled|error|failure
          tracking_numbers:
            - STRING
          tracking_urls:
            - STRING
      discount_applications:
        - foo: bar
      discount_codes:
        - foo: bar
      current_total_tax_set:
        foo: bar
      current_subtotal_price_set:
        foo: bar
      current_total_price_set:
        foo: bar
      current_total_discounts: STRING
      current_total_discounts_set:
        foo: bar
      current_total_duties_set:
        foo: bar
      billing_address:
        address1: STRING
        city: STRING
        province: STRING
        country: STRING
        last_name: STRING
        country_code: STRING
        province_code: STRING
        zip: STRING
        first_name: STRING
        phone: STRING
        company: STRING
        address2: STRING
        latitude: 1.0
        longitude: 1.0
        name: STRING
      shipping_address:
        address1: STRING
        city: STRING
        province: STRING
        country: STRING
        last_name: STRING
        country_code: STRING
        province_code: STRING
        zip: STRING
        first_name: STRING
        phone: STRING
        company: STRING
        address2: STRING
        latitude: 1.0
        longitude: 1.0
        name: STRING
      transactions:
        - id: 123
          amount: 1.0
          authorization: STRING
          created_at: STRING
          currency: STRING
          device_id: 123
          error_code: STRING
          extended_authorization_attributes:
            foo: bar
          gateway: STRING
          kind: authorization|capture|sale|void|refund
          location_id: 123
          message: STRING
          order_id: STRING
          parent_id: 123
          processed_at: STRING
          source_name: STRING
          status: pending|failure|success|error
          test: false
          user_id: 123
          currency_exchange_adjustment:
            foo: bar
          receipt:
            foo: bar
          payment_details:
            foo: bar
          authorization_expires_at: STRING
      closed_at: STRING
      fulfillment_status: fulfilled|partial|null|restocked
      phone: STRING
      cancelled_at: STRING
      landing_site: STRING
      cancel_reason: customer|fraud|inventory|declined|other
      referring_site: STRING
      customer_locale: STRING
      contact_email: STRING
      original_total_duties_set:
        foo: bar
      tags: STRING
      landing_site_ref: STRING
      shipping_lines:
        - foo: bar
      location_id: 123
    integration: integration.shopify