Banners and magazines

Read the brand's banners and magazines.

Access labels such as Origin + Brand key + Customer are defined in Headers and access. Each endpoint ends in a Try it console; set the host and keys once in its Settings tab or on the overview.

Get all banners

Method	URL path	Required access
GET	/api/v1/brand/banner	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
query.pages	array of string	optional	—
query.hubId	number	optional	—
query.name	string	optional	Whitespace trimmed

Example:

curl -X GET "$BASE_URL/api/v1/brand/banner" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY"

Response: JSON with success: true and result containing the operation’s service data. Result fields/details: md, sm, lg.

Source: app/v1/controller/banner_controller.js:6 → getAllBanners; routes: routes/v1/banner_route.js:10; service: _getBanners (app/v1/service/banner_service.js:6).

Get banner by ID

Method	URL path	Required access
GET	/api/v1/brand/banner/:bannerId	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
path.bannerId	number	yes	—

Example:

curl -X GET "$BASE_URL/api/v1/brand/banner/1" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY"

Response: JSON with success: true and result containing the operation’s service data.

Source: app/v1/controller/banner_controller.js:34 → getBannerById; routes: routes/v1/banner_route.js:20; service: _getBannerById (app/v1/service/banner_service.js:110).

Get all magazine

Method	URL path	Required access
GET	/api/v1/magazine	Origin + Brand key

Request fields: no body, query, or path fields are read by this controller. Context comes from the headers/middleware above.

Example:

curl -X GET "$BASE_URL/api/v1/magazine" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY"

Response: JSON with success: true and result containing the operation’s service data.

Source: app/v1/controller/magazine_controller.js:11 → getAllMagazine; routes: routes/v1/magazine_route.js:9; service: _getAllMagazine (app/v1/service/magazine_service.js:4).

Get magazine by ID

Method	URL path	Required access
GET	/api/v1/magazine/:magazineId	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
path.magazineId	number	yes	—

Example:

curl -X GET "$BASE_URL/api/v1/magazine/1" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY"

Response: JSON with success: true and result containing the operation’s service data.

Source: app/v1/controller/magazine_controller.js:23 → getMagazineById; routes: routes/v1/magazine_route.js:19; service: _getMagazineById (app/v1/service/magazine_service.js:22).

Related pages

• Batch Commerce API overview
• Implementation notes