Skip to main content

Order Import

Channel Engine orders are actively retrieved by Flowlyze.

The retrieved order information includes:

  • Sales channel (Channel).
  • Basic order information (e.g., name, ID, etc.).
  • Prices associated with the order.
  • Discounts present in the order.
  • The customer (Customer): information about the customer associated with the order.
  • Shipping and billing addresses (ShippingAddress and BillingAddress): details of the order's addresses.
  • Order items (OrderItems): details of the items included in the order.
  • Assigned locations (AssignedLocations): indicates which SKUs and quantities should be picked from each location.
  • Returns (Returns): the list of returns associated with the order.
  • Fulfillments (Fulfillments): the list of shipments associated with the order.

Active Order Flow Configuration

After creating the destination, which in the case of an active flow can be a database or an endpoint, you must configure the flow by enabling Scheduling (Schedulation Enabled) and set it as follows:

FieldValueNotes
Namee.g. active-flow-orderName of the scheduling
Cron Expression*/5 * * * *Frequency of order retrieval (e.g. */5 * * * * → every 5 minutes)
Source TypehttpThe type of source to be used
Urlhttps://adapt.flowlyze.com/api/adp/channel-engine/ingress/get-order-updated-afterURL of the endpoint to call (see note at the end of the table)
MethodGETHTTP method to call the endpoint
Headers :: x-api-key**********API key to validate interaction with the endpoint
Headers :: x-ce-urlhttps://CEURL.channelengine.net/apiURL of the Channel Engine to connect to
Headers :: x-ce-tokenALPHANUMERICCODEToken for the integration
Headers :: x-last-order-updated-processede.g. 2025-11-19T10:59:00.2238217ZDate from which to start retrieving orders
Headers :: x-number-of-orders10Number of orders to retrieve per request (default 10)

The x-last-order-updated-processed header on Flowlyze is required to retrieve orders automatically according to the last update date. It must be set as an incremental value (see here). The fields to set in the Incremental fields section of the flow form (Step 2 - Source) are:

  • Name: the variable name associated with the incremental field. Example: x-last-order-updated-processed = {{lastOrderUpdatedProcessed}}, where the incremental variable name is lastOrderUpdatedProcessed.
  • Message JSON Path: the field used to read the incremental value from the JSON message body. Example: updatedAt.
  • Aggregator: aggregation criterion to determine the incremental field value. Example: max.
  • Current Value: the value associated with the incremental field, which can initially be empty to allow retrieving also the least recently updated orders.

Example of Retrieved Information

{
"id": "167",
"orderNumber": null,
"orderName": "TEST_ORD_4",
"channel": "Amazon.it (v3)",
"srcName": "Amazon.it (v3)",
"note": null,
"tags": [],
"test": true,
"orderNotes": {},
"paymentStatus": "PENDING",
"fulfillmentStatus": "UNFULFILLED",
"isPickupInStore": false,
"pickupInStoreLocation": null,
"shippingAddress": {
"firstName": "Mario",
"lastName": "Rossi",
"company": "Company 1",
"street1": "Via Roma 1",
"street2": null,
"city": "Firenze",
"zip": "50051",
"province": null,
"provinceCode": null,
"country": null,
"countryCode": "IT",
"phone": null
},
"billingAddress": {
"firstName": "Mario",
"lastName": "Rossi",
"company": "Company 1",
"street1": "Via Roma 1",
"street2": null,
"city": "Firenze",
"zip": "50051",
"province": null,
"provinceCode": null,
"country": null,
"countryCode": "IT",
"phone": null
},
"customer": {
"id": "123456789",
"channel": null,
"email": "m.rossi@test.it",
"createdAt": null,
"updatedAt": null,
"firstName": null,
"lastName": null,
"phone": "0148759847",
"locale": null,
"tags": null,
"acceptsEmailMarketing": false,
"acceptsEmailMarketingDate": null,
"acceptsSmsMarketing": false,
"acceptsSmsMarketingDate": null,
"totalSpent": 0,
"ordersCount": 0
},
"cancelReason": null,
"cancelledAt": null,
"orderItems": [
{
"id": "280",
"sku": "BGSM001C2116",
"productId": null,
"variantId": null,
"imageUrl": null,
"bundleCode": null,
"name": "Product Test 1 Con Varianti",
"requiresShipping": false,
"vendor": null,
"isGiftCard": false,
"giftCards": [],
"metadata": {},
"shopTotals": {
"currencyCode": null,
"unitPrice": 15.99,
"originalUnitPrice": 15.99,
"totalNetPrice": 26.43,
"totalPrice": 31.98,
"originalTotalPrice": 31.98
},
"customerTotals": {
"currencyCode": "EUR",
"unitPrice": 15.99,
"originalUnitPrice": 15.99,
"totalNetPrice": 26.43,
"totalPrice": 31.98,
"originalTotalPrice": 31.98
},
"taxLines": [],
"taxBreakdown": {},
"unitWeight": null,
"duties": {},
"discountAllocations": [],
"qtyOrdered": 2,
"qtyShipped": 0,
"qtyRefunded": 0,
"unitAmountDiscounted": 0,
"orderItemNotes": {},
"itemGroup": null
},
{
"id": "281",
"sku": "BGSM002C001",
"productId": null,
"variantId": null,
"imageUrl": null,
"bundleCode": null,
"name": "Borsa Nera in Pelle",
"requiresShipping": false,
"vendor": null,
"isGiftCard": false,
"giftCards": [],
"metadata": {},
"shopTotals": {
"currencyCode": null,
"unitPrice": 109.99,
"originalUnitPrice": 109.99,
"totalNetPrice": 90.9,
"totalPrice": 109.99,
"originalTotalPrice": 109.99
},
"customerTotals": {
"currencyCode": "EUR",
"unitPrice": 109.99,
"originalUnitPrice": 109.99,
"totalNetPrice": 90.9,
"totalPrice": 109.99,
"originalTotalPrice": 109.99
},
"taxLines": [],
"taxBreakdown": {},
"unitWeight": null,
"duties": {},
"discountAllocations": [],
"qtyOrdered": 1,
"qtyShipped": 0,
"qtyRefunded": 0,
"unitAmountDiscounted": 0,
"orderItemNotes": {},
"itemGroup": null
}
],
"shopTotals": {
"currencyCode": null,
"subTotalPrice": 141.97,
"totalNetPrice": 125.59,
"totalPrice": 151.97,
"totalShippingPrice": 10,
"totalDiscounts": 0
},
"customerTotals": {
"currencyCode": "EUR",
"subTotalPrice": 141.97,
"totalNetPrice": 125.59,
"totalPrice": 151.97,
"totalShippingPrice": 10,
"totalDiscounts": 0
},
"taxExempt": false,
"taxesIncluded": true,
"taxLines": [],
"fulfillments": [
{
"id": "TEST_SHIPMENT_4_1",
"status": "PENDING",
"orderName": "TEST_ORD_4",
"shipmentDate": null,
"lineItems": [
{
"sku": "BGSM001C2116",
"qty": 1
}
],
"trackingInfo": {
"company": "DHL",
"number": "123",
"url": "https://www.dhl.com/nl-en/home/tracking/tracking-freight.html?submit=1&tracking-id={TrackTraceLink}"
},
"notifyCustomer": true,
"locationReference": ""
},
{
"id": "TEST_SHIPMENT_4_1",
"status": "PENDING",
"orderName": "TEST_ORD_4",
"shipmentDate": null,
"lineItems": [
{
"sku": "BGSM001C2116",
"qty": 1
},
{
"sku": "BGSM002C001",
"qty": 1
}
],
"trackingInfo": {
"company": "UPS",
"number": "1234",
"url": "http://wwwapps.ups.com/WebTracking/track?trackNums=1234&track.x=Traceren"
},
"notifyCustomer": true,
"locationReference": ""
}
],
"transactions": [],
"discounts": [],
"createdAt": "2025-11-28T11:07:21.7146242+01:00",
"updatedAt": "2025-11-28T11:10:24.8641714+01:00",
"processedAt": null,
"closedAt": "2025-11-28T11:09:33.3202112+01:00",
"returns": [
{
"id": "52",
"name": "TEST_RETURN_4_1",
"status": "CLOSED",
"totalQuantity": 1,
"note": "",
"returnItems": [
{
"id": "280",
"sku": "BGSM001C2116",
"quantity": 1
}
],
"returnShipping": null
},
{
"id": "53",
"name": "TEST_RETURN_4_2",
"status": "OPEN",
"totalQuantity": 1,
"note": "",
"returnItems": [
{
"id": "281",
"sku": "BGSM002C001",
"quantity": 1
}
],
"returnShipping": null
}
],
"refunds": [],
"shippingLines": [],
"metafields": [],
"metadata": {
"VAT_CALCULATION_METHOD_KEY": "FROM_PRICE_INCL"
},
"assignedLocations": [
{
"locationCode": "1",
"locationName": "Default Warehouse",
"assignedItems": [
{
"sku": "BGSM001C2116",
"quantity": 2
},
{
"sku": "BGSM002C001",
"quantity": 1
}
]
}
]
}