Post2Go для бизнеса

Подключите наше отслеживание посылок к своему сайту: увеличьте лояльность пользователей, уменьшите количество возвратов и улучшите информированность о прохождении посылок.

Подробнее Тарифы Оставить заявку

Добавление трекинг-номера

Метод addTracking

Добавляет один трекинг-номер и начинает его отслеживание.

Параметры

В теле запроса необходимо передать объект tracking содержащий поля:

  • tracking_number - трекинг-номер;
  • courier_slug - уникальный идентификатор службы доставки;
  • title - название посылки (необязательно).
  • order_code - Идентификатор заказа (необязательно).
  • order_url - Ссылка на заказ (необязательно).
  • customer_name - Имя клиента (необязательно).
  • emails - Массив email адресов для оповещения о новых статусах (необязательно).

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

{
    "jsonrpc": "2.0",
    "method": "addTracking",
    "params": {
        "tracking": {
            "tracking_number": "1234567890", 
            "courier_slug": "russian-post", 
            "title": "Посылочка",
            "order_code": "#qwsd12345",
            "order_url": "http://my-store.com",
            "customer_name": "Иван Иваныч",
            "emails": ["user1@my-store.com", "user2@my-store.com"]
        }
    },
    "id": 1
}

Формат ответа

Ответ содержит объект tracking со следующими полями:

  • tracking_number - добавленный трекинг-номер;
  • courier_slug - уникальный код службы доставки которая выдала трекинг-номер;

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

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "tracking": {
            "tracking_number": "1234567890",
            "courier_slug": "russian-post"
        }
    }
}

Ошибки

Объект tracking не передан или передан неправильно:

{
    "jsonrpc": "2.0",
    "error":{
        "code": -32602,
        "message": "Tracking must be an object type"
    },
    "id": null
}

tracking.tracking_number не передан или не является строкой:

{
    "jsonrpc": "2.0",
    "error":{
        "code": -32602,
        "message": "Tracking number is required and must be a string"
    },
    "id": null
}

tracking.courier_slug не передан или не является строкой:

{
    "jsonrpc": "2.0",
    "error":{
        "code": -32602,
        "message": "Courier slug is required and must be a string"
    },
    "id": null
}

Указанный курьер не найден:

{
    "jsonrpc": "2.0",
    "error":{
        "code": 404,
        "message": "Courier not found"
    },
    "id": null
}

Трекинг-номер не относится к указанному курьеру:

{
    "jsonrpc": "2.0",
    "error":{
        "code": -32604,
        "message": "Invalid tracking number for courier"
    },
    "id": null
}