Cash on delivery registry information
This method is used to get information about cash on delivery registries for which a cash on delivery payment was transferred to the client on the date specified by the client.
Request for Cash on delivery registry information
In order to use this process, a GET request should be sent to URL:
Environment | URL |
testing | |
production |
Request Parameters
The following parameters are supported:
No. | Field name | Description | Field type | Mandatory (yes/no) |
---|---|---|---|---|
1 | date | Date for which the information about cash on delivery registry information is requested | date | yes |
Response to the Request for Cash on delivery registry information
The response body is returned in the JSON format:
No. | Field name | Description | Field type | Mandatory (yes/no) |
---|---|---|---|---|
1 | registries | Cash on delivery registries for which a cash on delivery payment was transferred to the client | [ ] | no |
1.1 | registry_number | Cash on delivery registry number | integer | yes |
1.2 | payment_date | Actual date of payment of the cash on delivery registry | date | no |
1.3 | sum | Total sum of cash on delivery registry (in the currency of mutual settlements) | float | yes |
1.4 | payment_order_number | Number of the payment order within which the payment was made If the attribute is missing in the response or is empty, then please contact your manager to clarify the reasons | string | no |
1.5 | orders | List of orders | [ ] | yes |
1.5.1 | cdek_number | CDEK order number | string | yes |
1.5.2 | transfer_sum | Sum to be charged (in settlement currency) | float | yes |
1.5.3 | payment_sum | Sum of cash on delivery that was taken from the recipient (in the currency of mutual settlements) | float | yes |
1.5.4 | total_sum_without_agent | Total sum of the order, excluding agency fees (in the currency of mutual settlements) | float | yes |
1.5.5 | agent_commission_sum | Agency fee for the transfer of cash on delivery (in the currency of mutual settlements) | float | yes |
2 | errors | List of errors | error[ ] | no |
2.1 | code | Error code | string() | yes |
2.2 | message | Error description | string() | yes |
https://api.cdek.ru/v2/registries?date=2022-05-21' |
{ "registries": [ { "registry_number": 7100000, "payment_date": "2022-05-21", "sum": 8554.00, "orders": [ { "cdek_number": "1300000000", "transfer_sum": 7358.00, "payment_sum": 7358.00, "total_sum_without_agent": 182.07, "agent_commission_sum": 132.44 }, { "cdek_number": "130000001", "transfer_sum": 1196.00, "payment_sum": 1196.00, "total_sum_without_agent": 577.44, "agent_commission_sum": 21.53 } ] } ] } |
© 2000—2024, Курьерская компания СДЭК