Создание заказа #
Адрес метода #
Параметры запроса #
| Раздел | Параметр | Описание | Тип | Обязательный | Пример |
|---|---|---|---|---|---|
| order | |||||
| clientNumber | Номер заказа в системе клиента. Может быть переиспользован, если отменить или удалить заказ. | Строка | Да | 123-456 | |
| description | Коментарий к заказу | Строка | Нет | Важный заказ | |
| barcode | Штрих-код заказа. Если передается заказ с указанием мест (Place), то ШК надо указывать в параметре place.barcode | Строка | Нет | 123456 | |
| weight | Вес всего заказа в граммах | Число | Да | 100 | |
| height | Высота заказа в сантиметрах | Число | Нет | 10 | |
| length | Длина заказа в сантиметрах | Число | Нет | 10 | |
| width | Ширина заказа в сантиметрах | Число | Нет | 10 | |
| providerKey | Код службы доставки | Строка | Да | cdek | |
| providerConnectId | ID подключения к СД. Используется когда к одному аккаунту ApiShip подключено несколько договоров с одной и той же СД | Число | Нет | 12 | |
| pickupType | Тип забора груза 1 - от двери клиента 2 – клиент привозит заказ на склад СД | Число | Да | 1 | |
| deliveryType | Тип доставки 1 - до двери 2 – до ПВЗ | Число | Да | 1 | |
| tariffId | Тариф службы доставки по которому осуществляется доставка | Число | Да | 1 | |
| pointInId | ID пункта приема заказов из метода /lists/points. Обязательно если отгрузка на склад службы доставки. | Число | Нет | 32 | |
| pointOutId | ID пункта выдачи заказов из метода /lists/points. Обязательно если доставка до ПВЗ | Число | Нет | 21 | |
| pickupDate | Планируемая дата передачи заказа в СД (вызова курьера) | Дата | Нет | 2020-01-31 | |
| pickupTimeStart | Начальное время передачи заказа в СД (вызова курьера) | Время | Нет | 10:00 | |
| pickupTimeEnd | Конечное время передачи заказа в СД (вызова курьера) | Время | Нет | 18:00 | |
| deliveryDate | Желаемая дата доставки | Дата | Нет | 2020-01-31 | |
| deliveryTimeStart | Начальное время доставки | Время | Нет | 10:00 | |
| deliveryTimeEnd | Конечное время доставки | Время | Нет | 18:00 | |
| cost | |||||
| assessedCost | Оценочная стоимость / сумма страховки (в рублях) | Число | Да | 100,12 | |
| codCost | Сумма наложенного платежа с учетом НДС (в рублях) | Число | Да | 98,21 | |
| deliveryCost | Стоимость доставки с получателя. codCost должен содержать в себе эту сумму. | Число | Нет | 50,12 | |
| deliveryCostVat | Процентная ставка НДС (-1 - Без НДС, 0 - НДС 0%, 5 - НДС 5%, 7 - НДС 7%, 10 - НДС 10%, 20 - НДС 20%) | Число | Нет | 20 | |
| isDeliveryPayedByRecipient | Флаг для указания стороны, которая платит за услуги доставки (0-отправитель, 1-получатель) | Число | Нет | 1 | |
| paymentMethod | Способ оплаты заказа: - 1 - Наличные; - 2 - Карта; - 3 - Смешанная оплата(наличные и карта) - 4 - Безналичная оплата (по счету) | Число | Нет | 1 | |
| deliveryCostThresholds | Пороги стоимости доставки, используются для динамической стоимости доставки в случае частичного выкупа | deliveryCostThreshold | Нет | ||
| deliveryCostThreshold | |||||
| deliveryCost | Стоимость доставки при выкупе на сумму до порогового значения | Число | Да | 100 | |
| threshold | Пороговое значение суммы выкупа товара | Число | Да | 200 | |
| sender | |||||
| phone | Контактный телефон | Строка | Да | +7(925)111-11-11 | |
brandName | Бренд продавца | Строка | Нет | ApiShip | |
| companyName | Название компании | Строка | Нет | ООО КНД | |
| companyInn | ИНН компании | Строка | Нет | 1234567890 | |
| contactName | ФИО контактного лица | Строка | Да | Иванов Иван | |
| countryCode | Код страны в соответствии с ISO 3166-1 alpha-2 | Строка | Да | RU | |
| region | Область или республика или край | Строка | Да | Москва | |
| city | Город или населенный пункт | Строка | Да | Москва | |
| street | Улица | Строка | Да | Нижняя Красносельская | |
| house | Дом | Строка | Да | 1a | |
| block | Строение/Корпус | Строка | Нет | 1 | |
| office | Офис/Квартира | Строка | Нет | 1 | |
| Контактный email адрес | Строка | Нет | mail@gmail.com | ||
| addressString | Адрес одной строкой | Строка | Да | 105066, Москва, Нижняя Красносельская улица, 14А | |
| lat | Широта | Число | Нет | 55.756499 | |
| lng | Долгота | Число | Нет | 37.621864 | |
| postIndex | Почтовый индекс | Строка | Нет | 100100 | |
| area | Район | Строка | Нет | Кировский | |
| cityGuid | ID города в базе ФИАС | Строка | Нет | 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 | |
| comment | Комментарий | Строка | Нет | Позвонить с проходной | |
| recipient | |||||
| phone | Контактный телефон | Строка | Да | +7(925)111-11-11 | |
| companyName | Название компании | Строка | Нет | ООО КНД | |
| companyInn | ИНН компании | Строка | Нет | 1234567890 | |
| contactName | ФИО контактного лица | Строка | Да | Иванов Иван | |
| countryCode | Код страны в соответствии с ISO 3166-1 alpha-2 | Строка | Да | RU | |
| region | Область или республика или край | Строка | Да | Москва | |
| city | Город или населенный пункт | Строка | Да | Москва | |
| street | Улица | Строка | Да | Нижняя Красносельская | |
| house | Дом | Строка | Да | 1a | |
| block | Строение/Корпус | Строка | Нет | 1 | |
| office | Офис/Квартира | Строка | Нет | 1 | |
| Контактный email адрес | Строка | Нет | mail@gmail.com | ||
| addressString | Адрес одной строкой | Строка | Да | 105066, Москва, Нижняя Красносельская улица, 14А | |
| lat | Широта | Число | Нет | 55.756499 | |
| lng | Долгота | Число | Нет | 37.621864 | |
| postIndex | Почтовый индекс | Строка | Нет | 100100 | |
| area | Район | Строка | Нет | Кировский | |
| cityGuid | ID города в базе ФИАС | Строка | Нет | 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 | |
| comment | Комментарий | Строка | Нет | Позвонить с проходной | |
| returnAddress | |||||
| phone | Контактный телефон | Строка | Да | +7(925)111-11-11 | |
| companyName | Название компании | Строка | Нет | ООО КНД | |
| contactName | ФИО контактного лица | Строка | Да | Иванов Иван | |
| countryCode | Код страны в соответствии с ISO 3166-1 alpha-2 | Строка | Да | RU | |
| region | Область или республика или край | Строка | Да | Москва | |
| city | Город или населенный пункт | Строка | Да | Москва | |
| street | Улица | Строка | Да | Нижняя Красносельская | |
| house | Дом | Строка | Да | 1a | |
| block | Строение/Корпус | Строка | Нет | 1 | |
| office | Офис/Квартира | Строка | Нет | 1 | |
| Контактный email адрес | Строка | Нет | mail@gmail.com | ||
| addressString | Адрес одной строкой | Строка | Да | 105066, Москва, Нижняя Красносельская улица, 14А | |
| lat | Широта | Число | Нет | 55.756499 | |
| lng | Долгота | Число | Нет | 37.621864 | |
| postIndex | Почтовый индекс | Строка | Нет | 100100 | |
| area | Район | Строка | Нет | Кировский | |
| cityGuid | ID города в базе ФИАС | Строка | Нет | 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 | |
| comment | Комментарий | Строка | Нет | Позвонить с проходной | |
| place | |||||
| placeNumber | Номер места в информационной системе клиента | Строка | Нет | 1 | |
| barcode | Штрихкод места | Строка | Нет | 011-819 | |
| height | Высота места в сантиметрах | Число | Нет | 10 | |
| width | Ширина места в сантиметрах | Число | Нет | 10 | |
| length | Длина места в сантиметрах | Число | Нет | 10 | |
| weight | Вес места в граммах | Число | Да | 100 | |
| items | Содержимое места | item | Да | ||
| item | |||||
| description | Наименование товара | Строка | Да | Кирпич | |
| quantity | Кол-во товара | Число | Да | 2 | |
| articul | Артикул товара | Строка | Нет | 123-456 | |
| barcode | ШК предмета | Строка | Нет | 123456 | |
| assessedCost | Оценочная стоимость единицы товара в рублях | Число | Нет | 100,20 | |
| cost | Наложенная стоимость товара в рублях | Число | Нет | 100,20 | |
| costVat | Процентная ставка НДС (-1 - Без НДС, 0 - НДС 0%, 5 - НДС 5%, 7 - НДС 7%, 10 - НДС 10%, 20 - НДС 20%) | Число | Нет | 20 | |
| weight | Вес единицы товара в граммах | Число | Да | 100 | |
| height | Высота единицы товара в сантиметрах | Число | Нет | 10 | |
| length | Длина единицы товара в сантиметрах | Число | Нет | 10 | |
| width | Ширина единицы товара в сантиметрах | Число | Нет | 10 | |
| markCode | Код маркировки | Строка | Нет | 010468006347633 | |
| companyName | Наименование компании поставщика / продавца товара | Строка | Нет | ООО "Тест" | |
| companyInn | ИНН поставщика / продавца товара | Строка | Нет | 1234567890 | |
| companyPhone | Телефон поставщика / продавца товара | Строка | Нет | 79887776655 | |
| tnved | Код ТН ВЭД | Строка | Нет | 6810190009 | |
| url | Ссылка на страницу товара в интернет-магазине | Строка | Нет | https://mymarket.example.com/item/product-1/ | |
| extraParams | Нет | ||||
| key | Тип дополнительной услуги | Строка | Да | cdek.InspectionAttachments | |
| value | Значение дополнительной услуги | Строка | Да | 1 |
Заполнение поля addressString обязательно, если не заполнены другие обязательные поля адреса ( countryCode,city,region,street).
В случае заполнения addressString - адрес будет разобран на составляющие и будут использоваться данные полученные в следствии разбора строки addressString.
Пример данных #
| |
| |
Параметры корректного ответа #
| Раздел | Параметр | Описание | Тип | Обязательный | Пример |
|---|---|---|---|---|---|
| orderId | Номер заказа в ApiShip | Число | Да | 4561111 | |
| created | Дата создания заказа | Дата и время | Да | 2018-01-01T10:00:00+03:00 |
Пример ответа #
| |
| |