Page tree

Адрес метода

POST /orders

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

Раздел

Параметр

Описание

Тип

Обязательный

Пример

order







clientNumber

Номер заказа в системе клиента 

Строка

Да

123-456


weight

Вес всего заказа в граммах

Число

Да

100


height

Высота заказа в сантиметрах

Число

Нет

10


length

Длина заказа в сантиметрах

Число

Нет

10


width

Ширина заказа в сантиметрах

Число

Нет

10


providerKey

Код службы доставки

Строка

Да

knd


providerConnectId

ID подключения к СД

Число

Нет

12


pickupType

Тип забора груза
1 - от двери клиента
2 – клиент привозит заказ на склад СД

Число

Да

1


deliveryType

Тип доставки
1 - до двери
2 – до ПВЗ

Число

Да

1


tariffId

Тариф службы доставки по которому осуществляется доставка

Число

Да

1


deliveryTimeStart

Начальное время доставки

Время

Нет

10:00


deliveryTimeEnd

Конечное время доставки

Время

Нет

18:00

cost







assessedCost

Оценочная стоимость / сумма страховки (в рублях) 

Число

Да

100,12


codCost

Сумма наложенного платежа с учетом НДС (в рублях)

Число

Да

98,21


deliveryCostСтоимость доставки с получателя. codCost должен содержать в себе эту сумму.ЧислоНет50,12

sender







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Адрес одной строкойСтрокаДа[1]105066, Москва, Нижняя Красносельская улица, 14А

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Адрес одной строкойСтрокаДа[1]105066, Москва, Нижняя Красносельская улица, 14А
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


weight

Вес единицы товара в граммах 

Число

Да

100


height

Высота единицы товара в сантиметрах

Число

Нет

10


length

Длина единицы товара в сантиметрах

Число

Нет

10


width

Ширина единицы товара в сантиметрах

Число

Нет

10

extraParams


Нет

keyТип дополнительной услугиСтрокаДаcdek.InspectionAttachments

valueЗначение дополнительной услугиСтрокаДа1

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

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

## json формат
curl -X "POST" "https://api.apiship.ru/v1/orders" \
     -H 'Accept: application/json' \
     -H 'Authorization: 57fa8b7cb32530a0405bed4fbc8cb983' \
     -H 'Content-Type: application/json' \
     -d @request.json


## xml формат
curl -X "POST" "https://api.apiship.ru/v1/orders" \
     -H 'Accept: application/xml' \
     -H 'Authorization: 57fa8b7cb32530a0405bed4fbc8cb983' \
     -H 'Content-Type: application/xml' \
     -d @request.xml

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

{
  "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"
    }
  ]
}

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

<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>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>

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

Раздел

Параметр

Описание

Тип

Обязательный

Пример


orderId

Номер заказа в ApiShip

Число

Да

4561111


created

Дата создания заказа

Дата и время

Да

2018-01-01T10:00:00+03:00

Пример ответа в json формате

{
    "orderId": "4561111",
    "created": "2018-01-01T10:00:00+03:00"
}

Пример ответа в xml формате

<response>
    <orderId>4560036</orderId>
    <created>2018-06-19T09:43:09+03:00</created>
</response>
  • No labels