Разработчикам


Создание и обновление заявки

Метод:

https://api.ship2go.ru/order?{параметры}
Параметры запроса:

Параметр Описание
shop_id ID вашего магазина
sign Подпись запроса, подробнее можно прочитать здесь и попробовать здесь.
order_id Если нужно обновить данные какой-либо заявки, то необходимо указать ID заявки, которую вы собираетесь обновлять. Внимание: можно обновлять только те заявки, которые имеют статус "Создана".
data_type Формат, в котором будут приниматься данные заявки.
Принимаемые значения: json, xml (по умолчанию json)
result_type Формат, в котором будет отправлен езультат запроса.
Принимаемые значения: json, xml (по умолчанию json)

Все данные в запросе передаются через загружаемые на сервер файлы. Все данные заявки должны быть загружены в текстовом файле в кодировке UTF-8 под названием "data" (<input type="file" name="data">). Формат файла определяется параметром data_type.

Также можно загружать второстепенные файлы. К примеру, накладные, счета и т.п. Они могут быть загружены как файлы с произвольными именами.

Примеры содержания файлов с данными заявки в форматах XML и JSON:

{
    "invoice": "123124",
    "description": "Test description",
    "transporting": {
        "postindexto": "660111",
        "warehouse": 1,
        "company": {
            "id": 2,
            "service": "Автоперевозка"
        },
        "address": "Адрес доставки",
        "pickup": true,
        "delivery": true
    },
    "receiver": {
        "name": "ООО Деревянные изделия",
        "inn": "7816536889",
        "contact": {
            "person": "Елена",
            "phone": "89180001199",
            "email": "elena@example.com"
        }
    },
    "payment": {
        "pickup": true,
        "transfer": true,
        "delivery": false
    },
    "boxes": [
        {
            "weight": 12,
            "width": 1,
            "height": 1,
            "length": 1
        }
    ]
}
                



    123124
    Test description
    
        660111
        1
        
            2
            Автоперевозка
        
        
Адрес доставки
true true
ООО Деревянные изделия 7816536889 Елена 89180001199 elena@example.com true true true 12 1 1 1

  • invoice * (строка) - Номер заявки в системе интернет магазина
  • description * (строка) - Описание заявки
  • transporting
    • postindexto * (6ти значное число, почтовый индекс) - почтовый индекс города назначения.
    • warehouse * (число) - id склада отправления.
    • company
      • id * (число) - id транспортной компании.
      • service (строка) - сервис доставки транспортной компании, возможные сервисы можно посмотреть в настройках магазина или с помощью метода config. Если сервис не указан, то будет выбрал самый дешевый сервис данной транспортной компании.
    • address (строка, улица, дом, строение и т.п.) - адрес доставки; если доставка производится в адрес, то указывать не обязательно.
    • pickup * (true\false) - требуется ли забор груза в городе отправлении, true\false
    • delivery * (true\false) - требуется ли доставка груза в городе назначения, true\false
  • receiver
    • name * (строка) - наименование получателя, если получатель физ. лицо, то ФИО, если юр. лицо то название организации вместе с абривеатурв формы юр. лица
    • inn (10 или 12значное число) - ИНН организации, если получатель физ. лицо - не требуется
    • contact
      • person * (строка, ФИО) - контактное лицо
      • phone * (строка) - контактный телефон.
      • email * (строка) - email для оповещения.
  • payment
    • pickup (true\false) - true, если забор груза оплачивает интернет магазин, false - если получатель; если забор груза не планируется, то можно не указывать параметр
    • transfer * (true\false) - true, если трансфер между городами оплачивает интернет магазин, false - если получатель
    • delivery (true\false) - true, если доставку по городу оплачивает интернет магазин, false - если получатель; если доставка по городу не планируется, то можно не указывать параметр
  • boxes * в случае с json форматом, содержимое boxes представляет из себя список коробок; если коробки еще не известны, то оставляем поле пустым (json - пустой список, xml - пустой тег).
    • box
      • weight * (вещественное число, кг) - вес коробки
      • width * (вещественное число, метры) - ширина коробки
      • height * (вещественное число, метры) - высота коробки
      • length * (вещественное число, метры) - длина коробки
* - обязательные поля.

Ответ:

Url для запроса
https://api.ship2go.ru/order?shop_id=1&sign=********d22d8b4e8774f5b3f1fdc2d7
                {
                    "status": {
                        "message": "OK",
                        "code": 200
                    },
                    "result": {
                        "boxes": [
                            {
                                "width": 1.0,
                                "length": 1.0,
                                "id": 45,
                                "weight": 12.0,
                                "height": 1.0
                            }
                        ],
                        "ship2go_code": "SHIP2GO-32",
                        "id": 32
                    }
                }
            
Url для запроса
https://api.ship2go.ru/order?shop_id=1&result_type=xml&data_type=xml&sign=********d22d8b4e8774f5b3f1fdc2d7
                
                
                    
                        
                            
                                1.0
                                1.0
                                42
                                12.0
                                1.0
                            
                        
                        SHIP2GO-29
                        29
                    
                    
                        OK
                        200
                    
                
            
  • result
    • id - идентификатор заявки в системе ship2go
    • ship2go_code - номер под которым заявка зарегистрированна у транспортных компаний.
    • boxes
      • box
        • id - идентификатор коробки
        • weight (кг) - вес
        • width (метры) - ширина
        • height (метры) - высота
        • length (метры) - длина
  • status
    • message - текстовое описание результата запроса
    • code - код результата запроса, возможные коды можно посмотреть здесь

Отправка заявки в транспортную компанию

Метод:

https://api.ship2go.ru/order_send?{параметры}
Параметры запроса:

Параметр Описание
shop_id ID магазина
sign Подпись запроса, подробнее можно прочитать здесь и попробовать здесь.
order_id ID ранее созданной заявки

В случае успеха результат будет содержать статус заявки "Отправляется" (3).

После этого необходимо периодически запрашивать новый статус заявки с помощью запроса order_state.

Трекинг заявки

Метод:

https://api.ship2go.ru/order_state?{параметры}
Параметры запроса:

Параметр Описание
shop_id ID магазина
sign Подпись запроса, подробнее можно прочитать здесь и попробовать здесь.
order_id ID заявки

Ответ содержит поле state со статусом заявки.

Если системой был получен трекинг-номер, то он будет передан в поле tracking_number.

Если при отправке заявки в транспортную компанию возникли ошибки, они будут переданы в поле errors.