Resico KS izmanto HTTP POST pieprasījumus, lai no integrētās datu bāzes programmas pieprasītu jebkuru jaunu produktu, klientu, akcijas un citu informāciju.
KS POST pieprasījumu HTTPS URL parametros ir definēts unikāls klienta ID un sinhronizācijas iepriekšējās sinhronizācijas servera laiks.
Visos POS sistēmas pieprasījumos satura formāts tiek definēts kā Content-Type: application/json
Pieprasījumi no POS sistēmām tiek veikti periodiski. Perioda ilgumu iestata apkalpojošais dienests, uzstādot POS sistēmu. Pēc noklusējuma šis laiks ir 15 minūtes.
Ierobežojumi saistībā ar kolāciju:
Kolācija nosaka, kā SQL Server salīdzina un šķiro rakstzīmes.
- A = a
- ā = a
- š = s
PK lauks nedrīkst saturēt dublikātus, bet SQL Server dublikātu atpazīšana notiek pēc kolācijas.
Tāpēc nepieļaus “Name”, “name”, “nāme” kā atšķirīgas vērtības, tās SQL Server uztvers kā identiskas.
Datu sinhronizācija
POST
curl –location ‘https://api.resico.com/api/resicowin/v2/e041eb1d2054ea6361cf3d260b2f3d8e/sync’ \
–header ‘Authorization: bearer d2af303095c7d716d5094ba350465acc’ \
–header ‘Content-Type: application/json’
Datu sinhronizācijas atbildes datu piemērs
| Apraksts | Obligāts Jā / Nē | Lauka tips | |
| Request: POST | Pieprasījuma metode | ||
| https://api.resico.com/api/resicowin/v2/dd4a5f52e36b998d1fdfc376de3633e8/sync?limit=1000&page=1: | baseURL/Klienta kods | ||
| header: | |||
| Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5… | Autorizācijas tokens | ||
| body: | |||
| {“serverTime”:”2026-04-02 08:46:55″, | Servera laiks Ja nav norādīts, vai norādīti tukši dati (” “), tad nosūtās visi dati (Pilna sinhronizācija) |
||
| “Chapters”:[“VAT”,”Layouts”,”Workers”]} | Sinhronizējamās nodaļas. Nodaļu nosaukumi redzami Response sadaļā, piem. “Products” , “PaymentMethods”, u.t.t. Nodaļa “POS” atgriež vienmēr, neatkarīgi no pieprasījuma Ja nav norādīta šī sadaļa, norādīts tukšs masīvs vai NULL, nosūtās visas nodaļas. |
||
| Response: | |||
| { | |||
| “root”:{ | Jā | ||
| “serverTime”:”2024-03-05 15:43:36″, | Šis parametrs tiks sūtīts pie nākamā pieprasījuma | Jā | varchar(50) |
| “DefaultCurrency”:”EUR”, | Valūtas kods – tiek attēlots programmā un izdrukās | Jā | varchar(3) |
| “GiftcardsApiKey”:”A1bbSh0LdYow9jtqUTjaYOHsrmiZrQAC”, | API Key Dāvanu karšu risinājumam, ja tiek izmantots | Nē | varchar(256) |
| “JsonApiKey”:”9ac3a3a720c9758a35d765875abc3588″, | API Key pieslēgumam, ja izmanto klientu rediģēšanu no KS | Nē | varchar(256) |
| “POS”:{ | KS iestatījumi, obligāts pie izmaiņām | Jā | |
| “POSCode”:”1″, | Unikāls KS indentifikators | Nē | varchar(20) |
| “POSType”:1, | Retail=1; BaReCa=2; Kiosk=3; Tablet=4 | Nē | int |
| “POSName”:”1″, | KS nosaukums – tiek attēlots programmā un izdrukās | Nē | nvarchar(50) |
| “LocationCode”:”TP”, | Novietojuma identifikators | Nē | varchar(20) |
| “LocationName”:”TomaPasaule.lv”, | Novietojuma nosaukums – tiek attēlots progrāmmā, netiek drukāts | Nē | nvarchar(50) |
| “LocationAddress”:”Celmiņi, Dobeles nov., Tērvetes pag.”, | Novietojuma adrese – netiek izmantots | Nē | nvarchar(max) |
| “HeaderLine1”: “”, | Čeka galvene – tiek drukāts čekā | ||
| “FooterLine1″:””, | Čeka kājene – tiek drukāts čekā | Nē | nvarchar(max) |
| “MembershipRatio”:0, | Punktu attiecība | Nē | decimal |
| “MembershipPointsRate”:0, | Punktu likme | Nē | decimal |
| “PromoReceiptText”:”Text” | Reklāmas izdrukas teksts | Nē | nvarchar(max) |
| }, | |||
| “Products”:{ | Nē | ||
| “current_page”:1, | pašreizējais lapas numurs – netiek izmantots | Nē | |
| “data”:[ | Jā | ||
| { | |||
| “type”:”prod”, | Produkta tips: giftcard,prod,bom,service,voucher,deposit | Jā | varchar(8) |
| “action”:0, | 0 = pievienot vai labot, 1 = dzēst | Nē | int |
| “productNo”:”78250″, | Produkta numurs | Jā | varchar(50) |
| “parentProductNo”:””, | Virsprodukta numurs, ja šis produkts ir variācija – norāde uz esošu produktu | Nē | varchar(50) |
| “productName”:”Auto \”3 vienā\””, | Produkta nosaukums – tiek drukāts čekā | Jā | nvarchar(200) |
| “notes”:”Izmēri: Fuksijas krāsas auto: 12 cm x 4,5 cm x 6 cm Dzeltenās krāsa\n auto: 17m5 cm x 5,3 cm x 6,3 cm Gaiši zilās krāsas auto: 14 cm x 5 cm x\n 6 cm\n \n \n \n \n \n \n Materiāli:Korpusi: kalnu kļava / Riteņi: Dižskābardis\n\n\n\n \n \n \n \n \n \n Iepakojuma izmērs: 21,8 cm x 11 cm x 6,5 cm\n\n\n\n \n \n \n \n \n \n 3 savienojami automobiļi\n\n\n\n \n \n \n \n \n \n Ieteicams bērniem virs 3\ngadu vecuma\n\n\n \n \n \n\n\n\n\n\n Kā rūpēties par šo rotaļlietu\n \n \n \n \n \n \n \n \n Šī rotaļlieta un iepakojums ir izgatavoti no dabiskiem materiāliem, un\n to s var viegli pārsrādāt.\n \n \n \n \n \n Pirms došanas bērniem, lūdzu, noņemiet visu iepakojumu un stiprinājumus.\n \n \n \n \n \n Lūdzu nelietojiet asus instumentus, lai noņemtu iepakojumu.\n \n \n \n \n \n Tīriet rotaļlietas virsmu, izmantojot tikai mitru drāniņu.\n \n \n \n \n \n Lūdzu nepakļaujiet šo rotaļlietu augstas temperatūras vai augsta mitruma\n iedarbībai. Šādos apstākļos koksne var saliekties un deformēties.\n \n \n \n \n \n Mēs ieskām vēcāku uzraudzību, ja ar rotaļlietu spēlējās mazi bērni.\n \n \n \n \n\n\n\n \n \n\nVairāk jauku rotaļlietu\n”, | Produkts apraksts – netiek drukāts | Nē | nvarchar(max) |
| “unitOfMeasure”:”gb”, | Mērvienības kods – norāde uz esošo mērvienību | Jā | nvarchar(10) |
| “productCategoryCode”:”transporta-lidzekli”, | Kategorijas kods, ja produkts iekļauts kategorijā – norāde uz esošo kategoriju | Nē | varchar(50) |
| “department”:null, | Nodaļas identifikators – norāde uz esošo nodaļu | Nē | int |
| “VATid”:”A”, | PVN identifikators – norāde uz esošo PVN ierakstu | Jā | varchar(1) |
| “kitchenPrinter”:null, | Produktam piesaistītais virtuves printeris | Nē | int |
| “includeInMenu”:0, | 0 – nerādīt / 1 – rādīt KS ātrajā izvēlnē | Nē | int |
| “includeInQuickOrders”:0, | false – nerādīt / true – rādīt kioska ātrajā izvēlnē | Nē | bool |
| “notDiscountable”:false, | piemērot / nepiemērot atlaides | Nē | bool |
| “productPictureLink”:”https://storage.googleapis.com/resico-retail/699/372c28a124d02e5dc547166d5e8488c7/products/1-qb25vajd-large.jpg”, | Produkta attēla URL | Nē | varchar(120) |
| “snRequired”:false, | Produktam nepieciešmas ievadīt sērijas numuru: true/false | Nē | bool |
| “snValidationRequired”:false, | Sērijas numuram nepieciešama validācija true/false | Nē | bool |
| “reverseVAT”:false, | Produktam piemērojams reversais (apgrieztais) PVN | Nē | bool |
| “reverseVATtext”:””, | Tekst pie produkta, ja piemērots reversais pvn | Nē | nvarchar(max) |
| “salesPrice”:”24.0000″, | Produkta pārdošanas cena | Jā | decimal |
| “salesPrice2″:”24.0000”, | Produkta pārdošanas cena, ja piemērots reversais PVN | Nē | decimal |
| “infoCodeID”:””, | Infokoda identifikators – norāde uz esošo infokodu | Nē | varchar(45) |
| “productOptions”: [ | Papildus opcionāls produkts, piem., dzēriens burgerim vai bez tomātiem | Nē | |
| { | |||
| “productOptionName”: “Kola”, | Produkta iespējas nosaukums | nvarchar(MAX) | |
| “productOptionProduct”: “1000002”, | Produkta iespējai piesaistītais produkts, ja ir | varchar(20) | |
| “productOptionPrice”: “3”, | Produkta iespējas cena, ja ir piesaistīts produkts | decimal(15, 4) | |
| “productOptionValid”: false | Vai pēc noklusējuma, opcija ir ieslēgta | bit | |
| } | |||
| ], | |||
| “productPreparation”: [ | Produkta pagatavošans iespējas | Nē | |
| { | |||
| “productPreparationName”: “temp”, | Pagatavošanas iespējas nosaukums | nvarchar(MAX) | |
| “productPreparationChoice”: [ | Pagatavošanas iespējas | ||
| { | |||
| “text”: “250c”, | Nosaukums | nvarchar(MAX) | |
| “active”: false | Vai pēc noklusējuma, opcija ir ieslēgta | bit | |
| }, | |||
| { | |||
| “text”: “600c”, | Nosaukums | nvarchar(MAX) | |
| “active”: true | Vai pēc noklusējuma, opcija ir ieslēgta | bit | |
| } | |||
| ] | |||
| } | |||
| ], | |||
| “allowedDaysOfWeek”:null, | Atļauts pārdot norādēitajās nedēļas dienās. Nenorādīts – vienmēr atļauts. Pr=1, Se=6, Sv=0. Piemēram: “140” – Pr, Ce, Sv | Nē | varchar(7) |
| “allowedToSellFrom”:”00:15″, | Atļauts pārdot no plkst… Nenorādīts – no pusnakts | Nē | time(7) |
| “allowedToSellTo”:null, | Atļauts pārdot līdz plkst… Nenorādīts – līdz pusnaktij | Nē | time(7) |
| “Barcodes”:[ | Nē | ||
| { | |||
| “barcode”:”5906554278252″, | svītrkoda simbolu virkne | Jā | nvarchar(128) |
| “action”:0, | 0 – pievienot vai rediģēt, 1 – dzēst | Nē | int |
| “unitOfMeasure”:”pk”, | speciālās mērvienības kods konkrētajam svītrkodam – norāde uz esošo mērvienību | Nē | varchar(2) |
| “salesPrice”:”20.32″, | Produkta cena par speciālo mērvienību, ja norādīts | Nē | decimal |
| “salesPrice2″:”20.32” | Produkta cena par speciālo mērvienību, ja norādīts un piemērots reversais PVN | Nē | decimal |
| } | |||
| ], | |||
| “LinkedProducts”:[ | Saistītais produkts | Nē | |
| { | |||
| “ProductNo”: “1000006”, | Saistītā produkta nr. | Jā | varchar(20) |
| “Qty”: 1, | Pievienojamais daudzums | Jā | decimal(15, 4) |
| “action”: 0 | 0 – pievienot vai rediģēt, 1 – dzēst | Nē | |
| } | |||
| ], | |||
| “PriceGroupPrices”:[ | Cenu grupas cenas | Nē | |
| { | |||
| “PriceGroupCode”: “test”, | Cenugrupas ID | Jā | nvarchar(128) |
| “Price”: 90, | Cenugrupas cena | Jā | decimal(18, 2) |
| “action”: 0 | 0 – pievienot vai rediģēt, 1 – dzēst | Nē | |
| } | |||
| ] | |||
| } | |||
| ], | |||
| “first_page_url”:”https://retail.resico.com/api/resicowin/v2/372c28a124d02e5dc547166d5e8488c7/sync?limit=100&page=1″, | pirmās lapas URL – netiek izmantots | Nē | |
| “from”:1, | Elementi sarakstā “No” – Netiek izmantots | Nē | |
| “last_page”:8, | Pēdējās lapas numurs – netiek izmantots | Nē | |
| “last_page_url”:”https://retail.resico.com/api/resicowin/v2/372c28a124d02e5dc547166d5e8488c7/sync?limit=100&page=8″, | pēdē`jās lapas URL – netiek izmantots | Nē | |
| “next_page_url”:”https://retail.resico.com/api/resicowin/v2/372c28a124d02e5dc547166d5e8488c7/sync?limit=100&page=2″, | Nākamās lapas URL – Pēdējā lapā jābūt null, tukšam vai nenorādītam | Jā | |
| “path”:”https://retail.resico.com/api/resicowin/v2/372c28a124d02e5dc547166d5e8488c7/sync”, | Netiek izmantots | Nē | |
| “per_page”:100, | Netiek izmantots | Nē | |
| “prev_page_url”:null, | Iepriekšējās lapas URL – netiek izmantots | Nē | |
| “to”:100, | Elementi sarakstā “Līdz” – netiek izmantots | Nē | |
| “total”:757 | Netiek izmantots | Nē | |
| }, | |||
| InfoCodes: [ | Infokodi | Nē | |
| { | |||
| “infoCodeNo”: “TEsT”, | Infokoda ID | nvarchar(128) | |
| “infoCodeDescription”: “Pārbaudīt čeku”, | Infokoda nosaukums | nvarchar(MAX) | |
| “infoCodeText”: “Čeka pārbaude”, | Infokoda paziņojums – Izvēloties produktu uz kases, parādīs šo paziņojumu | nvarchar(MAX) | |
| “active”: true, | Aktīvs | bit | |
| “begins”: null, | Sākuma datums | nvarchar(MAX) | |
| “ends”: null, | Beigu Datums | nvarchar(MAX) | |
| “printOnReceipt”: false, | Vai drukāt paziņojumu uz čeka | bit | |
| “colorOnPOS”: true, | Paziņojuma krāsa uz kases: true = sarkana, false = balta | bit | |
| “action”: 0 | 0 – pievienot vai rediģēt, 1 – dzēst | ||
| } | |||
| ], | |||
| “UnitsOfMeasure”:[ | Mērvienības | Nē | |
| { | |||
| “action”:0, | 0 – jauns vai rediģēt / 1 – dzēst | Nē | int |
| “unitOfMeasure”:”gb”, | Mērvienības kods (daļēji reģistrjūtīgs*) | Jā | nvarchar(10) |
| “unitOfMeasureName”:”Gab”, | Mērvienības nosaukums – tiek drukāts čekā | Jā | nvarchar(20) |
| “weightUOM”:false, | true = Dalāma vērvienība / false – nedalāma | Nē | bool |
| “autoReadScale”:false | true = Automātiski nolasīt svarus | Nē | bool |
| } | |||
| ], | |||
| “ProductCategories”:[ | Produktu kategorijas | Nē | |
| { | |||
| “productCategoryCode”:”transporta-lidzekli”, | Kategorijas kods | Jā | varchar(50) |
| “productCategoryName”:”Transporta līdzekļi”, | Kategorijas nosaukums | Jā | nvarchar(max) |
| “productParentCategoryCode”:””, | Virskategorijas kods – norāde uz esošo kategoriju | Nē | varchar(50) |
| “productCategoryBackgroundColor”:”#337ab7″, | Fona krāsa | Nē | nvarchar(max) |
| “productCategoryTextColor”:”#ffffff”, | Teksta krāsa | Nē | nvarchar(max) |
| “productCategoryPictureLink”:””, | Kategorijas attēla URL | Nē | nvarchar(max) |
| “productCategoryOrder”:null, | Kārtošanas indekss – ātrajā izvēlnē tiks kārtots augošā secībā | Nē | int |
| “membershipVoid”:false, | ja true, tad pērkot šīs kategorijas prduktus, netiek skaitīti dalības punkti | Nē | bool |
| “action”:0 | 0 – jauns vai rediģēt / 1 – dzēst | Nē | int |
| } | |||
| ], | |||
| “VAT”:[ | PVN likmes. | Nē | |
| { | |||
| “action”:0, | 0 – jauns vai rediģēt / 1 – dzēst | Nē | int |
| “vatID”:”A”, | PVN kods | Jā | varchar(1) |
| “vatPercentage”:”0.0000″, | PVN procentu likme izteikta decimāldaļā, piemēram 21%=0.21 | Jā | decimal |
| “vatRate”:null | Netiek izmantots | Nē | nvarchar(max) |
| } | |||
| ], | |||
| “PaymentMethods”:[ | Apmaksas veidi | Nē | |
| { | |||
| “PaymentCode”: 1, | Apmaksas veida Kods | int | |
| “PaymentName”: “Skaidrā naudā”, | Apmaksas veida nosaukums | nvarchar(30) | |
| “PaymentType”: “cash”, | Apmaksas veida tips: cash, worldline, tara, giftcard, deposit, electronic | varchar(10) | |
| “RoundingAmount”: “0.0100”, | Apmaksas veida noapaļojamais apjoms | decimal(18, 2) | |
| “WarningAmount”: null, | Brīdinājuma summa | decimal(18, 2) | |
| “OpenCashDrawer”: true, | Vai pēc apmaksas atvērt naudas lādi | bit | |
| “action”: 0 | 0 – jauns vai rediģēt / 1 – dzēst | ||
| } | |||
| ], | |||
| “Workers”:[ | KS operatori | Nē | |
| { | |||
| “workerNo”: “2”, | Kasiera ID | decimal(18, 2) | |
| “workerName”: “Kasieris”, | Kasiera vārds | nvarchar(MAX) | |
| “workerSurname”: “Grīnberga”, | Kasiera uzvārds | nvarchar(MAX) | |
| “operatorPassword”: “!Piemērs123”, | Kasiera parole | nvarchar(MAX) | |
| “workerCardID”: “11”, | Kasiera kartes nr. | nvarchar(MAX) | |
| “action”: 0, | 0 – jauns vai rediģēt / 1 – dzēst | bit | |
| “winPrintXreportAllowed”: false, | Drukāt X-Atskaiti | bit | |
| “winPrintZreportAllowed”: true, | Drukāt Z-Atskaiti | bit | |
| “winCancelTransactionAllowed”: false, | Atcelt Darījumu | bit | |
| “winOpenDrawer”: false, | Atvērt naudas lādi | bit | |
| “winVoidLineAllowed”: false, | Atcelt rindu | bit | |
| “winStartReturnTransactionAllowed”: false, | Sākt Atgriezšanas Darījumu | bit | |
| “winSuspendTransactionAllowed”: false, | Aizturēt Darījumu | bit | |
| “winStartTenderLoanTransactionAllowed”: false, | Ielikt Maiņas naudu | bit | |
| “winStartTenderPickupTransactionAllowed”: false, | Inkasācija | bit | |
| “winStoreAdmin”: true, | Administratora tiesības | bit | |
| “winDiscountsAllowed”: false, | Izmantot atlaides | bit | |
| “winAllowEditBasket”: false | Atļaut rediģēt produktu grozu | bit | |
| } | bit | ||
| ], | |||
| “CustomerGroups”:[ | Klientu grupas | Nē | |
| { | |||
| “customerGroupID”:”mozello”, | Klientu grupas identifikators | Jā | nvarchar(128) |
| “customerGroupName”:”Mozello”, | Klientu grupas nosaukums | Jā | nvarchar(max) |
| “PriceGroupCode”:”PriceGroup1″, | Cenu grupa, ja tāda piešķirta | Nē | nvarchar(128) |
| “action”:0 | 0 – jauns vai rediģēt / 1 – dzēst | Nē | int |
| } | |||
| ], | |||
| “Customers”:{ | Klienti | Nē | |
| “current_page”:1, | Netiek izmantots | Nē | |
| “data”:[ | Jā | ||
| { | |||
| “customerID”:”1000056″, | Klienta identifikators – tikai cipari | Jā | nvarchar(128) |
| “customerName”:”Jaanus Peets”, | Klienta nosaukums / vārds (uzvārds) | Jā | nvarchar(max) |
| “customerAddress”:”Piiri 12. Keila Linn, Estonia”, | Klienta Adrese | Nē | nvarchar(max) |
| “customerDeliveryAddress”:””, | Klienta Piegādes adrese | Nē | nvarchar(max) |
| “customerBankName”:””, | Klienta Banka | Nē | nvarchar(max) |
| “customerBankCode”:””, | Klienta Bankas kods | Nē | nvarchar(max) |
| “customerBankAccount”:””, | Klienta Bankas konts | Nē | nvarchar(max) |
| “customerPhone”:”+3725251492″, | Klienta tālr. nr. | Nē | nvarchar(max) |
| “customerEmail”:””, | Klienta e-pasts | Nē | nvarchar(max) |
| “customerRegistrationNo”:””, | Reģistrācijas Nr | Nē | nvarchar(max) |
| “customerTaxPayerID”:””, | PVN maksātāja Nr | Nē | nvarchar(max) |
| “customerGroupID”:””, | Klientu grupas identifikators – norāde uz esošu klientu grupu | Nē | nvarchar(128) |
| “loyaltyDiscount”:0, | Lojalitātes atlaide % | Nē | decimal |
| “reverseVAT”:false, | Pazīme piešķir vai nepiešķir reverso PVN | Nē | bool |
| “eMailReceipt”:false, | true – Netiks drukāts čeks, bet sūtīts epastā | Nē | bool |
| “action”:0, | 0 – jauns vai rediģēt / 1 – dzēst | Nē | int |
| “membershipPoints”:0, | Uzkrātie dalības punkti | Nē | decimal |
| “loyaltyCards”:[ | Lojalitātes karšu numuri | Nē | |
| ] | |||
| } | |||
| ] | |||
| }, | |||
| “PromotionsPaged”: { | Akcijas | ||
| “current_page”: 1, | Netiek izmantots | ||
| “data”: [ | |||
| { | |||
| “action”: 0, | 0 – jauns vai rediģēt / 1 – dzēst | ||
| “promotionAssignmentID”: 50, | Akcija | int | |
| “productNo”: null, | Produkta nr., kuriem ir piesaistīta akcija | varchar(50) | |
| “productCategoryCode”: “”, | Produkta kategorijas kodi, kuriem spēkā akcija | nvarchar(MAX) | |
| “customerID”: null, | klienta ID, kuriem piesaistīta akcija | nvarchar(MAX) | |
| “customerGroupID”: null, | Klienta grupu id, kuriem spēkā akcija | nvarchar(MAX) | |
| “promotionID”: “test45546”, | Akcijas ID | varchar(32) | |
| “promotionType”: “basket”, | Akcijas tips | varchar(10) | |
| “promotionDescription”: “”, | Akcijas apraksts | nvarchar(255) | |
| “beginDate”: “2026-02-04 00:00:00”, | Akcijas sākuma datums | datetime | |
| “endDate”: null, | Akcijas beigu datums | datetime | |
| “limitationType”: “none”, | Ierobežojumu tips | ||
| “thresholdAmount”: “0.0000”, | Minimālā akcijas preču summa | decimal(18, 2) | |
| “thresholdQty”: “0.0000”, | Miimālais akcijas produktu skaits | decimal(18, 2) | |
| “limitAmount”: “0.0000”, | Maksimālā akcijas produktu summa | decimal(18, 2) | |
| “limitQty”: “0.0000”, | Maksimālais akcijas produktu skaits | decimal(18, 2) | |
| “multibuyQty”: 0, | Multi buy skaits | int | |
| “method”: “percred”, | Akcijas aprēķina metode: priceplus, percplus, percred, pricered, newprice | varchar(10) | |
| “priceAdjustment”: “0.0000”, | Cenas izmaiņa produktiem | decimal(18, 2) | |
| “percent”: “0.5200”, | Procentuāla atlaide | decimal(18, 2) | |
| “newPrice”: “0.0000”, | Jaunā komplekta cena | decimal(18, 2) | |
| “coupon”: null, | Kuponos, kurš iespējo akciju | nvarchar(MAX) | |
| “dayOfWeek”: null, | Nedēļas dienas, kurās akcija ir spēkā | varchar(7) | |
| “timeOfDay”: null, | Laiks, kad akcija ir spēkā | varchar(11) | |
| “locations”: “3” | Lokācija, kur akcija ir spēkā | varchar(8000) | |
| } | |||
| ], | |||
| “first_page_url”:”https://retail.resico.com/api/resicowin/v2/372c28a124d02e5dc547166d5e8488c7/sync?limit=100&page=1″, | Netiek izmantots | Nē | |
| “from”:1, | Netiek izmantots | Nē | |
| “last_page”:1, | Netiek izmantots | Nē | |
| “last_page_url”:”https://retail.resico.com/api/resicowin/v2/372c28a124d02e5dc547166d5e8488c7/sync?limit=100&page=1″, | Netiek izmantots | Nē | |
| “next_page_url”:null, | Nākamās lapas URL – Pēdējā lapā jābūt null, tukšam vai nenorādītam | Jā | |
| “path”:”https://retail.resico.com/api/resicowin/v2/372c28a124d02e5dc547166d5e8488c7/sync”, | Netiek izmantots | Nē | |
| “per_page”:100, | Netiek izmantots | Nē | |
| “prev_page_url”:null, | Netiek izmantots | Nē | |
| “to”:56, | Netiek izmantots | Nē | |
| “total”:56 | Netiek izmantots | Nē | |
| }, | |||
| “PriceGroups”:[ | Cenu grupas | Nē | |
| { | |||
| “PriceGroupCode”:”B2B”, | Cenu grupas identifikators | Jā | nvarchar(128) |
| “PriceGroupName”:”B2B cenas”, | Cenu grupas nosaukums | Jā | nvarchar(MAX) |
| “action”:0 | 0 – jauns vai rediģēt / 1 – dzēst | Nē | |
| } | |||
| ], | |||
| “Layouts”: { | Izkārtojums | ||
| “groupData”: { | Izkārtojuma grupas dati | ||
| “GroupName”: “Default Bareca LV”, | Grupas nosaukums | nvarchar(20) | |
| “LayoutColumns”: 20, | Kolonnu skaits izkārtojumā | int | |
| “LayoutRows”: 15, | Rindu skaits izkārtojumā | int | |
| “CellPadding”: 5, | Attālums starp pogām | int | |
| “DefaultLayout”: 12, | Noklusētā skata kods | int | |
| “OPdisplay”: { | Operātorā logs | ||
| “PosX”: 11, | Operātorā logs X kordināte (0x,0y ir aigšā kreisajā stūrī) | int | |
| “PosY”: 1, | Operātorā logs y kordināte (0x,0y ir aigšā kreisajā stūrī) | int | |
| “SizeX”: 9, | Operātora loga garums | int | |
| “SizeY”: 10, | Operātora loga augstums | int | |
| “BGColor”: “#FAB001”, | Fona krāsa | varchar(7) | |
| “SelectionColor”: “#000000”, | Operātora logā iezīmētā produkta krāsa | varchar(7) | |
| “FontColor”: “#000000”, | Fonta krāsa | varchar(7) | |
| “FontSize”: 12, | Fonta izmērs | int | |
| “SearchLineFontSize”: 16, | Meklēšanas rindas fonta izmērs: | int | |
| “FontSizeLabelNormal”: 18, | Informatīvās daļas fonta izmērs: | int | |
| “FontSizeLabelLarge”: 24, | Informatīvās daļas virsraksta fonta izmērs: | int | |
| “FontSizePayments”: 14, | Maksājumu fonta izmērs: | int | |
| “FontFamily”: “helvetica”, | Fonts | varchar(100) | |
| “HideTotalVoid”: 0, | Rādīt kopējo atcelšanu | bit | |
| “HideTotalDiscount”: 0, | Rādīt kopējo atlaidi | bit | |
| “HideSearchLine”: 0, | Rādīt meklēšanas līniju | bit | |
| “HideProductNoColumn”: 0, | Rādīt ProductNo kolonnu | bit | |
| “HideVatColumn”: 0, | Rādīt PVN kolonnu | bit | |
| “ShowPriceColumn”: true, | Rādīt cenas kolonnu | bit | |
| “AllowEditRows”: 0, | Atļaut rediģēt rindas | bit | |
| “HeaderFontWeightBold”: 1, | Galvene treknrakstā | bit | |
| “ShowVoidDiscounts”: false, | Rādīt nepiemērotās atlaides | ||
| “LineButtons”: null, | Produktu rindas pogas | ||
| “Buttons”: null | Groza pogas | ||
| }, | |||
| “Options”: { | Izkārtojuma iestatījumi | ||
| “ListFontSize”: 14, | Saraksta fonta lielums | int | |
| “ListHeaderFontSize”: 20, | Saraksta galvenes fonta lielums | int | |
| “ListInfoFontSize”: 14, | Saraksta info fonta lielums | int | |
| “ListButtonFontSize”: 18 | Saraksta pogas fonta lielums | int | |
| }, | |||
| “productBlockButton”: { | Produkta bloks | ||
| “PGPosX”: 1, | Produkta bloks X kordināte (0x,0y ir aigšā kreisajā stūrī) | int | |
| “PGPosY”: 2, | Produkta bloks y kordināte (0x,0y ir aigšā kreisajā stūrī) | int | |
| “PGSizeX”: 10, | Produkta bloks garums | int | |
| “PGSizeY”: 9, | Produkta bloks augstums | int | |
| “PGGridSize”: 2, | Šūnu izmērs | int | |
| “PGLayoutID”: 12, | Skata ID, kurā rādīsies produktu bloks | int | |
| “PGBGColor”: “#595761”, | Fona krāsa | varchar(7) | |
| “PGCellBGColor”: “#E06E1D”, | Šūnu fons | varchar(7) | |
| “PGFontColor”: “#FFFFFF”, | Teksta krāsa | varchar(7) | |
| “PGFontSize”: 12,”id”: 12, | Fonta izmērs | int | |
| “PGFontFamily”: “helvetica”, | Fonts | varchar(25) | |
| “PGLeftImageURL”: null, | Pogas Pa kreisi bilde | nvarchar(MAX) | |
| “PGRightImageURL”: null, | Pogas Pa labi bilde | nvarchar(MAX) | |
| “PGUpImageURL”: null, | Pogas uz augšu bilde | nvarchar(MAX) | |
| “PGDownImageURL”: null | Pogas uz leju bilde | nvarchar(MAX) | |
| } | |||
| }, | |||
| “Layouts”: [ | Skati | ||
| { | |||
| “id”: 12, | Skata ID | int | |
| “name”: “Primary_Bareca_LV”, | Skata Nosaukums | nvarchar(MAX) | |
| “backgroundColor”: “#363439”, | Fona Krāsa | nvarchar(MAX) | |
| “backgroundImage”: “”, | Fona Bilde | nvarchar(MAX) | |
| “buttons”: [ | Pogas | ||
| { | |||
| “ButtonName”: “1”, | Pogas nosaukums | nvarchar(100) | |
| “BGColor”: “#9D9D9D”, | Pogas krāsa | varchar(7) | |
| “FontColor”: “#FFFFFF”, | Fonta krāsa | varchar(7) | |
| “FontSize”: 32, | Fonta izmērs | int | |
| “FontFamily”: “helvetica”, | Fonts | varchar(25) | |
| “ImageURL”: “”, | Pogas bilde | nvarchar(254) | |
| “FontWeightBold”: “1”, | Treknraksts | bit | |
| “FontStyleItalic”: “0”, | Slīpraksts | bit | |
| “FontUnderline”: “0”, | Pasvītrojums | bit | |
| “FontStrikethrough”: “0”, | Pārsvītrojums | bit | |
| “FontAlignment”: “0”, | teksta izlīdzināšana | bit | |
| “Functions”: [ | Pogas funkcija | ||
| { | |||
| “FunctionName”: “input”, | Funkcijas nosaukums | nvarchar(MAX) | |
| “Parameter1”: “1”, | Parametrs 1 | nvarchar(MAX) | |
| “Parameter2”: null | Parametrs 2 | nvarchar(MAX) | |
| } | |||
| ], | |||
| “PosX”: 11, | Pogas X kordināte | int | |
| “PosY”: 12, | Pogas y kordināte | int | |
| “SizeX”: 2, | Pogas platums | int | |
| “SizeY”: 1 | Pogas augstums | int | |
| } | |||
| ] | |||
| } | |||
| ] | |||
| } | |||
| “ProductDepartments”: [ | Produktu nodaļas – masīvs | Nē | |
| { | |||
| “departmentId”: 3, | Nodaļas identifikators | Jā | int |
| “departmentName”: “Tabaka”, | Nodaļas nosaukums | Jā | nvarchar(max) |
| “departmentCode”: “04010”, | Predefinētās nodaļas Skandināvu tirgum | Nē | nvarchar(max) |
| “departmentNegative”: false, | Ja true, tad prece paredzēta tikai atmaksai (depozīta pieņemšana) | Nē | bool |
| “action”: 0 | 0 – jauns vai rediģēt / 1 – dzēst | Nē | int |
| } | |||
| ] | |||
| } | |||
| } |
Transakciju sinhronizācija ar integrēto sistēmu
Resico KS izmanto HTTP POST pieprasījumus, lai nodotu integrētajai datu bāzes programmai informāciju par KS notikušajām transakcijām.
KS POST pieprasījumu HTTPS URL parametros ir definēts unikāls klienta ID u
Visos POS sistēmas pieprasījumos satura formāts tiek definēts kā Content-Type: application/json
Ar noklusējma uzstādījumiem POST pieprasījumi no POS sistēmām tiek veikti uzreiz pēc katra notikuša darījuma. Iestatījumos iespējams noteikt periodisku datu nodošanas opciju, vai iespēju nodot visas transakcijas pēc dienas slēgšanas KS (Z atskaite).
Kases sistēma sūta katru transakciju tikai vienu reizi.
Lai kase uzskatītu, ka transakcija ir veiksmīgi saņemta un apstrādāta, serverim obligāti jāatgriež statusa kods 200 (OK) un atbildes saturs OK.
Ja netiek saņemts gan HTTP 200, gan atbildes body OK, kase uzskatīs, ka pieprasījums nav bijis veiksmīgs, un var mēģināt transakciju nosūtīt atkārtoti.
Datu sinhronizācijas datu piemērs
POST
curl –location ‘https://retail.resico.com/api/resicowin/v1/e041eb1d2054ea6361cf3d260b2f3d8e/transactions’ \
–header ‘Authorization: apikey 6c01d639b588c3e614424b3b1101a4c5’ \
–header ‘Content-Type: application/json’ \
| –data ‘{ | |
| “clientCode”: “e041eb1d2054ea6361cf3d260b2f3d8e”, | Klienta kods |
| “hardwareID”: “0F62488CE2E2B2C7DC4E68C935D13ABB”, | Kases sistēmas iekārtas unikāls idenfifikators |
| “Transactions”: [ | Transakciju masīvs |
| { | |
| “Flight”: null, | Reisa numurs (lidostām) |
| “BonusPoints”: 7, | Bonusa punkti = |
| “Journal”: null, | |
| “membershipPoints”: 0, | |
| “Void”: false, | “False”, ja normāls pabeigts, apmaksāts dokuments. “true”, ja kasieris atcēla iesākto darījumu un dokuments nav apmaksāts. |
| “SalesLines”: [ | Darījuma visu rindu masīvs |
| { | |
| “ActualAmount”: 55, | Summa bez atlaidēm / uzcenojumiem |
| “ActualSalesAmount”: 55, | Summa ar atlaidēm / uzcenojumiem |
| “ReturnFlag”: false, | Atgriešanas pazīme |
| “ItemSn”: [], | Produktu sērijas numuri |
| “AdjustmentAmount”: 0, | Atlaides / uzcenojuma summa |
| “LineSeqNo”: 0, | Rindas kārtas numurs darījumā |
| “ItemNo”: “126”, | Produkta numurs |
| “Quantity”: 1, | Daudzums rindā |
| “ActualPrice”: 55, | Produkta vienības cena |
| “VATid”: “A”, | PVN identifikators |
| “LineVoidFlag”: false, | Atceltai un korekcijas rindai “true” |
| “VATpercentage”: 0.25, | PVN likme / 100 |
| “Correction”: false, | Korekcijas rindai “true” |
| “ItemName”: “STOR SODAVAND”, | Produkta nosaukums |
| “UnitOfMeasure”: “1”, | Mērvienības kods |
| “UnitOfMeasureName”: “STK”, | Mērvienības nosaukums |
| “StandardUOM”: true, | Ja svītrkodā cita mērvienība, tad false |
| “Guest”: 1, | Viesa identifikators |
| “Course”: 1, | Galdiņa identifikators |
| “KitchenComment”: null, | Virtuves komentārs |
| “Options”: null, | Izvēlētās produkta opcijas. |
| “department”: 4, | Produkta nodaļas kods |
| “Comment”: null, | Rindas komentārs |
| “Started”: “2023-11-20 17:55:00”, | Rindas izveides datums un laiks |
| “VoidComment”: null | Atcelšanas komentārs (iemesls) |
| }, | |
| { | |
| …….. | |
| }, | |
| { | |
| …….. | |
| }, | |
| { | |
| …….. | |
| } | |
| ], | |
| “Total”: 383, | Kopsumma |
| “PaymentLines”: [ | Maksājuma rindas no kurām var nolasīt ar ko ir veikta apmaksa un kādā apmērā. Varbūt vairākas rindas. Ja ir izdošana, būs negatīvas rindas, jāsummē pēc maksājuma metodes tipa. |
| { | |
| “ReturnFlag”: false, | Atgriešanas pazīme |
| “PaymentCode”: 2, | Maksājuma tipa kods |
| “Amount”: 383, | Maksājuma summa |
| “LineSeqNo”: 0, | Maksājuma rindas kārtas numurs |
| “VoidFlag”: false, | “false”, ja maksājuma rinda atcelta. Var ignorēt, ja šāda info integrējamajā sistēmā nav vajadzīga. |
| “GiftCardNr”: null, | Dāvanu kartes numurs, ja apmaksāts ar dāvanu karti. |
| “PaymentName”: “Karte”, | Apmaksas veida nosaukums |
| “CardIssuerId”: null, | Tikai NETS karšu terminālim |
| “CardIssuerName”: null | Tikai NETS karšu terminālim |
| } | |
| ], | |
| “report”: null, | Pārskata perioda atskaites dati, ja tips ir “Zreport” |
| “TransactionNo”: 48185, | Transakcijas numurs |
| “TrDateTime”: “2023-11-20 18:35:59”, | Darījuma datums un laiks |
| “ShiftNo”: 649, | Pārskata perioda numurs |
| “Status”: 2, | Vienmēr 2 – Pabeigta transakcija |
| “WorkerNo”: 111, | Operatora (kasiera) identifikators |
| “Type”: “Sales”, | Transakcijas tips: Sales – Pārdošana ZReport – Z atskaite StartAmount – Maiņas naudas ielikšana BankDrop – Inkasācija (Banka) SafeDrop – Inkasācija (Seifs) Void – Atcelts darījums BuyBack – Uzpirkšanas darījums (Tara) |
| “Comment”: null, | Čeka komentārs |
| “ReturnFlag”: false, | “True”, ja noformēts atgriešanas darījums |
| “CustomerID”: null, | Klienta identifikators |
| “Rounding”: 0, | Noapaļojums |
| “FiscalDocumentNo”: 8908, | Čeka numurs (fiskālais) |
| “BasketID”: 32, | Groza numurs, ja darījums ienācis no integrētās sistēmas kā “Darījumu grozs” |
| “Table”: “Table 9”, | Galdiņa identifikators |
| “LoyaltyCardId”: null, | Lojalitātes kartes numurs |
| “Started”: “2023-11-20 17:54:58”, | Transakcijas uzsākšanas datums un laiks |
| “VoidComment”: null | Atcelšanas komentārs (iemesls) |
| } | |
| ] | |
| } | |
| Response: | |
| OK |
Produktu grozu informācijas nodošana KS
Grozu saraksts/ apmaksājamo dokumentu saraksts ar klienta informāciju:
GET
curl –location ‘https://dev.resico.com/api/resicowin/v1/e041eb1d2054ea6361cf3d260b2f3d8e/baskets’ \
–header ‘Authorization: apikey d2af303095c7d716d5094ba350465acc‘ \
–header ‘Content-Type: application/json’
Ar sarkanu iekrāsota konfigurācijā norādāmā URL daļa, kura norāda uz integrējamo sistēmu.
Ar zaļu iekrāsots klienta kods – katram klientam ir unikāls. Visām klienta kasēm būs vienāds.
Atbildes piemērs:
| Apraksts | Obligāts Jā / Nē | Lauka tips | Lauks tiek izmantots no KS versijas | |
| [ | Masīvs ar visiem šobrīd uz apmaksu gaidošajiem dokumentiem. Ja tādu nav tad kase sagaida tukšu masīvu [] | |||
| { | ||||
| “id”:38, | Groza identifikātors. Pēc tam tiks sūtīts transakcijā | Jā | int | |
| “Description”:”SI-2023-0018″, | Apraksts, nosaukums – uzrādās grozu sarakstā. Čekā kā komentārs | Jā | nvarchar(max) | |
| “CustomerID”:”5″, | Klienta identifikatots – jābūt skaitlim | Jā | varchar(32) | |
| “customerName”:”Richard John Cyril Allen”, | Klienta nosaukums / vārds | Jā | nvarchar(max) | |
| “customerAddress”:”1 Holborn Ave, Dronfield”, | klienta adrese | Nē | nvarchar(max) | |
| “customerPhone”:”+44 1246 415270″, | Klienta telefona Nr | Nē | nvarchar(max) | |
| “customerEmail”: ”richard@arksheffield.co.uk”, | klienta e-pasta adrese | Nē | nvarchar(max) | |
| “customerRegistrationNo”:”123456″, | klienta reģistrācijas numurs | Jā | nvarchar(max) | |
| “customerTaxPayerID”:”LV123456″ | klienta PVN maksātāja Nr | Nē | nvarchar(max) | |
| }, | ||||
| { | ||||
| “id”:39, | ||||
| “CustomerID”:”2″, | ||||
| “Description”:”SI-2023-0019″, | ||||
| “customerName”:”Northwick Park Hospital”, | ||||
| “customerAddress”:”Watford Rd, Harrow”, | ||||
| “customerPhone”:” +44 20 8864 3232″, | ||||
| “customerEmail”:lnwh-tr.FOI@nhs.net, | ||||
| “customerRegistrationNo”:”2548945292253″, | ||||
| “customerTaxPayerID”:”UK2548945292253″ | ||||
| ] |
Konkrētā Groza / dokumenta pieprasījums:
GET
curl –location ‘https://dev.resico.com/api/resicowin/v1/e041eb1d2054ea6361cf3d260b2f3d8e/baskets/38‘ \
–header ‘Authorization: apikey 6c01d639b588c3e614424b3b1101a4c5‘ \
–header ‘Content-Type: application/json’
Ar sarkanu iekrāsota konfigurācijā norādāmā URL daļa, kura norāda uz integrējamo sistēmu.
Ar zaļu iekrāsots klienta kods – katram klientam ir unikāls. Visām klienta kasēm būs vienāds.
Ar violetu iekrāsotais ir groza/dokumenta numurs
Atbildes piemērs:
| Apraksts | Obligāts Jā / Nē | Lauka tips | Lauks tiek izmantots no KS versijas | |
| { | ||||
| “header”:{ | ||||
| “id”:38, | Groza identifikātors. Pēc tam tiks sūtīts transakcijā | Jā | int | |
| “Description”:”SI-2023-0018″, | Apraksts, nosaukums – uzrādās grozu sarakstā. Čekā kā komentārs | Jā | nvarchar(max) | |
| “CustomerID”:”5″, | Klienta identifikatots – jābūt skaitlim | Jā | varchar(32) | |
| “customerName”:”Richard John Cyril Allen”, | Klienta nosaukums / vārds | Jā | nvarchar(max) | |
| “customerAddress”:”1 Holborn Ave, Dronfield”, | klienta adrese | Nē | nvarchar(max) | |
| “customerPhone”:”+44 1246 415270″, | Klienta telefona Nr | Nē | nvarchar(max) | |
| “customerEmail”: ”richard@arksheffield.co.uk”, | klienta e-pasta adrese | Nē | nvarchar(max) | |
| “customerRegistrationNo”:”123456″, | klienta reģistrācijas numurs | Jā | nvarchar(max) | |
| “customerTaxPayerID”:”LV123456″ | klienta PVN maksātāja Nr | Nē | nvarchar(max) | |
| “TotalValueDiscount”:0 | Kopējā groza atlaide % | Nē | decimal | |
| }, | ||||
| “lines”:[ | masīvs […] | |||
| { | ||||
| “ItemNo”:”1000010″, | Preces numurs – identifikators | Jā | varchar(50) | |
| “Price”:”20.0000″, | cena | Jā | string->decimal | |
| “Qty”:”1.0000″, | skaits | Jā | string->decimal | |
| “VATid”:”A” | PVN identifikātors kas izmantojasm šai konkrētajā darījumā. A,B,C,D,X,Y pēc iepriekš saskaņotas relācijas. | Jā | varchar(1) | |
| “UOM”:”gb” | Mērvienības identifikātors pēc iepriekš saskaņotas relācijas | Jā | nvarchar(10) | |
| “SerialNumber”:[], | Produktu sērijas numuri | Nē | String masīvs | |
| }, … | ||||
| } |
Atlikuma pārbaude
curl –location ‘https://dev.resico.com/api/resicowin/v1/e041eb1d2054ea6361cf3d260b2f3d8e/balance/1000006‘ \
–header ‘Authorization: apikey 6c01d639b588c3e614424b3b1101a4c5’ \
–header ‘Content-Type: application/json’
Ar zaļu iekrāsots klienta kods – katram klientam ir unikāls. Visām klienta kasēm būs vienāds.
Ar violetu iekrāsotais ir produkta nr.
| Apraksts | Obligāts Jā / Nē | Lauka tips | |
| Request: GET | Pieprasījuma metode | ||
| https://dev.resico.com/api/resicowin/v1/e041eb1d2054ea6361cf3d260b2f3d8e/balance/1000006: | API URL/balance/Product ID | ||
| header: | |||
| Authorization: Bearer 6c01d639b588c3e614424b3b1101a4c5 | Autorizācijas tokens | ||
| body: | |||
| Response: | |||
| { | |||
| “2”: { | Lokācijas kods, nav jāsakrtīt ar faktisko lokācijas kodu, jo tas netiek nekur glabāts un atrādīts. Galvenais, ka atlikums sakrīt ar lokācijas nosaukuma atlikumu |
Jā | |
| “balance”: -1, | Atlikums lokācijā | Jā | decimal |
| “location_id”: 2, | Lokācijas ID | Jā | int |
| “location_name”: “Noliktava (2)” | Lokācijas nosaukums | Jā | string |
| }, | |||
| “1”: { | Lokācijas kods, nav jāsakrtīt ar faktisko lokācijas kodu, jo tas netiek nekur glabāts un atrādīts. Galvenais, ka atlikums sakrīt ar lokācijas nosaukuma atlikumu |
Jā | |
| “balance”: -39, | Atlikums lokācijā | Jā | decimal |
| “location_id”: 1, | Lokācijas ID | Jā | int |
| “location_name”: “Veikals (1)” | Lokācijas nosaukums | Jā | string |
| }, | |||
| “Totals”: { | Speciāla lokācija kopējam atlikumam, šo lauku var saukt jebkā, jo sistēma uztvers kopējo atlikumu kā to, kuram nav “location_id” | Jā | |
| “balance”: -40 | Kopējais atlikums | Jā | decimal |
| } | |||
| } |
Pārdošanas ierobežojums, pārbauda vai noliktavā ir atlikums
–header ‘Content-Type: application/json’
Ar zaļu iekrāsots klienta kods – katram klientam ir unikāls. Visām klienta kasēm būs vienāds.
Ar violetu iekrāsotais ir produkta nr.
| Apraksts | Obligāts Jā / Nē | Lauka tips | |
| Request: GET | Pieprasījuma metode | ||
| https://dev.resico.com/api/resicowin/v1/e041eb1d2054ea6361cf3d260b2f3d8e/balance/1000006/3: | API URL/balance/Product ID/Lokācijas ID | ||
| header: | |||
| Authorization: Bearer 6c01d639b588c3e614424b3b1101a4c5 | |||
| body: | |||
| Response: | |||
| { | |||
| “balance”: -133 | Atlikums | Jā | decimal |
| } |
Dāvanu karšu datubāzes integrācija
Dāvanu karšu datubāzes integrācija izmantojama gadījumos, ja DK datubāzi nepieciešams uzturēt ārpus Resico ERP sistēmas.
DK informācijas pieprasījums
Paredzēts tikai kartes informācijas saņemšanai no servera. Izmanto kartes informācijas attēlošanai uz ekrāna un statusu pārbaudei pirms pārdošanas vai atprečošanas.
GET
curl –location
{base_url}/cards/{client_code}/{card_search_id}
–header ‘Authorization: Bearer {api_key} ‘ \
–header ‘Content-Type: application/json’
URL piemērs: https://www.api.resico.com/api/giftcards/v1/cards/XXX78600ff07139489ffe6c33xxx/1000025210483
Ar sarkanu iekrāsota konfigurācijā norādāmā URL daļa, kura norāda uz integrējamo sistēmu.
Ar zaļu iekrāsots klienta kods – katram klientam ir unikāls. Visām klienta kasēm būs vienāds.
Ar violetu iekrāsotais ir DK numurs
Ar oranžu iekrāsota autorizācijas atslēga
|
Response: |
json |
|
|
{ |
||
|
“OriginalBalance”: “5.00”, |
string |
* Sākotnējais balanss. |
|
“CurrentBalance”: “5.00”, |
string as decimal |
Aktuālais balanss. Kase neļaus atprečot par lielāku summu |
|
“IsAmountFixed”: 1, |
int |
1 = fiksēta vērtība / 0 = maināma vērtība. Ja ir fiksēta summa, tad kasē nav iespējams nomainīt kartes vērtību piepārdošanas |
|
“IsRedeemAllowed”: 0, |
int |
0 = daļēja atprečošana nav atļauta/ 1 = atļauta. Ja nav atļauta, tad pēc atprečošanas karte kļūst izlietota neatkarīgi no kartes vērtības un pirkuma summas |
|
“LocationCode”: ” (10483)”, |
string |
* Pārdošanas vieta (veikals), ja ir pārdota |
|
“CardStatus”: “active”, |
string |
Kartes satuss. Iespējamās vērtības: |
|
“ValidityPeriod”: 0, |
int |
* Kartes derīguma periods menešos. 0 = bezlimita. Ja 0, tad attēlojas “-“ |
|
“SearchID”: “1000025210483”, |
string |
Kartes numurs – tas pats kas url beigās |
|
“TransactionNo”: null, |
int? |
* Transakcijas id, kurā veikta kartes pārdošana, ja ir pārdota. Ja null, tad attēlojas “-“ |
|
“BatchNote”: “”, |
string |
* Partijas piezīme |
|
“ExpiryDate”: null, |
string |
Derīguma termiņš pēc pārdošanas. (pārdošanas datums + derīguma periods, mēn.) Iespējamie formāti: “dd-MM-yyyy” vai “yyyy-MM-dd”, |
|
“MinAmount”: 5, |
int |
Minimālā kartes vērtiba, kartēm ar maināmu vērtību pie pārdošanas. Kase neļaus ievadīt mazāku summu |
|
“MaxAmount”: 100, |
int |
Maksimālā kartes vērtiba, kartēm ar maināmu vērtību pie pārdošanas. Kase neļaus ievadīt lielāku summu |
|
} |
||
|
* – Lauks paredzēts tikai attēlošanai kartes informācijas logā. Nav funkcionālas nozīmes |
!!! Jebkura kļūdaina atbilde vai neatbilstošs json formāts tiek uzskatīts, ka karte neeksistē.
Situācijā, kad dāvanu karte netiek atrasta, sistēmai jāatgriež 200 atbilde, savukārt pazīme, ka karte neeksistē, ir atbildes saturs, kas neatbilst korektajam kartes formātam, piemēram — tukšs masīvs.
DK rezervācija
Šis pieprasījums iestata DK statusu “reserved”.
GET
curl –location
{base_url}/reserve/{client_code}/{card_search_id}
–header ‘Authorization: Bearer {api_key} ‘ \
–header ‘Content-Type: application/json’
–data ‘{ “locationCode”: “LOC123“}’
URL piemērs: https://www.api.resico.com/api/giftcards/v1/reserve/XXX78600ff07139489ffe6c33xxx/1000025210483
Ar sarkanu iekrāsota konfigurācijā norādāmā URL daļa, kura norāda uz integrējamo sistēmu.
Ar zaļu iekrāsots klienta kods – katram klientam ir unikāls. Visām klienta kasēm būs vienāds.
Ar violetu iekrāsotais ir DK numurs
Ar oranžu iekrāsota autorizācijas atslēga
Ar gaiši zilu iekrāsota pārdošanas vietas / veikala kods.
Response netiek izmantots.
DK rezervācijas atcelšana
Šis pieprasījums iestata DK statusu no “reserved” uz “active”.
GET
curl –location
{base_url}/cancelreserve/{client_code}/{card_search_id}
–header ‘Authorization: Bearer {api_key} ‘ \
–header ‘Content-Type: application/json’
URL piemērs: https://www.api.resico.com/api/giftcards/v1/cancelreserve/XXX78600ff07139489ffe6c33xxx/1000025210483
Ar sarkanu iekrāsota konfigurācijā norādāmā URL daļa, kura norāda uz integrējamo sistēmu.
Ar zaļu iekrāsots klienta kods – katram klientam ir unikāls. Visām klienta kasēm būs vienāds.
Ar violetu iekrāsotais ir DK numurs
Ar oranžu iekrāsota autorizācijas atslēga
Response netiek izmantots.
DK realizācija / pārdošana
Šis pieprasījums iestata DK statusu no “active” uz “sold”.
POST
curl –location
{base_url}/cards/{client_code}/{card_search_id}
–header ‘Authorization: Bearer {api_key} ‘ \
–header ‘Content-Type: application/json’
–data ‘{
|
“locationCode”: “Store1”, |
string |
pārdošanas vietas (veikala) kods |
|
“pos_id”: “0001”, |
string |
kases id |
|
“amount”: 5.00, |
decimal |
vērtība, par kādu pārdota karte |
|
“transactionNo”: 4 |
int |
Fiskālā dokumenta numurs (čeka numurs) |
}’
URL piemērs: https://www.api.resico.com/api/giftcards/v1/cards/XXX78600ff07139489ffe6c33xxx/1000025210483
Ar sarkanu iekrāsota konfigurācijā norādāmā URL daļa, kura norāda uz integrējamo sistēmu.
Ar zaļu iekrāsots klienta kods – katram klientam ir unikāls. Visām klienta kasēm būs vienāds.
Ar violetu iekrāsotais ir DK numurs.
Ar oranžu iekrāsota autorizācijas atslēga.
Response netiek izmantots.
DK atprečošana (norēķins ar DK)
Šis pieprasījums pārrēķina DK pieejamo bilanci un iestata DK statusu no “sold” uz “used”, ja karte pilnībā iztērēta.
POST
curl –location
{base_url}/transactions/{client_code}/{card_search_id}
–header ‘Authorization: Bearer {api_key} ‘ \
–header ‘Content-Type: application/json’
–data ‘{
|
“locationCode”: “Store1”, |
string |
pārdošanas vietas (veikala) kods |
|
“amount”: 5.00, |
decimal |
vērtība, par kādu pārdota karte |
|
“transactionNo”: 4 |
int |
Fiskālā dokumenta numurs (čeka numurs) |
}’
URL piemērs: https://www.api.resico.com/api/giftcards/v1/ transactions /XXX78600ff07139489ffe6c33xxx/1000025210483
Ar sarkanu iekrāsota konfigurācijā norādāmā URL daļa, kura norāda uz integrējamo sistēmu.
Ar zaļu iekrāsots klienta kods – katram klientam ir unikāls. Visām klienta kasēm būs vienāds.
Ar violetu iekrāsotais ir DK numurs
Ar oranžu iekrāsota autorizācijas atslēga
Response tāds pats kā DK informācijas GET pieprasījumam, nav obligāts.
