/
Re - sync orders items on Algolia.

Re - sync orders items on Algolia.

Owned by Manas Singh (Unlicensed)
Apr 25, 2022
4 min read

What is the purpose of this article?

This article contains the steps and information around how a person can initiate orders and returns historic sync independently for V2.

Prerequisites.

  • API Client: Postman, Insomnia.

  • From which date does the sync needs to happen.

Orders Historic Sync.

Orders historic sync can be required when any logic is changed in the structure, data is lost or new data needs to be populated for all orders.

When talking of orders sync, we specifically are syncing data for the forward journey/ shipment of any order item.

Below are the steps to initiate a historic Orders sync with Postman API client for example.

  1. Open Postman and click on Import as mentioned in the image below

     

  2. A dialog box will open, upon which click on “Raw Text”.

     

  3. Paste the curl provided below in the Text box.

    curl --location --request POST 'https://order-return-dot-eshopbox-client-portal-prod.appspot.com/_ah/api/esb/v2/orders/algolia/sync/init' \ --header 'Content-Type: application/json' \ --data-raw '{ "data": "{\"id\":254909,\"startDate\":\"2021-10-25 22:52:00\",\"endDate\":\"2022-03-21 22:59:00\",\"isHistoricSync\":\"1\",\"orderSyncIdentifier\":\"010101\"}" }'

  4. Then Click on “Continue” in the bottom right of the dialog box and the Click on “Import”.

  5. After importing the curl request the tab will open with the request parameters preconfigured. Click on Body as shown below.

     

  6. In the body, change the “startDate” value, with the start date from which re sync needs to be done in Algolia. Once changed press “Send”.

NOTE: The format of the dates must be in “yyyy-MM-dd HH:mm:ss“ where “MM“ stand for month of the year and “mm“ stands for minutes of the hour.

NOTE: Make sure that the value for “isHistoricSync” is always set to 1.
NOTE: Make sure that the start date is set to a maximum of 6 months past.

NOTE: The curl contains “\”“. Do not change those as it will distort the request body which is internally converted to Map.

NOTE FOR DEV: Please make sure to keep track of the API logs in GCP portal while initiating Historic syncs.

 

Returns Historic Sync.

Just as Orders historic sync, the Returns data of historic order items can be saved as well.

Please follow the steps below for Returns historic sync in Postman.

  1. Open Postman and click on Import as mentioned in the image below

     

  2. A dialog box will open, upon which click on “Raw Text”.

     

  3. Paste the curl provided below in the Text box.

    curl --location --request POST 'https://order-return-dot-eshopbox-client-portal-prod.appspot.com//_ah/api/esb/v2/returns/algolia/sync/init' \ --header 'Content-Type: application/json' \ --data-raw '{ "data": "{\"syncId\":298651,\"dateRangeEnd\":\"1650860760406\",\"dateRangeStart\":\"1635097234000\",\"returnShipmentOffset\":0,\"shipmentOffset\":0,\"limit\":0,\"randomIdentifier\":0,\"isHistoricSync\":1}" }'

  4. Then Click on “Continue” in the bottom right of the dialog box and the Click on “Import”.

  5. After importing the curl request the tab will open with the request parameters preconfigured. Click on Body as shown below.

     

  6. Convert your start date from which returns data is required to be synced to timestamp (in millisecond).

    1. Click on Epoch Converter .

    2. In the section highlighted below, please set your start date, select Local Time as time-zone and Click on “Human date to timestamp“. Copy the “Timestamp in milliseconds“ value.

       

  7. Once you have successfully converted the start date into timestamp (milliseconds), Paste the value against “dateRangeStart“ and the Hit “Send“.



Add label

Related content