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

Asynchronous creation of shipment #

URL #

POST /orders

Query parameters #

SectionParameterDescriptionTypeRequiredExample
order
clientNumberOrder number in the client’s system. It can be reused if you cancel or delete an order.StringYes123-456
providerNumberOrder number in the delivery service system. If the logistics company issues a range of order numbers.StringNo123-456
descriptionComments on the orderStringNoImportant order
barcodeBarcode of the order. If an order is passed with an indication of places (Place), then barcode must be specified in the place parameter.barcodeStringNo123456
weightTotal order weight in gramsNumberYes100
heightOrder height in centimetersNumberNo10
lengthOrder length in centimetersNumberNo10
widthOrder width in centimetersNumberNo10
providerKeyCode of the logistics companyStringYesknd
providerConnectIdID of the connection to the logistics company. Used when multiple contracts with the same logistics company are connected to the same ApiShip account.NumberNo12
pickupTypeType of cargo pickup 1 - from the customer’s door 2 - the customer brings the order to the warehouse of the logistics company.NumberYes1
deliveryTypeDelivery type 1 - to the door 2 - to the pick-up pointNumberYes1
tariffIdThe logistics company’s tariff that is used for deliveryNumberYes1
pointInIdID of the order acceptance point from the /lists/points method. Required if the shipment is to the warehouse of the logistics company.NumberNo32
pointOutIdID of the order pickup point from the /lists/points method. Required if the delivery is to the pick-up pointNumberNo21
pickupDatePlanned date of transfer of the order to the logistics company (courier call)DateNo2020-01-31
pickupTimeStartThe initial time when the order was sent to the logistics company (when the courier was called)TimeNo10:00
pickupTimeEndThe final time when the order is sent to the logistics company (when the courier is called)TimeNo18:00
deliveryDateDesired delivery dateDateNo2020-01-31
deliveryTimeStartInitial delivery timeTimeNo10:00
deliveryTimeEndThe final delivery timeTimeNo18:00
cost
assessedCostEstimated cost / amount of insurance (in rubles)NumberYes100,12
codCostCash on delivery amount including VAT (in rubles)NumberYes98,21
deliveryCostCost of delivery from the recipient. codCost must contain this amount.NumberNo50,12
deliveryCostVatVAT rateNumberNo20
isDeliveryPayedByRecipientFlag for specifying the party that pays for delivery services (0 - sender, 1 - recipient)NumberNo1
sender
phoneContact phone numberStringYes+7(925)111-11-11
companyNameCompany nameStringNoООО КНД
contactNameContact person’s full nameStringYesИванов Иван
countryCodeCountry code in accordance with ISO 3166-1 alpha-2StringYesRU
regionRegion or provinceStringYesМосква
cityСityStringYesМосква
streetStreetStringYesНижняя Красносельская
houseHouseStringYes1a
blockBuildingStringNo1
officeOffice / ApartmentStringNo1
emailContact email addressStringNomail@gmail.com
addressStringAddress in a single lineStringYes105066, Москва, Нижняя Красносельская улица, 14А
latLatitudeNumberNo55.756499
lngLongitudeNumberNo37.621864
postIndexPostal codeStringNo100100
areaAreaStringNoКировский
cityGuidCity ID in the FIAS databaseStringNo0c5b2444-70a0-4932-980c-b4dc0d3f02b5
commentCommentStringNoПозвонить с проходной
recipient
phoneContact phone numberStringYes+7(925)111-11-11
companyNameCompany nameStringNoООО КНД
contactNameContact person’s full nameStringYesИванов Иван
countryCodeCountry code in accordance with ISO 3166-1 alpha-2StringYesRU
regionRegion or provinceStringYesМосква
cityСityStringYesМосква
streetStreetStringYesНижняя Красносельская
houseHouseStringYes1a
blockBuildingStringNo1
officeOffice / ApartmentStringNo1
emailContact email addressStringNomail@gmail.com
addressStringAddress in a single lineStringYes105066, Москва, Нижняя Красносельская улица, 14А
latLatitudeNumberNo55.756499
lngLongitudeNumberNo37.621864
postIndexPostal codeStringNo100100
areaAreaStringNoКировский
cityGuidCity ID in the FIAS databaseStringNo0c5b2444-70a0-4932-980c-b4dc0d3f02b5
commentCommentStringNoПозвонить с проходной
returnAddress
phoneContact phone numberStringYes+7(925)111-11-11
companyNameCompany nameStringNoООО КНД
contactNameContact person’s full nameStringYesИванов Иван
countryCodeCountry code in accordance with ISO 3166-1 alpha-2StringYesRU
regionRegion or provinceStringYesМосква
cityСityStringYesМосква
streetStreetStringYesНижняя Красносельская
houseHouseStringYes1a
blockBuildingStringNo1
officeOffice / ApartmentStringNo1
emailContact email addressStringNomail@gmail.com
addressStringAddress in a single lineStringYes105066, Москва, Нижняя Красносельская улица, 14А
latLatitudeNumberNo55.756499
lngLongitudeNumberNo37.621864
postIndexPostal codeStringNo100100
areaAreaStringNoКировский
cityGuidCity ID in the FIAS databaseStringNo0c5b2444-70a0-4932-980c-b4dc0d3f02b5
commentCommentStringNoПозвонить с проходной
place
placeNumberPlace number in the client’s information systemStringNo1
barcodePlace barcodeStringNo011-819
heightPlace height in centimetersNumberYes10
widthPlace width in centimetersNumberYes10
lengthPlace length in centimetersNumberYes10
weightPlace weight in gramsNumberYes100
itemsThe contents of the placeitemYes
item
descriptionName of productStringYesКирпич
quantityQuantity of productNumberYes2
articulArticul of productStringNo123-456
barcodeBarcode of productStringNo123456
assessedCostEstimated cost of a product unit in rublesNumberNo100,20
costCash on delivery of the product in rublesNumberNo100,20
costVatVAT rateNumberNo20
weightWeight of a product unit in gramsNumberYes100
heightHeight of the product unit in centimetersNumberNo10
lengthLength of the product unit in centimetersNumberNo10
widthWidth of the product unit in centimetersNumberNo10
markCodeMarking codeStringNo010468006347633
extraParamsNo
keyType of additional serviceStringYescdek.InspectionAttachments
valueValue of an additional serviceStringYes1

You must fill in the addressString field if other required address fields are not filled in (countryCode,city,region,street).

If the addressString is filled in, the address will be parsed into its components and the data obtained as a result of parsing the addressString string will be used.

Request example #

 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>

Succsess response parameters #

SectionParameterDescriptionTypeRequiredExample
orderIdOrder ID in ApiShipNumberYes4561111
createdOrder creation dateDate and TimeYes2018-01-01T10:00:00+03:00

Response example #

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>