Promocode bearbeiten

POST/api/crm/v2/special_offers_promo_codes.updatev2

operationId: specialOffersPromoCodes.update

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Die Filiale, in der die Anfrage ausgeführt wird. Ein Partner mit mehreren Filialen muss diesen Parameter angeben, andernfalls wird die Anfrage mit einem Fehler abgelehnt. Bei einem Partner mit nur einer Filiale wird dieser Wert vom Server automatisch gesetzt.

Beispiel: 8778

special_offer_idintegererforderlich

Beispiel: 1

Anfragetext `application/json`

object

idintegererforderlich

Beispiel: 1

codestringerforderlich

Promo-Code; mehrere Promo-Codes können durch Kommas getrennt übergeben werden

Beispiel: CODE1940

countinteger

Anzahl

Beispiel: 2

date_availablestring (DataTimeFormat)

Beispiel: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Beispiel: 17:45 06/05/2024

bonuses_sumnumber

Beispiel: 3

bonuses_validityinteger

Gültigkeitsdauer der Boni in Tagen; 0 — unbegrenzt

Beispiel: 3

Antworten

object (Response)

statusstringerforderlich

Werte:successerror

Beispiel: success

Eine der Optionen

object

Fehlerinformationen

errorobjecterforderlich

codeintegererforderlich

Fehlercode

variablesobject

descriptionstringerforderlich

Fehlerbeschreibung

object

Datenarray (Struktur abhängig von der Aktion, siehe Beispiele)

dataobjecterforderlich

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

<?php

$client = new \GuzzleHttp\Client();

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

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

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

import requests

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

Antwort 200

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

Anfragen werden an foodsoul.pro gesendet – dies ist der Host dieses Portals, ein anderer kann nicht ausgewählt werden.

Promocode bearbeiten

Autorisierung

Abfrageparameter

Anfragetext application/json

Antworten

Anfragetext `application/json`