getProductsList
Metoda umożliwia pobranie dokładnych danych wybranych produktów z magazynu BaseLinkera lub magazynu sklepu/hurtowni podłączonych do BaseLinkera.
Parametry wejściowe
Dane wyjściowe:
Przykładowe wywołanie w php:
| storage_id | varchar(30) | Identyfikator magazynu w formacie "[typ:bl|shop|warehouse]_[id:int]" (np. "shop_2445"). |
| filter_category_id | varchar(30) | (nieobowiązkowe) Pobranie produktów z konkretnej kategorii (nieobowiązkowe) |
| filter_limit | varchar(30) | (PRZESTARZAŁY) (nieobowiązkowe) limit zwróconych kategorii w formacie SQLowym ("ilość pomijanych, ilość pobieranych") |
| filter_sort | varchar(30) | (nieobowiązkowe) wartość po której ma być sortowana lista produktów. Możliwe wartości: "id [ASC|DESC]", "name [ASC|DESC]", "quantity [ASC|DESC]", "price [ASC|DESC]" |
| filter_id | varchar(30) | (nieobowiązkowe) ograniczenie wyników do konkretnego id produktu |
| filter_ean | varchar(320) | (nieobowiązkowe) ograniczenie wyników do konkretnego ean |
| filter_sku | varchar(32) | (nieobowiązkowe) ograniczenie wyników do konkretnego sku (numeru magazynowego) |
| filter_name | varchar(100) | (nieobowiązkowe) filtr nazw przedmiotów (fragment szukanej nazwy lub puste pole) |
| filter_price_from | float | (nieobowiązkowe) dolne ograniczenie ceny (nie wyświetlane produkty z niższą ceną) |
| filter_price_to | float | (nieobowiązkowe) górne ograniczenie ceny |
| filter_quantity_from | int | (nieobowiązkowe) dolne ograniczenie ilości produktów |
| filter_quantity_to | int | (nieobowiązkowe) górne ograniczenie ilości produktów |
| filter_available | int | (nieobowiązkowe) wyświetlanie tylko produktów oznaczonych jako dostępne (wartość 1) lub niedostępne (0) lub wszystkich (pusta wartość) |
| page | int | (NOWY) (nieobowiązkowe) Stronicowanie wyników (w przypadku magazynu BaseLinkera po 1000 produktów na stronę) |
Dane wyjściowe
Metoda zwraca dane w formacie JSON.
| status | varchar(30) | SUCCESS - poprawnie wykonano zapytanie ERROR - wystąpił bład podczas zapytania API. Szczegóły błedu opisane będą w 2 dodatkowych zwracanych polach: error_message i error_code |
| storage_id | varchar(30) | Identyfikator magazynu w formacie "[typ:bl|shop|warehouse]_[id:int]" (np. "shop_2445"). |
| products | array | Tablica z produktami zawierająca pola wymienione poniżej |
| | - product_id | varchar(30) | Główny identyfikator produktu. |
| | - ean | varchar(32) | Numer EAN produktu. |
| | - sku | varchar(32) | Numer SKU produktu. |
| | - name | varchar(200) | Nazwa produktu |
| | - quantity | int | Stan magazynowy |
| | - price_brutto | float | Cena brutto produktu (z poziomu ten funkcji nie ma dostępu do ceny netto). |
Przykład
Dane wejściowe:Dane wyjściowe:
Przykładowe wywołanie w php:
Dokumentacja API