Редактирование Получателя

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Идентификатор записи раздела "Получатели"

Body Params application/json

code

string

required

Уникальный код получателя, содержащий только буквы и цифры

Match pattern:

^[A-Z0-9]+

isBlocked

boolean

optional

Запрет на выдачу

Default:

false

customer

string <iri-reference>

required

Клиент. Должен работать фильтр доступа, например, Менеджер по продажам должен видеть только своих клиентов

Example:

/customers/1

isPayRuDelivery

boolean

optional

Платит за доставку по РФ

Default:

false

type

string <iri-reference>

required

Тип получателя

Example:

/recipient-types/1

title

string

optional

Полное наименование организации

titleShort

string

required

Сокращенное наименование

inn

string

optional

ИНН организации

kpp

string

optional

КПП организации

ogrn

string

optional

ОГРН организации

legalAddress

string

optional

Юридический адрес организации

string <email>

optional

Электронная почта получателя

contacts

string

optional

Контактная информация

shippingMethod

string <iri-reference>

required

Способ отправки до места доставки/пересыла

Example:

/shipping-methods/1

city

string <iri-reference>

required

Город доставки

Example:

/cities/1

issuanceMethod

string <iri-reference>

required

Способ выдачи груза

Example:

/issuance-methods/1

addressDelivery

string

optional

Адрес доставки

fio

string

optional

Фамилия и инициалы получателя

passport

string

optional

Серия и номер паспорта

addressReg

string

optional

Адрес прописки получателя

Example

{
    "code": "string",
    "isBlocked": false,
    "customer": "/customers/1",
    "isPayRuDelivery": false,
    "type": "/recipient-types/1",
    "title": "string",
    "titleShort": "string",
    "inn": "string",
    "kpp": "string",
    "ogrn": "string",
    "legalAddress": "string",
    "email": "user@example.com",
    "contacts": "string",
    "shippingMethod": "/shipping-methods/1",
    "city": "/cities/1",
    "issuanceMethod": "/issuance-methods/1",
    "addressDelivery": "string",
    "fio": "string",
    "passport": "string",
    "addressReg": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

code

string

required

Уникальный код получателя, содержащий только буквы и цифры

Match pattern:

^[A-Z0-9]+

isBlocked

boolean

optional

Запрет на выдачу

Default:

false

customer

allOf {2}

required

Клиент. Должен работать фильтр доступа, например, Менеджер по продажам должен видеть только своих клиентов

object (BaseFieldsModel)

optional

object

optional

isPayRuDelivery

boolean

optional

Платит за доставку по РФ

Default:

false

type

object (Enum)

required

Тип получателя

title

string

optional

Полное наименование организации

titleShort

string

required

Сокращенное наименование

inn

string

optional

ИНН организации

kpp

string

optional

КПП организации

ogrn

string

optional

ОГРН организации

legalAddress

string

optional

Юридический адрес организации

string <email>

optional

Электронная почта получателя

contacts

string

optional

Контактная информация

shippingMethod

object (Способы отправки)

required

Способ отправки до места доставки/пересыла

deletedAt

string <date-time> | null

required

integer

required

>= 1

title

string

required

Способ отправки

code

string

required

Код способа отправки

Match pattern:

^[A-Z0-9]+

city

object (Города)

required

Город доставки

issuanceMethod

object (Способы выдачи груза)

required

Способ выдачи груза

deletedAt

string <date-time> | null

required

integer

required

>= 1

title

string

required

Способ выдачи (Способ передачи груза)

deliveryBases

array[object (Базисы поставки) {3}]

required

Базисы поставки

addressDelivery

string

optional

Адрес доставки

fio

string

optional

Фамилия и инициалы получателя

passport

string

optional

Серия и номер паспорта

addressReg

string

optional

Адрес прописки получателя

Example

🟠400Ошибки 4XX

🔴500Ошибки 5XX