Платежи доставки

Каждая операция ниже сгенерирована из OpenAPI v2 и содержит параметры, поля запроса, поля ответа, ошибки и примеры.

Платежи доставки

GET /api/v2/order-delivery-payments

Получить список платежей доставки

operationIdlistOrderDeliveryPayments
РазделПлатежи доставки
БезопасностьbearerAuth

Возвращает платежи доставки, видимые аутентифицированному аккаунту. Используйте описанные query parameters для фильтрации, сортировки и пагинации.
Unknown read parameters are ignored. per_page is silently capped; use meta.per_page. Date-only boundaries follow the installation's stored calendar dates; ISO timestamps are serialized in UTC. The default general API limit is 600/minute; a user-specific override may apply. Its bucket is shared by authenticated user, not by shop/domain; Retry-After is returned on throttling.
Unknown read parameters are ignored. per_page is silently capped; use meta.per_page. Date-only boundaries follow the installation's stored calendar dates; ISO timestamps are serialized in UTC. The default general API limit is 600/minute; a user-specific override may apply. Its bucket is shared by authenticated user, not by shop/domain; Retry-After is returned on throttling.
Unknown read parameters are ignored. per_page is silently capped; use meta.per_page. Date-only boundaries follow the installation's stored calendar dates; ISO timestamps are serialized in UTC. The default general API limit is 600/minute; a user-specific override may apply. Its bucket is shared by authenticated user, not by shop/domain; Retry-After is returned on throttling.
Unknown read parameters are ignored. per_page is silently capped; use meta.per_page. Date-only boundaries follow the installation's stored calendar dates; ISO timestamps are serialized in UTC. The default general API limit is 600/minute; a user-specific override may apply. Its bucket is shared by authenticated user, not by shop/domain; Retry-After is returned on throttling.
Unknown read parameters are ignored. per_page is silently capped; use meta.per_page. Date-only boundaries follow the installation's stored calendar dates; ISO timestamps are serialized in UTC. The default general API limit is 600/minute; a user-specific override may apply. Its bucket is shared by authenticated user, not by shop/domain; Retry-After is returned on throttling.
Unknown read parameters are ignored. per_page is silently capped; use meta.per_page. Date-only boundaries follow the installation's stored calendar dates; ISO timestamps are serialized in UTC. The default general API limit is 600/minute; a user-specific override may apply. Its bucket is shared by authenticated user, not by shop/domain; Retry-After is returned on throttling.

Пример HTTP-запроса (cURL)

Подставьте свой сервер и токен. ID из примера замените реальными доступными ID. Для тела запроса сохраните подходящий JSON из раздела ниже в request.json; перед отправкой замените демонстрационные значения. Заголовок Idempotency-Key использует ключ одной логической операции.

curl --globoff --request GET "${NWMS_BASE_URL}/api/v2/order-delivery-payments" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer ${NWMS_TOKEN}"

Параметры

Имя Где Обязательное Тип Style Explode Ограничения Описание Пример
page query нет integer:int64 form true min: 1 Номер страницы. Этот фильтр также можно передать как filter[page], если это поддерживает Laravel query adapter. 1
per_page query нет integer:int64 form true min: 1
max: 250
Количество записей на странице. По умолчанию 50; максимум 250. Этот фильтр также можно передать как filter[per_page], если это поддерживает Laravel query adapter. 50
sort query нет string form false pattern: ^-?[A-Za-z0-9_]+(,-?[A-Za-z0-9_]+)*$ Поля сортировки через запятую. Префикс - означает сортировку по убыванию. Допустимые поля: id, order_id, track_id, delivery_sum, cod_sum, created_at, updated_at. По умолчанию: -id. Этот фильтр также можно передать как filter[sort], если это поддерживает Laravel query adapter. "-id"
id query нет integer:int64 form true min: 1 Фильтр по id с точным совпадением. Этот фильтр также можно передать как filter[id], если это поддерживает Laravel query adapter. 1001
order_id query нет integer:int64 form true min: 1 Фильтр по order_id с точным совпадением. Этот фильтр также можно передать как filter[order_id], если это поддерживает Laravel query adapter. 1
status_id query нет integer:int64 form true min: 1 Фильтр по status_id с точным совпадением. Этот фильтр также можно передать как filter[status_id], если это поддерживает Laravel query adapter. 1
payment_order_id query нет integer:int64 form true min: 1 Фильтр по payment_order_id с точным совпадением. Этот фильтр также можно передать как filter[payment_order_id], если это поддерживает Laravel query adapter. 9401
transaction_id query нет integer:int64 form true min: 1 Фильтр по transaction_id с точным совпадением. Этот фильтр также можно передать как filter[transaction_id], если это поддерживает Laravel query adapter. 9501
cod_act_id query нет integer:int64 form true min: 1 Фильтр по cod_act_id с точным совпадением. Этот фильтр также можно передать как filter[cod_act_id], если это поддерживает Laravel query adapter. 9601
track_id query нет string form true Фильтр по track_id с частичным текстовым совпадением. Этот фильтр также можно передать как filter[track_id], если это поддерживает Laravel query adapter. "CDEK-123456789"
etalon_order_id query нет string form true Фильтр по etalon_order_id с частичным текстовым совпадением. Этот фильтр также можно передать как filter[etalon_order_id], если это поддерживает Laravel query adapter. "EXT-10045"
created_at_from query нет string:date form true Нижняя включительная граница даты для created_at. Этот фильтр также можно передать как filter[created_at_from], если это поддерживает Laravel query adapter. "2026-07-14"
created_at_to query нет string:date form true Верхняя включительная граница даты для created_at. Этот фильтр также можно передать как filter[created_at_to], если это поддерживает Laravel query adapter. "2026-07-14"
updated_at_from query нет string:date form true Нижняя включительная граница даты для updated_at. Этот фильтр также можно передать как filter[updated_at_from], если это поддерживает Laravel query adapter. "2026-07-14"
updated_at_to query нет string:date form true Верхняя включительная граница даты для updated_at. Этот фильтр также можно передать как filter[updated_at_to], если это поддерживает Laravel query adapter. "2026-07-14"
delivery_sum_from query нет number:float form true Нижняя включительная числовая граница для delivery_sum. Этот фильтр также можно передать как filter[delivery_sum_from], если это поддерживает Laravel query adapter. 48.58
delivery_sum_to query нет number:float form true Верхняя включительная числовая граница для delivery_sum. Этот фильтр также можно передать как filter[delivery_sum_to], если это поддерживает Laravel query adapter. 48.58
cod_sum_from query нет number:float form true Нижняя включительная числовая граница для cod_sum. Этот фильтр также можно передать как filter[cod_sum_from], если это поддерживает Laravel query adapter. 48.58
cod_sum_to query нет number:float form true Верхняя включительная числовая граница для cod_sum. Этот фильтр также можно передать как filter[cod_sum_to], если это поддерживает Laravel query adapter. 48.58

Тело запроса

Тело запроса отсутствует.

Ответы

200 Successful response.

Successful response.

Поле Обязательное Тип Флаги Ограничения Описание Пример
data да array<OrderDeliveryPayment>
data[] нет OrderDeliveryPayment Строка сверки платежей доставки.
data[].id да integer:int64 readOnly min: 1 1001
data[].created_at нет string:date-time | null "2026-07-14T10:30:00Z"
data[].updated_at нет string:date-time | null "2026-07-14T10:30:00Z"
data[].domain_id нет integer:int64 | null min: 1 3
data[].order_id нет integer:int64 | null min: 1 8101
data[].track_id нет string | null "CDEK-123456789"
data[].amounts да OrderDeliveryPaymentAmounts
data[].amounts.delivery_sum нет number:float | null 8.6
data[].amounts.delivery_tax нет number:float | null 1.72
data[].amounts.cod_sum нет number:float | null 48.58
data[].amounts.cod_agent_sum нет number:float | null 1.5
data[].status_id нет integer:int64 | null 1
data[].payment_order_id нет integer:int64 | null min: 1 9401
data[].etalon_order_id нет string | null "EXT-10045"
data[].transaction_id нет integer:int64 | null min: 1 9501
data[].cod_act_id нет integer:int64 | null min: 1 9601
links да PaginationLinks
links.first да string:uri | null "https://betawms.ffcdek.ru/api/v2/orders?page=1"
links.last да string:uri | null "https://betawms.ffcdek.ru/api/v2/orders?page=2"
links.prev да string:uri | null
links.next да string:uri | null "https://betawms.ffcdek.ru/api/v2/orders?page=2"
meta да PaginationMeta
meta.api_version да enum enum: v2 "v2"
meta.current_page да integer:int32 min: 1 1
meta.from да integer:int32 | null min: 1 1
meta.last_page да integer:int32 min: 1 2
meta.path да string:uri "https://betawms.ffcdek.ru/api/v2/orders"
meta.per_page да integer:int32 min: 1 50
meta.to да integer:int32 | null min: 1 50
meta.total да integer:int32 min: 0 73

Примеры ответа

success

{
  "data": [
    {
      "id": 9301,
      "domain_id": 3,
      "order_id": 8101,
      "track_id": "CDEK-123456789",
      "amounts": {
        "delivery_sum": 8.6,
        "delivery_tax": 1.72,
        "cod_sum": 48.58,
        "cod_agent_sum": 1.5
      },
      "status_id": 1,
      "payment_order_id": 9401,
      "etalon_order_id": "EXT-10045",
      "transaction_id": 9501,
      "cod_act_id": 9601,
      "created_at": "2026-07-14T09:00:00Z",
      "updated_at": "2026-07-14T09:30:00Z"
    }
  ],
  "links": {
    "first": "https://betawms.ffcdek.ru/api/v2/order-delivery-payments?page=1",
    "last": "https://betawms.ffcdek.ru/api/v2/order-delivery-payments?page=2",
    "prev": null,
    "next": "https://betawms.ffcdek.ru/api/v2/order-delivery-payments?page=2"
  },
  "meta": {
    "api_version": "v2",
    "current_page": 1,
    "from": 1,
    "last_page": 2,
    "path": "https://betawms.ffcdek.ru/api/v2/order-delivery-payments",
    "per_page": 50,
    "to": 50,
    "total": 73
  }
}

401 Требуется аутентификация

Unauthorized

Требуется аутентификация.

Поле Обязательное Тип Флаги Ограничения Описание Пример
message да string "The request could not be processed."
error да string "BAD_REQUEST"

Примеры ответа

AUTH_REQUIRED

{
  "message": "Authentication is required.",
  "error": "AUTH_REQUIRED"
}

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

Forbidden

Аутентифицированному аккаунту запрещено выполнять это действие.

Поле Обязательное Тип Флаги Ограничения Описание Пример
message да string "The request could not be processed."
error да string "BAD_REQUEST"

Примеры ответа

FORBIDDEN

{
  "message": "The authenticated account is not allowed to perform this action.",
  "error": "FORBIDDEN"
}

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

TooManyRequests

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

Поле Обязательное Тип Флаги Ограничения Описание Пример
message да string "Too Many Attempts."
error да string "RATE_LIMITED"

500 Внутренняя ошибка сервера

InternalServerError

Произошла непредвиденная ошибка сервера.

Поле Обязательное Тип Флаги Ограничения Описание Пример
message да string "The request could not be processed."
error да string "BAD_REQUEST"

Примеры ответа

INTERNAL_SERVER_ERROR

{
  "message": "An unexpected server error occurred.",
  "error": "INTERNAL_SERVER_ERROR"
}