Get all banners

get

https://merchant.services.drelife.com/banners

Retrieve a list of all banners, optionally filtered by mode.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

number

The current page of results, each containing pageSize banners.

pageSize

number

The page size of results.

modes

array of strings

Filter by banner modes

modes

Allowed:

title

string

Filter by banner title. Matches the text of ANY language of the localized title.

types

array of strings

Filter by banner types

types

Allowed:

locations

array of strings

Filter by banner locations

locations

enabled

array of booleans

Filter by banner enabled state

enabled

shippingTypes

array of strings

Filter by the shipping types the banners are restricted to: those that chose all of them. Banners without the condition are left out.

shippingTypes

Allowed:

paymentMethods

array of strings

Filter by the refund methods the banners are restricted to: those that chose all of them. Banners without the condition are left out.

paymentMethods

Allowed:

carrierIds

array of strings

Filter by the carriers the banners are restricted to: those that chose all of them. Banners without the condition are left out.

carrierIds

methodIds

array of strings

Filter by the shipping methods the banners are restricted to: those that chose all of them. Banners without the condition are left out.

methodIds

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of all banners is provided.

401Missing, invalid or expired Bearer token.

403The user does not have one of the roles the endpoint requires.

429Rate limit exceeded. Retry after the window (60 seconds by default).

500Unexpected error.

503The API is under maintenance, the database is unreachable, or the returns of the marketplace are disabled (Returns are not available).