Argip api

Dokumentacja API

Jak zacząć

Adres bazowy

Adres bazowy naszego serwisu to: https://api.argip.com.pl
Po tej części następuje podanie wersji funkcji api, następinie nazwa zasobu i opcjonalne parametry

Przykładowo, wywołanie: https://api.argip.com.pl/v1/lists zwraca nazwy i parametyry wszystkich list (magazynów) jakie zostały zadeklarowane na Twoim koncie na witrynie Argip Sp. z o.o.

Autentykacja
Każde wywołanie metody wymaga uwierzytelnienia. Więcej na ten temat znajdziesz w sekcji Uwierzytelnianie

Dostępne zasoby

GET Lists
Zasób zwraca nazwy i parametyry wszystkich list (magazynów) jakie zostały zadeklarowane na Twoim koncie na witrynie Argip Sp. z o.o. Jest to wywołanie bezparametrowe.
Przykład zwracaych danych w fomacie JSON (2 rekordy):
[
{
"Id": 8016,
"Opis": "Ulubione",
"IsFavourite": true,
"IsKanban": false
},
{
"Id": 8312,
"Opis": "Ulubione 2",
"IsFavourite": false,
"IsKanban": false
}
]
Gdzie:
  • Id - numer idenyfikacyjny twojego magazynu (liczba całkowita)
  • Opis - nazwa przyjazna magazynu (string)
  • IsFavourite - informacja, czy jest to domyślny magazyn (boolean)
  • IsKanban - informacja, czy magazyn jest kanbanowy (boolean). Dotyczy firm, które korzystają z opcji kanbanu.
GET ListsItems
Zwraca wszystkie pozycje asortymentowe z danej listy. Metoda wymaga podania parametru - id interesującej nas listy
Przykład zwracaych danych w fomacie JSON (2 rekordy):
[
{ "Id": 851873,
"NazwaArgip": "Śruba M10×70-8.8 oc.B DIN 931",
"IndeksArgip": "SSK-10070-7 o1",
"Nazwa": "Śruba M10*70-8.8 oc.B DIN 931",
"NazwaEn": "",
"Indeks": "SSK-1123",
"Lokalizacja": "",
"CenaPodstawowa": 42.68,
"CenaHurtowa": 39.7,
"CenaPaletowa": 36.71,
"ProgHurtowy": 1500,
"ProgPaletowy": 7500,
"KodEan": null,
"IloscSztuk": 100,
"Dostepnosc": 2,
"ZdjecieMimeType": "image/jpeg",
"ZdjecieBinaria": "/9j/4AAQSkZJRgABAQEASABIAAD/=....."
},
{
"Id": 862532,
"NazwaArgip": "Tubes - kpl. śrub M12×80-A2-70",
"IndeksArgip": "KPL-00459- 1",
"Nazwa": "Śruba M12×80-A2-70",
"NazwaEn": "",
"Indeks": "KPL-00459- 1",
"Lokalizacja": null,
"CenaPodstawowa": 916.36,
"CenaHurtowa": 763.89,
"CenaPaletowa": 0,
"ProgHurtowy": 50,
"ProgPaletowy": 0,
"KodEan": null,
"IloscSztuk": 100,
"Dostepnosc": 0,
"ZdjecieMimeType": "image/jpeg",
"ZdjecieBinaria": "/9j/4AAQSkZJRgABAQEASABIA..."
}]
Gdzie:
  • Id - numer idenyfikacyjny pozycji w liście (liczba całkowita)
  • NazwaArgip - aktualna nazwa asortymenu (string)
  • IndeksArgip - aktualny indeks asortymentu (string)
  • Nazwa - Twoja nazwa asortymentu (string). Edycja w listach portalowych
  • NazwaEn - aktualna nazwa angielska asortymenu (string)
  • Indeks - Twój indeks asortymentowy (string). Edycja w listach portalowych
  • Lokalizacja - Twója lokalizacja, w twoim magazynie - tekst pomocniczy (string). Edycja w listach portalowych
  • CenaPodstawowa - cena podstawowa asortymenu za 100 szt. w PLN (decimal). Cena uwzględnia wszystkie rabaty i upusty.
  • CenaHurtowa - cena asortymenu za 100 szt. w PLN obowiązująca przy progu hurtowym (decimal). Cena uwzględnia wszystkie rabaty i upusty.
  • CenaPaletowa - cena asortymenu za 100 szt. w PLN obowiązująca przy progu paletowym (decimal). Cena uwzględnia wszystkie rabaty i upusty.
  • ProgHurtowy - ilość sztuk asortymentu, przy którym będzie już obowiązywała cena hurtowa (liczba całkowita)
  • ProgPaletowy - ilość sztuk asortymentu, przy którym będzie już obowiązywała cena paletowa (liczba całkowita)
  • KodEan - unikalny kod EN13 nadany dla pozycji (string). Obowiązuje przy zamówieniach kanban
  • IloscSztuk - ilość sztuk w opakowaniu (liczba całkowita)
  • Dostepnosc - liczba całkowita 0,1 lub 2, gdzie: 0 - brak na stanie, 1 - na wyczerpaniu, 2 - duża ilość
  • ZdjecieMimeType - mime type dla zdjącia asortymenu z pola ZdjecieBinaria (string)
  • ZdjecieBinaria - zdjęcie asortymentu zapisane w postaci binarnej (string)