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

Получение информации по заказу #

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

GET /orders/{orderId}

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

ПараметрОписаниеТипОбязательныйПример
orderIdID заказа в системе ApiShip, по которому нужна информациячислообязательный11000010

Пример запроса #

# GET параметры
# orderID = 11000010 

curl -X GET --header 'Accept: application/json' 
    --header 'Authorization: XXXXXXXXXXXXXXXXXXXX' 
       'https://api.apiship.ru/v1/orders/11000010'

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

РазделПараметрОписаниеТипПример
order
orderIdID заказаЧисло11000010
providerNumberНомер заказа в системе службы доставки. Если СД выдает диапазон номеров заказаСтрока11e51r6
additionalProviderNumberДополнительный номер заказа в системе службы доставкиСтрока21309812039812
clientNumberНомер заказа в системе клиента. Может быть переиспользован, если отменить или удалить заказ.Строка123-456
descriptionКоментарий к заказуСтрокаВажный заказ
barcodeШтрих-код заказа. Если передается заказ с указанием мест (Place), то ШК надо указывать в параметре place.barcodeСтрока123456
weightВес всего заказа в граммахЧисло100
heightВысота заказа в сантиметрахЧисло10
lengthДлина заказа в сантиметрахЧисло10
widthШирина заказа в сантиметрахЧисло10
providerKeyКод службы доставкиСтрокаcdek
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Процентная ставка НДС (-1 - Без НДС, 0 - НДС 0%, 10 - НДС 10%, 20 - НДС 20%)Число20
isDeliveryPayedByRecipientФлаг для указания стороны, которая платит за услуги доставки (0-отправитель, 1-получатель)Число1
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Контактный 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Название компанииСтрокаООО КНД
companyInnИНН компанииСтрока1234567890
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Процентная ставка НДС (-1 - Без НДС, 0 - НДС 0%, 10 - НДС 10%, 20 - НДС 20%)Число20
weightВес единицы товара в граммахЧисло100
heightВысота единицы товара в сантиметрахЧисло10
lengthДлина единицы товара в сантиметрахЧисло10
widthШирина единицы товара в сантиметрахЧисло10
markCodeКод маркировкиСтрока010468006347633
companyNameНаименование компании поставщика / продавца товараСтрокаООО "Тест"
companyInnИНН поставщика / продавца товараСтрока1234567890
extraParams
keyТип дополнительной услугиСтрокаcdek.InspectionAttachments
valueЗначение дополнительной услугиСтрока1

Пример данных ответа #

  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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
{
  "order": {
    "orderId": 11000010,
    "providerNumber": "11e51r6",
    "additionalProviderNumber": "21309812039812",
    "clientNumber": "6532-TR-23",
    "barcode": "123456",
    "description": "Очень важный заказ",
    "providerKey": "cdek",
    "providerConnectId": "11102",
    "pickupType": 1,
    "deliveryType": 1,
    "tariffId": 16,
    "pointInId": 333,
    "pointOutId": 407,
    "pickupDate": "2022-07-29",
    "pickupTimeStart": "09:00",
    "pickupTimeEnd": "18:00",
    "deliveryDate": "2022-07-29",
    "deliveryTimeStart": "09:00",
    "deliveryTimeEnd": "18:00",
    "height": 45,
    "length": 30,
    "width": 20,
    "weight": 20
  },
  "cost": {
    "assessedCost": 50,
    "deliveryCost": 200,
    "deliveryCostVat": -1,
    "codCost": 230,
    "isDeliveryPayedByRecipient": false,
    "usedPaymentType": 2
  },
  "sender": {
    "countryCode": "RU",
    "postIndex": "105062",
    "region": "Москва",
    "area": "",
    "city": "Москва",
    "cityGuid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
    "street": "Машкова",
    "house": "21",
    "block": "",
    "office": "",
    "lat": 55.7647252,
    "lng": 37.6537218,
    "addressString": "г Москва, ул Машкова, д 21",
    "companyName": "ООО \"Тест\"",
    "companyInn": "1234567890",
    "contactName": "Иванов Иван Иванович",
    "phone": "79250001115",
    "email": "test@test.com",
    "comment": "",
    "brandName": "ApiShip"
  },
  "recipient": {
    "countryCode": "RU",
    "postIndex": "105062",
    "region": "Москва",
    "area": "",
    "city": "Москва",
    "cityGuid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
    "street": "Машкова",
    "house": "21",
    "block": "",
    "office": "",
    "lat": 55.7647252,
    "lng": 37.6537218,
    "addressString": "г Москва, ул Машкова, д 21",
    "companyName": "ООО \"Тест\"",
    "companyInn": "1234567890",
    "contactName": "Иванов Иван Иванович",
    "phone": "79250001115",
    "email": "test@test.com",
    "comment": ""
  },
  "returnAddress": {
    "countryCode": "RU",
    "postIndex": "105062",
    "region": "Москва",
    "area": "",
    "city": "Москва",
    "cityGuid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
    "street": "Машкова",
    "house": "21",
    "block": "",
    "office": "",
    "lat": 55.7647252,
    "lng": 37.6537218,
    "addressString": "г Москва, ул Машкова, д 21",
    "companyName": "ООО \"Тест\"",
    "companyInn": "1234567890",
    "contactName": "Иванов Иван Иванович",
    "phone": "79250001115",
    "email": "test@test.com",
    "comment": ""
  },
  "items": [
    {
      "height": 45,
      "length": 30,
      "width": 20,
      "weight": 20,
      "articul": "1189.0",
      "markCode": "010290000046994521AK-rO?H!hC2(M\\u001D91003A\\u001D92cYTu3sTj82KJR3+6hVtQyAfa5Zf6Q2alfJEnwe2RIv4GAWVy2GUptk7P1NYxRsIgsTJi+Wgg+K3dncPELDJ9Ag==",
      "description": "Товар 1",
      "quantity": 1,
      "quantityDelivered": 2,
      "assessedCost": 50,
      "cost": 30,
      "costVat": -1,
      "barcode": "1234567890123",
      "companyName": "ООО \"Тест\"",
      "companyInn": "1234567890"
    }
  ],
  "places": [
    {
      "height": 45,
      "length": 30,
      "width": 20,
      "weight": 20,
      "placeNumber": "123421931239",
      "barcode": "800028197737",
      "items": [
        {
          "height": 45,
          "length": 30,
          "width": 20,
          "weight": 20,
          "articul": "1189.0",
          "markCode": "010290000046994521AK-rO?H!hC2(M\\u001D91003A\\u001D92cYTu3sTj82KJR3+6hVtQyAfa5Zf6Q2alfJEnwe2RIv4GAWVy2GUptk7P1NYxRsIgsTJi+Wgg+K3dncPELDJ9Ag==",
          "description": "Товар 1",
          "quantity": 1,
          "quantityDelivered": 2,
          "assessedCost": 50,
          "cost": 30,
          "costVat": -1,
          "barcode": "1234567890123",
          "companyName": "ООО \"Тест\"",
          "companyInn": "1234567890"
        }
      ]
    }
  ],
  "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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<OrderInfoResponse>
	<order>
		<orderId>11000010</orderId>
		<providerNumber>11e51r6</providerNumber>
		<additionalProviderNumber>21309812039812</additionalProviderNumber>
		<clientNumber>6532-TR-23</clientNumber>
		<barcode>123456</barcode>
		<description>Очень важный заказ</description>
		<providerKey>cdek</providerKey>
		<providerConnectId>11102</providerConnectId>
		<pickupType>1</pickupType>
		<deliveryType>1</deliveryType>
		<tariffId>16</tariffId>
		<pointInId>333</pointInId>
		<pointOutId>407</pointOutId>
		<pickupDate>2022-07-29</pickupDate>
		<pickupTimeStart>09:00</pickupTimeStart>
		<pickupTimeEnd>18:00</pickupTimeEnd>
		<deliveryDate>2022-07-29</deliveryDate>
		<deliveryTimeStart>09:00</deliveryTimeStart>
		<deliveryTimeEnd>18:00</deliveryTimeEnd>
		<height>45</height>
		<length>30</length>
		<width>20</width>
		<weight>20</weight>
	</order>
	<cost>
		<assessedCost>50</assessedCost>
		<deliveryCost>200</deliveryCost>
		<deliveryCostVat>-1</deliveryCostVat>
		<codCost>230</codCost>
		<isDeliveryPayedByRecipient>false</isDeliveryPayedByRecipient>
		<usedPaymentType>2</usedPaymentType>
	</cost>
	<sender>
		<countryCode>RU</countryCode>
		<postIndex>105062</postIndex>
		<region>Москва</region>
		<area></area>
		<city>Москва</city>
		<cityGuid>0c5b2444-70a0-4932-980c-b4dc0d3f02b5</cityGuid>
		<street>Машкова</street>
		<house>21</house>
		<block></block>
		<office></office>
		<lat>55.7647252</lat>
		<lng>37.6537218</lng>
		<addressString>г Москва, ул Машкова, д 21</addressString>
		<companyName>ООО &quot;Тест&quot;</companyName>
		<companyInn>1234567890</companyInn>
		<contactName>Иванов Иван Иванович</contactName>
		<phone>79250001115</phone>
		<email>test@test.com</email>
		<comment></comment>
		<brandName>ApiShip</brandName>
	</sender>
	<recipient>
		<countryCode>RU</countryCode>
		<postIndex>105062</postIndex>
		<region>Москва</region>
		<area></area>
		<city>Москва</city>
		<cityGuid>0c5b2444-70a0-4932-980c-b4dc0d3f02b5</cityGuid>
		<street>Машкова</street>
		<house>21</house>
		<block></block>
		<office></office>
		<lat>55.7647252</lat>
		<lng>37.6537218</lng>
		<addressString>г Москва, ул Машкова, д 21</addressString>
		<companyName>ООО &quot;Тест&quot;</companyName>
		<companyInn>1234567890</companyInn>
		<contactName>Иванов Иван Иванович</contactName>
		<phone>79250001115</phone>
		<email>test@test.com</email>
		<comment></comment>
	</recipient>
	<returnAddress>
		<countryCode>RU</countryCode>
		<postIndex>105062</postIndex>
		<region>Москва</region>
		<area></area>
		<city>Москва</city>
		<cityGuid>0c5b2444-70a0-4932-980c-b4dc0d3f02b5</cityGuid>
		<street>Машкова</street>
		<house>21</house>
		<block></block>
		<office></office>
		<lat>55.7647252</lat>
		<lng>37.6537218</lng>
		<addressString>г Москва, ул Машкова, д 21</addressString>
		<companyName>ООО &quot;Тест&quot;</companyName>
		<companyInn>1234567890</companyInn>
		<contactName>Иванов Иван Иванович</contactName>
		<phone>79250001115</phone>
		<email>test@test.com</email>
		<comment></comment>
	</returnAddress>
	<items>
		<height>45</height>
		<length>30</length>
		<width>20</width>
		<weight>20</weight>
		<articul>1189.0</articul>
		<markCode>010290000046994521AK-rO?H!hC2(M\u001D91003A\u001D92cYTu3sTj82KJR3+6hVtQyAfa5Zf6Q2alfJEnwe2RIv4GAWVy2GUptk7P1NYxRsIgsTJi+Wgg+K3dncPELDJ9Ag==</markCode>
		<description>Товар 1</description>
		<quantity>1</quantity>
		<quantityDelivered>2</quantityDelivered>
		<assessedCost>50</assessedCost>
		<cost>30</cost>
		<costVat>-1</costVat>
		<barcode>1234567890123</barcode>
		<companyName>ООО &quot;Тест&quot;</companyName>
		<companyInn>1234567890</companyInn>
	</items>
	<places>
		<height>45</height>
		<length>30</length>
		<width>20</width>
		<weight>20</weight>
		<placeNumber>123421931239</placeNumber>
		<barcode>800028197737</barcode>
		<items>
			<height>45</height>
			<length>30</length>
			<width>20</width>
			<weight>20</weight>
			<articul>1189.0</articul>
			<markCode>010290000046994521AK-rO?H!hC2(M\u001D91003A\u001D92cYTu3sTj82KJR3+6hVtQyAfa5Zf6Q2alfJEnwe2RIv4GAWVy2GUptk7P1NYxRsIgsTJi+Wgg+K3dncPELDJ9Ag==</markCode>
			<description>Товар 1</description>
			<quantity>1</quantity>
			<quantityDelivered>2</quantityDelivered>
			<assessedCost>50</assessedCost>
			<cost>30</cost>
			<costVat>-1</costVat>
			<barcode>1234567890123</barcode>
			<companyName>ООО &quot;Тест&quot;</companyName>
			<companyInn>1234567890</companyInn>
		</items>
	</places>
	<extraParams>
		<key>testParam</key>
		<value>testValue</value>
	</extraParams>
</OrderInfoResponse>