Swagger API Личный кабинет Центр поддержки

Асинхронное создание заказа #

Адрес метода #

POST /orders

Параметры запроса #

РазделПараметрОписаниеТипОбязательныйПример
order
clientNumberНомер заказа в системе клиента. Может быть переиспользован, если отменить или удалить заказ.СтрокаДа123-456
providerNumberНомер заказа в системе службы доставки. Если СД выдает диапазон номеров заказа.СтрокаНет123-456
descriptionКоментарий к заказуСтрокаНетВажный заказ
barcodeШтрих-код заказа. Если передается заказ с указанием мест (Place), то ШК надо указывать в параметре place.barcodeСтрокаНет123456
weightВес всего заказа в граммахЧислоДа100
heightВысота заказа в сантиметрахЧислоНет10
lengthДлина заказа в сантиметрахЧислоНет10
widthШирина заказа в сантиметрахЧислоНет10
providerKeyКод службы доставкиСтрокаДаknd
providerConnectIdID подключения к СД. Используется когда к одному аккаунту ApiShip подключено несколько договоров с одной и той же СДЧислоНет12
pickupTypeТип забора груза 1 - от двери клиента 2 – клиент привозит заказ на склад СДЧислоДа1
deliveryTypeТип доставки 1 - до двери 2 – до ПВЗЧислоДа1
tariffIdТариф службы доставки по которому осуществляется доставкаЧислоДа1
pointInIdID пункта приема заказов из метода /lists/points. Обязательно если отгрузка на склад службы доставки.ЧислоНет32
pointOutIdID пункта выдачи заказов из метода /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Процентная ставка НДСЧислоНет20
isDeliveryPayedByRecipientФлаг для указания стороны, которая платит за услуги доставки (0-отправитель, 1-получатель)ЧислоНет1
sender
phoneКонтактный телефонСтрокаДа+7(925)111-11-11
brandNameБренд продавцаСтрокаНетApiShip
companyNameНазвание компанииСтрокаНетООО КНД
contactNameФИО контактного лицаСтрокаДаИванов Иван
countryCodeКод страны в соответствии с ISO 3166-1 alpha-2СтрокаДаRU
regionОбласть или республика или крайСтрокаДаМосква
cityГород или населенный пунктСтрокаДаМосква
streetУлицаСтрокаДаНижняя Красносельская
houseДомСтрокаДа1a
blockСтроение/КорпусСтрокаНет1
officeОфис/КвартираСтрокаНет1
emailКонтактный email адресСтрокаНетmail@gmail.com
addressStringАдрес одной строкойСтрокаДа105066, Москва, Нижняя Красносельская улица, 14А
latШиротаЧислоНет55.756499
lngДолготаЧислоНет37.621864
postIndexПочтовый индексСтрокаНет100100
areaРайонСтрокаНетКировский
cityGuidID города в базе ФИАССтрокаНет0c5b2444-70a0-4932-980c-b4dc0d3f02b5
commentКомментарийСтрокаНетПозвонить с проходной
recipient
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Контактный email адресСтрокаНетmail@gmail.com
addressStringАдрес одной строкойСтрокаДа105066, Москва, Нижняя Красносельская улица, 14А
latШиротаЧислоНет55.756499
lngДолготаЧислоНет37.621864
postIndexПочтовый индексСтрокаНет100100
areaРайонСтрокаНетКировский
cityGuidID города в базе ФИАССтрокаНет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Контактный email адресСтрокаНетmail@gmail.com
addressStringАдрес одной строкойСтрокаДа105066, Москва, Нижняя Красносельская улица, 14А
latШиротаЧислоНет55.756499
lngДолготаЧислоНет37.621864
postIndexПочтовый индексСтрокаНет100100
areaРайонСтрокаНетКировский
cityGuidID города в базе ФИАССтрокаНет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
weightВес единицы товара в граммахЧислоДа100
heightВысота единицы товара в сантиметрахЧислоНет10
lengthДлина единицы товара в сантиметрахЧислоНет10
widthШирина единицы товара в сантиметрахЧислоНет10
markCodeКод маркировкиСтрокаНет010468006347633
extraParamsНет
keyТип дополнительной услугиСтрокаДаcdek.InspectionAttachments
valueЗначение дополнительной услугиСтрокаДа1

Заполнение поля addressString обязательно, если не заполнены другие обязательные поля адреса (countryCode,city,region,street).

В случае заполнения addressString - адрес будет разобран на составляющие и будут использоваться данные полученные в следствии разбора строки addressString.

Пример данных #

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
{
  "order": {
    "clientNumber": "knd_test_1",
    "height": 45,
    "length": 30,
    "width": 20,
    "weight": 20,
    "providerKey": "knd",
    "providerConnectId": 123,
    "pickupType": 1,
    "deliveryType": 1,
    "tariffId": 1,
    "deliveryTimeStart": "10:00",
    "deliveryTimeEnd": "18:00"
  },
  "cost": {
    "codCost": 30,
    "assessedCost": 50
  },
  "sender": {
    "phone": "+7(925)111-11-11",
    "companyName": "ООО КНД",
    "contactName": "Отправитель",
    "countryCode": "RU",
    "region": "Москва",
    "city": "Москва",
    "street": "Нижняя Красносельская",
    "house": "35",
    "block": "9",
    "office": "1",
    "email": "mail@gmail.com"
  },
  "recipient": {
    "phone": "+79251111111",
    "companyName": "ООО КНД",
    "contactName": "Получатель",
    "countryCode": "RU",
    "region": "Москва",
    "city": "Москва",
    "street": "Лазоревый проезд",
    "house": "1а",
    "block": "1",
    "office": "1",
    "email": "mail@gmail.com"
  },
  "places": [
    {
      "placeNumber": "001189",
      "barcode": "011-819",
      "height": 45,
      "length": 30,
      "width": 20,
      "weight": 20,
      "items": [
        {
          "articul": "001189",
          "description": "Товар 1",
          "quantity": 1,
          "height": 45,
          "length": 30,
          "width": 20,
          "weight": 20,
          "assessedCost": 50,
          "cost": 30,
          "costVat": 20,
          "barcode": "1234567890123"
        }
      ]
    }
  ],
  "extraParams": [
    {
      "key": "testParam",
      "value": "testValue"
    }
  ]
}
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
<request>
    <order>
        <clientNumber>knd_test_1</clientNumber>
        <weight>2</weight>
        <height>20</height>
        <length>20</length>
        <width>20</width>
        <providerKey>knd</providerKey>
        <providerConnectId>123</providerConnectId>
        <pickupType>1</pickupType>
        <deliveryType>1</deliveryType>
        <tariffId>1</tariffId>
        <deliveryTimeEnd>18:00</deliveryTimeEnd>
        <deliveryTimeStart>10:00</deliveryTimeStart>
    </order>
    <cost>
        <codCost>240</codCost>
        <assessedCost>240</assessedCost>
    </cost>
    <sender>
        <phone>+7(925)111-11-11</phone>
        <companyName>ООО КНД</companyName>
        <contactName>Отправитель</contactName>
        <countryCode>RU</countryCode>
        <region>Москва</region>
        <city>Москва</city>
        <street>Нижняя Красносельская</street>
        <house>35</house>
        <block>9</block>
        <office>1</office>
        <email>mail@gmail.com</email>
    </sender>
    <recipient>
        <phone>+7(925)1111111</phone>
        <companyName>ООО КНД</companyName>
        <contactName>Получатель</contactName>
        <countryCode>RU</countryCode>
        <region>Москва</region>
        <city>Москва</city>
        <street>Лазоревый проезд</street>
        <house></house>
        <block>1</block>
        <office>11</office>
        <email>mail@gmail.com</email>
    </recipient>
    <places>
      <item>
         <placeNumber>120000</placeNumber>
         <barcode>011-819</barcode>
         <height>10</height>
         <length>10</length>
         <width>10</width>
         <weight>1</weight>
         <items>
            <item>
               <articul>120000</articul>
               <description>Товар 1</description>
               <quantity>1</quantity>
               <quantityDelivered>1</quantityDelivered>
               <height>10</height>
               <length>10</length>
               <width>10</width>
               <weight>1</weight>
               <assessedCost>120</assessedCost>
               <cost>120</cost>
               <costVat>20</costVat>
               <barcode>1234567890123</barcode>
            </item>
         </items>
      </item>
      <item>
         <placeNumber>120001</placeNumber>
         <barcode>011-820</barcode>
         <height>10</height>
         <length>10</length>
         <width>10</width>
         <weight>1</weight>
         <items>
            <item>
               <articul>120000</articul>
               <description>Товар 1</description>
               <quantity>1</quantity>
               <quantityDelivered>1</quantityDelivered>
               <height>10</height>
               <length>10</length>
               <width>10</width>
               <weight>1</weight>
               <assessedCost>120</assessedCost>
               <cost>120</cost>
               <costVat>20</costVat>
               <barcode>1234567890222</barcode>
            </item>
         </items>
      </item>
    </places>
    <extraParams>
      <item>
         <key>testParam</key>
         <value>testValue</value>
      </item>
   </extraParams>
</request>

Параметры корректного ответа #

РазделПараметрОписаниеТипОбязательныйПример
orderIdНомер заказа в ApiShipЧислоДа4561111
createdДата создания заказаДата и времяДа2018-01-01T10:00:00+03:00

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

1
2
3
4
{
    "orderId": "4561111",
    "created": "2018-01-01T10:00:00+03:00"
}
1
2
3
4
<response>
    <orderId>4560036</orderId>
    <created>2018-06-19T09:43:09+03:00</created>
</response>