метод REST scope: sale

sale.shipmentitem.list

Получить список элементов табличной части отгрузки

Кто может выполнять: администратор

Описание

Метод sale.shipmentitem.list позволяет получить список элементов табличной части отгрузки.

Параметры

select array необязательный

Массив содержит список полей, которые необходимо выбрать (смотрите поля объекта sale_order_shipment_item).

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

filter object необязательный

Объект для фильтрации выбранных элементов табличной части отгрузки в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта sale_order_shipment_item.

Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN (в качестве значения передается массив)
- !@ — NOT IN (в качестве значения передается массив)
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищем значения, начинающиеся с «мол»
- "%мол" — ищем значения, заканчивающиеся на «мол»
- "%мол%" — ищем значения, где «мол» может быть в любой позиции

  • %= — LIKE (см. описание выше)
  • !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.
  • !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    - "мол%" — ищем значения, не начинающиеся с «мол»
    - "%мол" — ищем значения, не заканчивающиеся на «мол»
    - "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции
  • !%= — NOT LIKE (см. описание выше)
  • = — равно, точное совпадение (используется по умолчанию)
  • != - не равно
  • ! — не равно
order object необязательный

Объект для сортировки выбранных элементов табличной части отгрузки в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям объекта sale_order_shipment_item.

Возможные значения для order:
- asc — в порядке возрастания
- desc — в порядке убывания

start integer необязательный

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный: 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

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

-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","orderDeliveryId","basketId","quantity","xmlId","dateInsert","reservedQuantity"],"filter":{"<id":10,"@orderDeliveryId":[2431,2430],"basketId":2716},"order":{"id":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentitem.list

Ответ

HTTP-статус: 200

{
    "result":{
        "shipmentItems":[
            {
                "basketId":2716,
                "dateInsert":"2024-04-11T09:10:34+03:00",
                "id":7,
                "orderDeliveryId":2431,
                "quantity":5,
                "reservedQuantity":0,
                "xmlId":"myNewXmlId"
            },
            {
                "basketId":2716,
                "dateInsert":"2024-04-08T10:36:24+03:00",
                "id":1,
                "orderDeliveryId":2430,
                "quantity":5,
                "reservedQuantity":0,
                "xmlId":"myXmlId2"
            }
        ]
    },
    "total":2,
    "time":{
        "start":1712819741.592596,
        "finish":1712819741.796288,
        "duration":0.20369195938110352,
        "processing":0.01679706573486328,
        "date_start":"2024-04-11T10:15:41+03:00",
        "date_finish":"2024-04-11T10:15:41+03:00"
    }
}

Возвращаемые данные

result object

Корневой элемент ответа

shipmentItems sale_order_shipment_item[]

Массив объектов с информацией о выбранных элементах табличной части отгрузки

total integer

Общее количество найденных записей

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error":0,
    "error_description":"error"
}
Код Описание Значение
200040300010 Недостаточно прав для чтения элемента табличной части отгрузки
0 Другие ошибки (например, фатальные ошибки)

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.