type: meya.shopify.component.customer.order.list
class: ShopifyCustomerOrderListComponent
path: /meya/shopify/component/customer/order/list.py
signature: -
Get customer orders
Fields
field | signature | required | type | default | description |
---|---|---|---|---|---|
spec | ○ | ○ | 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 |
customer_id | ○ | ◉ | int | Customer ID | |
integration | ○ | ◉ | ShopifyIntegrationRef | ||
ids | ○ | ○ | list | null | List of orders IDs |
financial_status | ○ | ○ | OrderFilterFinancialStatus | "any" | Financial status |
fulfillment_status | ○ | ○ | OrderFilterFulfillmentStatus | "any" | Fulfillment status |
status | ○ | ○ | OrderFilterStatus | "open" | Order status |
Examples
Basic
triggers:
- keyword: meya.shopify.component.customer.order.list
steps:
- type: meya.shopify.component.customer.order.list
customer_id: 123
integration: integration.shopify
Full
triggers:
- keyword: meya.shopify.component.customer.order.list
steps:
- type: meya.shopify.component.customer.order.list
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
customer_id: 123
integration: integration.shopify
ids:
- 123
financial_status: authorized|pending|paid|partially_paid|refunded|voided|partially_refunded|any|unpaid
fulfillment_status: shipped|partial|unshipped|any|unfulfilled
status: open|closed|cancelled|any