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

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

page

integer

optional

The collection page number

pagination

boolean

optional

Enable or disable pagination

exists[deletedAt]

boolean

optional

fields[]

string

optional

Example:

fields[]=id

Responses

🟢200OK

application/json

Body

data

array[object (Получатели) {20}]

optional

code

string

required

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

Match pattern:

^[A-Z0-9]+

isBlocked

boolean

optional

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

Default:

false

customer

allOf {2}

required

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

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

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

city

object (Города)

required

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

issuanceMethod

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

required

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

addressDelivery

string

optional

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

fio

string

optional

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

passport

string

optional

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

addressReg

string

optional

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

pagination

object (Pagination)

optional

first

integer

optional

>= 1

current

integer

optional

>= 1

last

integer

optional

>= 1

integer

optional

>= 1

integer

optional

>= 1

total

integer

optional

>= 0

Example

🟠400Ошибки 4XX

🔴500Ошибки 5XX

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

Request

Request samples

Responses