Перейти к содержанию

Справочник "Наименования грузов"

Описание

Получение наименований грузов.

Структура URL

1
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
1
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/cargo?ids=7,10,18"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
[
    {
        "id": 7,
        "name": "абрикосы"
    },
    {
        "id": 10,
        "name": "абразивный порошок"
    },
    {
        "id": 18,
        "name": "автохимия"
    }
]

Использование параметра query

query

Запрос на англ. языке (no URL-encoding, query=aprico)

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

Запрос на укр. языке (URL-encoded, query=абрик)

1
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"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
[
    {
        "id": 12,
        "name": "абрикос в ящиках"
    },
    {
        "id": 6,
        "name": "абрикоси в ящиках"
    },
    {
        "id": 7,
        "name": "абрикоси"
    }
]

Запрос на укр. языке (URL-encoded, query=абр, limit=5)

1
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"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
[
    {
        "id": 11,
        "name": "абразив"
    },
    {
        "id": 5,
        "name": "абразиви"
    },
    {
        "id": 8,
        "name": "абразиви в біг-бегах"
    },
    {
        "id": 9,
        "name": "абразиви навалом"
    },
    {
        "id": 10,
        "name": "абразивний порошок"
    }
]