Рефсейлс API
Справочники

Создать способ доставки

POST
/api/v1/references/delivery-types

Способы доставки общие для всех магазинов владельца. Через API создаётся способ без интеграции: СДЭК и Яндекс Доставка подключаются в настройках. Право: references:write.

Авторизация

bearerApiKey
headerАвторизацияBearer <ключ>

Ключ API в заголовке Authorization: Bearer rsk_live_…. Ключ создаёт владелец магазина: Настройки → Интеграции → API-ключи.

Тело запроса

application/json
  1. body
name*string

Название для покупателя.

Length1 <= length <= 100
kind*string

Вид: courier (свой курьер), pickup (самовывоз) или carrier (служба доставки).

Value in"courier""pickup""carrier"
code?string

Код латиницей: строчные буквы, цифры и _, до 50 символов. Без кода его придумает Рефсейлс.

Match^[a-z0-9_]{1,50}$

Ответ

Запись создана.

application/json
  1. response
data*
curl -X POST "https://example.com/api/v1/references/delivery-types" \  -H "Content-Type: application/json" \  -d '{    "name": "Курьер по Петербургу",    "kind": "courier",    "code": "spb_courier"  }'
{  "data": {    "id": "9b3e6d1a-4c8f-4a2e-9d7b-3f1c5a8e2d60",    "code": "spb_courier",    "name": "Курьер по Петербургу",    "kind": "courier",    "provider": null,    "isActive": true  }}

Способы доставки GET

Способы доставки, которые магазин включил. id передавайте в delivery.typeId при создании заказа. Список короткий, поэтому приходит одной страницей. Право: references:read.

Изменить способ доставки PATCH

Название, код и вид меняются во всех магазинах владельца. У способа с интеграцией вид не меняется. isActive работает как переключатель в настройках: способ, доступный во всех магазинах, включается и выключается везде, а способ выбранных магазинов только в этом. Право: references:write.