Перейти к основному контенту

/api/lite/purchase_orders

Запрос списка заказов поставщиков

/api/lite/purchase_orders

Метод возвращает список заказов с заданной фильтрацией.

Можно использовать как для получения списка, так и единичного заказа.

 

Фильтрация

Для фильтрации есть следующие возможности:

  • id - по номеру заказа
  • filter_tags - по меткам заказов (можно указывать несколько через зяпятую)
  • filter_states - по статусам заказов (можно указывать несколько через зяпятую)  
  • date_from - по дате заказа, от.    формат: 2020-02-19T12:35:31
  • date_to - по дате заказа, до
  • updated_from - по дате/времени изменения. формат: 2020-02-19T12:35:31. Не суммируется с другими параметрами фильтрации
  • product_id - по коду продукта в заказе.
  • problemOrders - true - для вывода заказов с ошибками (согласовано с количеством в поле problemOrders в методе /api/lite/orders/statuses)

 

Пейджинация

Для пейджинации используются параметры page и size: size - записей на странице, page - номер страницы.

Пример: /api/lite/orders?page=0&size=200

Если параметры не переданы, то дефолтные значения page=0&size=100

Также для отображение пейджинации следует анализировать параметр recordsTotal, возвращающий общее количество записей (с учетом примененной фильтрации, если она есть).

 

Сортировка

Для сортировки задается параметр order, принимающий код поля для сортировки и направление сортировки (asc, desc), отделенное символом плюса.

Пример сортировки по дате (возрастание): /api/lite/orders?order=date+asc

Пример сортировки по дате (убывание): /api/lite/orders?order=date+desc

Доступные коды сортировки:

  • date (дата заказа)
  • id (номер заказа)

По умолчанию используется сортировка по дате заказа по убыванию.

Полный комплект данных по заказам будет передан только если в запросе будет параметр full_info=true

 

Описание результата запроса

Пример запроса по одному заказу и полными данными:

api/lite/purchase_orders?id=1004&full_info=true

 

Пример результата запроса

{      
    "success": true,
    "recordsTotal": 1,
    "purchaseOrders": [
        {
            "id": "1012",
            "date": "2020-02-17 12:48:23",
            "updateTs": "2020-02-17 12:48:52.322",
            "totalOrderSum": 7900,
            "paymentStatus": "PAID",
            "totalQuantity": 15,
            "supplier": {
                "id": "c82e2616-91e7-702e-d666-320534119a13",
                "type": "COMPANY",
                "name": " ИП Макоева Е.В.",
                "organization": {
                    "id": "f23b14bf-1151-dcb5-1b25-57a2b931e3ac",
                    "name": " ИП Макоева Е.В.",
                    "fullName": " ИП Макоева Е.В.",
                    "phones": null,
                    "inn": "501808148652 ",
                    "kpp": null,
                    "ogrn": null,
                    "okpo": null,
                    "persons": null,
                    "orgLegalType": "SELF_EMPLOYED",
                    "address": {
                        "country": "Россия",
                        "countryCode": "RU",
                        "region": "Москва",
                        "area": null,
                        "city": "Москва",
                        "settlement": null,
                        "street": "Новоалексеевская",
                        "house": "18",
                        "block": "3",
                        "building": "",
                        "flat": null,
                        "fullAddress": "г Москва, Алексеевский р-н, ул Новоалексеевская, д 18 к 3",
                        "fullCity": null,
                        "rawData": null,
                        "zip": "129626",
                        "regionFias": null,
                        "areaFias": null,
                        "cityFias": null,
                        "settlementFias": null
                    },
                    "email": null
                },
                "person": null
            },
            "warehouseName": "Tempoline",
            "warehouseCode": "6805bc64-270f-ae7d-1231-773ff181e446",
          	"warehouseFFExported":true,
          	"warehouseFFSync":true,
          	"warehouseFFSyncDate":"2020-08-11 16:09:13",
            "dateOfDeliveryPlan": "2020-02-18 00:00:00",
          	"files": [
                {
                    "id": "43f79bac-0d82-2d82-f11d-abd1a53b26a0",
                    "fileType": "PDF",
                  	"fileSource": "FULFILLMENT", //ESHOP | USER
                    "fileName": "МХ1",
                    "fileExt": "pdf",
                    "url": "https://storage.yandexcloud.net/order-files-kak2c/e7cf604e-7092-4243-97ba-13b3f7bb4b68.doc"yadi.sk/d/BzKXkRigQZtVnB",
                    "printWhenPacking": true,
                    "copiesQty": 1
                }
           	 ],
        }
    ]
}

 

Пример запроса по списку заказов:

/api/lite/purchase_orders

 

Пример результата запроса:

{
     
    "success": true,
    "recordsTotal": 2,
    "purchaseOrders": [
        {
            "id": "1004",
            "date": "2019-08-21 16:00:44",
            "updateTs": "2019-08-21 16:02:36.546",
            "status": "NEW",
            "totalOrderSum": 251210,
            "totalQuantity": 15,
            "comment": "комментарий складу",
             "supplier": {
                "id": "c82e2616-91e7-702e-d666-320534119a13",
                "type": "COMPANY",
                "name": " ИП Макоева Е.В.",
                "organization": {
                    "id": "f23b14bf-1151-dcb5-1b25-57a2b931e3ac",
                    "name": " ИП Макоева Е.В.",
                    "fullName": " ИП Макоева Е.В.",
                    "phones": null,
                    "inn": "501808148652 ",
                    "kpp": null,
                    "ogrn": null,
                    "okpo": null,
                    "persons": null,
                    "orgLegalType": "SELF_EMPLOYED",
                    "address": {
                        "country": "Россия",
                        "countryCode": "RU",
                        "region": "Москва",
                        "area": null,
                        "city": "Москва",
                        "settlement": null,
                        "street": "Новоалексеевская",
                        "house": "18",
                        "block": "3",
                        "building": "",
                        "flat": null,
                        "fullAddress": "г Москва, Алексеевский р-н, ул Новоалексеевская, д 18 к 3",
                        "fullCity": null,
                        "rawData": null,
                        "zip": "129626",
                        "regionFias": null,
                        "areaFias": null,
                        "cityFias": null,
                        "settlementFias": null
                    },
                    "email": null
                },
                "person": null
            },
            "warehouseName": "Tempoline",
            "warehouseCode": "269e05b9-9f01-98ac-5d83-2521d2ece971",
            "dateOfDeliveryPlan": "2019-08-21 00:00:00"
        },
        {
            "id": "1002",
            "date": "2019-08-21 15:01:26",
            "updateTs": "2019-08-21 16:00:27.991",
            "status": "NEW",
            "totalOrderSum": 251210,
            "totalQuantity": 15,
            "comment": "комментарий складу",
             "supplier": {
                "id": "c82e2616-91e7-702e-d666-320534119a13",
                "type": "COMPANY",
                "name": " ИП Макоева Е.В.",
                "organization": {
                    "id": "f23b14bf-1151-dcb5-1b25-57a2b931e3ac",
                    "name": " ИП Макоева Е.В.",
                    "fullName": " ИП Макоева Е.В.",
                    "phones": null,
                    "inn": "501808148652 ",
                    "kpp": null,
                    "ogrn": null,
                    "okpo": null,
                    "persons": null,
                    "orgLegalType": "SELF_EMPLOYED",
                    "address": {
                        "country": "Россия",
                        "countryCode": "RU",
                        "region": "Москва",
                        "area": null,
                        "city": "Москва",
                        "settlement": null,
                        "street": "Новоалексеевская",
                        "house": "18",
                        "block": "3",
                        "building": "",
                        "flat": null,
                        "fullAddress": "г Москва, Алексеевский р-н, ул Новоалексеевская, д 18 к 3",
                        "fullCity": null,
                        "rawData": null,
                        "zip": "129626",
                        "regionFias": null,
                        "areaFias": null,
                        "cityFias": null,
                        "settlementFias": null
                    },
                    "email": null
                },
                "person": null
            },
            "warehouseName": "Tempoline",
            "warehouseCode": "269e05b9-9f01-98ac-5d83-2521d2ece971",
            "dateOfDeliveryPlan": "2019-08-21 00:00:00"
        }      
    ]
}

 

Создание/редактирование заказа

/api/lite/purchase_orders

Создание/редактирование заказа для кабинета.

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

Если параметр id не указан - система создаст новый заказ и присвоит внутренний номер.

 

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

{ 
               
            "date": "2019-12-13 12:09:18",
            "supplier": {
                "id": "6f93a982-aea5-2a48-63e8-88082b056009",
                "type": "COMPANY",
                "name": "ООО \"УМБО\""
            },
            "items": [
                {
                    "num": 1,
                    "variantId": "1053",
                    "productId": "1024",
                  	"variantExtId": "EXT1053",
                    "name": "",
                    "article": "",
                  	"barcode": "6000000123",
                    "quantity": 3,
                    "quantityFact": 10,
                    "vatRate": "NO_VAT",
                    "price": 2800,
                    "img": "https://img.kak2c.ru/i/8/l/L0RSHj34_c.jpg",
                    "skuType": "SKU"
                },
                  {
                    "num": 2,
                    "variantId": "1030",
                    "productId": "1015",
                    "name": "",
                    "article": "",
                    "quantity": 30,
                    "quantityFact": 10,
                    "vatRate": "NO_VAT",
                    "price": 26589,
                    "img": "https://img.kak2c.ru/i/8/l/L0RSHj34_c.jpg",
                    "skuType": "SKU"
                }
            ],
            "warehouseName": "Склад UMBO",
            "warehouseCode": "bb06756d-98c3-f0ab-afde-bd9d0587a12b",
            "dateOfDeliveryPlan": "2019-12-13 00:00:00",
            "comment": "комментарий складу",
  			"searchColumnType": "HUMANID" //"EXTID"|"ARTICLE"|"BARCODE" Поле для поиска номенклатуры. Если не задано, то поиск идёт по HUMANID
  }

 

В ответ возвращается:

{
    "success": true,
    "orderId": "111",
    "c": "2b92b631-7f1b-c52a-897e-30bc628f87e5"
}

 

Ошибка: 

{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}