Asynchronous creation of shipment #

URL #

POST /orders

Query parameters #

Section	Parameter	Description	Type	Required	Example
order
	clientNumber	Order number in the client’s system. It can be reused if you cancel or delete an order.	String	Yes	123-456
	providerNumber	Order number in the delivery service system. If the logistics company issues a range of order numbers.	String	No	123-456
	description	Comments on the order	String	No	Important order
	barcode	Barcode of the order. If an order is passed with an indication of places (Place), then barcode must be specified in the place parameter.barcode	String	No	123456
	weight	Total order weight in grams	Number	Yes	100
	height	Order height in centimeters	Number	No	10
	length	Order length in centimeters	Number	No	10
	width	Order width in centimeters	Number	No	10
	providerKey	Code of the logistics company	String	Yes	cdek
	providerConnectId	ID of the connection to the logistics company. Used when multiple contracts with the same logistics company are connected to the same ApiShip account.	Number	No	12
	pickupType	Type of cargo pickup 1 - from the customer’s door 2 - the customer brings the order to the warehouse of the logistics company.	Number	Yes	1
	deliveryType	Delivery type 1 - to the door 2 - to the pick-up point	Number	Yes	1
	tariffId	The logistics company’s tariff that is used for delivery	Number	Yes	1
	pointInId	ID of the order acceptance point from the /lists/points method. Required if the shipment is to the warehouse of the logistics company.	Number	No	32
	pointOutId	ID of the order pickup point from the /lists/points method. Required if the delivery is to the pick-up point	Number	No	21
	pickupDate	Planned date of transfer of the order to the logistics company (courier call)	Date	No	2020-01-31
	pickupTimeStart	The initial time when the order was sent to the logistics company (when the courier was called)	Time	No	10:00
	pickupTimeEnd	The final time when the order is sent to the logistics company (when the courier is called)	Time	No	18:00
	deliveryDate	Desired delivery date	Date	No	2020-01-31
	deliveryTimeStart	Initial delivery time	Time	No	10:00
	deliveryTimeEnd	The final delivery time	Time	No	18:00
cost
	assessedCost	Estimated cost / amount of insurance (in rubles)	Number	Yes	100,12
	codCost	Cash on delivery amount including VAT (in rubles)	Number	Yes	98,21
	deliveryCost	Cost of delivery from the recipient. codCost must contain this amount.	Number	No	50,12
	deliveryCostVat	VAT rate	Number	No	20
	isDeliveryPayedByRecipient	Flag for specifying the party that pays for delivery services (0 - sender, 1 - recipient)	Number	No	1
sender
	phone	Contact phone number	String	Yes	+7(925)111-11-11
	companyName	Company name	String	No	ООО КНД
	contactName	Contact person’s full name	String	Yes	Иванов Иван
	countryCode	Country code in accordance with ISO 3166-1 alpha-2	String	Yes	RU
	region	Region or province	String	Yes	Москва
	city	Сity	String	Yes	Москва
	street	Street	String	Yes	Нижняя Красносельская
	house	House	String	Yes	1a
	block	Building	String	No	1
	office	Office / Apartment	String	No	1
	email	Contact email address	String	No	mail@gmail.com
	addressString	Address in a single line	String	Yes	105066, Москва, Нижняя Красносельская улица, 14А
	lat	Latitude	Number	No	55.756499
	lng	Longitude	Number	No	37.621864
	postIndex	Postal code	String	No	100100
	area	Area	String	No	Кировский
	cityGuid	City ID in the FIAS database	String	No	0c5b2444-70a0-4932-980c-b4dc0d3f02b5
	comment	Comment	String	No	Позвонить с проходной
recipient
	phone	Contact phone number	String	Yes	+7(925)111-11-11
	companyName	Company name	String	No	ООО КНД
	contactName	Contact person’s full name	String	Yes	Иванов Иван
	countryCode	Country code in accordance with ISO 3166-1 alpha-2	String	Yes	RU
	region	Region or province	String	Yes	Москва
	city	Сity	String	Yes	Москва
	street	Street	String	Yes	Нижняя Красносельская
	house	House	String	Yes	1a
	block	Building	String	No	1
	office	Office / Apartment	String	No	1
	email	Contact email address	String	No	mail@gmail.com
	addressString	Address in a single line	String	Yes	105066, Москва, Нижняя Красносельская улица, 14А
	lat	Latitude	Number	No	55.756499
	lng	Longitude	Number	No	37.621864
	postIndex	Postal code	String	No	100100
	area	Area	String	No	Кировский
	cityGuid	City ID in the FIAS database	String	No	0c5b2444-70a0-4932-980c-b4dc0d3f02b5
	comment	Comment	String	No	Позвонить с проходной
returnAddress
	phone	Contact phone number	String	Yes	+7(925)111-11-11
	companyName	Company name	String	No	ООО КНД
	contactName	Contact person’s full name	String	Yes	Иванов Иван
	countryCode	Country code in accordance with ISO 3166-1 alpha-2	String	Yes	RU
	region	Region or province	String	Yes	Москва
	city	Сity	String	Yes	Москва
	street	Street	String	Yes	Нижняя Красносельская
	house	House	String	Yes	1a
	block	Building	String	No	1
	office	Office / Apartment	String	No	1
	email	Contact email address	String	No	mail@gmail.com
	addressString	Address in a single line	String	Yes	105066, Москва, Нижняя Красносельская улица, 14А
	lat	Latitude	Number	No	55.756499
	lng	Longitude	Number	No	37.621864
	postIndex	Postal code	String	No	100100
	area	Area	String	No	Кировский
	cityGuid	City ID in the FIAS database	String	No	0c5b2444-70a0-4932-980c-b4dc0d3f02b5
	comment	Comment	String	No	Позвонить с проходной
place
	placeNumber	Place number in the client’s information system	String	No	1
	barcode	Place barcode	String	No	011-819
	height	Place height in centimeters	Number	Yes	10
	width	Place width in centimeters	Number	Yes	10
	length	Place length in centimeters	Number	Yes	10
	weight	Place weight in grams	Number	Yes	100
	items	The contents of the place	item	Yes
item
	description	Name of product	String	Yes	Кирпич
	quantity	Quantity of product	Number	Yes	2
	articul	Articul of product	String	No	123-456
	barcode	Barcode of product	String	No	123456
	assessedCost	Estimated cost of a product unit in rubles	Number	No	100,20
	cost	Cash on delivery of the product in rubles	Number	No	100,20
	costVat	VAT rate	Number	No	20
	weight	Weight of a product unit in grams	Number	Yes	100
	height	Height of the product unit in centimeters	Number	No	10
	length	Length of the product unit in centimeters	Number	No	10
	width	Width of the product unit in centimeters	Number	No	10
	markCode	Marking code	String	No	010468006347633
extraParams				No
	key	Type of additional service	String	Yes	cdek.InspectionAttachments
	value	Value of an additional service	String	Yes	1

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 #

json

 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": "test_1",
    "height": 45,
    "length": 30,
    "width": 20,
    "weight": 20,
    "providerKey": "cdek",
    "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"
    }
  ]
}

xml

  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>test_1</clientNumber>
        <weight>2</weight>
        <height>20</height>
        <length>20</length>
        <width>20</width>
        <providerKey>cdek</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>1а</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 #

Section	Parameter	Description	Type	Required	Example
	orderId	Order ID in ApiShip	Number	Yes	4561111
	created	Order creation date	Date and Time	Yes	2018-01-01T10:00:00+03:00

Response example #

json

1
2
3
4
{
    "orderId": "4561111",
    "created": "2018-01-01T10:00:00+03:00"
}

xml

1
2
3
4
<response>
    <orderId>4560036</orderId>
    <created>2018-06-19T09:43:09+03:00</created>
</response>