Delivery Payments
Every operation below is generated from the OpenAPI v2 specification and includes parameters, request fields, response fields, errors, and examples.
Delivery Payments
List delivery payments
| operationId | listOrderDeliveryPayments |
|---|---|
| Tag | Delivery Payments |
| Security | bearerAuth |
Returns delivery payments visible to the authenticated account. Use documented query parameters for filtering, sorting, and pagination.
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 request example (cURL)
Set your server and token. Replace sample IDs with accessible IDs. For requests with a body, save the applicable JSON example below as request.json and replace sample values before sending. Idempotency-Key identifies one logical operation.
curl --globoff --request GET "${NWMS_BASE_URL}/api/v2/order-delivery-payments" \
--header "Accept: application/json" \
--header "Authorization: Bearer ${NWMS_TOKEN}"Parameters
| Name | In | Required | Type | Style | Explode | Constraints | Description | Example |
|---|---|---|---|---|---|---|---|---|
page |
query | no | integer:int64 |
form | true | min: 1 | Page number. The same filter may also be sent as filter[page] where supported by the Laravel query adapter. |
1 |
per_page |
query | no | integer:int64 |
form | true | min: 1 max: 250 |
Number of records per page. Default is 50; maximum is 250. The same filter may also be sent as filter[per_page] where supported by the Laravel query adapter. |
50 |
sort |
query | no | string |
form | false | pattern: ^-?[A-Za-z0-9_]+(,-?[A-Za-z0-9_]+)*$ | Comma-separated sort fields. Prefix with - for descending order. Allowed fields: id, order_id, track_id, delivery_sum, cod_sum, created_at, updated_at. Default: -id. The same filter may also be sent as filter[sort] where supported by the Laravel query adapter. |
"-id" |
id |
query | no | integer:int64 |
form | true | min: 1 | Filter by id using exact matching. The same filter may also be sent as filter[id] where supported by the Laravel query adapter. |
1001 |
order_id |
query | no | integer:int64 |
form | true | min: 1 | Filter by order_id using exact matching. The same filter may also be sent as filter[order_id] where supported by the Laravel query adapter. |
1 |
status_id |
query | no | integer:int64 |
form | true | min: 1 | Filter by status_id using exact matching. The same filter may also be sent as filter[status_id] where supported by the Laravel query adapter. |
1 |
payment_order_id |
query | no | integer:int64 |
form | true | min: 1 | Filter by payment_order_id using exact matching. The same filter may also be sent as filter[payment_order_id] where supported by the Laravel query adapter. |
9401 |
transaction_id |
query | no | integer:int64 |
form | true | min: 1 | Filter by transaction_id using exact matching. The same filter may also be sent as filter[transaction_id] where supported by the Laravel query adapter. |
9501 |
cod_act_id |
query | no | integer:int64 |
form | true | min: 1 | Filter by cod_act_id using exact matching. The same filter may also be sent as filter[cod_act_id] where supported by the Laravel query adapter. |
9601 |
track_id |
query | no | string |
form | true | Filter by track_id using partial text matching. The same filter may also be sent as filter[track_id] where supported by the Laravel query adapter. |
"CDEK-123456789" |
|
etalon_order_id |
query | no | string |
form | true | Filter by etalon_order_id using partial text matching. The same filter may also be sent as filter[etalon_order_id] where supported by the Laravel query adapter. |
"EXT-10045" |
|
created_at_from |
query | no | string:date |
form | true | Lower inclusive date boundary for created_at. The same filter may also be sent as filter[created_at_from] where supported by the Laravel query adapter. |
"2026-07-14" |
|
created_at_to |
query | no | string:date |
form | true | Upper inclusive date boundary for created_at. The same filter may also be sent as filter[created_at_to] where supported by the Laravel query adapter. |
"2026-07-14" |
|
updated_at_from |
query | no | string:date |
form | true | Lower inclusive date boundary for updated_at. The same filter may also be sent as filter[updated_at_from] where supported by the Laravel query adapter. |
"2026-07-14" |
|
updated_at_to |
query | no | string:date |
form | true | Upper inclusive date boundary for updated_at. The same filter may also be sent as filter[updated_at_to] where supported by the Laravel query adapter. |
"2026-07-14" |
|
delivery_sum_from |
query | no | number:float |
form | true | Lower inclusive numeric boundary for delivery_sum. The same filter may also be sent as filter[delivery_sum_from] where supported by the Laravel query adapter. |
48.58 |
|
delivery_sum_to |
query | no | number:float |
form | true | Upper inclusive numeric boundary for delivery_sum. The same filter may also be sent as filter[delivery_sum_to] where supported by the Laravel query adapter. |
48.58 |
|
cod_sum_from |
query | no | number:float |
form | true | Lower inclusive numeric boundary for cod_sum. The same filter may also be sent as filter[cod_sum_from] where supported by the Laravel query adapter. |
48.58 |
|
cod_sum_to |
query | no | number:float |
form | true | Upper inclusive numeric boundary for cod_sum. The same filter may also be sent as filter[cod_sum_to] where supported by the Laravel query adapter. |
48.58 |
Request body
No request body.
Responses
200 Successful response.
Successful response.
| Field | Required | Type | Flags | Constraints | Description | Example |
|---|---|---|---|---|---|---|
data |
yes | array<OrderDeliveryPayment> |
|
|||
data[] |
no | OrderDeliveryPayment |
Delivery payment reconciliation row. | |
||
data[].id |
yes | integer:int64 |
readOnly | min: 1 | 1001 |
|
data[].created_at |
no | string:date-time | null |
"2026-07-14T10:30:00Z" |
|||
data[].updated_at |
no | string:date-time | null |
"2026-07-14T10:30:00Z" |
|||
data[].domain_id |
no | integer:int64 | null |
min: 1 | 3 |
||
data[].order_id |
no | integer:int64 | null |
min: 1 | 8101 |
||
data[].track_id |
no | string | null |
"CDEK-123456789" |
|||
data[].amounts |
yes | OrderDeliveryPaymentAmounts |
|
|||
data[].amounts.delivery_sum |
no | number:float | null |
8.6 |
|||
data[].amounts.delivery_tax |
no | number:float | null |
1.72 |
|||
data[].amounts.cod_sum |
no | number:float | null |
48.58 |
|||
data[].amounts.cod_agent_sum |
no | number:float | null |
1.5 |
|||
data[].status_id |
no | integer:int64 | null |
1 |
|||
data[].payment_order_id |
no | integer:int64 | null |
min: 1 | 9401 |
||
data[].etalon_order_id |
no | string | null |
"EXT-10045" |
|||
data[].transaction_id |
no | integer:int64 | null |
min: 1 | 9501 |
||
data[].cod_act_id |
no | integer:int64 | null |
min: 1 | 9601 |
||
links |
yes | PaginationLinks |
|
|||
links.first |
yes | string:uri | null |
"https://betawms.ffcdek.ru/api/v2/orders?page=1" |
|||
links.last |
yes | string:uri | null |
"https://betawms.ffcdek.ru/api/v2/orders?page=2" |
|||
links.prev |
yes | string:uri | null |
|
|||
links.next |
yes | string:uri | null |
"https://betawms.ffcdek.ru/api/v2/orders?page=2" |
|||
meta |
yes | PaginationMeta |
|
|||
meta.api_version |
yes | enum |
enum: v2 | "v2" |
||
meta.current_page |
yes | integer:int32 |
min: 1 | 1 |
||
meta.from |
yes | integer:int32 | null |
min: 1 | 1 |
||
meta.last_page |
yes | integer:int32 |
min: 1 | 2 |
||
meta.path |
yes | string:uri |
"https://betawms.ffcdek.ru/api/v2/orders" |
|||
meta.per_page |
yes | integer:int32 |
min: 1 | 50 |
||
meta.to |
yes | integer:int32 | null |
min: 1 | 50 |
||
meta.total |
yes | integer:int32 |
min: 0 | 73 |
Response examples
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 Authentication required
Unauthorized
Authentication is required.
| Field | Required | Type | Flags | Constraints | Description | Example |
|---|---|---|---|---|---|---|
message |
yes | string |
"The request could not be processed." |
|||
error |
yes | string |
"BAD_REQUEST" |
Response examples
AUTH_REQUIRED
{
"message": "Authentication is required.",
"error": "AUTH_REQUIRED"
}403 Forbidden
Forbidden
The authenticated account is not allowed to perform this action.
| Field | Required | Type | Flags | Constraints | Description | Example |
|---|---|---|---|---|---|---|
message |
yes | string |
"The request could not be processed." |
|||
error |
yes | string |
"BAD_REQUEST" |
Response examples
FORBIDDEN
{
"message": "The authenticated account is not allowed to perform this action.",
"error": "FORBIDDEN"
}429 Rate limit exceeded
TooManyRequests
Rate limit exceeded.
| Field | Required | Type | Flags | Constraints | Description | Example |
|---|---|---|---|---|---|---|
message |
yes | string |
"Too Many Attempts." |
|||
error |
yes | string |
"RATE_LIMITED" |
500 Internal server error
InternalServerError
An unexpected server error occurred.
| Field | Required | Type | Flags | Constraints | Description | Example |
|---|---|---|---|---|---|---|
message |
yes | string |
"The request could not be processed." |
|||
error |
yes | string |
"BAD_REQUEST" |
Response examples
INTERNAL_SERVER_ERROR
{
"message": "An unexpected server error occurred.",
"error": "INTERNAL_SERVER_ERROR"
}