Order Import

Shopify orders are actively retrieved by Flowlyze.

The information retrieved about orders includes:

• the sales channel (Channel).
• basic order information (for example name, identifier, etc.).
• taxes and prices associated with the order.
• discounts present in the order.
• the associated customer (Customer): information about the customer associated with the order.
• shipping and billing addresses (ShippingAddress and BillingAddress): details of the order's shipping and billing addresses.
• executed transactions (Transactions): data on payment transactions.
• fulfillments (Fulfillments and FulfillmentOrders): information regarding order fulfillments.
• items present (LineItems): details about items included in the order.
• shipping (ShippingLines): information about shipping costs.
• assigned locations (AssignedLocations): specifies which SKUs and quantities must be picked from each location.
• metadata (Metadata): a field containing additional Shopify order-specific data, including details such as the fulfillment status (displayed exactly as shown on Shopify, without any transformation).
• the order operator (OrderOperator): staff member who executed the order (e.g. Shopify POS), available if the x-include-staff-member-info header is true. Requires the read_users access scope. The app must be a finance embedded app or installed on a Shopify Plus or Advanced store. Contact Shopify Support to enable this scope for your app.

The Adapter adds a tag to the order to verify its export (EXPORT) and avoid duplicate sends towards the destination, but only if the unique synchronization header is set to true. This behavior allows synchronizing an order only once, ignoring any subsequent updates (optional behavior, configurable via header). If the header is not set, the tag is not added and the order can be exported multiple times.

warning

Compatibility with Shopify plans

Using this endpoint with a Shopify store on Basic plan, only limited information will be available on the customer within order data, due to Shopify API restrictions.

Active Order Flow Configuration

After creating the destination, which in the case of an active flow can be a database or an endpoint, it is necessary to configure the flow by enabling scheduling (Schedulation Enabled) and setting it as follows:

Campo	Valore	Note
Name	e.g. active-flow-order	Scheduling name
Cron Expression	*/5 * * * *	How often to retrieve orders (e.g. */5 * * * * -> every 5 minutes)
Source Type	http	Source type to use
Url	https://adapter.flowlyze.io/api/adp/shopify/ingress/get-orders-updated-after	Endpoint URL to call (see note at end of table)
Method	GET	Method to call the endpoint
Headers :: x-api-key	**********	API key for endpoint interaction verification
Headers :: x-shopify-graphql-url	https://SHOPIFYURL.myshopify.com/	Shopify shop URL to connect to
Headers :: x-shopify-access-token	shpat_CODICEALFANUMERICO	Secret of the custom app created for integration
Headers :: x-last-order-updated-processed"	e.g. 2024-11-15T12:00:00Z	Date to start retrieving orders from
Headers :: x-sync-order-once	true	Boolean to insert the order only once, does not propagate updates (default false)
Headers :: channel-code"	Your Shopify Store	Your Shopify shop name or code
Headers :: x-number-of-orders	10	Number of orders to retrieve per call (default 10)
Headers :: x-include-merchant-info	true/false	Boolean to retrieve merchant information (default false)
Headers :: x-include-company-info	true/false	Boolean to retrieve B2B company information (default false)
Headers :: x-include-staff-member-info	true/false	Boolean to retrieve the operator who executed the order, e.g. with Shopify POS (default false).

info

Two distinct endpoints are available, which differ only in output:

1. Standard:
   • URL : https://adapter.flowlyze.io/api/adp/shopify/ingress/get-orders-updated-after
   • The output of order information is simplified, without nodes (nodes) and pagination information (pageInfo).
2. Legacy:
   • URL : https://adapter.flowlyze.io/api/adp/shopify/ingress/get-orders-updated-after-legacy
   • The output includes more detailed structures, with nodes (nodes) and pagination information (pageInfo).

Example of retrieved information - Standard behavior

The standard output provides simplified order data. For complete detailed examples with all fields, see the original documentation in the Italian version.

When x-include-staff-member-info is true, the payload includes orderOperator:

{
    "orderOperator": {
      "id": "gid://shopify/StaffMember/123456789",
      "name": "Mario Rossi",
      "email": "[email protected]",
      "phone": "+39 333 1234567"
    }
}