Agregar un código promocional

POST/api/crm/v2/special_offers_promo_codes.addv2

operationId: specialOffersPromoCodes.add

Agrega un código promocional. En code se pueden enviar varios códigos promocionales separados por comas.

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Sucursal en la que se realiza la solicitud. Un socio con varias sucursales debe proporcionarla, de lo contrario la solicitud fallará. Para un socio con una sola sucursal, el servidor la asigna automáticamente.

Ejemplo: 8778

special_offer_idintegerobligatorio

Ejemplo: 1

Cuerpo de la solicitud `application/json`

object

codestringobligatorio

Código promocional; se pueden enviar varios códigos promocionales separados por comas

Ejemplo: CODE1940

countinteger

Ejemplo: 2

date_availablestring (DataTimeFormat)

Ejemplo: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Ejemplo: 17:45 06/05/2024

bonuses_sumnumber

Ejemplo: 3.14

bonuses_validityinteger

Plazo de validez de los bonos en días; 0 — sin límite

Ejemplo: 3

Respuestas

object (Response)

statusstringobligatorio

Valores:successerror

Ejemplo: success

Una de las opciones

object

Información sobre el error

errorobjectobligatorio

codeintegerobligatorio

Código de error

variablesobject

descriptionstringobligatorio

Descripción del error

object

Matriz de datos (la estructura depende de la acción, ver ejemplos)

dataobjectobligatorio

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: es' \
  -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' => 'es',
        '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": "es",
        "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": "es",
        "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()

Respuesta 200

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

Las solicitudes se envían a foodsoul.pro, que es el host de este portal; no se puede elegir otro.

Agregar un código promocional

Autorización

Parámetros de consulta

Cuerpo de la solicitud application/json

Respuestas

Cuerpo de la solicitud `application/json`