API Reference
  1. Drelife Merchants
  2. Banners

Update a banner

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

Updates a banner

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

The banner's attributes to update.

boolean
required
Defaults to true

Flag indicating whether the banner is enabled.

string
enum
required

The type of the banner, defined by the BannerType enum.

Allowed:
title
object | null

Localized title for the banner, mapped by language. A banner must have at least a title or a description.

description
object | null

Localized description for the banner, mapped by language. A banner must have at least a title or a description.

string
enum
required

Where the banner is displayed, defined by the BannerLocation enum.

string
enum
required

The mode the banner belongs to, defined by the DawaMode enum. A PATCH cannot change it.

Allowed:
shippingTypes
array of strings | null

Shipping types the banner is restricted to. Empty or null does not restrict it. Accepted by the ShippingType, ShippingMethod, Address and ConfirmationView locations. Omitted on a PATCH, the current ones are kept.

shippingTypes
Allowed:
paymentMethods
array of strings | null

Refund methods the banner is restricted to, among those of its mode. Empty or null does not restrict it. Accepted by the RefundMethod location, and by the ConfirmationView one out of the Repair mode. Omitted on a PATCH, the current ones are kept.

paymentMethods
Allowed:
carrierIds
array of strings | null

Identifiers of the carriers of the store the banner is restricted to. Empty or null does not restrict it. Accepted by the ShippingMethod, Schedule and ConfirmationView locations. Omitted on a PATCH, the current ones are kept. A deleted carrier is unlinked, and a banner left without carriers is disabled.

carrierIds
methodIds
array of strings | null

Identifiers of the shipping methods of the store the banner is restricted to. Empty or null does not restrict it. Accepted by the Address location. Omitted on a PATCH, the current ones are kept. A deleted method is unlinked, and a banner left without methods is disabled.

methodIds
string
required

The unique identifier of the banner entity to be patched.

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?