Return Orders

The guide illustrates the Shopware Return Orders processing strategy on Alumio

Problem statement

Return Orders placed on the website is captured in the Shopware environment, Alumio is responsible for performing periodic Return order dumps from Shopware to a destination endpoint.

Return orders can be complete return or partial returns, it is indicated by a status flag that can have the following values return or return_partially.

Strategy 

The strategy adopted for processing the Return Orders is as follows,

  1. Invoke the in-built prototype "Shopware return order subscriber"  to fetch the return orders dump from Shopware to Alumio environment (Incoming connection).
  2. Perform necessary transformations to prepare the payload (Optional).
  3. Write the processed return orders to a destination storage (FTP, SFTP) or redirect the data to an external endpoint (outgoing connection).

Shopware API call details

The API call to fetch the return orders from Shopware is,

Shopware return order subscriber

/api/v1/search/state-machine-state/&{statusId}/order-deliveries


statusId is obtained by invoking the
/api/v1/search/state-machine-state

Incoming Configuration

The subscriber used to construct the Incoming connection is the "Shopware return order subscriber", the subscriber utilizes OAuth for authentication and thus the relevant information has to be fed to the subscriber as shown below.

Return State - is used to select if the incoming connection should process the "returned" orders or "returned_partially" orders.

Alumio provided Shopware 6 connector package ships with a "Shopware Return Order Restructure Transformer" that processes the raw return order data into a refined structure.
The return orders also utilize the Identity tracker and Mutation Dates to process only new return order entries from Shopware. This concept is discussed here.

Route Configuration

The route configuration to link the Incoming return orders connection to the Outgoing connection. The transformer Country Dictionary Map is also invoked here to convert the country code hash values to their respective ISO code.

Outgoing configuration

The outgoing configuration of the return orders is a simple Filesystem XML publisher that performs a dump to the FTP location depicted in the Filesystem configuration.

KeyPath: The keypath will be directly translated as the FileNames of the created XML in the FTP storage.