Перейти до змісту

Довідник "Найменування вантажів"

Опис

Отримання найменувань вантажів.

Структура URL

GET /v2/references/cargo

Список параметрів

Назва Опис Тип передачі параметра Обов'язковий(+)/За замовчуванням(значення)
language Мова локалізації. Опис використання. Query string parameter ru
ids Додаткові параметри фільтрації. Query string parameter
query Текст для пошуку. Query string parameter
limit Бажана кількість відповідей, максимум 100. Query string parameter 10

Особливості формування запиту

У запиті обов'язково повинен бути вказаний параметр ids (?ids=2,4,7) або параметр query (?query=test)

Результат

Масив структур "Базовий елемент довідника".

Зразки запитів і відповідей

Використання параметра ids

ids
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/cargo?ids=7,10,18"
[
    {
        "id": 7,
        "name": "абрикосы"
    },
    {
        "id": 10,
        "name": "абразивный порошок"
    },
    {
        "id": 18,
        "name": "автохимия"
    }
]

Використання параметра query

query

Запит англ. мовою (no URL-encoding, query=aprico)

curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/cargo?query=aprico&language=en"
[
    {
        "id": 12,
        "name": "apricot in boxes"
    },
    {
        "id": 6,
        "name": "apricots in boxes"
    },
    {
        "id": 7,
        "name": "apricots"
    }
]

Запит укр. мовою (URL-encoded, query=абрик)

curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/cargo?query=%D0%B0%D0%B1%D1%80%D0%B8%D0%BA&language=uk"
[
    {
        "id": 12,
        "name": "абрикос в ящиках"
    },
    {
        "id": 6,
        "name": "абрикоси в ящиках"
    },
    {
        "id": 7,
        "name": "абрикоси"
    }
]

Запит укр. мовою (URL-encoded, query=абр, limit=5)

curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/cargo?query=%D0%B0%D0%B1%D1%80&limit=5&language=uk"
[
    {
        "id": 11,
        "name": "абразив"
    },
    {
        "id": 5,
        "name": "абразиви"
    },
    {
        "id": 8,
        "name": "абразиви в біг-бегах"
    },
    {
        "id": 9,
        "name": "абразиви навалом"
    },
    {
        "id": 10,
        "name": "абразивний порошок"
    }
]