Ajouter un code promo

POST/api/crm/v2/special_offers_promo_codes.addv2

operationId: specialOffersPromoCodes.add

Ajoute un code promo. Vous pouvez transmettre plusieurs codes promo dans code, séparés par une virgule.

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

La succursale dans laquelle la requête est effectuée. Un partenaire disposant de plusieurs succursales doit obligatoirement la transmettre, sinon la requête échoue. Pour un partenaire avec une seule succursale, le serveur la renseigne automatiquement.

Exemple: 8778

special_offer_idintegerobligatoire

Exemple: 1

Corps de la requête `application/json`

object

codestringobligatoire

Code promo ; plusieurs codes promo peuvent être transmis, séparés par une virgule

Exemple: CODE1940

countinteger

Exemple: 2

date_availablestring (DataTimeFormat)

Exemple: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Exemple: 17:45 06/05/2024

bonuses_sumnumber

Exemple: 3.14

bonuses_validityinteger

Durée de validité des bonus en jours ; 0 — illimité

Exemple: 3

Réponses

object (Response)

statusstringobligatoire

Valeurs:successerror

Exemple: success

L'une des options

object

Informations sur l’erreur

errorobjectobligatoire

codeintegerobligatoire

Code d’erreur

variablesobject

descriptionstringobligatoire

Description de l’erreur

object

Tableau de données (la structure dépend de l'action, voir les exemples)

dataobjectobligatoire

curl -X POST 'https://foodsoul.pro/api/crm/v2/special_offers_promo_codes.add?special_offer_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: fr' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"code":"CODE1940","count":2,"date_available":"17:45 06/05/2024","date_expiration":"17:45 06/05/2024","bonuses_sum":3.14,"bonuses_validity":3}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/special_offers_promo_codes.add?special_offer_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'fr',
        'role' => 'partner',
    ],
    'json' => [
        'code' => 'CODE1940',
        'count' => 2,
        'date_available' => '17:45 06/05/2024',
        'date_expiration' => '17:45 06/05/2024',
        'bonuses_sum' => 3.14,
        'bonuses_validity' => 3,
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/special_offers_promo_codes.add?special_offer_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "fr",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "code": "CODE1940",
        "count": 2,
        "date_available": "17:45 06/05/2024",
        "date_expiration": "17:45 06/05/2024",
        "bonuses_sum": 3.14,
        "bonuses_validity": 3
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/special_offers_promo_codes.add?special_offer_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "fr",
        "role": "partner",
    },
    json={
        "code": "CODE1940",
        "count": 2,
        "date_available": "17:45 06/05/2024",
        "date_expiration": "17:45 06/05/2024",
        "bonuses_sum": 3.14,
        "bonuses_validity": 3,
    },
)
data = response.json()

Réponse 200

{
  "error": {
    "code": 0,
    "variables": {},
    "description": "string"
  }
}

Les requêtes sont envoyées à foodsoul.pro — l’hôte de ce portail, il n’est pas possible d’en choisir un autre.

Ajouter un code promo

Autorisation

Paramètres de requête

Corps de la requête application/json

Réponses

Corps de la requête `application/json`