Artikel hinzufügen

POST/api/crm/v2/items.addv2

operationId: items.add

Autorisierung

api-token + language + role

Abfrageparameter

branch_idintegererforderlich

Beispiel: 8785

Anfragetext `multipart/form-data`

object

Arrays von Parametern mit gleicher Länge: parameter_id, description, measure_index, old_cost, cost, bonuses, proteins, fats, carbohydrates, calories, vendor_code, modifiers_groups_ids

nameobject (TranslationField) erforderlich

Übersetzbares Katalogfeld; gleiche Struktur in Antwort und Anfrage.
Beim Erstellen bleibt jede Netzwerksprache, die nicht in translations enthalten ist, leer und wird zur AI-Übersetzung in die Warteschlange gestellt.
Beim Ändern werden nur die in translations enthaltenen Sprachen gespeichert: Eine Sprache, die nicht im Objekt enthalten ist, behält ihren bisherigen Wert, sofern das Original nicht geändert wurde; ein leerer Wert löscht die Übersetzung und stellt sie zur AI-Übersetzung in die Warteschlange.
Eine Änderung des Originals löscht Übersetzungen, die unverändert übermittelt wurden – sie entsprechen nicht mehr dem Original; eine Übersetzung mit geändertem Wert wird als manuelle Korrektur gespeichert. Diese Löschung erfolgt nur, solange die automatische Übersetzung im Netzwerk aktiviert ist.
Ein Wert in einer nicht veröffentlichten Sprache wird abgelehnt; ein Wert in einer Sprache außerhalb des Netzwerksatzes wird ignoriert.

defaultstring

Код исходного языка сети; в запросе должен совпадать с настройкой сети

Beispiel: ru

translationsobjecterforderlich

Wert nach Sprachcode; keine Übersetzung – kein Schlüssel

Werte des Wörterbuchs

string

compositionobject (TranslationField) erforderlich

defaultstring

Код исходного языка сети; в запросе должен совпадать с настройкой сети

Beispiel: ru

translationsobjecterforderlich

Wert nach Sprachcode; keine Übersetzung – kein Schlüssel

Werte des Wörterbuchs

string

excise_enabledboolean

Beispiel: false

separate_export_enabledboolean

Beispiel: false

date_availablestring (DataTimeFormat)

Beispiel: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Beispiel: 17:45 06/05/2024

days_of_weekarray of integererforderlich

time_periodsarray of string

labels_idsarray of integer

template_modifiers_groups_idsarray of integer

modifiers_multiplier_enabledboolean

Beispiel: true

only_informing_enabledboolean

Beispiel: true

hide_cost_if_zero_enabledboolean

Beispiel: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

image_desktopobject (ImageSource)

Hochladen eines Bildes über multipart/form-data mit optionalem Zuschnitt

binarystring · binary

cropobject

Koordinaten des Bildzuschnitts

offsetsobject

xintegererforderlich

Beispiel: 100

yintegererforderlich

Beispiel: 50

sizesobject

widthintegererforderlich

Beispiel: 800

heightintegererforderlich

Beispiel: 600

image_mobileobject (ImageSource)

Hochladen eines Bildes über multipart/form-data mit optionalem Zuschnitt

binarystring · binary

cropobject

Koordinaten des Bildzuschnitts

offsetsobject

xintegererforderlich

Beispiel: 100

yintegererforderlich

Beispiel: 50

sizesobject

widthintegererforderlich

Beispiel: 800

heightintegererforderlich

Beispiel: 600

parameter_idarray of stringerforderlich

ID der Artikelparameter, jeweils ein Element pro Parameter; beim Erstellen eines Artikels sind die Elemente leer. Die Elemente werden indexbasiert mit cost, description und measure_index abgeglichen.

descriptionarray of stringerforderlich

measure_indexarray of integererforderlich

old_costarray of number

costarray of numbererforderlich

bonusesarray of number

proteinsarray of integer

fatsarray of integer

carbohydratesarray of integer

caloriesarray of integer

vendor_codearray of stringerforderlich

modifiers_groups_idsarray of array of integer

modifiers_groups_ids[0][17589436, 17589435], modifiers_groups_ids[1][17589436, 17589435]

category_idintegererforderlich

Beispiel: 3386598

typestringerforderlich

Werte:bouquetproductcombodishdrinkgift

Beispiel: product

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

curl -X POST 'https://foodsoul.ru/api/crm/v2/items.add?branch_id=8785' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: de' \
  -H 'role: partner' \
  -F 'name={"default":"ru","translations":{"ru":"Пицца","en":"Pizza"}}' \
  -F 'composition={"default":"ru","translations":{"ru":"Пицца","en":"Pizza"}}' \
  -F 'excise_enabled=false' \
  -F 'separate_export_enabled=false' \
  -F 'date_available=17:45 06/05/2024' \
  -F 'date_expiration=17:45 06/05/2024' \
  -F 'days_of_week=[1]' \
  -F 'time_periods=["17:45 - 21:15"]' \
  -F 'labels_ids=[7411]' \
  -F 'template_modifiers_groups_ids=[17589435]' \
  -F 'modifiers_multiplier_enabled=true' \
  -F 'only_informing_enabled=true' \
  -F 'hide_cost_if_zero_enabled=true' \
  -F 'hide_for_districts_ids=[55311]' \
  -F 'hide_for_pickups_ids=[4926]' \
  -F 'image_desktop={"binary":"<file>","crop":{"offsets":{"x":100,"y":50},"sizes":{"width":800,"height":600}}}' \
  -F 'image_mobile={"binary":"<file>","crop":{"offsets":{"x":100,"y":50},"sizes":{"width":800,"height":600}}}' \
  -F 'parameter_id=["94076952"]' \
  -F 'description=["150"]' \
  -F 'measure_index=[1]' \
  -F 'old_cost=[100]' \
  -F 'cost=[80]' \
  -F 'bonuses=[50]' \
  -F 'proteins=[10]' \
  -F 'fats=[10]' \
  -F 'carbohydrates=[10]' \
  -F 'calories=[100]' \
  -F 'vendor_code=["d1763be5-76a6-4ddb-8e11-3a1f91de199c::d835bcc9-1349-4911-af1d-131fd73141e8"]' \
  -F 'modifiers_groups_ids=[[17523566]]' \
  -F 'category_id=3386598' \
  -F 'type=product'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/items.add?branch_id=8785', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'de',
        'role' => 'partner',
    ],
    'multipart' => [
        [
            'name' => 'name',
            'contents' => '{"default":"ru","translations":{"ru":"Пицца","en":"Pizza"}}',
        ],
        [
            'name' => 'composition',
            'contents' => '{"default":"ru","translations":{"ru":"Пицца","en":"Pizza"}}',
        ],
        [
            'name' => 'excise_enabled',
            'contents' => 'false',
        ],
        [
            'name' => 'separate_export_enabled',
            'contents' => 'false',
        ],
        [
            'name' => 'date_available',
            'contents' => '17:45 06/05/2024',
        ],
        [
            'name' => 'date_expiration',
            'contents' => '17:45 06/05/2024',
        ],
        [
            'name' => 'days_of_week',
            'contents' => '[1]',
        ],
        [
            'name' => 'time_periods',
            'contents' => '["17:45 - 21:15"]',
        ],
        [
            'name' => 'labels_ids',
            'contents' => '[7411]',
        ],
        [
            'name' => 'template_modifiers_groups_ids',
            'contents' => '[17589435]',
        ],
        [
            'name' => 'modifiers_multiplier_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'only_informing_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'hide_cost_if_zero_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'hide_for_districts_ids',
            'contents' => '[55311]',
        ],
        [
            'name' => 'hide_for_pickups_ids',
            'contents' => '[4926]',
        ],
        [
            'name' => 'image_desktop',
            'contents' => '{"binary":"<file>","crop":{"offsets":{"x":100,"y":50},"sizes":{"width":800,"height":600}}}',
        ],
        [
            'name' => 'image_mobile',
            'contents' => '{"binary":"<file>","crop":{"offsets":{"x":100,"y":50},"sizes":{"width":800,"height":600}}}',
        ],
        [
            'name' => 'parameter_id',
            'contents' => '["94076952"]',
        ],
        [
            'name' => 'description',
            'contents' => '["150"]',
        ],
        [
            'name' => 'measure_index',
            'contents' => '[1]',
        ],
        [
            'name' => 'old_cost',
            'contents' => '[100]',
        ],
        [
            'name' => 'cost',
            'contents' => '[80]',
        ],
        [
            'name' => 'bonuses',
            'contents' => '[50]',
        ],
        [
            'name' => 'proteins',
            'contents' => '[10]',
        ],
        [
            'name' => 'fats',
            'contents' => '[10]',
        ],
        [
            'name' => 'carbohydrates',
            'contents' => '[10]',
        ],
        [
            'name' => 'calories',
            'contents' => '[100]',
        ],
        [
            'name' => 'vendor_code',
            'contents' => '["d1763be5-76a6-4ddb-8e11-3a1f91de199c::d835bcc9-1349-4911-af1d-131fd73141e8"]',
        ],
        [
            'name' => 'modifiers_groups_ids',
            'contents' => '[[17523566]]',
        ],
        [
            'name' => 'category_id',
            'contents' => '3386598',
        ],
        [
            'name' => 'type',
            'contents' => 'product',
        ],
    ],
]);

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

const body = new FormData()
body.append("name", "{\"default\":\"ru\",\"translations\":{\"ru\":\"Пицца\",\"en\":\"Pizza\"}}")
body.append("composition", "{\"default\":\"ru\",\"translations\":{\"ru\":\"Пицца\",\"en\":\"Pizza\"}}")
body.append("excise_enabled", "false")
body.append("separate_export_enabled", "false")
body.append("date_available", "17:45 06/05/2024")
body.append("date_expiration", "17:45 06/05/2024")
body.append("days_of_week", "[1]")
body.append("time_periods", "[\"17:45 - 21:15\"]")
body.append("labels_ids", "[7411]")
body.append("template_modifiers_groups_ids", "[17589435]")
body.append("modifiers_multiplier_enabled", "true")
body.append("only_informing_enabled", "true")
body.append("hide_cost_if_zero_enabled", "true")
body.append("hide_for_districts_ids", "[55311]")
body.append("hide_for_pickups_ids", "[4926]")
body.append("image_desktop", "{\"binary\":\"<file>\",\"crop\":{\"offsets\":{\"x\":100,\"y\":50},\"sizes\":{\"width\":800,\"height\":600}}}")
body.append("image_mobile", "{\"binary\":\"<file>\",\"crop\":{\"offsets\":{\"x\":100,\"y\":50},\"sizes\":{\"width\":800,\"height\":600}}}")
body.append("parameter_id", "[\"94076952\"]")
body.append("description", "[\"150\"]")
body.append("measure_index", "[1]")
body.append("old_cost", "[100]")
body.append("cost", "[80]")
body.append("bonuses", "[50]")
body.append("proteins", "[10]")
body.append("fats", "[10]")
body.append("carbohydrates", "[10]")
body.append("calories", "[100]")
body.append("vendor_code", "[\"d1763be5-76a6-4ddb-8e11-3a1f91de199c::d835bcc9-1349-4911-af1d-131fd73141e8\"]")
body.append("modifiers_groups_ids", "[[17523566]]")
body.append("category_id", "3386598")
body.append("type", "product")

const response = await fetch("https://foodsoul.ru/api/crm/v2/items.add?branch_id=8785", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "de",
        "role": "partner"
    },
    body,
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.ru/api/crm/v2/items.add?branch_id=8785",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "de",
        "role": "partner",
    },
    files={
        "name": [
            None,
            "{\"default\":\"ru\",\"translations\":{\"ru\":\"Пицца\",\"en\":\"Pizza\"}}",
        ],
        "composition": [
            None,
            "{\"default\":\"ru\",\"translations\":{\"ru\":\"Пицца\",\"en\":\"Pizza\"}}",
        ],
        "excise_enabled": [
            None,
            "false",
        ],
        "separate_export_enabled": [
            None,
            "false",
        ],
        "date_available": [
            None,
            "17:45 06/05/2024",
        ],
        "date_expiration": [
            None,
            "17:45 06/05/2024",
        ],
        "days_of_week": [
            None,
            "[1]",
        ],
        "time_periods": [
            None,
            "[\"17:45 - 21:15\"]",
        ],
        "labels_ids": [
            None,
            "[7411]",
        ],
        "template_modifiers_groups_ids": [
            None,
            "[17589435]",
        ],
        "modifiers_multiplier_enabled": [
            None,
            "true",
        ],
        "only_informing_enabled": [
            None,
            "true",
        ],
        "hide_cost_if_zero_enabled": [
            None,
            "true",
        ],
        "hide_for_districts_ids": [
            None,
            "[55311]",
        ],
        "hide_for_pickups_ids": [
            None,
            "[4926]",
        ],
        "image_desktop": [
            None,
            "{\"binary\":\"<file>\",\"crop\":{\"offsets\":{\"x\":100,\"y\":50},\"sizes\":{\"width\":800,\"height\":600}}}",
        ],
        "image_mobile": [
            None,
            "{\"binary\":\"<file>\",\"crop\":{\"offsets\":{\"x\":100,\"y\":50},\"sizes\":{\"width\":800,\"height\":600}}}",
        ],
        "parameter_id": [
            None,
            "[\"94076952\"]",
        ],
        "description": [
            None,
            "[\"150\"]",
        ],
        "measure_index": [
            None,
            "[1]",
        ],
        "old_cost": [
            None,
            "[100]",
        ],
        "cost": [
            None,
            "[80]",
        ],
        "bonuses": [
            None,
            "[50]",
        ],
        "proteins": [
            None,
            "[10]",
        ],
        "fats": [
            None,
            "[10]",
        ],
        "carbohydrates": [
            None,
            "[10]",
        ],
        "calories": [
            None,
            "[100]",
        ],
        "vendor_code": [
            None,
            "[\"d1763be5-76a6-4ddb-8e11-3a1f91de199c::d835bcc9-1349-4911-af1d-131fd73141e8\"]",
        ],
        "modifiers_groups_ids": [
            None,
            "[[17523566]]",
        ],
        "category_id": [
            None,
            "3386598",
        ],
        "type": [
            None,
            "product",
        ],
    },
)
data = response.json()

Antwort 200

{
  "status": "success",
  "data": {}
}

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

Artikel hinzufügen

Autorisierung

Abfrageparameter

Anfragetext multipart/form-data

Antworten

Anfragetext `multipart/form-data`