Adicionar código promocional

POST/api/crm/v2/special_offers_promo_codes.addv2

operationId: specialOffersPromoCodes.add

Adiciona um código promocional. Em code, é possível enviar vários códigos promocionais separados por vírgula.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Filial no qual a solicitação é executada. Parceiros com múltiplos filiais devem fornecê-lo, caso contrário, a solicitação resultará em erro. Para parceiros com um único filial, o servidor o define automaticamente.

Exemplo: 8778

special_offer_idintegerobrigatório

Exemplo: 1

Corpo da solicitação `application/json`

object

codestringobrigatório

Código promocional; é possível enviar vários códigos promocionais separados por vírgula

Exemplo: CODE1940

countinteger

Exemplo: 2

date_availablestring (DataTimeFormat)

Exemplo: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Exemplo: 17:45 06/05/2024

bonuses_sumnumber

Exemplo: 3.14

bonuses_validityinteger

Validade dos bônus em dias; 0 — sem limite

Exemplo: 3

Respostas

object (Response)

statusstringobrigatório

Valores:successerror

Exemplo: success

Uma das opções

object

Informações sobre o erro

errorobjectobrigatório

codeintegerobrigatório

Código de erro

variablesobject

descriptionstringobrigatório

Descrição do erro

object

Matriz de dados (a estrutura depende da ação, veja exemplos)

dataobjectobrigatório

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

Resposta 200

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

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.

Adicionar código promocional

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`