Работа с сущностью "Отправитель (sender)"

Изменено Fri, 24 Jun 2022 на 03:19 PM

Получить информацию об отправителе

Route: https://cdek.orderadmin.ru/api/delivery-services/senders?filter[0][type]=eq&filter[0][field]=id&filter[0][value]=<sender_id>
Method: GET
Headers: Accept: application/json
Authorization: basic

Пример запроса (PHP):

<?php

$url = 'https://cdek.orderadmin.ru/api/delivery-services/senders?filter[0][type]=eq&filter[0][field]=id&filter[0][value]=706';
$headers = [
    'Accept: application/json'
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, '<user>:<password>');
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($data);

Пример запроса (curl):

curl -X GET \
-u "<user>:<password>" \
-H "Accept: application/json" \
"https://cdek.orderadmin.ru/api/delivery-services/senders?filter[0][type]=eq&filter[0][field]=id&filter[0][value]=706"

Пример запроса (Python):

import requests

api_url = 'https://cdek.orderadmin.ru/api/delivery-services/senders?filter[0][type]=eq&filter[0][field]=id&filter[0][value]=706'
result = requests.get(api_url, auth=(
    '<user>', 
    '<password>'
))
print(result.json())

Пример ответа сервера:

{
    "_links": {
        "self": {
            "href": "https://cdek.orderadmin.ru/api/delivery-services/senders?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=id&filter%5B0%5D%5Bvalue%5D=706&page=1"
        },
        "first": {
            "href": "https://cdek.orderadmin.ru/api/delivery-services/senders?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=id&filter%5B0%5D%5Bvalue%5D=706"
        },
        "last": {
            "href": "https://cdek.orderadmin.ru/api/delivery-services/senders?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=id&filter%5B0%5D%5Bvalue%5D=706&page=1"
        }
    },
    "_embedded": {
        "senders": [
            {
                "id": 706,
                "state": "active",
                "type": "private",
                "name": "Тест ФФ Сдэк",
                "extId": null,
                "_embedded": {
                    "defaultSenderProfile": {
                        "id": 1514588,
                        "displayName": null,
                        "surname": null,
                        "name": "Тестовый отправитель",
                        "middleName": null,
                        "email": null,
                        "description": null,
                        "state": "active",
                        "raw": {
                            "name": "Тестовый отправитель СДЕК",
                            "extId": "sender-706"
                        },
                        "extId": "sender-706",
                        "addresses": {},
                        "phones": [
                            {
                                "id": "4838693"
                            }
                        ]
                    },
                    "owner": {
                        "domain": "cdek",
                        "username": "Testman",
                        "email": "ff1@cdek.ru",
                        "name": "Тест ФФ Сдэк",
                        "id": 7065,
                        "state": "active"
                    }
                },
                "_links": {
                    "self": {
                        "href": "https://cdek.orderadmin.ru/api/delivery-services/senders/706"
                    }
                }
            }
        ]
    },
    "page_count": 1,
    "page_size": 25,
    "total_items": 1,
    "page": 1
}

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

Route: https://cdek.orderadmin.ru/api/delivery-services/senders
Method: GET
Headers: Accept: application/json
Authorization: basic

Пример запроса (PHP):

<?php

$url = 'https://cdek.orderadmin.ru/api/delivery-services/senders';
$headers = [
    'Accept: application/json'
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, '<user>:<password>');
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($data);

Пример запроса (curl):

curl -X GET \
-u "<user>:<password>" \
-H "Accept: application/json" \
"https://cdek.orderadmin.ru/api/delivery-services/senders"

Пример запроса (Python):

import requests

api_url = 'https://cdek.orderadmin.ru/api/delivery-services/senders'
result = requests.get(api_url, auth=(
    '<user>', 
    '<password>'
))
print(result.json())

Пример ответа сервера:

{
    "_links": {
        "self": {
            "href": "https://cdek.orderadmin.ru/api/delivery-services/senders?page=1"
        },
        "first": {
            "href": "https://cdek.orderadmin.ru/api/delivery-services/senders"
        },
        "last": {
            "href": "https://cdek.orderadmin.ru/api/delivery-services/senders?page=7"
        },
        "next": {
            "href": "https://cdek.orderadmin.ru/api/delivery-services/senders?page=2"
        }
    },
    "_embedded": {
        "senders": [
            /* Массив объектов sender */
        ]
    },
    "page_count": 7,
    "page_size": 25,
    "total_items": 160,
    "page": 1
}