Skip to main content
POST
Créer une remise pour une organisation

Autorisations

x-api-key
string
header
requis

Clé API d’établissement ou d’organisation.

Paramètres de chemin

organization_id
string
requis

Corps

application/json
name
string
requis
Required string length: 1 - 160
benefit
object
requis
description
string | null
code
string
Required string length: 1 - 128
image_url
string<uri> | null
enabled
boolean
défaut:true
visibility
enum<string>
défaut:public
Options disponibles:
public,
promoted,
code_only,
negotiated
negotiation_difficulty
enum<string> | null
Options disponibles:
easy,
medium,
hard
combinable
boolean
défaut:true
once_per_customer
boolean
défaut:true
starts_on
string<date> | null
ends_on
string<date> | null
minimum_order
object | null
first_order_only
boolean
défaut:false
required_items
object[]
locations
object[]

Affectations initiales. Elles sont requises pour les avantages liés à des produits ; si elles sont omises, les remises simples ciblent les établissements disposant d’un catalogue.

Réponse

Le modèle de remise créé.

id
string
requis
object
enum<string>
requis
Options disponibles:
discount
name
string
requis
description
string | null
requis
code
string
requis
image_url
string<uri> | null
requis
enabled
boolean
requis
visibility
enum<string>
requis
Options disponibles:
public,
promoted,
code_only,
negotiated
negotiation_difficulty
enum<string> | null
requis
Options disponibles:
easy,
medium,
hard
combinable
boolean
requis
once_per_customer
boolean
requis
starts_on
string<date> | null
requis
ends_on
string<date> | null
requis
minimum_order
object | null
requis
first_order_only
boolean
requis
benefit
object
requis
created_at
string<date-time>
requis
updated_at
string<date-time>
requis
organization_id
string
requis
target_summary
object
requis