Примеры сообщения об ошибках от API

Скопировать ссылку на статью

Скопировано

При обращении к API могут допускаться ошибки, о чем система будет сообщать. Возможны следующие виды ошибок.

1) Не указан apiKey:

{ 
    "errorMsg": "\u0022apiKey\u0022 is missing.", 
    "success": false 
}

2) Неверный apiKey:

{ 
    "errorMsg": "Wrong \u0022apiKey\u0022 value.", 
    "success": false 
}

3) Доступ к API ограничен по IP.

{
    "success": false,
    "errorMsg": "Forbidden"
}

4) Аккаунт системы не найден

{
    "success": false,
    "errorMsg": "Account does not exist."
}

5) Ошибка на сервере

{
    "success": false,
    "errorMsg": "Service overloaded."
}

или

{
    "success": false,
    "errorMsg": "Application error"
}

6) Некорректные данные в параметрах запроса

{
    "success": false,
    "errorMsg": "Invalid request: Errors in the input parameters",
    "errors": {
        "children[deliveryType]": "This value is not valid."
    }
}

7) Некорректные данные в некоторых элементах входящего массива данных (например, массива заказов)

{
    "success": false,
    "uploadedOrders": [],
    "errorMsg": "Orders are loaded with errors",
    "errors": [
        "Order with externalId=4414145 already exists.",
        "OrderType with code 'some-code' not found. Order externalId=44141452"
    ]
}