Get Brands

Retrieves a paginated list of brands.

Endpoint

POST https://partners.waffarx.com/api/{partner}/GetPartnerBrands

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.

Path Parameters

Name	Type	Required	Description
partner	string		The partner name

Request Parameters

Name	Type	Required	Description
PageNumber	integer		Page number to retrieve (1-based index, must be ≥ 1)
PageSize	integer		Number of items per page (1–50)

Request Body

Example Request Body

{
  "PageNumber": 1,
  "PageSize": 20
}

cURL Example

curl -X POST "https://partners.waffarx.com/api/{partner}/getpartnerbrands" \
  -H "Content-Type: application/json" \
  -H "Accept-Language: en" \
  -H "wxc-id: {YOUR_CLIENT_ID}" \
  -H "wxc-date: 2025-05-04T22:34:33Z" \
  -H "wxc-auth: 9e177beaee0d90ddb6b26e9b2886bc9de16f5363bad6db8286848cbc90" \
  -d '{
    "PageNumber": 1,
    "PageSize": 1
  }'

Responses

Success (HTTP 200)

Success Response Example

 {
   "totalCount": 2,
   "status": "Success",
   "data": [
       {
           "brandId": "6971587fc77793772f5f9ed3",
           "brandName": "Test",
           "imageUrl": "https://www.waffarx.com/_next/static/media/logo.cdaa0d56.svg"
       },
       {
           "brandId": "69720893af09e110ef5ef637",
           "brandName": "نيتيت",
           "imageUrl": "https://www.waffarx.com/_next/static/media/logo.cdaa0d56.svg"
       }
   ],
   "message": null,
   "errors": null
 }

Error (HTTP 4XX/5XX)

Error Response Example

{
  "status": "Error",
  "data": null,
  "message": "",
  "errors": ["Invalid PageNumber: must be ≥ 1"]
}