API Reference
  1. Drelife Merchants
  2. Reasons

Create new reason

post
https://merchant.services.drelife.com/reasons

Allows for the creation of a reason.

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

Payload containing reason's attributes necessary for creation.

number

The order of the reason in the list.

string
enum
required

The type of the reason, defined by the ReasonType enum.

Allowed:
string

Extra information for the reason.

tags
array of strings
required

A list of tags associated with the reason.

tags*
categories
array of strings
required

A list of identifiers of categories associated with the reason.

categories*
products
array of strings
required

A list of identifiers of products associated with the reason.

products*
productsChange
array of strings
required

A list of identifiers of available products for exchanges associated with the reason.

productsChange*
orders
array of strings

A list of internal identifiers of orders associated with the reason. When set, the reason is only offered for those orders (mirrors products).

orders
content
object
required

Localized content for the reason, mapped by language.

description
object
required

Localized description for the reason, mapped by language.

boolean

Flag indicating if the customer is allowed to upload an image for the reason.

boolean

Flag indicating if the customer is required to upload an image for the reason.

number

Minimum number of pictures a customer must upload if images are required.

number

Minimum number of videos a customer must upload if images are required.

boolean

Flag indicating if the customer information can be provided for the reason.

boolean

Flag indicating if the customer information is required for the reason.

boolean

Flag that indicates if free shipping is applicable for this reason.

boolean
Defaults to false

Flag indicating if the reason is exclusive to specific products or variants.

boolean
Defaults to false

Flag indicating if the reason is exclusive to specific categories.

boolean
Defaults to false

Flag indicating if the reason is exclusive to specific orders.

boolean
Defaults to false

Flag indicating whether the reason is enabled and can be used.

number
Defaults to null

Amount of the product to sell.

number
Defaults to null

Upper bound of the offer range. When set, amount is the lower bound; only allowed on assessable Purchase/Repair reasons and must be >= amount.

boolean
Defaults to false

Flag indicating whether this reason is assessable during validation.

boolean
required
Defaults to false

Flag indicating whether the amount is absolute or percentage.

subQuestion
object

Localized content for the reason's question, mapped by language.

string

The unique identifier of the reason to list its children

boolean

Whether the price to use is the price configured in the parent reason (true) or use the price configured in the reason itself (false).

boolean
Defaults to false

Flag indicating whether the reason stays selectable only for a limited number of days. Only applies to Return and Change reasons; forced to false otherwise.

number
Defaults to null

Number of days the reason stays selectable, measured from the delivery date (or creation date when unknown). Required when validityDaysEnabled is true.

Responses

400

Invalid reason parameters

401

Unauthorized

Updated about 2 hours 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 hours ago

Did this page help you?