Fulfillments

The fulfillment flow is used to send shipment data to ChannelEngine. This flow allows you to provide both the shipped products and the carrier tracking information.

Below is an example of the payload sent during the fulfillment process:

{
    "externalReference": "CE-S-97_1",
    "orderName": "CE-TEST-123",
    "lineItems": [
        {
            "sku": "0001BK",
            "qty": 1
        }
    ],
    "trackingInfo": {
        "company": "UPS",
        "number": "1Z001985YW99744790",
        "url": "https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER"
    }
}

Description of the main fields

• externalReference
  A unique identifier for the shipment generated by the source system.

• orderName
  The reference to the order in ChannelEngine.

• lineItems
  The list of items included in the shipment. For each product, the following are provided:

  • sku: the unique product code
  • qty: the quantity shipped

• trackingInfo
  The tracking details provided by the carrier:

  • company: the carrier’s name
  • number: the tracking number
  • url: the direct link to the tracking page

Destination configuration

Configure a Channel Engine destination and associate it with the flow, in addition to the basic data flow configuration.

Field	Value	Notes
Destination Type	Channel Engine
Operation	Fulfillment sync	POST /egress/sync-fulfillment-to-ce
Channel Engine URL	https://CEURL.channelengine.net/api	Channel Engine API base URL
Channel Engine token	ALPHANUMERICCODE	Channel Engine API token

Deprecated — previous configuration (HTTP Adapter)

Deprecated

Configuration via HTTP Adapter with Base Url, Resource Path, and x-api-key header in Settings Override is deprecated. Use the Channel Engine destination configuration described above.

In addition to the basic data flow configuration, the following Settings Override settings were required:

Field	Value	Notes
Base Url	https://adapter.flowlyze.io	URL of the adapters
Resource Path	/api/adp/channel-engine/egress/sync-fulfillment-to-ce	Adapter path for fulfillment
Headers :: x-api-key	**********	API key for endpoint interaction verification
Headers :: x-ce-url	https://CEURL.channelengine.net/api	Channel Engine URL to connect to
Headers :: x-ce-token	ALPHANUMERICCODE	Token for the integration