WinShopAPI docs
ReferenceItem lists

Pos

List pos

GET
/api/item-lists/pos

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Response Body

application/json
  1. response
[index: integer]?

List view of a cash register (till).

curl -X GET 'https://<your-instance>/api/item-lists/pos' \  -H 'Authorization: Bearer <access-token>'
[  {    "description": "string",    "id": 0,    "isInTestMode": true,    "isInactive": true,    "name": "string",    "number": "stri",    "posType": 0,    "terminalName": "string",    "warehouseId": 0  }]

Create a cash register

POST
/api/item-lists/pos

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Request Body

application/json
  1. body

Full configuration of a cash register. Read through GET api/item-lists/pos/{id}/detail and written by the create/update routes; the till itself reads the same columns at boot.

description?|
Lengthlength <= 100
id?integer
Formatint32
isInTestMode?boolean|null
isInactive?boolean|null
name?|
Lengthlength <= 50
number?|
Lengthlength <= 4
posType?|
Formatint32
terminalName?|

Device id the till app mints for itself. The API resolves a till's cash register through it on every token issuance, so it must stay unique and cannot change once a device is enrolled.

Lengthlength <= 30
warehouseId?|
Formatint32
a4PrinterName?|
Lengthlength <= 80
a4PrinterNameDocumentsOverLimit?|
Lengthlength <= 80
advertisingText?string|null
allowInvoicing?boolean|null
applyDiscountFromWarehousePrice?boolean|null
banDiscountOnItemsInPromo?boolean|null
bank?|
Lengthlength <= 50
bankAccountNumber?|
Lengthlength <= 50
bankCode?|
Lengthlength <= 4
barcodeScannerComPort?|
Formatint32
barcodeScannerType?|
Formatint32
bindingOrderText?string|null
branchAddress1?|
Lengthlength <= 80
branchAddress2?|
Lengthlength <= 80
branchAddress3?|
Lengthlength <= 80
branchAddress4?|
Lengthlength <= 80
branchCity?|
Lengthlength <= 80
branchCompanyIdentificationNumber?|
Lengthlength <= 10
branchCountry?|
Lengthlength <= 40
branchName?|
Lengthlength <= 80
branchShortcut?|
Lengthlength <= 20
branchVATRegistrationNumber?|
Lengthlength <= 15
branchZipCode?|
Lengthlength <= 6
businessRegister?string|null
cannotProcessOrdersCustomer?boolean|null
cannotProcessOrdersInternet?boolean|null
claimProtocolText?string|null
constantSymbol?|
Lengthlength <= 4
currency?|
Lengthlength <= 3
discountPurposeMandatory?boolean|null
doNotAllowCustomerDiscount?boolean|null
doNotPrintReceiptWhenSentToEmail?boolean|null
eetCzBranchId?|
Lengthlength <= 50
eetCzModeId?|
Formatint32
eetCzPosTerminalId?|
Lengthlength <= 50
eetCzTimeout?|
Formatint32
eetCzVATRegistrationNumber?|
Lengthlength <= 50
enableDiscountFromManualPrice?boolean|null
enableReceiptDeferral?boolean|null
fiscalModule?boolean|null
ibanCode?|
Lengthlength <= 60
isOutlet?boolean|null
isSignotecSignatureDeliveryNoteEnabled?boolean|null
mandatoryLimitForDepositOfTurnoverToSafetyDeposit?|
Formatdecimal
morningBalance?|
Formatdecimal
onlyProductsInStock?boolean|null
paymentCreditPercentageBonus?|
Formatdecimal
paymentDisableCash?boolean|null
paymentDisableCashOnDelivery?boolean|null
paymentDisableCreditCard?boolean|null
paymentDisableForeignCurrency?boolean|null
paymentDisableInvoice?boolean|null
paymentDisableMealVoucher?boolean|null
paymentDisableVoucher?boolean|null
paymentPanelHideDelay?|
Formatint32
paymentTerminalId?|
Formatint32
paymentTerminalIp?|
Lengthlength <= 15
prefillAmountToPay?boolean|null
printDeferredReceipt?boolean|null
printDeferredReceiptOnRequest?boolean|null
printReceiptCopyOnCreditCardPayment?boolean|null
printerName?|
Lengthlength <= 80
printerType?|
Formatint32
purposeOfDepositMandatory?boolean|null
purposeOfWithdrawalMandatory?boolean|null
receiptFooterText?string|null
receiptHeaderText?string|null
receiptPrintOnRequest?boolean|null
sendReceiptToCustomersPrimaryEmailAutomatically?boolean|null
sendReceiptViaEmail?boolean|null
touchscreenKeyboardShowOnlyOnStock?boolean|null
touchscreenKeyboardShowProductCode?boolean|null
touchscreenKeyboardShowProductPrice?boolean|null
touchscreenKeyboardShowStockQuantity?boolean|null
touchscreenKeyboardTypeId?|
Formatint32
touchscreenSpeedCodesTypeId?|
Formatint32
warnWhenSellingBelowStockLevels?boolean|null

Response Body

application/json
  1. response

Full configuration of a cash register. Read through GET api/item-lists/pos/{id}/detail and written by the create/update routes; the till itself reads the same columns at boot.

description?|
Lengthlength <= 100
id?integer
Formatint32
isInTestMode?boolean|null
isInactive?boolean|null
name?|
Lengthlength <= 50
number?|
Lengthlength <= 4
posType?|
Formatint32
terminalName?|

Device id the till app mints for itself. The API resolves a till's cash register through it on every token issuance, so it must stay unique and cannot change once a device is enrolled.

Lengthlength <= 30
warehouseId?|
Formatint32
a4PrinterName?|
Lengthlength <= 80
a4PrinterNameDocumentsOverLimit?|
Lengthlength <= 80
advertisingText?string|null
allowInvoicing?boolean|null
applyDiscountFromWarehousePrice?boolean|null
banDiscountOnItemsInPromo?boolean|null
bank?|
Lengthlength <= 50
bankAccountNumber?|
Lengthlength <= 50
bankCode?|
Lengthlength <= 4
barcodeScannerComPort?|
Formatint32
barcodeScannerType?|
Formatint32
bindingOrderText?string|null
branchAddress1?|
Lengthlength <= 80
branchAddress2?|
Lengthlength <= 80
branchAddress3?|
Lengthlength <= 80
branchAddress4?|
Lengthlength <= 80
branchCity?|
Lengthlength <= 80
branchCompanyIdentificationNumber?|
Lengthlength <= 10
branchCountry?|
Lengthlength <= 40
branchName?|
Lengthlength <= 80
branchShortcut?|
Lengthlength <= 20
branchVATRegistrationNumber?|
Lengthlength <= 15
branchZipCode?|
Lengthlength <= 6
businessRegister?string|null
cannotProcessOrdersCustomer?boolean|null
cannotProcessOrdersInternet?boolean|null
claimProtocolText?string|null
constantSymbol?|
Lengthlength <= 4
currency?|
Lengthlength <= 3
discountPurposeMandatory?boolean|null
doNotAllowCustomerDiscount?boolean|null
doNotPrintReceiptWhenSentToEmail?boolean|null
eetCzBranchId?|
Lengthlength <= 50
eetCzModeId?|
Formatint32
eetCzPosTerminalId?|
Lengthlength <= 50
eetCzTimeout?|
Formatint32
eetCzVATRegistrationNumber?|
Lengthlength <= 50
enableDiscountFromManualPrice?boolean|null
enableReceiptDeferral?boolean|null
fiscalModule?boolean|null
ibanCode?|
Lengthlength <= 60
isOutlet?boolean|null
isSignotecSignatureDeliveryNoteEnabled?boolean|null
mandatoryLimitForDepositOfTurnoverToSafetyDeposit?|
Formatdecimal
morningBalance?|
Formatdecimal
onlyProductsInStock?boolean|null
paymentCreditPercentageBonus?|
Formatdecimal
paymentDisableCash?boolean|null
paymentDisableCashOnDelivery?boolean|null
paymentDisableCreditCard?boolean|null
paymentDisableForeignCurrency?boolean|null
paymentDisableInvoice?boolean|null
paymentDisableMealVoucher?boolean|null
paymentDisableVoucher?boolean|null
paymentPanelHideDelay?|
Formatint32
paymentTerminalId?|
Formatint32
paymentTerminalIp?|
Lengthlength <= 15
prefillAmountToPay?boolean|null
printDeferredReceipt?boolean|null
printDeferredReceiptOnRequest?boolean|null
printReceiptCopyOnCreditCardPayment?boolean|null
printerName?|
Lengthlength <= 80
printerType?|
Formatint32
purposeOfDepositMandatory?boolean|null
purposeOfWithdrawalMandatory?boolean|null
receiptFooterText?string|null
receiptHeaderText?string|null
receiptPrintOnRequest?boolean|null
sendReceiptToCustomersPrimaryEmailAutomatically?boolean|null
sendReceiptViaEmail?boolean|null
touchscreenKeyboardShowOnlyOnStock?boolean|null
touchscreenKeyboardShowProductCode?boolean|null
touchscreenKeyboardShowProductPrice?boolean|null
touchscreenKeyboardShowStockQuantity?boolean|null
touchscreenKeyboardTypeId?|
Formatint32
touchscreenSpeedCodesTypeId?|
Formatint32
warnWhenSellingBelowStockLevels?boolean|null
curl -X POST 'https://<your-instance>/api/item-lists/pos' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{}'
{  "description": "string",  "id": 0,  "isInTestMode": true,  "isInactive": true,  "name": "string",  "number": "stri",  "posType": 0,  "terminalName": "string",  "warehouseId": 0,  "a4PrinterName": "string",  "a4PrinterNameDocumentsOverLimit": "string",  "advertisingText": "string",  "allowInvoicing": true,  "applyDiscountFromWarehousePrice": true,  "banDiscountOnItemsInPromo": true,  "bank": "string",  "bankAccountNumber": "string",  "bankCode": "stri",  "barcodeScannerComPort": 0,  "barcodeScannerType": 0,  "bindingOrderText": "string",  "branchAddress1": "string",  "branchAddress2": "string",  "branchAddress3": "string",  "branchAddress4": "string",  "branchCity": "string",  "branchCompanyIdentificationNumber": "string",  "branchCountry": "string",  "branchName": "string",  "branchShortcut": "string",  "branchVATRegistrationNumber": "string",  "branchZipCode": "string",  "businessRegister": "string",  "cannotProcessOrdersCustomer": true,  "cannotProcessOrdersInternet": true,  "claimProtocolText": "string",  "constantSymbol": "stri",  "currency": "str",  "discountPurposeMandatory": true,  "doNotAllowCustomerDiscount": true,  "doNotPrintReceiptWhenSentToEmail": true,  "eetCzBranchId": "string",  "eetCzModeId": 0,  "eetCzPosTerminalId": "string",  "eetCzTimeout": 0,  "eetCzVATRegistrationNumber": "string",  "enableDiscountFromManualPrice": true,  "enableReceiptDeferral": true,  "fiscalModule": true,  "ibanCode": "string",  "isOutlet": true,  "isSignotecSignatureDeliveryNoteEnabled": true,  "mandatoryLimitForDepositOfTurnoverToSafetyDeposit": 0,  "morningBalance": 0,  "onlyProductsInStock": true,  "paymentCreditPercentageBonus": 0,  "paymentDisableCash": true,  "paymentDisableCashOnDelivery": true,  "paymentDisableCreditCard": true,  "paymentDisableForeignCurrency": true,  "paymentDisableInvoice": true,  "paymentDisableMealVoucher": true,  "paymentDisableVoucher": true,  "paymentPanelHideDelay": 0,  "paymentTerminalId": 0,  "paymentTerminalIp": "string",  "prefillAmountToPay": true,  "printDeferredReceipt": true,  "printDeferredReceiptOnRequest": true,  "printReceiptCopyOnCreditCardPayment": true,  "printerName": "string",  "printerType": 0,  "purposeOfDepositMandatory": true,  "purposeOfWithdrawalMandatory": true,  "receiptFooterText": "string",  "receiptHeaderText": "string",  "receiptPrintOnRequest": true,  "sendReceiptToCustomersPrimaryEmailAutomatically": true,  "sendReceiptViaEmail": true,  "touchscreenKeyboardShowOnlyOnStock": true,  "touchscreenKeyboardShowProductCode": true,  "touchscreenKeyboardShowProductPrice": true,  "touchscreenKeyboardShowStockQuantity": true,  "touchscreenKeyboardTypeId": 0,  "touchscreenSpeedCodesTypeId": 0,  "warnWhenSellingBelowStockLevels": true}

Get a po

GET
/api/item-lists/pos/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

id*integer
Formatint32

Response Body

application/json
  1. response

List view of a cash register (till).

description?|
Lengthlength <= 100
id?integer
Formatint32
isInTestMode?boolean|null
isInactive?boolean|null
name?|
Lengthlength <= 50
number?|
Lengthlength <= 4
posType?|
Formatint32
terminalName?|

Device id the till app mints for itself. The API resolves a till's cash register through it on every token issuance, so it must stay unique and cannot change once a device is enrolled.

Lengthlength <= 30
warehouseId?|
Formatint32
curl -X GET 'https://<your-instance>/api/item-lists/pos/0' \  -H 'Authorization: Bearer <access-token>'
{  "description": "string",  "id": 0,  "isInTestMode": true,  "isInactive": true,  "name": "string",  "number": "stri",  "posType": 0,  "terminalName": "string",  "warehouseId": 0}

Update a cash register

PATCH
/api/item-lists/pos/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

id*integer
Formatint32

Request Body

application/json
  1. body

Full configuration of a cash register. Read through GET api/item-lists/pos/{id}/detail and written by the create/update routes; the till itself reads the same columns at boot.

description?|
Lengthlength <= 100
id?integer
Formatint32
isInTestMode?boolean|null
isInactive?boolean|null
name?|
Lengthlength <= 50
number?|
Lengthlength <= 4
posType?|
Formatint32
terminalName?|

Device id the till app mints for itself. The API resolves a till's cash register through it on every token issuance, so it must stay unique and cannot change once a device is enrolled.

Lengthlength <= 30
warehouseId?|
Formatint32
a4PrinterName?|
Lengthlength <= 80
a4PrinterNameDocumentsOverLimit?|
Lengthlength <= 80
advertisingText?string|null
allowInvoicing?boolean|null
applyDiscountFromWarehousePrice?boolean|null
banDiscountOnItemsInPromo?boolean|null
bank?|
Lengthlength <= 50
bankAccountNumber?|
Lengthlength <= 50
bankCode?|
Lengthlength <= 4
barcodeScannerComPort?|
Formatint32
barcodeScannerType?|
Formatint32
bindingOrderText?string|null
branchAddress1?|
Lengthlength <= 80
branchAddress2?|
Lengthlength <= 80
branchAddress3?|
Lengthlength <= 80
branchAddress4?|
Lengthlength <= 80
branchCity?|
Lengthlength <= 80
branchCompanyIdentificationNumber?|
Lengthlength <= 10
branchCountry?|
Lengthlength <= 40
branchName?|
Lengthlength <= 80
branchShortcut?|
Lengthlength <= 20
branchVATRegistrationNumber?|
Lengthlength <= 15
branchZipCode?|
Lengthlength <= 6
businessRegister?string|null
cannotProcessOrdersCustomer?boolean|null
cannotProcessOrdersInternet?boolean|null
claimProtocolText?string|null
constantSymbol?|
Lengthlength <= 4
currency?|
Lengthlength <= 3
discountPurposeMandatory?boolean|null
doNotAllowCustomerDiscount?boolean|null
doNotPrintReceiptWhenSentToEmail?boolean|null
eetCzBranchId?|
Lengthlength <= 50
eetCzModeId?|
Formatint32
eetCzPosTerminalId?|
Lengthlength <= 50
eetCzTimeout?|
Formatint32
eetCzVATRegistrationNumber?|
Lengthlength <= 50
enableDiscountFromManualPrice?boolean|null
enableReceiptDeferral?boolean|null
fiscalModule?boolean|null
ibanCode?|
Lengthlength <= 60
isOutlet?boolean|null
isSignotecSignatureDeliveryNoteEnabled?boolean|null
mandatoryLimitForDepositOfTurnoverToSafetyDeposit?|
Formatdecimal
morningBalance?|
Formatdecimal
onlyProductsInStock?boolean|null
paymentCreditPercentageBonus?|
Formatdecimal
paymentDisableCash?boolean|null
paymentDisableCashOnDelivery?boolean|null
paymentDisableCreditCard?boolean|null
paymentDisableForeignCurrency?boolean|null
paymentDisableInvoice?boolean|null
paymentDisableMealVoucher?boolean|null
paymentDisableVoucher?boolean|null
paymentPanelHideDelay?|
Formatint32
paymentTerminalId?|
Formatint32
paymentTerminalIp?|
Lengthlength <= 15
prefillAmountToPay?boolean|null
printDeferredReceipt?boolean|null
printDeferredReceiptOnRequest?boolean|null
printReceiptCopyOnCreditCardPayment?boolean|null
printerName?|
Lengthlength <= 80
printerType?|
Formatint32
purposeOfDepositMandatory?boolean|null
purposeOfWithdrawalMandatory?boolean|null
receiptFooterText?string|null
receiptHeaderText?string|null
receiptPrintOnRequest?boolean|null
sendReceiptToCustomersPrimaryEmailAutomatically?boolean|null
sendReceiptViaEmail?boolean|null
touchscreenKeyboardShowOnlyOnStock?boolean|null
touchscreenKeyboardShowProductCode?boolean|null
touchscreenKeyboardShowProductPrice?boolean|null
touchscreenKeyboardShowStockQuantity?boolean|null
touchscreenKeyboardTypeId?|
Formatint32
touchscreenSpeedCodesTypeId?|
Formatint32
warnWhenSellingBelowStockLevels?boolean|null

Response Body

application/json
  1. response

Full configuration of a cash register. Read through GET api/item-lists/pos/{id}/detail and written by the create/update routes; the till itself reads the same columns at boot.

description?|
Lengthlength <= 100
id?integer
Formatint32
isInTestMode?boolean|null
isInactive?boolean|null
name?|
Lengthlength <= 50
number?|
Lengthlength <= 4
posType?|
Formatint32
terminalName?|

Device id the till app mints for itself. The API resolves a till's cash register through it on every token issuance, so it must stay unique and cannot change once a device is enrolled.

Lengthlength <= 30
warehouseId?|
Formatint32
a4PrinterName?|
Lengthlength <= 80
a4PrinterNameDocumentsOverLimit?|
Lengthlength <= 80
advertisingText?string|null
allowInvoicing?boolean|null
applyDiscountFromWarehousePrice?boolean|null
banDiscountOnItemsInPromo?boolean|null
bank?|
Lengthlength <= 50
bankAccountNumber?|
Lengthlength <= 50
bankCode?|
Lengthlength <= 4
barcodeScannerComPort?|
Formatint32
barcodeScannerType?|
Formatint32
bindingOrderText?string|null
branchAddress1?|
Lengthlength <= 80
branchAddress2?|
Lengthlength <= 80
branchAddress3?|
Lengthlength <= 80
branchAddress4?|
Lengthlength <= 80
branchCity?|
Lengthlength <= 80
branchCompanyIdentificationNumber?|
Lengthlength <= 10
branchCountry?|
Lengthlength <= 40
branchName?|
Lengthlength <= 80
branchShortcut?|
Lengthlength <= 20
branchVATRegistrationNumber?|
Lengthlength <= 15
branchZipCode?|
Lengthlength <= 6
businessRegister?string|null
cannotProcessOrdersCustomer?boolean|null
cannotProcessOrdersInternet?boolean|null
claimProtocolText?string|null
constantSymbol?|
Lengthlength <= 4
currency?|
Lengthlength <= 3
discountPurposeMandatory?boolean|null
doNotAllowCustomerDiscount?boolean|null
doNotPrintReceiptWhenSentToEmail?boolean|null
eetCzBranchId?|
Lengthlength <= 50
eetCzModeId?|
Formatint32
eetCzPosTerminalId?|
Lengthlength <= 50
eetCzTimeout?|
Formatint32
eetCzVATRegistrationNumber?|
Lengthlength <= 50
enableDiscountFromManualPrice?boolean|null
enableReceiptDeferral?boolean|null
fiscalModule?boolean|null
ibanCode?|
Lengthlength <= 60
isOutlet?boolean|null
isSignotecSignatureDeliveryNoteEnabled?boolean|null
mandatoryLimitForDepositOfTurnoverToSafetyDeposit?|
Formatdecimal
morningBalance?|
Formatdecimal
onlyProductsInStock?boolean|null
paymentCreditPercentageBonus?|
Formatdecimal
paymentDisableCash?boolean|null
paymentDisableCashOnDelivery?boolean|null
paymentDisableCreditCard?boolean|null
paymentDisableForeignCurrency?boolean|null
paymentDisableInvoice?boolean|null
paymentDisableMealVoucher?boolean|null
paymentDisableVoucher?boolean|null
paymentPanelHideDelay?|
Formatint32
paymentTerminalId?|
Formatint32
paymentTerminalIp?|
Lengthlength <= 15
prefillAmountToPay?boolean|null
printDeferredReceipt?boolean|null
printDeferredReceiptOnRequest?boolean|null
printReceiptCopyOnCreditCardPayment?boolean|null
printerName?|
Lengthlength <= 80
printerType?|
Formatint32
purposeOfDepositMandatory?boolean|null
purposeOfWithdrawalMandatory?boolean|null
receiptFooterText?string|null
receiptHeaderText?string|null
receiptPrintOnRequest?boolean|null
sendReceiptToCustomersPrimaryEmailAutomatically?boolean|null
sendReceiptViaEmail?boolean|null
touchscreenKeyboardShowOnlyOnStock?boolean|null
touchscreenKeyboardShowProductCode?boolean|null
touchscreenKeyboardShowProductPrice?boolean|null
touchscreenKeyboardShowStockQuantity?boolean|null
touchscreenKeyboardTypeId?|
Formatint32
touchscreenSpeedCodesTypeId?|
Formatint32
warnWhenSellingBelowStockLevels?boolean|null
curl -X PATCH 'https://<your-instance>/api/item-lists/pos/0' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{}'
{  "description": "string",  "id": 0,  "isInTestMode": true,  "isInactive": true,  "name": "string",  "number": "stri",  "posType": 0,  "terminalName": "string",  "warehouseId": 0,  "a4PrinterName": "string",  "a4PrinterNameDocumentsOverLimit": "string",  "advertisingText": "string",  "allowInvoicing": true,  "applyDiscountFromWarehousePrice": true,  "banDiscountOnItemsInPromo": true,  "bank": "string",  "bankAccountNumber": "string",  "bankCode": "stri",  "barcodeScannerComPort": 0,  "barcodeScannerType": 0,  "bindingOrderText": "string",  "branchAddress1": "string",  "branchAddress2": "string",  "branchAddress3": "string",  "branchAddress4": "string",  "branchCity": "string",  "branchCompanyIdentificationNumber": "string",  "branchCountry": "string",  "branchName": "string",  "branchShortcut": "string",  "branchVATRegistrationNumber": "string",  "branchZipCode": "string",  "businessRegister": "string",  "cannotProcessOrdersCustomer": true,  "cannotProcessOrdersInternet": true,  "claimProtocolText": "string",  "constantSymbol": "stri",  "currency": "str",  "discountPurposeMandatory": true,  "doNotAllowCustomerDiscount": true,  "doNotPrintReceiptWhenSentToEmail": true,  "eetCzBranchId": "string",  "eetCzModeId": 0,  "eetCzPosTerminalId": "string",  "eetCzTimeout": 0,  "eetCzVATRegistrationNumber": "string",  "enableDiscountFromManualPrice": true,  "enableReceiptDeferral": true,  "fiscalModule": true,  "ibanCode": "string",  "isOutlet": true,  "isSignotecSignatureDeliveryNoteEnabled": true,  "mandatoryLimitForDepositOfTurnoverToSafetyDeposit": 0,  "morningBalance": 0,  "onlyProductsInStock": true,  "paymentCreditPercentageBonus": 0,  "paymentDisableCash": true,  "paymentDisableCashOnDelivery": true,  "paymentDisableCreditCard": true,  "paymentDisableForeignCurrency": true,  "paymentDisableInvoice": true,  "paymentDisableMealVoucher": true,  "paymentDisableVoucher": true,  "paymentPanelHideDelay": 0,  "paymentTerminalId": 0,  "paymentTerminalIp": "string",  "prefillAmountToPay": true,  "printDeferredReceipt": true,  "printDeferredReceiptOnRequest": true,  "printReceiptCopyOnCreditCardPayment": true,  "printerName": "string",  "printerType": 0,  "purposeOfDepositMandatory": true,  "purposeOfWithdrawalMandatory": true,  "receiptFooterText": "string",  "receiptHeaderText": "string",  "receiptPrintOnRequest": true,  "sendReceiptToCustomersPrimaryEmailAutomatically": true,  "sendReceiptViaEmail": true,  "touchscreenKeyboardShowOnlyOnStock": true,  "touchscreenKeyboardShowProductCode": true,  "touchscreenKeyboardShowProductPrice": true,  "touchscreenKeyboardShowStockQuantity": true,  "touchscreenKeyboardTypeId": 0,  "touchscreenSpeedCodesTypeId": 0,  "warnWhenSellingBelowStockLevels": true}

Delete a po

DELETE
/api/item-lists/pos/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

id*integer
Formatint32

Response Body

curl -X DELETE 'https://<your-instance>/api/item-lists/pos/0' \  -H 'Authorization: Bearer <access-token>'
Empty

Get a cash register

GET
/api/item-lists/pos/{id}/detail

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

id*integer
Formatint32

Response Body

application/json
  1. response

Full configuration of a cash register. Read through GET api/item-lists/pos/{id}/detail and written by the create/update routes; the till itself reads the same columns at boot.

description?|
Lengthlength <= 100
id?integer
Formatint32
isInTestMode?boolean|null
isInactive?boolean|null
name?|
Lengthlength <= 50
number?|
Lengthlength <= 4
posType?|
Formatint32
terminalName?|

Device id the till app mints for itself. The API resolves a till's cash register through it on every token issuance, so it must stay unique and cannot change once a device is enrolled.

Lengthlength <= 30
warehouseId?|
Formatint32
a4PrinterName?|
Lengthlength <= 80
a4PrinterNameDocumentsOverLimit?|
Lengthlength <= 80
advertisingText?string|null
allowInvoicing?boolean|null
applyDiscountFromWarehousePrice?boolean|null
banDiscountOnItemsInPromo?boolean|null
bank?|
Lengthlength <= 50
bankAccountNumber?|
Lengthlength <= 50
bankCode?|
Lengthlength <= 4
barcodeScannerComPort?|
Formatint32
barcodeScannerType?|
Formatint32
bindingOrderText?string|null
branchAddress1?|
Lengthlength <= 80
branchAddress2?|
Lengthlength <= 80
branchAddress3?|
Lengthlength <= 80
branchAddress4?|
Lengthlength <= 80
branchCity?|
Lengthlength <= 80
branchCompanyIdentificationNumber?|
Lengthlength <= 10
branchCountry?|
Lengthlength <= 40
branchName?|
Lengthlength <= 80
branchShortcut?|
Lengthlength <= 20
branchVATRegistrationNumber?|
Lengthlength <= 15
branchZipCode?|
Lengthlength <= 6
businessRegister?string|null
cannotProcessOrdersCustomer?boolean|null
cannotProcessOrdersInternet?boolean|null
claimProtocolText?string|null
constantSymbol?|
Lengthlength <= 4
currency?|
Lengthlength <= 3
discountPurposeMandatory?boolean|null
doNotAllowCustomerDiscount?boolean|null
doNotPrintReceiptWhenSentToEmail?boolean|null
eetCzBranchId?|
Lengthlength <= 50
eetCzModeId?|
Formatint32
eetCzPosTerminalId?|
Lengthlength <= 50
eetCzTimeout?|
Formatint32
eetCzVATRegistrationNumber?|
Lengthlength <= 50
enableDiscountFromManualPrice?boolean|null
enableReceiptDeferral?boolean|null
fiscalModule?boolean|null
ibanCode?|
Lengthlength <= 60
isOutlet?boolean|null
isSignotecSignatureDeliveryNoteEnabled?boolean|null
mandatoryLimitForDepositOfTurnoverToSafetyDeposit?|
Formatdecimal
morningBalance?|
Formatdecimal
onlyProductsInStock?boolean|null
paymentCreditPercentageBonus?|
Formatdecimal
paymentDisableCash?boolean|null
paymentDisableCashOnDelivery?boolean|null
paymentDisableCreditCard?boolean|null
paymentDisableForeignCurrency?boolean|null
paymentDisableInvoice?boolean|null
paymentDisableMealVoucher?boolean|null
paymentDisableVoucher?boolean|null
paymentPanelHideDelay?|
Formatint32
paymentTerminalId?|
Formatint32
paymentTerminalIp?|
Lengthlength <= 15
prefillAmountToPay?boolean|null
printDeferredReceipt?boolean|null
printDeferredReceiptOnRequest?boolean|null
printReceiptCopyOnCreditCardPayment?boolean|null
printerName?|
Lengthlength <= 80
printerType?|
Formatint32
purposeOfDepositMandatory?boolean|null
purposeOfWithdrawalMandatory?boolean|null
receiptFooterText?string|null
receiptHeaderText?string|null
receiptPrintOnRequest?boolean|null
sendReceiptToCustomersPrimaryEmailAutomatically?boolean|null
sendReceiptViaEmail?boolean|null
touchscreenKeyboardShowOnlyOnStock?boolean|null
touchscreenKeyboardShowProductCode?boolean|null
touchscreenKeyboardShowProductPrice?boolean|null
touchscreenKeyboardShowStockQuantity?boolean|null
touchscreenKeyboardTypeId?|
Formatint32
touchscreenSpeedCodesTypeId?|
Formatint32
warnWhenSellingBelowStockLevels?boolean|null
curl -X GET 'https://<your-instance>/api/item-lists/pos/0/detail' \  -H 'Authorization: Bearer <access-token>'
{  "description": "string",  "id": 0,  "isInTestMode": true,  "isInactive": true,  "name": "string",  "number": "stri",  "posType": 0,  "terminalName": "string",  "warehouseId": 0,  "a4PrinterName": "string",  "a4PrinterNameDocumentsOverLimit": "string",  "advertisingText": "string",  "allowInvoicing": true,  "applyDiscountFromWarehousePrice": true,  "banDiscountOnItemsInPromo": true,  "bank": "string",  "bankAccountNumber": "string",  "bankCode": "stri",  "barcodeScannerComPort": 0,  "barcodeScannerType": 0,  "bindingOrderText": "string",  "branchAddress1": "string",  "branchAddress2": "string",  "branchAddress3": "string",  "branchAddress4": "string",  "branchCity": "string",  "branchCompanyIdentificationNumber": "string",  "branchCountry": "string",  "branchName": "string",  "branchShortcut": "string",  "branchVATRegistrationNumber": "string",  "branchZipCode": "string",  "businessRegister": "string",  "cannotProcessOrdersCustomer": true,  "cannotProcessOrdersInternet": true,  "claimProtocolText": "string",  "constantSymbol": "stri",  "currency": "str",  "discountPurposeMandatory": true,  "doNotAllowCustomerDiscount": true,  "doNotPrintReceiptWhenSentToEmail": true,  "eetCzBranchId": "string",  "eetCzModeId": 0,  "eetCzPosTerminalId": "string",  "eetCzTimeout": 0,  "eetCzVATRegistrationNumber": "string",  "enableDiscountFromManualPrice": true,  "enableReceiptDeferral": true,  "fiscalModule": true,  "ibanCode": "string",  "isOutlet": true,  "isSignotecSignatureDeliveryNoteEnabled": true,  "mandatoryLimitForDepositOfTurnoverToSafetyDeposit": 0,  "morningBalance": 0,  "onlyProductsInStock": true,  "paymentCreditPercentageBonus": 0,  "paymentDisableCash": true,  "paymentDisableCashOnDelivery": true,  "paymentDisableCreditCard": true,  "paymentDisableForeignCurrency": true,  "paymentDisableInvoice": true,  "paymentDisableMealVoucher": true,  "paymentDisableVoucher": true,  "paymentPanelHideDelay": 0,  "paymentTerminalId": 0,  "paymentTerminalIp": "string",  "prefillAmountToPay": true,  "printDeferredReceipt": true,  "printDeferredReceiptOnRequest": true,  "printReceiptCopyOnCreditCardPayment": true,  "printerName": "string",  "printerType": 0,  "purposeOfDepositMandatory": true,  "purposeOfWithdrawalMandatory": true,  "receiptFooterText": "string",  "receiptHeaderText": "string",  "receiptPrintOnRequest": true,  "sendReceiptToCustomersPrimaryEmailAutomatically": true,  "sendReceiptViaEmail": true,  "touchscreenKeyboardShowOnlyOnStock": true,  "touchscreenKeyboardShowProductCode": true,  "touchscreenKeyboardShowProductPrice": true,  "touchscreenKeyboardShowStockQuantity": true,  "touchscreenKeyboardTypeId": 0,  "touchscreenSpeedCodesTypeId": 0,  "warnWhenSellingBelowStockLevels": true}