Добавить склад v 3.0 catalog.store.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: catalog

Кто может выполнять метод: пользователь с правом «Редактирование складов»

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод catalog.store.add создает склад и возвращает его данные. Вместе со складом можно загрузить его изображение. В методе предыдущей версии такой возможности нет.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Объект с полями нового склада. Описание полей

Параметр fields

Название
тип

Описание

address*
string

Адрес склада. Пустая строка не принимается

title
string

Название склада

active
boolean

Активность склада.

Возможные значения:

  • true — склад активен
  • false — склад неактивен

Значения Y, N и null не принимаются.

По умолчанию: true

description
string

Описание склада

gpsN
double

Широта склада, например 54.71411. Передайте число: строка вызовет ошибку

gpsS
double

Долгота склада, например 20.56675. Передайте число: строка вызовет ошибку

image
object

Изображение склада. Описание объекта

phone
string

Телефон склада

schedule
string

График работы склада, например Пн–Пт 9:00–18:00

email
string

E-mail склада. Формат адреса метод не проверяет

issuingCenter
boolean

Признак пункта выдачи.

Возможные значения:

  • true — склад работает как пункт выдачи
  • false — обычный склад

Значения Y, N и null не принимаются.

По умолчанию: false

sort
integer

Порядок сортировки склада в списках.

По умолчанию: 100

code
string

Символьный код склада. Уникальность кода метод не проверяет

xmlId
string

Внешний код склада. Используйте его для связи склада с записью во внешней системе

Поля id, imageId, imageUrl, userId, modifiedBy, dateCreate и dateModify метод заполняет сам. Если передать их в fields, метод вернет ошибку.

Методы REST 3.0 не поддерживают пользовательские поля склада.

Объект image

Название
тип

Описание

upload*
object

Данные загружаемого файла. Описание объекта

Объект image.upload

Название
тип

Описание

name*
string

Имя файла с расширением, например store.png. Загрузить можно только изображение: тип файла метод определяет по расширению

data
string

Содержимое файла в формате Base64.

Передайте data или url, но не оба параметра сразу

url
string

Публичная ссылка на файл. Битрикс24 скачает файл по ссылке.

Передайте data или url, но не оба параметра сразу

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.store.add

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"title":"Склад на Московском","address":"Калининград, Московский проспект, 51","description":"Склад для самовывоза","phone":"+7 4012 00-00-00","email":"store@example.com","schedule":"Пн–Пт 9:00–18:00","gpsN":54.71411,"gpsS":20.56675,"sort":200,"xmlId":"store-moscow-51","code":"moscow_51","issuingCenter":true,"image":{"upload":{"name":"store.png","data":"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg=="}}}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.store.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"title":"Склад на Московском","address":"Калининград, Московский проспект, 51","description":"Склад для самовывоза","phone":"+7 4012 00-00-00","email":"store@example.com","schedule":"Пн–Пт 9:00–18:00","gpsN":54.71411,"gpsS":20.56675,"sort":200,"xmlId":"store-moscow-51","code":"moscow_51","issuingCenter":true,"image":{"upload":{"name":"store.png","data":"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg=="}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.store.add
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type StoreAddResult = {
  item: {
    id: number
    title: string
    active: boolean
    address: string
    description: string
    gpsN: number | null
    gpsS: number | null
    imageId: number
    imageUrl: string
    dateModify: string
    dateCreate: string | null
    userId: number
    modifiedBy: number
    phone: string
    schedule: string
    xmlId: string
    sort: number
    email: string
    issuingCenter: boolean
    code: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<StoreAddResult>({
    method: 'catalog.store.add',
    params: {
      fields: {
        title: 'Склад на Московском',
        address: 'Калининград, Московский проспект, 51',
        description: 'Склад для самовывоза',
        phone: '+7 4012 00-00-00',
        email: 'store@example.com',
        schedule: 'Пн–Пт 9:00–18:00',
        gpsN: 54.71411,
        gpsS: 20.56675,
        sort: 200,
        xmlId: 'store-moscow-51',
        code: 'moscow_51',
        issuingCenter: true,
        image: {
          upload: {
            name: 'store.png',
            data: 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==',
          },
        },
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Store created:', result.item.id)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addStore() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.store.add',
        params: {
          fields: {
            title: 'Склад на Московском',
            address: 'Калининград, Московский проспект, 51',
            description: 'Склад для самовывоза',
            phone: '+7 4012 00-00-00',
            email: 'store@example.com',
            schedule: 'Пн–Пт 9:00–18:00',
            gpsN: 54.71411,
            gpsS: 20.56675,
            sort: 200,
            xmlId: 'store-moscow-51',
            code: 'moscow_51',
            issuingCenter: true,
            image: {
              upload: {
                name: 'store.png',
                data: 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==',
              },
            },
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Store created:', result.item.id)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addStore)
</script>

У методов catalog.store.* REST 3.0 нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через call_method токена клиента с prefer_version=3.

from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError

method = "catalog.store.add"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
bitrix_token = client.get_token()

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "fields": {
                "title": "Склад на Московском",
                "address": "Калининград, Московский проспект, 51",
                "description": "Склад для самовывоза",
                "phone": "+7 4012 00-00-00",
                "email": "store@example.com",
                "schedule": "Пн–Пт 9:00–18:00",
                "gpsN": 54.71411,
                "gpsS": 20.56675,
                "sort": 200,
                "xmlId": "store-moscow-51",
                "code": "moscow_51",
                "issuingCenter": True,
                "image": {
                    "upload": {
                        "name": "store.png",
                        "data": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==",
                    },
                },
            },
        },
        prefer_version=3,
    )
    result = response["result"]
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"code: {error.code}",
        f"message: {error.error.message}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.store.add',
            [
                'fields' => [
                    'title' => 'Склад на Московском',
                    'address' => 'Калининград, Московский проспект, 51',
                    'description' => 'Склад для самовывоза',
                    'phone' => '+7 4012 00-00-00',
                    'email' => 'store@example.com',
                    'schedule' => 'Пн–Пт 9:00–18:00',
                    'gpsN' => 54.71411,
                    'gpsS' => 20.56675,
                    'sort' => 200,
                    'xmlId' => 'store-moscow-51',
                    'code' => 'moscow_51',
                    'issuingCenter' => true,
                    'image' => [
                        'upload' => [
                            'name' => 'store.png',
                            'data' => 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==',
                        ],
                    ],
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'catalog.store.add',
    {
        fields: {
            title: 'Склад на Московском',
            address: 'Калининград, Московский проспект, 51',
            description: 'Склад для самовывоза',
            phone: '+7 4012 00-00-00',
            email: 'store@example.com',
            schedule: 'Пн–Пт 9:00–18:00',
            gpsN: 54.71411,
            gpsS: 20.56675,
            sort: 200,
            xmlId: 'store-moscow-51',
            code: 'moscow_51',
            issuingCenter: true,
            image: {
                upload: {
                    name: 'store.png',
                    data: 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==',
                },
            },
        },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'catalog.store.add',
    [
        'fields' => [
            'title' => 'Склад на Московском',
            'address' => 'Калининград, Московский проспект, 51',
            'description' => 'Склад для самовывоза',
            'phone' => '+7 4012 00-00-00',
            'email' => 'store@example.com',
            'schedule' => 'Пн–Пт 9:00–18:00',
            'gpsN' => 54.71411,
            'gpsS' => 20.56675,
            'sort' => 200,
            'xmlId' => 'store-moscow-51',
            'code' => 'moscow_51',
            'issuingCenter' => true,
            'image' => [
                'upload' => [
                    'name' => 'store.png',
                    'data' => 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==',
                ],
            ],
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.store.add", b24.Params{
	"fields": b24.Params{
		"title":         "Склад на Московском",
		"address":       "Калининград, Московский проспект, 51",
		"description":   "Склад для самовывоза",
		"phone":         "+7 4012 00-00-00",
		"email":         "store@example.com",
		"schedule":      "Пн–Пт 9:00–18:00",
		"gpsN":          54.71411,
		"gpsS":          20.56675,
		"sort":          200,
		"xmlId":         "store-moscow-51",
		"code":          "moscow_51",
		"issuingCenter": true,
		"image": b24.Params{
			"upload": b24.Params{
				"name": "store.png",
				"data": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==",
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("catalog.store.add: %w", err)
}

// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
	return fmt.Errorf("в ответе нет ключа item")
}

var item struct {
	ID            int    `json:"id"`
	Title         string `json:"title"`
	Active        bool   `json:"active"`
	Address       string `json:"address"`
	IssuingCenter bool   `json:"issuingCenter"`
	ImageURL      string `json:"imageUrl"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Title, item.Address)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 51,
            "title": "Склад на Московском",
            "active": true,
            "address": "Калининград, Московский проспект, 51",
            "description": "Склад для самовывоза",
            "gpsN": 54.71411,
            "gpsS": 20.56675,
            "imageId": 40757,
            "imageUrl": "https://cdn-ru.bitrix24.ru/b1234567/catalog/fee/fee4295e698466f04b617988b6f415ff/508cb2bfea465e513a642ec8849f1023.png",
            "dateModify": "2026-11-17T16:37:04+03:00",
            "dateCreate": "2026-11-17T16:37:04+03:00",
            "userId": 1295,
            "modifiedBy": 1295,
            "phone": "+7 4012 00-00-00",
            "schedule": "Пн–Пт 9:00–18:00",
            "xmlId": "store-moscow-51",
            "sort": 200,
            "email": "store@example.com",
            "issuingCenter": true,
            "code": "moscow_51"
        }
    },
    "time": {
        "start": 1794922623,
        "finish": 1794922624.198856,
        "duration": 1.1988561153411865,
        "processing": 1,
        "date_start": "2026-11-17T16:37:03+03:00",
        "date_finish": "2026-11-17T16:37:04+03:00",
        "operating_reset_at": 1794922800,
        "operating": 0.5085549354553223
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Объект с данными ответа

result.item
object

Созданный склад. Описание полей

time
time

Информация о времени выполнения запроса

Объект item

Название
тип

Описание

id
integer

Идентификатор склада

title
string

Название склада. Пустая строка, если название не задано

active
boolean

Активность склада: true — склад активен, false — неактивен

address
string

Адрес склада

description
string

Описание склада. Пустая строка, если описание не задано

gpsN
double

Широта склада. Если координата не задана, приходит 0. Если в Битрикс24 сохранено значение, которое не является числом, например пустая строка, приходит null

gpsS
double

Долгота склада. Если координата не задана, приходит 0. Если в Битрикс24 сохранено значение, которое не является числом, например пустая строка, приходит null

imageId
integer

Идентификатор файла изображения склада. 0, если изображения нет

imageUrl
string

Ссылка на изображение склада. Пустая строка, если изображения нет

dateModify
datetime

Дата последнего изменения склада

dateCreate
datetime

Дата создания склада. У складов, которые Битрикс24 создал сам, может быть null

userId
integer

Идентификатор пользователя, который создал склад. 0 у складов, которые Битрикс24 создал сам

modifiedBy
integer

Идентификатор пользователя, который последним изменил склад

phone
string

Телефон склада. Пустая строка, если телефон не задан

schedule
string

График работы склада. Пустая строка, если график не задан

xmlId
string

Внешний код склада. Пустая строка, если код не задан

sort
integer

Порядок сортировки склада в списках

email
string

E-mail склада. Пустая строка, если адрес не задан

issuingCenter
boolean

Признак пункта выдачи: true — склад работает как пункт выдачи, false — обычный склад

code
string

Символьный код склада. Пустая строка, если код не задан

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта",
        "validation": [
            {
                "message": "Не заполнено обязательное поле \"address\"",
                "field": "address"
            }
        ]
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

fields

Обязательное поле fields не указано

Передайте объект fields с полем address

-

Не указан адрес склада

Передайте в address непустую строку

active, issuingCenter

В поле #FIELD# требуется тип данных bool для такого запроса

Передайте true или false, а не Y, N или null

gpsN, gpsS

В поле #FIELD# требуется тип данных float для такого запроса

Передайте координату числом

sort

В поле sort требуется тип данных int для такого запроса

Передайте порядок сортировки целым числом

Ошибки валидации полей

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

address

Не заполнено обязательное поле "address"

Добавьте address в fields

id, imageId, imageUrl, userId, modifiedBy, dateCreate, dateModify

Поле "#FIELD#" не доступно к заполнению

Уберите поле из fields: значение заполняется автоматически. Изображение передайте в поле image

image.upload

Не заполнено обязательное поле "upload"

Передайте файл в объекте image.upload

image.upload

Должно быть передано только одно из значений: data, url

Передайте в image.upload либо data, либо url

Ошибки файла

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_INVALIDFILEEXCEPTION

Поле

Описание ошибки

Как исправить

FILE_TYPE_NOT_ALLOWED

Файл неверного типа.

Загрузите изображение и укажите в name расширение изображения, например store.png

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

fields

Неизвестное поле #FIELD# для сущности StoreDto

Передайте в fields только поля из таблицы параметра fields. Пользовательские поля UF_* метод не принимает

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

У пользователя нет права «Редактирование складов»

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Следующая