Skip to main content
GET
/
banner
List banners
curl --request GET \
  --url https://store.salesive.com/api/v1/banner \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "banners": [
    {
      "id": "<string>",
      "title": "<string>",
      "image": "<string>",
      "url": "<string>",
      "active": true,
      "description": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 1,
  "page": 2,
  "limit": 2
}

​
Request

GET /banner?page=1&limit=10
x-shop-id: {{shopId}}

​
Headers

HeaderTypeDescription
x-shop-idstringIdentify the shop context.

​
Query parameters

ParameterTypeDescription
pageintegerPage number to return (default: 1).
limitintegerMaximum number of banners per page (default: 10).
qstringOptional search phrase applied to banner titles.

​
Successful response

{
    "status": 200,
    "success": true,
    "message": "Banners found",
    "data": {
        "banners": [],
        "pagination": {
            "total": 0,
            "page": 1,
            "limit": 10,
            "pages": 0,
            "hasNext": false,
            "hasPrev": false,
            "nextPage": null,
            "prevPage": null
        }
    }
}

​
Error response

{
    "status": 500,
    "success": false,
    "message": "You are not authorized to access this resource",
    "data": {}
}

Authorizations

​
Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

​
x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

​
x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Query Parameters

​
page
integer
default:1

Page number to return (defaults to 1).

Required range: x >= 1
​
limit
integer
default:10

Maximum number of banners per page (defaults to 10).

Required range: x >= 1
​
q
string

Optional search phrase applied to banner titles.

Response

200 - application/json

Paginated banners response.

​
banners
object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
limit
integer
required
Required range: x >= 1