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

Пример получения списка ПВЗ в москве

# GET параметры
# limit = 5
# offset = 0
# filter = providerKey=cdek;city=Москва

curl "https://api.apiship.ru/v1/lists/points?limit=5&offset=0&filter=providerKey%3Dcdek%3Bcity%3D%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0" \
     -H 'Accept: application/json' \
     -H 'Authorization: XXXXXXXX'

Ответ в файле points_response.json

Пример получения списка доступных тарифов

# GET параметры
# limit = 5000
# filter = providerKey=cdek

curl "https://api.apiship.ru/v1/lists/tariffs?limit=5000&filter=providerKey%3Dcdek" \
     -H 'Accept: application/json' \
     -H 'Authorization: XXXX'

Ответ в файле tariffs_response.json

Пример создания заказа до ПВЗ СДЕК

Создается заказ в СД СДЕК:

  • номер заказа в магазине 123_456
  • кол-во мест в заказе = 1
  • оценочная стоимость = 293 руб
  • наложенный платеж = 110 руб (100 руб - товар, 10 руб - доставка)
  • вес заказа = 230 грамм
  • тариф СДЕК (tariffId: 55) - Посылка дверь-склад
  • пвз СДЕК (pointOutId: 39718) - https://www.cdek.ru/ru/offices/view/msk165-na-zivopisnoj-ul-zivopisnaa-30k3
curl -X "POST" "https://api.apiship.ru/orders" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json' \
     -H 'Authorization: XXXXX' \
     -d $'{
  "recipient": {
    "countryCode": "RU",
    "contactName": "Иванов Иван Иванович",
    "phone": "+79528819479",
    "email": "enelsilencio91@gmail.com"
  },
  "order": {
    "length": 10,
    "height": 30,
    "weight": 230,
    "clientNumber": "123_456",
    "deliveryType": 2,
    "width": 20,
    "tariffId": 55,
    "pickupType": 1,
    "pointOutId": 39718,
    "providerKey": "cdek"
  },
  "sender": {
    "region": "Москва, г",
    "city": "Москва",
    "street": "Семеновская набережная",
    "block": "стр. 1",
    "house": "2/1",
    "office": "",
    "contactName": "ООО Отправитель",
    "countryCode": "RU",
    "phone": "+7800-111-11-11"
  },
  "cost": {
    "assessedCost": 293,
    "codCost": 110,
    "deliveryCost": 10
  },
  "places": [
    {
      "items": [
        {
          "quantity": 1,
          "articul": "К29788",
          "assessedCost": 293,
          "description": "Товар",
          "cost": 100
        }
      ],
      "weight": 230
    }
  ]
}'

Успешный ответ на создание заказа

{
  "orderId": "14069426",
  "created": "2020-11-13T09:39:05+03:00"
}

Пример отмены заказа

Отменяет заказ с orderId = 14069334 - номер заказа в ApiShip

curl "https://api.apiship.ru/orders/14069334/cancel" \
     -H 'Authorization: XXXXXXX' \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json'

Пример успешного ответа (HTTP/1.1 200 OK)

{
  "orderId": "14069334",
  "canceled": "2020-11-13T09:34:50+03:00"
}

Пример ответа c ошибкой (HTTP/1.1 400 Bad Request)

{
  "code": "040081",
  "message": "Указанный заказ уже отменен",
  "description": "Указанный заказ уже отменен",
  "moreInfo": "Вопросы пишите на адрес support@apiship.ru"
}

Пример ответа c ошибкой (HTTP/1.1 404 Not Found)

{
  "code": "040080",
  "message": "Указанного заказа не существует",
  "description": "Указанного заказа не существует",
  "moreInfo": "Вопросы пишите на адрес support@apiship.ru"
}