-------------------------------------------------- Kluczowe paramerty: cache - kod skrytki np: A1 cabinet - kod skrytkomatu np: H5123ABC storage - kod magazynu np: PODST releaseId - unikalny numer wydania complaintId - unikalny numer reklamacji employeeId - unikalny numer pracownika complaintReasonId - unikalny numer powodu reklamacji productId - unikalny numer produktu quantity - ilość produktu przy reklamacji -------------------------------------------------- Tłumaczenia odpowiedzi: https://szafasandbox.crmexpert.co/webservice/ParcelLocker/Translations?lang=pl-PL W przypadku prawidłowej odpowiedzi na wykonanie operacji PUT, POST odpowiedź zawiera "result" np: { "status": 1, "result": { "status": "LBL_DELIVERED" }, "message": "Data retrieved successfully" } gdy pojawi się jakiś błąd odpowiedź nie zawiera "result" tylko strukturę: { "status": 0, "error": { "message": "...treść błedu...", "code": 400 //lub inny } } -------------------------------------------------- Żyje: GET {{url}}/webservice/heartbeat Odpowiedź: { "status": "ok", "version": "1.0.0" } -------------------------------------------------- Pobranie tokena API: POST {{url}}/webservice/ParcelLocker/Token -------------------------------------------------- Autoryzacja pracownika/serwisanta: POST {{url}}/webservice/ParcelLocker/Employee/Auth Parametry: {"rfid":"qwerty","pin":"123456"} Odpowiedź: "result": { "employeeId": "1480", //unikalny numer pracownika "role": "EMPLOYEE", //informacja czy jest to pracownik EMPLOYEE czy serwisant SERVICE "lang": "pl-PL" //język pracownika/serwisanta (pl-PL, en-US) }, -------------------------------------------------- Lista translacji: GET {{url}}/webservice/ParcelLocker/Translations?lang=pl-PL Parametry: lang - język (pl-PL, en-US) -------------------------------------------------- Lista powodów reklamacji, podajemy przy składaniu reklamacji: complaintReasonId GET {{url}}/webservice/ParcelLocker/ComplaintReasons -------------------------------------------------- Lista wydań dla pracownika z danego skrytkomatu GET {{url}}/webservice/ParcelLocker/Employee/PendingReleases?employeeId=1480&cabinet=DSA0-2131 Parametry: employeeId - numer pracownika cabinet - kod skrytkomatu -------------------------------------------------- Lista następnych wydań dla pracownika GET {{url}}/webservice/ParcelLocker/Employee/NextReleases?employeeId=1480 Parametry: employeeId - numer pracownika -------------------------------------------------- Utworzenie reklamacji bez wybrania wolnej skrytki POST {{url}}/webservice/ParcelLocker/Employee/CreateComplaint Parametry: {"employeeId":1480,"cabinet":"H5123ABC","products":[{"productId":1101,"releaseId":1495,"quantity":2,"complaintReasonId":349}]} Odpowiedz: "result": { "complaintId": 1635, "status": "LBL_CREATED" } -------------------------------------------------- Po wybraniu wolnej skrytki: GET {{url}}/webservice/ParcelLocker/Machine/Schema?cabinet=H5123ABC i otwarciu tworzymy PUT {{url}}/webservice/ParcelLocker/Machine/ComplaintProvided aby potwierdzić załadunek reklamacji do skrytki przez pracownika Parametry: {"complaintId":1621,"cache":"A1"} Odpowiedz: "result": { "status": "LBL_LOCKER_PROVIDED" } -------------------------------------------------- Anulowanie reklamacji {{url}}/webservice/ParcelLocker/Machine/ComplaintCanceled {{url}}/webservice/ParcelLocker/Storage/ComplaintCanceled Parametry: {"complaintId":1681} Odpowiedz: "result": { "status": "LBL_CANCELED" } -------------------------------------------------- Lista produktów które może pracownik zareklamować GET {{url}}/webservice/ParcelLocker/Employee/Guarantee?employeeId=1480 Parametry: employeeId - numer pracownika -------------------------------------------------- Struktura skrytkomatu + czy dana skrytka jest wolna/zajęta/niedostępna GET {{url}}/webservice/ParcelLocker/Machine/Schema?cabinet=H5123ABC Parametry: cabinet - kod skrytkomatu -------------------------------------------------- Lista paczek przeterminowanych GET {{url}}/webservice/ParcelLocker/Machine/DeadlineReleases?cabinet=DSA0-2131 Parametry: cabinet - kod skrytkomatu -------------------------------------------------- Potwierdzenie otwarcia skrytki dla paczki przeterminowanej aby wyciągnąć paczkę PUT {{url}}/webservice/ParcelLocker/Machine/DeadlineDelivered Parametry: {"releaseId":1495,"storage":"PODST"} Podajemy storage, ponieważ paczka ma trafić do tego magazynu Odpowiedz: "result": { "status": "LBL_PICKUP_FROM_WAREHOUSE" } -------------------------------------------------- Lista paczek reklamacyjnych w danym skrytkomacie GET {{url}}/webservice/ParcelLocker/Machine/Complaints?cabinet=H5123ABC Parametry: cabinet - kod skrytkomatu -------------------------------------------------- PUT {{url}}/webservice/ParcelLocker/Machine/ComplaintDelivered Parametry: complaintId - numer reklamacji otwarcie skrytki i odbiór reklamacji Odpowiedz: "result": { "status": "LBL_RECEIVED" } -------------------------------------------------- Odebranie paczki przez pracownika kodem QR PUT {{url}}/webservice/ParcelLocker/Machine/QrDelivered Parametry: {"qr":"qwerty","cabinet":"34-100"} Odpowiedz: "result": { "location": "A1", "status": "LBL_DELIVERED" } -------------------------------------------------- Odebranie awaryjne paczki przez obsługę kodem QR PUT {{url}}/webservice/ParcelLocker/Machine/QrEmergency Parametry: {"qr":"qwerty2","cabinet":"34-100"} Odpowiedz: "result": { "location": "A1", "status": "LBL_EMERGENCY" } -------------------------------------------------- Umieszczenie paczki przez obsługę kodem QR PUT {{url}}/webservice/ParcelLocker/Machine/QrProvided Parametry dla sprawdzenia czy kod QR poprawny: {"qr":"$1$aadc4986$WGC4Z2ZLCswiiD1ltzJ9Z0","cabinet":"EDUMAT","check":true,"cache":"A2"} Odpowiedzi: "result": { "status": "EXIST" } "result": { "status": "NOT EXIST" } Parametry dla potwierdzenia załadunku do skrytki: {"qr":"$1$aadc4986$WGC4Z2ZLCswiiD1ltzJ9Z0","cabinet":"EDUMAT","check":false,"cache":"A2"} Odpowiedz: "result": { "location": "A1", "status": "LBL_LOCKER_PROVIDED" } -------------------------------------------------- Dostarczenie paczki przez obsługę kodem QR do magazynu PUT {{url}}/webservice/ParcelLocker/Storage/QrProvided Parametry {"qr":"qwerty","storage":"PODST"} Odpowiedz: "result": { "releaseNumber": "WD/234/2", "status": "LBL_WAREHOUSE_PROVIDED" } -------------------------------------------------- Otwarcie danej skrytki aby odebrać paczkę PUT {{url}}/webservice/ParcelLocker/Machine/Delivered Parametry: {"releaseId":1495} Odpowiedz: "result": { "status": "LBL_DELIVERED" } -------------------------------------------------- Otwarcie danej skrytki aby włożyć paczkę PUT {{url}}/webservice/ParcelLocker/Machine/Provided Parametry: {"releaseId":1495,"cache":"A1"} Odpowiedz: "result": { "status": "LBL_LOCKER_PROVIDED" } -------------------------------------------------- Następne wydania dla danego pracownika w magazynie GET {{url}}/webservice/ParcelLocker/Storage/NextReleases?employeeId=1480 Parametry: employeeId -------------------------------------------------- Lista wydań w magazynie dla danego pracownika aby odebrać paczkę GET {{url}}/webservice/ParcelLocker/Storage/PendingReleases?storage=PODST&employeeId=1480 Parametry: storage employeeId Lista wydań w magazynie aby dostarczyć paczkę GET {{url}}/webservice/ParcelLocker/Storage/PendingReleases?storage=PODST&employeeId=0 Parametry: storage employeeId=0 -------------------------------------------------- Lista przeterminowanych paczek w magazynie GET {{url}}/webservice/ParcelLocker/Storage/DeadlineReleases?storage=PODST -------------------------------------------------- Odebranie paczki z magazynu przez pracownika PUT {{url}}/webservice/ParcelLocker/Storage/Delivered Parametry {"releaseId":1528} Odpowiedz: "result": { "status": "LBL_DELIVERED" } -------------------------------------------------- Dostarczenie paczki do magazynu PUT {{url}}/webservice/ParcelLocker/Storage/Provided Parametry: {"releaseId":1528} Odpowiedz: "result": { "status": "LBL_WAREHOUSE_PROVIDED" } -------------------------------------------------- Odebranie paczki przez pracownika kodem QR PUT {{url}}/webservice/ParcelLocker/Storage/QrDelivered Parametry: {"qr":"qwerty","storage":"PODST"} Odpowiedz: "result": { "releaseNumber": "WD/6543/5", "status": "LBL_DELIVERED" } -------------------------------------------------- Odebranie awaryjne paczki przez obsługę kodem QR PUT {{url}}/webservice/ParcelLocker/Storage/QrEmergency Parametry: {"qr":"qwerty2","storage":"PODST"} Odpowiedz: "result": { "releaseNumber": "WD/6543/5", "status": "LBL_EMERGENCY" } -------------------------------------------------- Utworzenie reklamacji w magazynie POST {{url}}/webservice/ParcelLocker/Storage/CreateComplaint Parametry: {"employeeId":1480,"storage":"PODST","products":[{"productId":1101,"releaseId":1495,"quantity":2,"complaintReasonId":349}]} Odpowiedz: "result": { "complaintId": 145, "status": "LBL_CREATED" } -------------------------------------------------- Potwierdzenie otrzymania paczki reklamacyjnej w magazynie dostarczonej przez pracownika PUT {{url}}/webservice/ParcelLocker/Storage/ComplaintProvided Parametry: {"complaintId":1623} Odpowiedz: "result": { "status": "LBL_WAREHOUSE_PROVIDED" } -------------------------------------------------- Odebranie paczki reklamacyjnej przez obsługę z magazynu PUT {{url}}/webservice/ParcelLocker/Storage/ComplaintDelivered Parametry: {"complaintId":1623} Odpowiedz: "result": { "status": "LBL_RECEIVED" } -------------------------------------------------- Lista (dla obsługi) dostarczonych reklamacji przez pracownika w magazynie GET {{url}}/webservice/ParcelLocker/Storage/Complaints?storage=PODST -------------------------------------------------- Lista magazynów: GET {{url}}/webservice/ParcelLocker/Storage/Storages Odpowiedz: name - nazwa magazynu (tylko informacyjnie) storage - kod magazynu -------------------------------------------------- Odebranie reklamacji przez serwisanta kodem QR ze skrytkomatu PUT {{url}}/webservice/ParcelLocker/Machine/QrComplaintDelivered Parametry: {"qr":"RK%2F5%2F04%2F25","cabinet":"H5123ABC"} Odpowiedz: "result": { "location": "A1", "status": "LBL_RECEIVED" } -------------------------------------------------- Odebranie paczki reklamacyjnej kodem QR przez serwisanta z magazynu PUT {{url}}/webservice/ParcelLocker/Storage/QrComplaintDelivered Parametry: {"qr":"RK%2F5%2F04%2F25","storage":"PODST"} Odpowiedz: "result": { "complaintNumber": "RK/5/04/25", "status": "LBL_RECEIVED" } -------------------------------------------------- Potwierdzenie otwarcia skrytki dla paczki przeterminowanej w magazynie aby wyciągnąć paczkę PUT {{url}}/webservice/ParcelLocker/Storage/DeadlineDelivered Parametry: {"releaseId":1495} Odpowiedz: "result": { "status": "LBL_PICKUP_FROM_WAREHOUSE" } --------------------------------------------------