Shopping Trip¶

Generates a user redirection link to the merchant’s shopping page for a given store or product.

Endpoint¶

GET https://partners.waffarx.com/{ShoppingUrlBase}

Request Headers¶

Header	Description
wxc-id	Your WaffarX Client Id
wxc-auth	Signature auth header for the request
wxc-date	UTC timestamp of the request, e.g. `2024-04-24T12:34:56Z`
Accept-Language	Response language preference (e.g. `en \| ar`)
Content-Type	Must be `application/json`

Note

wxc-id: The WaffarX client ID specified in your integration data.

ShoppingUrlBase will be used in the signature as ACTION_NAME

Path Parameters¶

Name	Type	Description
ShoppingUrlBase	string	Base URL for initiating the shopping trip
variantId	string	The unique ID for a product variant; required when multiple variants exist and, if present, obtained from the ShoppingUrl.
uId	string	Unique user identifier
subId	string	Partner-specific sub-identifier (e.g., a custom ShoppingTripId)

Important

The shoppingUrlBase property is provided so you can construct your API.

To redirect a user into a specific product, use the product object’s shoppingUrlBase.
To redirect a user to a store’s landing page, use the store object’s shoppingUrlBase.

cURL Example¶

curl --location 'https://partners.waffarx.com/api/{partner}/shoppingtrip/productsearch/b694f32b-84c0-4dcc-8560-f28c2b8f2ad1/67f1fdaba5d15ba872298edc' \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: en' \
  --header 'wxc-id: {YOUR_CLIENT_ID}' \
  --header 'wxc-date: 2025-05-04T23:13:30Z' \
  --header 'wxc-auth: f74b0c640ace778dd0ae9dc694e3362916ffcb237ab8f1265514f251a12745'

Responses¶

Success (HTTP 200)¶

Success Response Example¶

 {
   "status": "Success",
   "data": {
       "redirectUrl": "https://waffarad.com/Redirection/Redirect?af_id=6ff4f760-4621-4e18-8d7f-ff0c0c275563&pid=10001&mrid=10033&redirecturl=https://btech.com/en/apc-easy-ups-20kva-3outlet-black-srv20krilrk.html?sid=4443&utm_source=waffarx&subid=11417638&subid2=1404025",
       "redirectionType": 1
   },
   "message": null,
   "errors": null
 }

Important

The Redirection Type is an identifier that determines the optimal way to open the merchant link for reliable order tracking.

1 – Open links inside the app
2 – Ask user how to open each time
3 – Always open in external browser

Error (HTTP 4XX/5XX)¶

Error Response Example¶

 {
   "status": "Error",
   "message": "",
   "errors": ["Unable to generate redirect link"]
 }