Endpoints

List Retailers

Retrieves a list of the retailers available to the organisation.

GET

/v1/retailers

List Retailers

curl --request GET \
  --url 'https://public-api.bladepro.io/v1/retailers?name%5BLIKE%5D=%3Cstring%3E&name%5BNOT_LIKE%5D=%3Cstring%3E'

{
  "data": [
    {
      "active": 1,
      "created": "2019-11-25T14:52:56.000Z",
      "description": "Demo Retailer",
      "id": 1,
      "modified": "2019-11-25T14:52:56.000Z",
      "name": "Demo Retailer"
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "per_page": 250,
      "records": 1,
      "total_pages": 1,
      "total_records": 1
    },
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::ORDERS::READ

Query Parameters

name[LIKE]stringquery

Filter for name of the retailer. (LIKE)

name[NOT_LIKE]stringquery

Filter for name of the retailer. (NOT_LIKE)

Response

successful operation

activenumber

Is the retailer switched on?

createdany

Created timestamp in BladePRO.

descriptionstring

Description of the retailer.

idnumber

The retailer's unique identifier.

modifiedany

Last modified timestamp in BladePRO.

namestring

Name of the retailer.

Still need help? Share an idea