Select an item from the list at right side.
Errors ¶
Types ¶
Type | Description | |
---|---|---|
identifierType | string [1..50] ( ^(?!^(PRN|AUX|CLOCK\$|NUL|CON|COM\d|LPT\d|\.\.?)$)[^\x00-\x1f\\?*:\";|/<>]+$ ) |
|
corporateIdType | string [..95] ( ^(?!^(PRN|AUX|CLOCK\$|NUL|CON|COM\d|LPT\d|\.\.?)$)[^\x00-\x1f\\?*:\";|/<>]+$ ) | |
sellerIdType | string |
|
printTypeEnum | One of the following values: 'Normal', 'Copy', 'Proforma' |
|
controlUnitLocationType | One of the following values: 'DEVICE', 'REMOTE' |
|
countryType | string [2..2] |
|
cashRegisterNameType | string [..16] |
|
roleType | One of the following values: 'ROLE_HYPER_ADMIN', 'ROLE_SOFTWARE_VENDOR_ADMIN', 'SELLER_ADMIN', 'ACTIVATION' |
|
activationStatusType | One of the following values: 'ISSUED', 'ACTIVE', 'WORKING', 'CLOSED' | |
imageVersionType | One of the following values: 'current', 'version' | |
sellerFieldsType | One of the following values: 'COUNTRY', 'NAME' | |
ticketCategoryType | One of the following values: 'CONTROL_UNIT_BROKEN', 'ACTIVATION_ISSUED', 'CONTROL_UNIT_ADDRESS_CHANGED' | |
ticketStatusType | One of the following values: 'OPEN', 'CLOSED' | |
salesUnitType | One of the following values: 'Piece', 'Price', 'Kilogram', 'Hektogram', 'Meters', 'Centimeters', 'Hours', 'Minutes' | |
changeBalanceActionType | One of the following values: 'DEPOSIT', 'WITHDRAWAL' | |
deviceFormFactorType | One of the following values: 'PHONE', 'TABLET_SMALL', 'TABLET_BIG' | |
saleStateType | One of the following values: 'Open', 'Paid', 'Cancelled', 'Complete' | |
printType | One of the following values: 'Normal', 'Copy', 'Proforma' | |
deliveryType | One of the following values: 'Display', 'Print', 'SMS', 'Email', 'Discard', 'Journal' | |
paymentType | One of the following values: 'Cash', 'Card', 'WyWallet', 'PayEx', 'SEQR', 'AirPay', 'ClosePayment' | |
paymentStateType | One of the following values: 'SENDING', 'SENDING_FAILED', 'PENDING', 'APPROVED', 'REJECTED', 'PAUSED', 'CANCELLED', 'CHARGE_FAILED', 'CHARGE_UNKNOWN' | |
keyActionType | One of the following values: 'Product', 'SaleItemsView', 'POSSaleItemsView', 'Camera', 'InitiateReturn', 'InitSaleCash', 'InitSaleCard', 'InitSaleAirpay', 'InitSaleSEQR', 'InitSaleIZettle', 'InitSaleWyWallet', 'InitSalePayex', 'SubKeyboard', 'Numeric1', 'Numeric2', 'Numeric3', 'Numeric4', 'Numeric5', 'Numeric6', 'Numeric7', 'Numeric8', 'Numeric9', 'Numeric0', 'Numeric00', 'CurrencyUnit', 'ProductUnit', 'NumericReset', 'NumericDot', 'NumericBackspace', 'NumericIndicator', 'PercentDiscount', 'CurrencyDiscount', 'SendOrder', 'GetOrders', 'SubtotalIndicator', 'ProductsSearchView', 'GroupsProductsView', 'GroupsProductsTextView', 'TablesProductsView', 'TablesProductsTextView', 'NetworkIndicator', 'PrintProforma' | |
activationFeatureType | One of the following values: 'VOUCHERS', 'SEQR', 'WYWALLET', 'PAYEX', 'CLOSEPAYMENT', 'AIRPAY', 'SUPPORT', 'SYNCRONIZATION', 'MULTIUSERS', 'IZETTLE' | |
autoActivationConditionType | One of the following values: 'NEVER', 'ALWAYS', 'NO_FEATURES' |
|
corporateIdValidationMethodType | One of the following values: 'NONE', 'VALIDATE_SWEDISH' |
GET /v15/auth/handshake ¶
Request
Response
GET /v15/auth/handshake HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Description | |
---|---|
SellerNotFoundJsonException |
|
GET /v15/auth/user ¶
Request
Response
GET /v15/auth/user HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{/*Non-public information of user for super admins. It has password hash. */
'deleted': 'false', // True if entity was deleted. .
'username': 'username', //Regular field. . String. Minimum 1 characters. Maximum 50 characters. May NOT be null.
'email': 'mail@username.com', //User's email. . String. Minimum 6 characters. Maximum 50 characters. Regular expression
/^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
. May NOT be null.
'role': 'ROLE_SOFTWARE_VENDOR_ADMIN', // roleType. May NOT be null.
'softwareVendor': null, //
If role == ROLE_HYPER_ADMIN, then null.
If role == ROLE_SOFTWARE_VENDOR_ADMIN, then not null.
. Integer. May be null.
'password': '9999' // String. Maximum 200 characters. May NOT be null.
}
{/*
'username': 'username', //
'email': 'mail@username.com', //
'role': 'ROLE_SOFTWARE_VENDOR_ADMIN', // roleType. May NOT be null.
'softwareVendor': null, //
'password': '9999' // String. Maximum 200 characters. May NOT be null.
}
Description | |
---|---|
WrongUsernameOrPasswordJsonException |
|
SellerIsNotFoundJsonException |
|
POST /v15/noauth/activations/generate-production-number ¶
Request
Response
POST /v15/noauth/activations/generate-production-number HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Provides info about device */
'deviceId': '111AAA222BBB3-022', // Unique number of every Device . String. Minimum 1 characters. Maximum 17 characters. May NOT be null.
'buildInfo': {'KEY1':'VALUE1', 'KEY2':'VALUE2'}, //Information about the device. For instance for Android it can be taken from
android.os.Build
. A complex object. May be null.
'applicationPackage': 'com.pos4mobile', //A unique identifier of the software, but not it's version. For instance for Android it can be
getPackageName()
. String. Maximum 120 characters. May NOT be null.
'gcmRegistrationId': null //An identifier of the device on Google Cloud Message service . String. May be null.
}
'buildInfo': {'KEY1':'VALUE1', 'KEY2':'VALUE2'}, //
'applicationPackage': 'com.pos4mobile', //
'gcmRegistrationId': null //
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
{ 'productionNumber': 'TEST100000000000000000081' //ProductionNumber - serial number uniquely identifies instance of the Installation.
It represents production number of cash register according to Swedish regulations.
It has format "{softwareId}{number}". It must be unique number through the entire world.
According to swedish regulation, the definition is: Each cash register must have a production number.
Production number is a globally unique serial number on physical cash registers.
Production number has to be unique for each cash register from one vendor and should also
indicate vendor as a part of the field
. String. Maximum 25 characters. May NOT be null.
}
{ 'productionNumber': 'TEST100000000000000000081' //
}
Description | |
---|---|
ReferenceNotFoundJsonException |
|
POST /v15/noauth/activations/order-activation ¶
Request
Response
POST /v15/noauth/activations/order-activation HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* An order sent from end customer to srv4pos sales team to request an activation */
'installationOrderInfo': {/* Provides info about device */
'deviceId': '111AAA222BBB3-022', // Unique number of every Device . String. Minimum 1 characters. Maximum 17 characters. May NOT be null.
'buildInfo': {}, //Information about the device. For instance for Android it can be taken from
android.os.Build
. A complex object. May be null.
'applicationPackage': 'com.pos4mobile', //A unique identifier of the software, but not it's version. For instance for Android it can be
getPackageName()
. String. Maximum 120 characters. May NOT be null.
'gcmRegistrationId': null //An identifier of the device on Google Cloud Message service . String. May be null.
}, //At which device this activation should work . A complex object. May NOT be null.
'productionNumber': 'TEST100000000000000000081', //
ProductionNumber - serial number uniquely identifies instance of the Installation.
It represents production number of cash register according to Swedish regulations.
It has format "{softwareId}{number}". It must be unique number through the entire world.
According to swedish regulation, the definition is: Each cash register must have a production number.
Production number is a globally unique serial number on physical cash registers.
Production number has to be unique for each cash register from one vendor and should also
indicate vendor as a part of the field
. String. Maximum 25 characters. May NOT be null.
'country': 'se', // countryType. May NOT be null.
'corporateId': '9876543210', // corporateIdType. May NOT be null.
'companyName': 'MyExampleCompanyName', // String. May NOT be null.
'contactInfo': {/*Information about person. */
'name': 'Stefan', // Name of person who makes activation . String. May NOT be null.
'phone': '56745325', //Phone number of person who requests activation . String. May NOT be null.
'email': 'test@test.se' //Email of person who requests activation . String. May NOT be null.
}, //
Information about person who orders an activation. So sales team can contact him with invoice.
. A complex object. May NOT be null.
'activationDetailsInfo': {/*Information about activation period (when and which features are activated, per which period). */
'validFrom': 1414800000000, // When activation starts being active . Date: amount of milliseconds since UNIX epoch. May NOT be null.
'validTo': 1446336000000, //When activation ends being active . Date: amount of milliseconds since UNIX epoch. May NOT be null.
'features': [], //List of features . activationFeatureType. May NOT be null.
'controlUnitLocation': 'DEVICE', //Where control unit is connected and how . controlUnitLocationType. May NOT be null.
'controlUnitSerialNumber': null //
Serial number of contorl unit. It is null if "controlUnitLocation" == 'REMOTE'
or application doesn't support control units. Otherwise it might be null too
. String. May be null.
}, // A complex object. May NOT be null.
'deviceLocation': {/*Just simple address structure. */
'address': 'address', // String. May NOT be null.
'city': 'Koenig', // String. May NOT be null.
'postalCode': '45664' // String. May NOT be null.
}, //
Where device (with control unit) is located. This information is sent to taxation authority.
This field is set when customer makes an order and "controlUnitLocation" == 'DEVICE'.
If this field is set and sales person makes an activation, he must check it's validity because
it's content will be copied to controlUnit geolocation and will be applied for all the sellers
connected to this control unit
. A complex object. May be null.
'cashRegisterName': 'Cash1', // cashRegisterNameType. May NOT be null.
'comment': '' //Any information which user would like to tell to sales at srv4pos . String. May be null.
}
'buildInfo': {}, //
'applicationPackage': 'com.pos4mobile', //
'gcmRegistrationId': null //
}, //
'productionNumber': 'TEST100000000000000000081', //
'country': 'se', // countryType. May NOT be null.
'corporateId': '9876543210', // corporateIdType. May NOT be null.
'companyName': 'MyExampleCompanyName', // String. May NOT be null.
'contactInfo': {/*
'phone': '56745325', //
'email': 'test@test.se' //
}, //
'activationDetailsInfo': {/*
'validTo': 1446336000000, //
'features': [], //
'controlUnitLocation': 'DEVICE', //
'controlUnitSerialNumber': null //
}, // A complex object. May NOT be null.
'deviceLocation': {/*
'city': 'Koenig', // String. May NOT be null.
'postalCode': '45664' // String. May NOT be null.
}, //
'cashRegisterName': 'Cash1', // cashRegisterNameType. May NOT be null.
'comment': '' //
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
/* unqiue secure random identifier which represents activation ordered */
{ 'activationSecurityToken': 's854kfsdgfwqeigr23iu4ry9efh2o398y1r2y3hr' //
Securely randomly generated number, represents the order. It has to be passed to the server
to get an activation based on the order made
. String. May NOT be null.
}
{ 'activationSecurityToken': 's854kfsdgfwqeigr23iu4ry9efh2o398y1r2y3hr' //
}
Description | |
---|---|
ReferenceNotFoundJsonException |
|
CashRegisterNameIsNotUniqueJsonException |
|
InconsistentDataJsonException |
|
ValidationJsonException |
|
POST /v15/noauth/activations/cash-register-name/existance ¶
Request
Response
POST /v15/noauth/activations/cash-register-name/existance HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Parameters passed to ActivationService#cashRegisterNameExists(CashRegisterNameExistsInfo) */
'country': 'se', // countryType. May NOT be null.
'corporateId': '9876543210', // corporateIdType. May NOT be null.
'cashRegisterName': 'Cash1' // cashRegisterNameType. May NOT be null.
}
'corporateId': '9876543210', // corporateIdType. May NOT be null.
'cashRegisterName': 'Cash1' // cashRegisterNameType. May NOT be null.
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
{ 'exists': false //True if cash register with given name is already registered for particular seller . Boolean. May NOT be null.
}
{ 'exists': false //
}
GET /v15/activations/activation-code ¶
Request
Response
GET /v15/activations/activation-code HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'activationInfoVersion': 2, //
Version of data structure, returned by/activations/activation-code.
The device has to support all the previous versions to avoid reactivation.
Also this version changes when public/private key for "signature" generation is changed, or algorithm
of serializing "activationDescriptorInfo" is changed. Right now it is 2
. Integer. May NOT be null.
'activationDescriptorInfo': 'TODO show json here', //
Json serialized data returned by
/activations/activation-code
. String. May NOT be null.
'signature': 'TODO show signature here' //Digital signature of
activationDescriptorInfo
. String. May NOT be null.
}
{ 'activationInfoVersion': 2, //
'activationDescriptorInfo': 'TODO show json here', //
'signature': 'TODO show signature here' //
}
GET /v15/activations/{activationId} ¶
activationId | identifierType |
|
Request
Response
GET /v15/activations/ HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{/*Advanced information about activation which covers some fields by expanded structures. */
'activationInfo': {/* Represents server-side entity available for admin. */
'id': 4567, // Integer. May NOT be null.
'status': 'ISSUED', // activationStatusType. May NOT be null.
'issued': 14472336592, //
This field is set by activation server internal logic every time we do an action with the activation
. Date: amount of milliseconds since UNIX epoch. May NOT be null.
'controlUnitLocation': 'REMOTE', // controlUnitLocationType. May NOT be null.
'validFrom': 23, // Integer. May NOT be null.
'validTo': 67, // Integer. May NOT be null.
'sellerName': 'Test', //This field is set when customer makes an order. When order is approved by sales person this field will be written into the
Seller.
. String. Maximum 96 characters. May NOT be null.
'controlUnitId': 1, // Integer.
'controlUnitGeolocation': {/*Just simple address structure. */
'address': 'address', // String. May NOT be null.
'city': 'Koenig', // String. May NOT be null.
'postalCode': '45664' // String. May NOT be null.
}, // A complex object.
'contact': {/*Information about person. */
'name': 'Stefan', // Name of person who makes activation . String. May NOT be null.
'phone': '56745325', //Phone number of person who requests activation . String. May NOT be null.
'email': 'test@test.se' //Email of person who requests activation . String. May NOT be null.
}, // A complex object. May NOT be null.
'comment': '', // String. Maximum 1024 characters.
'features': [] //List of features . activationFeatureType. May NOT be null.
}, // A complex object. May NOT be null.
'controlUnitInfo': {/*Represents server-side entity available for admin. */
'id': 77, // Integer. May be null.
'registrationDate': 14472336592, // Date: amount of milliseconds since UNIX epoch. May be null.
'controlUnitLocation': '', // controlUnitLocationType. May NOT be null.
'serial': '56778945332455', //Identifier of control unit. . String. Minimum 1 characters. Maximum 20 characters. May NOT be null.
'geolocation': {/*Just simple address structure. */
'address': 'address', // String. May NOT be null.
'city': 'Koenig', // String. May NOT be null.
'postalCode': '45664' // String. May NOT be null.
}, // A complex object. May be null.
'softwareVendor': //Identifier of SoftwareVendor who owns this controlUnit . Integer. May be null.
}, // A complex object.
'registrationAdvancedInfo': {/*Represents server-side entity available for admin. */
'registrationInfo': {
'id': 654, // Integer. May NOT be null.
'cashRegisterName': 'cash name', // String. Maximum 16 characters. May NOT be null.
'country': 'se', // String. Minimum 2 characters. Maximum 2 characters. May NOT be null.
'corporateId': '345342356', // corporateIdType. May NOT be null.
'installationId': 8764444578 // Integer. May NOT be null.
}, // A complex object. May NOT be null.
'sellerInfo': { 'corporateId': '1231231231', // corporateIdType. May NOT be null.
'name': 'CompanyName', // String. Maximum 96 characters. May NOT be null.
'country': 'se', // countryType. May NOT be null.
'publicAccess': true, // Boolean. May NOT be null.
'description': 'description', // String. Maximum 1024 characters. May be null.
'city': 'Koenig', // String. Maximum 255 characters. May be null.
'workHours': '24', // String. Maximum 255 characters. May be null.
'phone': '89814532074', // String. Maximum 255 characters. May be null.
'custom': 'some text' // String. Maximum 65535 characters. May be null.
}, // A complex object. May NOT be null.
'installationAdvancedInfo': {/*This entity provides info about android device. */
'installationInfo': {/* This entity provides info about android device. */
'id': 654353, // Integer. May be null.
'registrationDate': 45672345, // Date: amount of milliseconds since UNIX epoch.
'deviceId': 465, // Integer. May NOT be null.
'applicationPackage': 'package', // String. Maximum 120 characters. May NOT be null.
'productionNumber': 'TEST100000000000000000081' // String. Maximum 25 characters.
}{/*This entity provides info about android device. */
'id': , // Integer.
'registrationDate': , // Date: amount of milliseconds since UNIX epoch.
'deviceId': , // Integer.
'applicationPackage': '', // String. Maximum 120 characters.
'productionNumber': '', // String.
'gcmRegistrationId': '' // String. Minimum 1 characters.
}, // A complex object. A complex object.
'deviceInfo': {/*This entity provides info about android device. */
'id': 5432, // Integer.
'deviceId': '34565673' //Unique number of every android device. . String. Minimum 1 characters. Maximum 17 characters. May NOT be null.
}, // A complex object.
'applicationDescriptionInfo': {/*Information about person. */
'applicationPackage': ' package', // String.
'productionNumberPrefix': 'pre', // String.
'controlUnitRequired': true, // Boolean.
'name': 'test name', // String.
'softwareVendor': , // Integer.
'autoActivationCondition': 'NEVER', // autoActivationConditionType.
'corporateIdValidationMethod': 'NONE' // corporateIdValidationMethodType.
} // A complex object.
} // A complex object. May NOT be null.
}, // A complex object. May NOT be null.
'issued': 124534242, // Date: amount of milliseconds since UNIX epoch.
'registrationAdvanced': '' //
}
{/*
'status': 'ISSUED', // activationStatusType. May NOT be null.
'issued': 14472336592, //
'controlUnitLocation': 'REMOTE', // controlUnitLocationType. May NOT be null.
'validFrom': 23, // Integer. May NOT be null.
'validTo': 67, // Integer. May NOT be null.
'sellerName': 'Test', //
'controlUnitId': 1, // Integer.
'controlUnitGeolocation': {/*
'city': 'Koenig', // String. May NOT be null.
'postalCode': '45664' // String. May NOT be null.
}, // A complex object.
'contact': {/*
'phone': '56745325', //
'email': 'test@test.se' //
}, // A complex object. May NOT be null.
'comment': '', // String. Maximum 1024 characters.
'features': [] //
}, // A complex object. May NOT be null.
'controlUnitInfo': {/*
'registrationDate': 14472336592, // Date: amount of milliseconds since UNIX epoch. May be null.
'controlUnitLocation': '', // controlUnitLocationType. May NOT be null.
'serial': '56778945332455', //
'geolocation': {/*
'city': 'Koenig', // String. May NOT be null.
'postalCode': '45664' // String. May NOT be null.
}, // A complex object. May be null.
'softwareVendor': //
}, // A complex object.
'registrationAdvancedInfo': {/*
'cashRegisterName': 'cash name', // String. Maximum 16 characters. May NOT be null.
'country': 'se', // String. Minimum 2 characters. Maximum 2 characters. May NOT be null.
'corporateId': '345342356', // corporateIdType. May NOT be null.
'installationId': 8764444578 // Integer. May NOT be null.
}, // A complex object. May NOT be null.
'sellerInfo': { 'corporateId': '1231231231', // corporateIdType. May NOT be null.
'name': 'CompanyName', // String. Maximum 96 characters. May NOT be null.
'country': 'se', // countryType. May NOT be null.
'publicAccess': true, // Boolean. May NOT be null.
'description': 'description', // String. Maximum 1024 characters. May be null.
'city': 'Koenig', // String. Maximum 255 characters. May be null.
'workHours': '24', // String. Maximum 255 characters. May be null.
'phone': '89814532074', // String. Maximum 255 characters. May be null.
'custom': 'some text' // String. Maximum 65535 characters. May be null.
}, // A complex object. May NOT be null.
'installationAdvancedInfo': {/*
'registrationDate': 45672345, // Date: amount of milliseconds since UNIX epoch.
'deviceId': 465, // Integer. May NOT be null.
'applicationPackage': 'package', // String. Maximum 120 characters. May NOT be null.
'productionNumber': 'TEST100000000000000000081' // String. Maximum 25 characters.
}{/*
'registrationDate': , // Date: amount of milliseconds since UNIX epoch.
'deviceId': , // Integer.
'applicationPackage': '', // String. Maximum 120 characters.
'productionNumber': '', // String.
'gcmRegistrationId': '' // String. Minimum 1 characters.
}, // A complex object. A complex object.
'deviceInfo': {/*
'deviceId': '34565673' //
}, // A complex object.
'applicationDescriptionInfo': {/*
'productionNumberPrefix': 'pre', // String.
'controlUnitRequired': true, // Boolean.
'name': 'test name', // String.
'softwareVendor': , // Integer.
'autoActivationCondition': 'NEVER', // autoActivationConditionType.
'corporateIdValidationMethod': 'NONE' // corporateIdValidationMethodType.
} // A complex object.
} // A complex object. May NOT be null.
}, // A complex object. May NOT be null.
'issued': 124534242, // Date: amount of milliseconds since UNIX epoch.
'registrationAdvanced': '' //
}
POST /v15/pospluses/kd ¶
Request
Response
POST /v15/pospluses/kd HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{
'brutto': 1000, // Integer. May NOT be null.
'vatRateToSum': {'6':1000}, //A javascript object. The key - tax value. The value - the sum. E.g. 20.12 SEK splitted between 12.05 SEK for VAT 6% and 10.07 SEK
for VAT 12% will do {'6': 1205, '12': 1007}
. A complex object. May NOT be null.
'refund': false, // Boolean. May NOT be null.
'printType': 'Normal', // printTypeEnum. May NOT be null.
'receiptNumber': 1, //Autoincrement receipt number within one POS terminal . Integer. May be null.
'date': 1414800000001 // Date: amount of milliseconds since UNIX epoch. May NOT be null.
}
'vatRateToSum': {'6':1000}, //
'refund': false, // Boolean. May NOT be null.
'printType': 'Normal', // printTypeEnum. May NOT be null.
'receiptNumber': 1, //
'date': 1414800000001 // Date: amount of milliseconds since UNIX epoch. May NOT be null.
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
{ 'response': 'K34P72NUH7A3HST7HY7EF6RUWJLLWVOC; MKFXCN7ENWYJS4KRP3JJ3KG64M', // String. May NOT be null.
'controlUnitSerial': 'PTEST000000000001' // String. May NOT be null.
}
{ 'response': 'K34P72NUH7A3HST7HY7EF6RUWJLLWVOC; MKFXCN7ENWYJS4KRP3JJ3KG64M', // String. May NOT be null.
'controlUnitSerial': 'PTEST000000000001' // String. May NOT be null.
}
Description | |
---|---|
ControlUnitReceiptJsonException |
|
InconsistentDataJsonException |
|
ControlUnitUnavailableJsonException |
|
ControlUnitCommunicationJsonException |
|
GET /v15/sellers/{sellerId} ¶
sellerId | sellerIdType |
|
Request
Response
GET /v15/sellers/se9876543210 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'corporateId': '1231231231', // corporateIdType. May NOT be null.
'name': 'CompanyName', // String. Maximum 96 characters. May NOT be null.
'country': 'se', // countryType. May NOT be null.
'publicAccess': true, // Boolean. May NOT be null.
'description': 'description', // String. Maximum 1024 characters. May be null.
'city': 'Koenig', // String. Maximum 255 characters. May be null.
'workHours': '24', // String. Maximum 255 characters. May be null.
'phone': '89814532074', // String. Maximum 255 characters. May be null.
'custom': 'some text' // String. Maximum 65535 characters. May be null.
}
{ 'corporateId': '1231231231', // corporateIdType. May NOT be null.
'name': 'CompanyName', // String. Maximum 96 characters. May NOT be null.
'country': 'se', // countryType. May NOT be null.
'publicAccess': true, // Boolean. May NOT be null.
'description': 'description', // String. Maximum 1024 characters. May be null.
'city': 'Koenig', // String. Maximum 255 characters. May be null.
'workHours': '24', // String. Maximum 255 characters. May be null.
'phone': '89814532074', // String. Maximum 255 characters. May be null.
'custom': 'some text' // String. Maximum 65535 characters. May be null.
}
POST /v15/sellers ¶
Request
Response
POST /v15/sellers HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{
'corporateId': '1231231231', // corporateIdType. May NOT be null.
'name': 'CompanyName', // String. Maximum 96 characters. May NOT be null.
'country': 'se', // countryType. May NOT be null.
'publicAccess': true, // Boolean. May NOT be null.
'description': 'description', // String. Maximum 1024 characters. May be null.
'city': 'Koenig', // String. Maximum 255 characters. May be null.
'workHours': '24', // String. Maximum 255 characters. May be null.
'phone': '89814532074', // String. Maximum 255 characters. May be null.
'custom': 'some text' // String. Maximum 65535 characters. May be null.
}
'name': 'CompanyName', // String. Maximum 96 characters. May NOT be null.
'country': 'se', // countryType. May NOT be null.
'publicAccess': true, // Boolean. May NOT be null.
'description': 'description', // String. Maximum 1024 characters. May be null.
'city': 'Koenig', // String. Maximum 255 characters. May be null.
'workHours': '24', // String. Maximum 255 characters. May be null.
'phone': '89814532074', // String. Maximum 255 characters. May be null.
'custom': 'some text' // String. Maximum 65535 characters. May be null.
}
HTTP/1.1 201 CREATED
Description | |
---|---|
VersionConflictJsonException |
|
GET /v15/{sellerId}/version ¶
sellerId | sellerIdType |
|
Request
Response
GET /v15/se9876543210/version HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'version': 0 //Version number . Integer. Minimum 0. May NOT be null.
}
{ 'version': 0 //
}
PUT /v15/sellers/{sellerId} ¶
sellerId | sellerIdType |
|
Request
Response
PUT /v15/sellers/se9876543210 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Data to put */
'corporateId': '1231231231', // corporateIdType. May NOT be null.
'name': 'CompanyName', // String. Maximum 96 characters. May NOT be null.
'country': 'se', // countryType. May NOT be null.
'publicAccess': true, // Boolean. May NOT be null.
'description': 'description', // String. Maximum 1024 characters. May be null.
'city': 'Koenig', // String. Maximum 255 characters. May be null.
'workHours': '24', // String. Maximum 255 characters. May be null.
'phone': '89814532074', // String. Maximum 255 characters. May be null.
'custom': 'some text' // String. Maximum 65535 characters. May be null.
}
'name': 'CompanyName', // String. Maximum 96 characters. May NOT be null.
'country': 'se', // countryType. May NOT be null.
'publicAccess': true, // Boolean. May NOT be null.
'description': 'description', // String. Maximum 1024 characters. May be null.
'city': 'Koenig', // String. Maximum 255 characters. May be null.
'workHours': '24', // String. Maximum 255 characters. May be null.
'phone': '89814532074', // String. Maximum 255 characters. May be null.
'custom': 'some text' // String. Maximum 65535 characters. May be null.
}
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
DELETE /v15/sellers/{sellerId} ¶
sellerId | sellerIdType |
|
Request
Response
DELETE /v15/sellers/se9876543210 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
GET /v15/sellers ¶
orderBy | Query string. Optional | sellerFieldsType |
|
orderDesc | Query string. Optional | boolean |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/sellers HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* return list of items to be added, edited or deleted (actually, only created) */
{ 'corporateId': '1231231231', // corporateIdType. May NOT be null.
'name': 'CompanyName', // String. Maximum 96 characters. May NOT be null.
'country': 'se', // countryType. May NOT be null.
'publicAccess': true, // Boolean. May NOT be null.
'description': 'description', // String. Maximum 1024 characters. May be null.
'city': 'Koenig', // String. Maximum 255 characters. May be null.
'workHours': '24', // String. Maximum 255 characters. May be null.
'phone': '89814532074', // String. Maximum 255 characters. May be null.
'custom': 'some text' // String. Maximum 65535 characters. May be null.
}
{ 'corporateId': '1231231231', // corporateIdType. May NOT be null.
'name': 'CompanyName', // String. Maximum 96 characters. May NOT be null.
'country': 'se', // countryType. May NOT be null.
'publicAccess': true, // Boolean. May NOT be null.
'description': 'description', // String. Maximum 1024 characters. May be null.
'city': 'Koenig', // String. Maximum 255 characters. May be null.
'workHours': '24', // String. Maximum 255 characters. May be null.
'phone': '89814532074', // String. Maximum 255 characters. May be null.
'custom': 'some text' // String. Maximum 65535 characters. May be null.
}
GET /v15/{sellerId}/stats ¶
sellerId | sellerIdType |
|
Request
Response
GET /v15/se9876543210/stats HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{/*Information about availability of local control units and activation expiration.Б. */
'hasLocalControlUnits': TRUE, // True if at least one used activation has local control unit . Boolean. May be null.
'expiredActivations': , //Amount of "latest installations" (Device.latest) with latest activation date less then TODAY . Integer. May be null.
'expireSoonActivations': , //Amount of "latest installations" (Device.latest) with latest activation date more TODAY and less TODAY + 1 MONTH . Integer. May be null.
'hasTables': false, //Always false . Boolean. May be null.
'hasAdditives': false, //Always false . Boolean. May be null.
'hasAdditiveClasses': false //Always false . Boolean. May be null.
}
{/*
'expiredActivations': , //
'expireSoonActivations': , //
'hasTables': false, //
'hasAdditives': false, //
'hasAdditiveClasses': false //
}
GET /v15/{sellerId}/seller-images-diff/{versionFrom}/{versionTo} ¶
sellerId | sellerIdType |
|
|
versionFrom | integer |
|
|
versionTo | integer |
|
Request
Response
GET /v15/se9876543210/seller-images-diff/0/9999 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{/*Information about product's picture */
'deleted': 'false', // True if entity was deleted. Only possible if return diff . May NOT be null.
'filename': 'MAIN.PNG', //Filename of picture . String. Minimum 1 characters. Maximum 50 characters. Regular expression
^(?!^(PRN|AUX|CLOCK\$|NUL|CON|COM\d|LPT\d|\.\.?)$)[^\x00-\x1f\\?*:\";|/<>]+$
. May NOT be null.
'version': 12345, //Version of picture (to be able to get old version) . Integer. May NOT be null.
'entityIdentifier': '12345', //This field unique identifies product . identifierType. May NOT be null.
'modified': 78953145421 //Last modified date . Date: amount of milliseconds since UNIX epoch. May NOT be null.
}
{/*
'filename': 'MAIN.PNG', //
'version': 12345, //
'entityIdentifier': '12345', //
'modified': 78953145421 //
}
GET /v15/{sellerId}/images ¶
sellerId | sellerIdType |
|
Request
Response
GET /v15/se9876543210/images HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* List of paths for images
*/
[ 'paths': 'se9876543210/images/current/MAIN.PNG' //
]
[ 'paths': 'se9876543210/images/current/MAIN.PNG' //
]
GET /v15/{sellerId}/images/current/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
pictureFilename | identifierType |
|
Request
Response
GET /v15/se9876543210/images/current/MAIN.PNG HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
GET /v15/{sellerId}/images/{pictureVersion}/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
pictureVersion | imageVersionType |
|
|
pictureFilename | identifierType |
|
Request
Response
GET /v15/se9876543210/images/10/MAIN.PNG HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
PUT /v15/{sellerId}/images/current/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
pictureFilename | identifierType |
|
Request
Response
PUT /v15/se9876543210/images/current/MAIN.PNG HTTP/1.1
Content-Type: image/png
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
ReferenceNotFoundJsonException |
|
VersionConflictJsonException |
|
DELETE /v15/{sellerId}/images/current/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
pictureFilename | identifierType |
|
Request
Response
DELETE /v15/se9876543210/images/current/MAIN.PNG HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
POST /v15/{sellerId}/taxes ¶
sellerId | sellerIdType |
|
Request
Response
POST /v15/se9876543210/taxes HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{
'deleted': 'false', // true if entity was deleted . May NOT be null.
'identifier': null, //This field uniqly identifies entity. There is no decision what is it, only the requirement - it must be unique trough one seller
. identifierType. May be null.
'vat': 1, //Regular field . Integer. Minimum 0. Maximum 100. May NOT be null.
'name': 'Test', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'custom': '' //Custom data concerned tax . String. Maximum 65535 characters. May be null.
}
'identifier': null, //
'vat': 1, //
'name': 'Test', //
'custom': '' //
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
{/*Methods called "new" will return the identifier of newly created entity by using this class
Generated unique identifier */
'identifier': '0-2U0Z' // identifierType. May NOT be null.
}
{/*
}
Description | |
---|---|
VersionConflictJsonException |
|
PUT /v15/{sellerId}/taxes/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
PUT /v15/se9876543210/taxes/0-2U0Z HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Data to put */
'deleted': 'false', // true if entity was deleted . May NOT be null.
'identifier': '0-2U0Z', //This field uniqly identifies entity. There is no decision what is it, only the requirement - it must be unique trough one seller
. identifierType. May be null.
'vat': 10, //Regular field . Integer. Minimum 0. Maximum 100. May NOT be null.
'name': 'Tax 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'custom': '' //Custom data concerned tax . String. Maximum 65535 characters. May be null.
}
'identifier': '0-2U0Z', //
'vat': 10, //
'name': 'Tax 1', //
'custom': '' //
}
HTTP/1.1 201 CREATED or HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
GET /v15/{sellerId}/taxes/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
GET /v15/se9876543210/taxes/0-2U0Z HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* Null if not modified since version or entity. If version is null then return value can not be null */
{ 'deleted': 'false', //true if entity was deleted . May NOT be null.
'identifier': '0-2U0Z', //This field uniqly identifies entity. There is no decision what is it, only the requirement - it must be unique trough one seller
. identifierType. May be null.
'vat': 10, //Regular field . Integer. Minimum 0. Maximum 100. May NOT be null.
'name': 'Tax 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'custom': '' //Custom data concerned tax . String. Maximum 65535 characters. May be null.
}
{ 'deleted': 'false', //
'identifier': '0-2U0Z', //
'vat': 10, //
'name': 'Tax 1', //
'custom': '' //
}
Description | |
---|---|
VersionConflictJsonException |
|
NotFoundJsonException |
|
ForbiddenJsonException |
|
DELETE /v15/{sellerId}/taxes/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
DELETE /v15/se9876543210/taxes/0-2U0Z HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
GET /v15/{sellerId}/taxes-diff/{versionFrom}/{versionTo} ¶
sellerId | sellerIdType |
|
|
versionFrom | integer |
|
|
versionTo | integer |
|
Request
Response
GET /v15/se9876543210/taxes-diff/0/9999 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'deleted': 'false', //true if entity was deleted . May NOT be null.
'identifier': 'se9876543210', //This field uniqly identifies entity. There is no decision what is it, only the requirement - it must be unique trough one seller
. identifierType. May be null.
'vat': 10, //Regular field . Integer. Minimum 0. Maximum 100. May NOT be null.
'name': 'Tax 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'custom': '' //Custom data concerned tax . String. Maximum 65535 characters. May be null.
}
{ 'deleted': 'false', //
'identifier': 'se9876543210', //
'vat': 10, //
'name': 'Tax 1', //
'custom': '' //
}
GET /v15/{sellerId}/taxes ¶
sellerId | sellerIdType |
|
|
orderBy | Query string. Optional | sellerFieldsType |
|
orderDesc | Query string. Optional | boolean |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/taxes HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'deleted': 'false', //true if entity was deleted . May NOT be null.
'identifier': 'se9876543210', //This field uniqly identifies entity. There is no decision what is it, only the requirement - it must be unique trough one seller
. identifierType. May be null.
'vat': 10, //Regular field . Integer. Minimum 0. Maximum 100. May NOT be null.
'name': 'Tax 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'custom': '' //Custom data concerned tax . String. Maximum 65535 characters. May be null.
}
{ 'deleted': 'false', //
'identifier': 'se9876543210', //
'vat': 10, //
'name': 'Tax 1', //
'custom': '' //
}
POST /v15/{sellerId}/categories ¶
sellerId | sellerIdType |
|
Request
Response
POST /v15/se9876543210/categories HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Data to put */
'deleted': 'false', // True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': null, // identifierType. May be null.
'name': 'Test' //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
}
'identifier': null, // identifierType. May be null.
'name': 'Test' //
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
/* Generated unique identifier */
{/*Methods called "new" will return the identifier of newly created entity by using this class */
'identifier': '0-2U10' // identifierType. May NOT be null.
}
{/*
}
Description | |
---|---|
VersionConflictJsonException |
|
PUT /v15/{sellerId}/categories/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
PUT /v15/se9876543210/categories/0-2U10 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Data to put */
'deleted': 'false', // True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U10', // identifierType. May be null.
'name': 'Test1' //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
}
'identifier': '0-2U10', // identifierType. May be null.
'name': 'Test1' //
}
HTTP/1.1 201 CREATED or HTTP/1.1 204 NO CONTENT
Content-Type: application/json;charset=UTF-8
{/*Methods called "new" will return the identifier of newly created entity by using this class */
'identifier': '' // identifierType. May NOT be null.
}
{/*
}
Description | |
---|---|
VersionConflictJsonException |
|
GET /v15/{sellerId}/categories/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
GET /v15/se9876543210/categories/0-2U10 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* Null if not modified since version or entity. If version is null then return value can not be null */
{ 'deleted': 'false', //True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U10', // identifierType. May be null.
'name': 'Test1' //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
}
{ 'deleted': 'false', //
'identifier': '0-2U10', // identifierType. May be null.
'name': 'Test1' //
}
Description | |
---|---|
VersionConflictJsonException |
|
NotFoundJsonException |
|
DELETE /v15/{sellerId}/categories/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
DELETE /v15/se9876543210/categories/0-2U10 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
GET /v15/{sellerId}/categories-diff/{versionFrom}/{versionTo} ¶
sellerId | sellerIdType |
|
|
versionFrom | integer |
|
|
versionTo | integer |
|
Request
Response
GET /v15/se9876543210/categories-diff/2211/9999 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'deleted': 'false', //True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': 'se9876543210', // identifierType. May be null.
'name': 'Category name' //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
}
{ 'deleted': 'false', //
'identifier': 'se9876543210', // identifierType. May be null.
'name': 'Category name' //
}
GET /v15/{sellerId}/categories ¶
sellerId | sellerIdType |
|
|
orderBy | Query string. Optional | sellerFieldsType |
|
orderDesc | Query string. Optional | boolean |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/categories HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'deleted': 'false', //True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': 'se9876543210', // identifierType. May be null.
'name': 'Category name' //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
}
{ 'deleted': 'false', //
'identifier': 'se9876543210', // identifierType. May be null.
'name': 'Category name' //
}
GET /v15/{sellerId}/category-images-diff/{versionFrom}/{versionTo} ¶
sellerId | sellerIdType |
|
|
versionFrom | imageVersionType |
|
|
versionTo | imageVersionType |
|
Request
Response
GET /v15/se9876543210/category-images-diff/0/99999 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{/*Information about product's picture */
'deleted': 'false', // True if entity was deleted. Only possible if return diff . May NOT be null.
'filename': 'test', //Filename of picture . String. Minimum 1 characters. Maximum 50 characters. Regular expression
^(?!^(PRN|AUX|CLOCK\$|NUL|CON|COM\d|LPT\d|\.\.?)$)[^\x00-\x1f\\?*:\";|/<>]+$
. May NOT be null.
'version': 12345, //Version of picture (to be able to get old version) . Integer. May NOT be null.
'entityIdentifier': '12345', //This field unique identifies product . identifierType. May NOT be null.
'modified': 78953145421 //Last modified date . Date: amount of milliseconds since UNIX epoch. May NOT be null.
}
{/*
'filename': 'test', //
'version': 12345, //
'entityIdentifier': '12345', //
'modified': 78953145421 //
}
GET /v15/{sellerId}/categories/{categoryIdentifier}/images ¶
sellerId | sellerIdType |
|
|
categoryIdentifier | identifierType |
|
Request
Response
GET /v15/se9876543210/categories/0-2U10/images HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* List of paths for images */
[ 'paths': 'se9876543210/categories/0-2U10/images/current/MAIN.PNG' //
]
[ 'paths': 'se9876543210/categories/0-2U10/images/current/MAIN.PNG' //
]
GET /v15/{sellerId}/categories/{categoryIdentifier}/images/current/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
categoryIdentifier | identifierType |
|
|
pictureFilename | identifierType |
|
Request
Response
GET /v15/se9876543210/categories/0-2U10/images/current/MAIN.PNG HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
GET /v15/{sellerId}/categories/{categoryIdentifier}/images/{pictureVersion}/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
categoryIdentifier | identifierType |
|
|
pictureVersion | imageVersionType |
|
|
pictureFilename | identifierType |
|
Request
Response
GET /v15/se9876543210/categories/0-2U10/images/12345/MAIN.PNG HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
PUT /v15/{sellerId}/categories/{categoryIdentifier}/images/current/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
categoryIdentifier | identifierType |
|
|
pictureFilename | identifierType |
|
Request
Response
PUT /v15/se9876543210/categories/0-2U10/images/current/MAIN.PNG HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
ReferenceNotFoundJsonException |
|
VersionConflictJsonException |
|
DELETE /v15/{sellerId}/categories/{categoryIdentifier}/images/current/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
categoryIdentifier | identifierType |
|
|
pictureFilename | identifierType |
|
Request
Response
DELETE /v15/se9876543210/categories/0-2U10/images/current/MAIN.PNG HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
GET /v15/{sellerId}/categories/stats ¶
sellerId | sellerIdType |
|
|
period | Query string. Optional | integer |
|
cashRegisterName | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/categories/stats HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{/*
Represents categories stats by total brutto, amount of sold products for all categories and list of categories stats in particular.
*/
'totalBrutto': 1200, // Total stats by categories brutto. . Integer. Minimum 0.
'totalProductsSold': 100, //Total amount of sold products for all categories.. . Integer. Minimum 0.
'categoryStats': Stats by category in particular.[ {/*Stats by particular categories brutto sum and amount of sold products. Contains identifier and name of category. */
'identifier': 'UF-2', // identifierType. May NOT be null.
'name': 'Latte', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'brutto': 200, //Sum by brutto for sold products by current category. . Integer. Minimum 0.
'count': 50 //Amount of sold product units by current category. . Integer. Minimum 0.
} ] //Stats by category in particular. . List of objects. May NOT be null.
}
{/*
'totalProductsSold': 100, //
'categoryStats': Stats by category in particular.[ {/*
'name': 'Latte', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'brutto': 200, //
'count': 50 //
} ] //
}
Description | |
---|---|
ValidationJsonException |
|
ReferenceNotFoundJsonException |
|
POST /v15/{sellerId}/products ¶
sellerId | sellerIdType |
|
Request
Response
POST /v15/se9876543210/products HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{
'deleted': 'false', // True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'barcode': '012345678912', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'netto': 100, //Regular field . Integer. May NOT be null.
'tax': '0-2U0Z', //Regular field . String. May NOT be null.
'salesUnit': 'Piece', //Regular field . salesUnitType. May NOT be null.
'countedInPrice': 'false', //Regular field . May NOT be null.
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //
'barcode': '012345678912', //
'netto': 100, //
'tax': '0-2U0Z', //
'salesUnit': 'Piece', //
'countedInPrice': 'false', //
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
{/*Methods called "new" will return the identifier of newly created entity by using this class */
'identifier': '0-2U12' // identifierType. May NOT be null.
}
{/*
}
Description | |
---|---|
VersionConflictJsonException |
|
ReferenceNotFoundJsonException |
|
PUT /v15/{sellerId}/products/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
PUT /v15/se9876543210/products/0-2U12 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Data to put */
'deleted': 'false', // True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'barcode': '012345678912', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'netto': 100, //Regular field . Integer. May NOT be null.
'tax': '0-2U0Z', //Regular field . String. May NOT be null.
'salesUnit': 'Piece', //Regular field . salesUnitType. May NOT be null.
'countedInPrice': 'false', //Regular field . May NOT be null.
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //
'barcode': '012345678912', //
'netto': 100, //
'tax': '0-2U0Z', //
'salesUnit': 'Piece', //
'countedInPrice': 'false', //
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
HTTP/1.1 201 CREATED or HTTP/1.1 204 NO CONTENT
GET /v15/{sellerId}/products/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
GET /v15/se9876543210/products/0-2U12 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'deleted': 'false', //True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'barcode': '012345678912', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'netto': 100, //Regular field . Integer. May NOT be null.
'tax': '0-2U0Z', //Regular field . String. May NOT be null.
'salesUnit': 'Piece', //Regular field . salesUnitType. May NOT be null.
'countedInPrice': 'false', //Regular field . May NOT be null.
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
{ 'deleted': 'false', //
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //
'barcode': '012345678912', //
'netto': 100, //
'tax': '0-2U0Z', //
'salesUnit': 'Piece', //
'countedInPrice': 'false', //
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
Description | |
---|---|
VersionConflictJsonException |
|
NotFoundJsonException |
|
GET /v15/{sellerId}/products ¶
sellerId | sellerIdType |
|
|
orderBy | Query string. Optional | sellerFieldsType |
|
orderDesc | Query string. Optional | boolean |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/products HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* List of entities which exists on current seller or null if list of entities is not modified since version */
[ { 'deleted': 'false', //True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'barcode': '012345678912', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'netto': 100, //Regular field . Integer. May NOT be null.
'tax': '0-2U0Z', //Regular field . String. May NOT be null.
'salesUnit': 'Piece', //Regular field . salesUnitType. May NOT be null.
'countedInPrice': 'false', //Regular field . May NOT be null.
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
} ]
[ { 'deleted': 'false', //
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //
'barcode': '012345678912', //
'netto': 100, //
'tax': '0-2U0Z', //
'salesUnit': 'Piece', //
'countedInPrice': 'false', //
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
} ]
DELETE /v15/{sellerId}/products/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
DELETE /v15/se9876543210/products/0-2U12 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
PUT /v15/{sellerId}/products/{productIdentifier}/images/current/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
productIdentifier | identifierType |
|
|
pictureFilename | identifierType |
|
Request
Response
PUT /v15/se9876543210/products/0-2U12/images/current/MAIN.PNG HTTP/1.1
Content-Type: image/png
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
ReferenceNotFoundJsonException |
|
GET /v15/{sellerId}/products/{productIdentifier}/images ¶
sellerId | sellerIdType |
|
|
productIdentifier | identifierType |
|
Request
Response
GET /v15/se9876543210/products/0-2U12/images HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* List of paths for images */
[ 'paths': 'se9876543210/products/0-2U12/images/current/MAIN.PNG' //
]
[ 'paths': 'se9876543210/products/0-2U12/images/current/MAIN.PNG' //
]
GET /v15/{sellerId}/products/{productIdentifier}/images/current/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
productIdentifier | identifierType |
|
|
pictureFilename | identifierType |
|
Request
Response
GET /v15/se9876543210/products/0-2U12/images/current/MAIN.PNG HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Description | |
---|---|
VersionConflictJsonException |
|
ReferenceNotFoundJsonException |
|
GET /v15/{sellerId}/products/{productIdentifier}/images/{pictureVersion}/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
productIdentifier | identifierType |
|
|
pictureVersion | imageVersionType |
|
|
pictureFilename | identifierType |
|
Request
Response
GET /v15/se9876543210/products/0-2U12/images/20/MAIN.PNG HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Description | |
---|---|
NotFoundJsonException |
|
ReferenceNotFoundJsonException |
|
DELETE /v15/{sellerId}/products/{productIdentifier}/images/current/{pictureFilename} ¶
sellerId | sellerIdType |
|
|
productIdentifier | identifierType |
|
|
pictureFilename | identifierType |
|
Request
Response
DELETE /v15/se9876543210/products/0-2U12/images/current/MAIN.PNG HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
ReferenceNotFoundJsonException |
|
GET /v15/{sellerId}/product-images-diff/{versionFrom}/{versionTo} ¶
sellerId | sellerIdType |
|
|
versionFrom | integer |
|
|
versionTo | integer |
|
Request
Response
GET /v15/se9876543210/product-images-diff/0/9999 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{/*Information about product's picture */
'deleted': 'false', // True if entity was deleted. Only possible if return diff . May NOT be null.
'filename': 'MAIN.PNG', //Filename of picture . String. Minimum 1 characters. Maximum 50 characters. Regular expression
^(?!^(PRN|AUX|CLOCK\$|NUL|CON|COM\d|LPT\d|\.\.?)$)[^\x00-\x1f\\?*:\";|/<>]+$
. May NOT be null.
'version': 1, //Version of picture (to be able to get old version) . Integer. May NOT be null.
'entityIdentifier': '12345', //This field unique identifies product . identifierType. May NOT be null.
'modified': 78953145421 //Last modified date . Date: amount of milliseconds since UNIX epoch. May NOT be null.
}
{/*
'filename': 'MAIN.PNG', //
'version': 1, //
'entityIdentifier': '12345', //
'modified': 78953145421 //
}
GET /v15/{sellerId}/products/stats ¶
sellerId | sellerIdType |
|
|
period | Query string. Optional | integer |
|
cashRegisterName | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/products/stats HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{/*Represents products stats by total brutto, amount of sold products and list of product stats in particular. */
'totalBrutto': 1200, // Total stats by products brutto. . Integer. Minimum 0.
'totalProductsSold': 100, //Total amount of sold products. . Integer. Minimum 0.
'productStats': Stats by product in particular.[ {/*Stats by particular product by brutto and amount of sold units. Contains identifier, name and sales unit type. */
'identifier': 'UF-2', // identifierType. May NOT be null.
'name': 'Latte', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'brutto': 200, //Sum by brutto for sold products. . Integer. Minimum 0.
'count': 50, //Amount of sold product units. . Integer. Minimum 0.
'salesUnit': 'Piece' //Sales unit type (i.e. kilogram or piece). . salesUnitType.
} ] //Stats by product in particular. . List of objects. May NOT be null.
}
{/*
'totalProductsSold': 100, //
'productStats': Stats by product in particular.[ {/*
'name': 'Latte', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'brutto': 200, //
'count': 50, //
'salesUnit': 'Piece' //
} ] //
}
Description | |
---|---|
ValidationJsonException |
|
ReferenceNotFoundJsonException |
|
POST /v15/{sellerId}/commodities ¶
sellerId | sellerIdType |
|
Request
Response
POST /v15/se9876543210/commodities HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Data to put */
'deleted': false, // True if entity was deleted. Only possible if return diff . Boolean. May NOT be null.
'identifier': null, //This field uniquely identifies entity. There is no decision what is it, only the requirement - it must be unique trough one
seller
. identifierType. May NOT be null.
'product': '0-2U12', //Regular field. Product identifier . String. May NOT be null.
'category': '0-2U10', //Regular field. Tax identifier . String. May NOT be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
'identifier': null, //
'product': '0-2U12', //
'category': '0-2U10', //
'custom': '' // String. Maximum 65535 characters. May be null.
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
{/*Methods called "new" will return the identifier of newly created entity by using this class */
'identifier': '0-2U18' // identifierType. May NOT be null.
}
{/*
}
Description | |
---|---|
VersionConflictJsonException |
|
ReferenceNotFoundJsonException |
|
PUT /v15/{sellerId}/commodities/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
PUT /v15/se9876543210/commodities/0-2U18 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Data to put */
'deleted': false, // True if entity was deleted. Only possible if return diff . Boolean. May NOT be null.
'identifier': '0-2U18', //This field uniquely identifies entity. There is no decision what is it, only the requirement - it must be unique trough one
seller
. identifierType. May NOT be null.
'product': '0-2U12', //Regular field. Product identifier . String. May NOT be null.
'category': '0-2U10', //Regular field. Tax identifier . String. May NOT be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
'identifier': '0-2U18', //
'product': '0-2U12', //
'category': '0-2U10', //
'custom': '' // String. Maximum 65535 characters. May be null.
}
HTTP/1.1 201 CREATED or HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
ReferenceNotFoundJsonException |
|
GET /v15/{sellerId}/commodities/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
GET /v15/se9876543210/commodities/0-2U18 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Description | |
---|---|
VersionConflictJsonException |
|
NotFoundJsonException |
|
GET /v15/{sellerId}/commodities ¶
sellerId | sellerIdType |
|
|
orderBy | Query string. Optional | sellerFieldsType |
|
orderDesc | Query string. Optional | boolean |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/commodities HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* List of entities which exists on current seller or null if list of entities is not modified since version */
[ { 'deleted': false, //True if entity was deleted. Only possible if return diff . Boolean. May NOT be null.
'identifier': '0-2U18', //This field uniquely identifies entity. There is no decision what is it, only the requirement - it must be unique trough one
seller
. identifierType. May NOT be null.
'product': '0-2U12', //Regular field. Product identifier . String. May NOT be null.
'category': '0-2U16', //Regular field. Tax identifier . String. May NOT be null.
'custom': '' // String. Maximum 65535 characters. May be null.
} ]
[ { 'deleted': false, //
'identifier': '0-2U18', //
'product': '0-2U12', //
'category': '0-2U16', //
'custom': '' // String. Maximum 65535 characters. May be null.
} ]
GET /v15/{sellerId}/commodities/advanced ¶
sellerId | sellerIdType |
|
|
orderBy | Query string. Optional | sellerFieldsType |
|
orderDesc | Query string. Optional | boolean |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/commodities/advanced HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* List of entities which exists on current seller or null if list of entities is not modified since version */
[ {/*
Info entity with complete Product and Category infoes instead of solely their identifiers.
See Commodity for comparison.
*/
'deleted': false, // True if entity was deleted . Boolean. May NOT be null.
'identifier': '0-2U18', //
This field uniquely identifies entity.
There is no decision what is it, only the requirement - it must be unique trough one seller.
. identifierType. May NOT be null.
'product': {/*Data to put */
'deleted': 'false', // True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'barcode': '012345678912', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'netto': 100, //Regular field . Integer. May NOT be null.
'tax': '0-2U0Z', //Regular field . String. May NOT be null.
'salesUnit': 'Piece', //Regular field . salesUnitType. May NOT be null.
'countedInPrice': 'false', //Regular field . May NOT be null.
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '', // String. Maximum 65535 characters. May be null.
'price': '0' //
}, // A complex object. May NOT be null.
'categoryInfo': {/*Data to put */
'deleted': 'false', // True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': null, // identifierType. May be null.
'name': 'Test' //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
}, // A complex object. May NOT be null.
'custom': '' // String. Maximum 65535 characters.
} ]
[ {/*
'identifier': '0-2U18', //
'product': {/*
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //
'barcode': '012345678912', //
'netto': 100, //
'tax': '0-2U0Z', //
'salesUnit': 'Piece', //
'countedInPrice': 'false', //
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '', // String. Maximum 65535 characters. May be null.
'price': '0' //
}, // A complex object. May NOT be null.
'categoryInfo': {/*
'identifier': null, // identifierType. May be null.
'name': 'Test' //
}, // A complex object. May NOT be null.
'custom': '' // String. Maximum 65535 characters.
} ]
DELETE /v15/{sellerId}/commodities/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
DELETE /v15/se9876543210/commodities/0-2U18 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
GET /v15/{sellerId}/commodities-diff/{versionFrom}/{versionTo} ¶
sellerId | sellerIdType |
|
|
versionFrom | integer |
|
|
versionTo | integer |
|
Request
Response
GET /v15/se9876543210/commodities-diff/0/9999 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'deleted': false, //True if entity was deleted. Only possible if return diff . Boolean. May NOT be null.
'identifier': '1', //This field uniquely identifies entity. There is no decision what is it, only the requirement - it must be unique trough one
seller
. identifierType. May NOT be null.
'product': 'test product', //Regular field. Product identifier . String. May NOT be null.
'category': 'test category', //Regular field. Tax identifier . String. May NOT be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
{ 'deleted': false, //
'identifier': '1', //
'product': 'test product', //
'category': 'test category', //
'custom': '' // String. Maximum 65535 characters. May be null.
}
POST /v15/{sellerId}/keyboards ¶
sellerId | sellerIdType |
|
Request
Response
POST /v15/se9876543210/keyboards HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Data to put */
'deleted': 'false', // true if entity was deleted . May NOT be null.
'identifier': null, // identifierType. May be null.
'name': 'Test', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'width': 0, //Regular field . Integer. May NOT be null.
'height': 0, //Regular field . Integer. May NOT be null.
'deviceFormFactor': 'PHONE', //Regular field . deviceFormFactorType. May NOT be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
'identifier': null, // identifierType. May be null.
'name': 'Test', //
'width': 0, //
'height': 0, //
'deviceFormFactor': 'PHONE', //
'custom': '' // String. Maximum 65535 characters. May be null.
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
/* Generated unique identifier */
{/*Methods called "new" will return the identifier of newly created entity by using this class */
'identifier': '0-2U20' // identifierType. May NOT be null.
}
{/*
}
Description | |
---|---|
VersionConflictJsonException |
|
PUT /v15/{sellerId}/keyboards/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
PUT /v15/se9876543210/keyboards/0-2U20 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Data to put */
'deleted': 'false', // true if entity was deleted . May NOT be null.
'identifier': '0-2U20', // identifierType. May be null.
'name': 'Test1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'width': 0, //Regular field . Integer. May NOT be null.
'height': 0, //Regular field . Integer. May NOT be null.
'deviceFormFactor': 'PHONE', //Regular field . deviceFormFactorType. May NOT be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
'identifier': '0-2U20', // identifierType. May be null.
'name': 'Test1', //
'width': 0, //
'height': 0, //
'deviceFormFactor': 'PHONE', //
'custom': '' // String. Maximum 65535 characters. May be null.
}
HTTP/1.1 201 CREATED or HTTP/1.1 204 NO CONTENT
Content-Type: application/json;charset=UTF-8
{/*Methods called "new" will return the identifier of newly created entity by using this class */
'identifier': '' // identifierType. May NOT be null.
}
{/*
}
Description | |
---|---|
VersionConflictJsonException |
|
GET /v15/{sellerId}/keyboards/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
GET /v15/se9876543210/keyboards/0-2U20 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* Null if not modified since version or entity. If version is null then return value can not be null */
{ 'deleted': 'false', //true if entity was deleted . May NOT be null.
'identifier': '0-2U20', // identifierType. May be null.
'name': 'Test1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'width': 0, //Regular field . Integer. May NOT be null.
'height': 0, //Regular field . Integer. May NOT be null.
'deviceFormFactor': 'PHONE', //Regular field . deviceFormFactorType. May NOT be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
{ 'deleted': 'false', //
'identifier': '0-2U20', // identifierType. May be null.
'name': 'Test1', //
'width': 0, //
'height': 0, //
'deviceFormFactor': 'PHONE', //
'custom': '' // String. Maximum 65535 characters. May be null.
}
Description | |
---|---|
VersionConflictJsonException |
|
NotFoundJsonException |
|
GET /v15/{sellerId}/keyboards ¶
sellerId | sellerIdType |
|
|
orderBy | Query string. Optional | sellerFieldsType |
|
orderDesc | Query string. Optional | boolean |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/keyboards HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* Returns list of entities */
[ { 'deleted': 'false', //true if entity was deleted . May NOT be null.
'identifier': '0-2U20', // identifierType. May be null.
'name': 'Test1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'width': 0, //Regular field . Integer. May NOT be null.
'height': 0, //Regular field . Integer. May NOT be null.
'deviceFormFactor': 'PHONE', //Regular field . deviceFormFactorType. May NOT be null.
'custom': '' // String. Maximum 65535 characters. May be null.
} ]
[ { 'deleted': 'false', //
'identifier': '0-2U20', // identifierType. May be null.
'name': 'Test1', //
'width': 0, //
'height': 0, //
'deviceFormFactor': 'PHONE', //
'custom': '' // String. Maximum 65535 characters. May be null.
} ]
DELETE /v15/{sellerId}/keyboards/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
DELETE /v15/se9876543210/keyboards/0-2U20 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
GET /v15/{sellerId}/keyboards-diff/{versionFrom}/{versionTo} ¶
sellerId | sellerIdType |
|
|
versionFrom | integer |
|
|
versionTo | integer |
|
Request
Response
GET /v15/se9876543210/keyboards-diff/0/9999 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* return list of items to be added, edited or deleted ({@link KeyboardInfo#isDeleted()} = true) */
{ 'deleted': 'false', //true if entity was deleted . May NOT be null.
'identifier': '0-2U20', // identifierType. May be null.
'name': 'Test1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'width': 0, //Regular field . Integer. May NOT be null.
'height': 0, //Regular field . Integer. May NOT be null.
'deviceFormFactor': 'PHONE', //Regular field . deviceFormFactorType. May NOT be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
{ 'deleted': 'false', //
'identifier': '0-2U20', // identifierType. May be null.
'name': 'Test1', //
'width': 0, //
'height': 0, //
'deviceFormFactor': 'PHONE', //
'custom': '' // String. Maximum 65535 characters. May be null.
}
POST /v15/{sellerId}/keyboard-entries ¶
sellerId | sellerIdType |
|
Request
Response
POST /v15/se9876543210/keyboard-entries HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Data to put */
'deleted': false, // true if entity was deleted . Boolean. May NOT be null.
'identifier': null, //This field uniquely identifies entity. There is no decision what is it, only the requirement - it must be unique trough one
seller
. identifierType. May NOT be null.
'product': '0-2U12', //Regular field. Product identifier . String. May NOT be null.
'keyboard': '0-2U20', //Regular field. Keyboard identifier . String. May NOT be null.
'subKeyboard': '0-2U20', //Regular field. SubKeyboard identifier . String. May be null.
'positionX': 1, //Regular field . Integer. May NOT be null.
'positionY': 1, //Regular field . Integer. May NOT be null.
'width': 1, //Regular field . Integer. May NOT be null.
'height': 1, //Regular field . Integer. May NOT be null.
'keyAction': 'Product', //Regular field . keyActionType. May NOT be null.
'label': 'KeyboardEntry 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
'identifier': null, //
'product': '0-2U12', //
'keyboard': '0-2U20', //
'subKeyboard': '0-2U20', //
'positionX': 1, //
'positionY': 1, //
'width': 1, //
'height': 1, //
'keyAction': 'Product', //
'label': 'KeyboardEntry 1', //
'custom': '' // String. Maximum 65535 characters. May be null.
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
{/*Methods called "new" will return the identifier of newly created entity by using this class */
'identifier': '0-2U28' // identifierType. May NOT be null.
}
{/*
}
Description | |
---|---|
VersionConflictJsonException |
|
ReferenceNotFoundJsonException |
|
PUT /v15/{sellerId}/keyboard-entries/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
PUT /v15/se9876543210/keyboard-entries/0-2U28 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Data to put */
'deleted': false, // true if entity was deleted . Boolean. May NOT be null.
'identifier': '0-2U28', //This field uniquely identifies entity. There is no decision what is it, only the requirement - it must be unique trough one
seller
. identifierType. May NOT be null.
'product': '0-2U12', //Regular field. Product identifier . String. May NOT be null.
'keyboard': '0-2U20', //Regular field. Keyboard identifier . String. May NOT be null.
'subKeyboard': '0-2U20', //Regular field. SubKeyboard identifier . String. May be null.
'positionX': 1, //Regular field . Integer. May NOT be null.
'positionY': 1, //Regular field . Integer. May NOT be null.
'width': 1, //Regular field . Integer. May NOT be null.
'height': 1, //Regular field . Integer. May NOT be null.
'keyAction': 'Product', //Regular field . keyActionType. May NOT be null.
'label': 'KeyboardEntry 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'custom': '' // String. Maximum 65535 characters. May be null.
}
'identifier': '0-2U28', //
'product': '0-2U12', //
'keyboard': '0-2U20', //
'subKeyboard': '0-2U20', //
'positionX': 1, //
'positionY': 1, //
'width': 1, //
'height': 1, //
'keyAction': 'Product', //
'label': 'KeyboardEntry 1', //
'custom': '' // String. Maximum 65535 characters. May be null.
}
HTTP/1.1 201 CREATED or HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
ReferenceNotFoundJsonException |
|
GET /v15/{sellerId}/keyboard-entries/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
GET /v15/se9876543210/keyboard-entries/0-2U28 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Description | |
---|---|
VersionConflictJsonException |
|
NotFoundJsonException |
|
DELETE /v15/{sellerId}/keyboard-entries/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
DELETE /v15/se9876543210/keyboard-entries/0-2U28 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
GET /v15/{sellerId}/keyboard-entries-diff/{versionFrom}/{versionTo} ¶
sellerId | sellerIdType |
|
|
versionFrom | integer |
|
|
versionTo | integer |
|
Request
Response
GET /v15/se9876543210/keyboard-entries-diff/0/9999 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* return list of items to be added, edited or deleted ({@link KeyboardEntryInfo#isDeleted()} = true) */
{ 'deleted': false, //true if entity was deleted . Boolean. May NOT be null.
'identifier': '45а5543534', //This field uniquely identifies entity. There is no decision what is it, only the requirement - it must be unique trough one
seller
. identifierType. May NOT be null.
'product': 'test', //Regular field. Product identifier . String. May NOT be null.
'keyboard': 'keyboard', //Regular field. Keyboard identifier . String. May NOT be null.
'subKeyboard': 'value', //Regular field. SubKeyboard identifier . String. May be null.
'positionX': 56, //Regular field . Integer. May NOT be null.
'positionY': 89, //Regular field . Integer. May NOT be null.
'width': 123, //Regular field . Integer. May NOT be null.
'height': 675, //Regular field . Integer. May NOT be null.
'keyAction': 'Product', //Regular field . keyActionType. May NOT be null.
'label': 'test', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'custom': 'test' // String. Maximum 65535 characters. May be null.
}
{ 'deleted': false, //
'identifier': '45а5543534', //
'product': 'test', //
'keyboard': 'keyboard', //
'subKeyboard': 'value', //
'positionX': 56, //
'positionY': 89, //
'width': 123, //
'height': 675, //
'keyAction': 'Product', //
'label': 'test', //
'custom': 'test' // String. Maximum 65535 characters. May be null.
}
GET /v15/{sellerId}/keyboard-entries ¶
sellerId | sellerIdType |
|
|
orderBy | Query string. Optional | sellerFieldsType |
|
orderDesc | Query string. Optional | boolean |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15//keyboard-entries HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
/* return list of entities which exists on current seller or null if list of entities is not modified since version */
{ 'deleted': false, //true if entity was deleted . Boolean. May NOT be null.
'identifier': '45а5543534', //This field uniquely identifies entity. There is no decision what is it, only the requirement - it must be unique trough one
seller
. identifierType. May NOT be null.
'product': 'test', //Regular field. Product identifier . String. May NOT be null.
'keyboard': 'keyboard', //Regular field. Keyboard identifier . String. May NOT be null.
'subKeyboard': 'value', //Regular field. SubKeyboard identifier . String. May be null.
'positionX': 56, //Regular field . Integer. May NOT be null.
'positionY': 89, //Regular field . Integer. May NOT be null.
'width': 123, //Regular field . Integer. May NOT be null.
'height': 675, //Regular field . Integer. May NOT be null.
'keyAction': 'Product', //Regular field . keyActionType. May NOT be null.
'label': 'test', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'custom': 'test' // String. Maximum 65535 characters. May be null.
}
{ 'deleted': false, //
'identifier': '45а5543534', //
'product': 'test', //
'keyboard': 'keyboard', //
'subKeyboard': 'value', //
'positionX': 56, //
'positionY': 89, //
'width': 123, //
'height': 675, //
'keyAction': 'Product', //
'label': 'test', //
'custom': 'test' // String. Maximum 65535 characters. May be null.
}
GET /v15/{sellerId}/orders-diff/{versionFrom}/{versionTo} ¶
sellerId | sellerIdType |
|
|
versionFrom | integer |
|
|
versionTo | integer |
|
Request
Response
GET /v15/se9876543210/orders-diff/0/9999 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{/*Represents customer's order - list of order items. */
'treasurerName': 'Test name', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'orderItems': [ {/*Represents how many products of particular type was ordered. */
'productIdentifier': '0-2U12', // identifierType. May NOT be null.
'productCustomization': 'Customization A', //Any customer's wishes about product customization. . String. Maximum 512 characters. May be null.
'delta': 700 //
The number of products (kg, hg, hours, whatever unit) if deltaUnit is true,
otherwise the amount of currency.
. Integer. May NOT be null.
} ] // List of objects.
}
{/*
'orderItems': [ {/*
'productCustomization': 'Customization A', //
'delta': 700 //
} ] // List of objects.
}
POST /v15/{sellerId}/orders ¶
sellerId | sellerIdType |
|
Request
Response
POST /v15/se9876543210/orders HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Represents customer's order - list of order items. */
'treasurerName': 'treasurerName', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'orderItems': [ {/*Represents how many products of particular type was ordered. */
'productIdentifier': '0-2U12', // identifierType. May NOT be null.
'productCustomization': 'Customization A', //Any customer's wishes about product customization. . String. Maximum 512 characters. May be null.
'delta': 700 //
The number of products (kg, hg, hours, whatever unit) if deltaUnit is true,
otherwise the amount of currency.
. Integer. May NOT be null.
} ] // List of objects.
}
'orderItems': [ {/*
'productCustomization': 'Customization A', //
'delta': 700 //
} ] // List of objects.
}
HTTP/1.1 201 CREATED
Description | |
---|---|
ReferenceNotFoundJsonException |
|
ValidationJsonException |
|
GET /v15/{sellerId}/orders/advanced ¶
sellerId | sellerIdType |
|
Request
Response
GET /v15/se9876543210/orders/advanced HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[ {/*Represents customer's order - list of order items. Provides advanced information. */
'treasurerName': 'Test name', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'orderItems': {/*Represents how many products of particular type was ordered. */
'productInfo': {
'deleted': 'false', // True if entity was deleted. Only possible if return diff . May NOT be null.
'product': { 'deleted': 'false', //True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'barcode': '012345678912', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'netto': 100, //Regular field . Integer. May NOT be null.
'tax': '0-2U0Z', //Regular field . String. May NOT be null.
'salesUnit': 'Piece', //Regular field . salesUnitType. May NOT be null.
'countedInPrice': 'false', //Regular field . May NOT be null.
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '', // String. Maximum 65535 characters. May be null.
'price': '0' //
}, // A complex object. May NOT be null.
'tax': { 'deleted': 'false', //true if entity was deleted . May NOT be null.
'identifier': null, //This field uniqly identifies entity. There is no decision what is it, only the requirement - it must be unique trough one seller
. identifierType. May be null.
'vat': 1, //Regular field . Integer. Minimum 0. Maximum 100. May NOT be null.
'name': 'Test', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'custom': '' //Custom data concerned tax . String. Maximum 65535 characters. May be null.
} // A complex object. May NOT be null.
}, // A complex object. May NOT be null.
'productCustomization': 'Pizza', //Any customer's wishes about product customization. . String. Maximum 512 characters. May be null.
'delta': 1 //
The number of products (kg, hg, hours, whatever unit) if deltaUnit is true,
otherwise the amount of currency.
. Integer. May NOT be null.
}, // List of objects. A complex object.
'id': 42 // Integer.
} ]
[ {/*
'orderItems': {/*
'product': { 'deleted': 'false', //
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //
'barcode': '012345678912', //
'netto': 100, //
'tax': '0-2U0Z', //
'salesUnit': 'Piece', //
'countedInPrice': 'false', //
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '', // String. Maximum 65535 characters. May be null.
'price': '0' //
}, // A complex object. May NOT be null.
'tax': { 'deleted': 'false', //
'identifier': null, //
'vat': 1, //
'name': 'Test', //
'custom': '' //
} // A complex object. May NOT be null.
}, // A complex object. May NOT be null.
'productCustomization': 'Pizza', //
'delta': 1 //
}, // List of objects. A complex object.
'id': 42 // Integer.
} ]
GET /v15/{sellerId}/orders/{orderId}/advanced ¶
sellerId | sellerIdType |
|
|
orderId | integer |
|
Request
Response
GET /v15/se9876543210/orders/42/advanced HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{/*Represents customer's order - list of order items. Provides advanced information. */
'treasurerName': 'Test name', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'orderItems': {/*Represents how many products of particular type was ordered. */
'productInfo': {
'deleted': 'false', // True if entity was deleted. Only possible if return diff . May NOT be null.
'product': { 'deleted': 'false', //True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'barcode': '012345678912', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'netto': 100, //Regular field . Integer. May NOT be null.
'tax': '0-2U0Z', //Regular field . String. May NOT be null.
'salesUnit': 'Piece', //Regular field . salesUnitType. May NOT be null.
'countedInPrice': 'false', //Regular field . May NOT be null.
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '', // String. Maximum 65535 characters. May be null.
'price': '0' //
}, // A complex object. May NOT be null.
'tax': { 'deleted': 'false', //true if entity was deleted . May NOT be null.
'identifier': null, //This field uniqly identifies entity. There is no decision what is it, only the requirement - it must be unique trough one seller
. identifierType. May be null.
'vat': 1, //Regular field . Integer. Minimum 0. Maximum 100. May NOT be null.
'name': 'Test', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'custom': '' //Custom data concerned tax . String. Maximum 65535 characters. May be null.
} // A complex object. May NOT be null.
}, // A complex object. May NOT be null.
'productCustomization': 'Pizza', //Any customer's wishes about product customization. . String. Maximum 512 characters. May be null.
'delta': 1 //
The number of products (kg, hg, hours, whatever unit) if deltaUnit is true,
otherwise the amount of currency.
. Integer. May NOT be null.
}, // List of objects. A complex object.
'id': 42 // Integer.
}
{/*
'orderItems': {/*
'product': { 'deleted': 'false', //
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //
'barcode': '012345678912', //
'netto': 100, //
'tax': '0-2U0Z', //
'salesUnit': 'Piece', //
'countedInPrice': 'false', //
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '', // String. Maximum 65535 characters. May be null.
'price': '0' //
}, // A complex object. May NOT be null.
'tax': { 'deleted': 'false', //
'identifier': null, //
'vat': 1, //
'name': 'Test', //
'custom': '' //
} // A complex object. May NOT be null.
}, // A complex object. May NOT be null.
'productCustomization': 'Pizza', //
'delta': 1 //
}, // List of objects. A complex object.
'id': 42 // Integer.
}
Description | |
---|---|
ValidationJsonException |
|
GET /v15/{sellerId}/registrations/{cashRegisterName}/balance ¶
sellerId | sellerIdType |
|
|
cashRegisterName | cashRegisterNameType |
Request
Response
GET /v15/se9876543210/registrations/CashTK/balance HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'amount': 10000 //Amount of money in the cash register . Integer. Minimum 0. May NOT be null.
}
{ 'amount': 10000 //
}
Description | |
---|---|
ReferenceNotFoundJsonException |
|
POST /v15/{sellerId}/registrations/{cashRegisterName}/balance ¶
sellerId | sellerIdType |
|
|
cashRegisterName | cashRegisterNameType |
Request
Response
POST /v15/se9876543210/registrations/CashTK/balance HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{
'amount': 10000, // Amount of money . Integer. Minimum 0. May NOT be null.
'action': 'DEPOSIT' //Action . changeBalanceActionType. May NOT be null.
}
'action': 'DEPOSIT' //
}
HTTP/1.1 201 CREATED
GET /v15/{sellerId}/registrations ¶
sellerId | sellerIdType |
|
|
activeOnly | Query string. Optional | boolean |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
Request
Response
GET /v15/se9876543210/registrations HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'id': 654, // Integer. May NOT be null.
'cashRegisterName': 'cash name', // String. Maximum 16 characters. May NOT be null.
'country': 'se', // String. Minimum 2 characters. Maximum 2 characters. May NOT be null.
'corporateId': '345342356', // corporateIdType. May NOT be null.
'installationId': 8764444578 // Integer. May NOT be null.
}
{ 'id': 654, // Integer. May NOT be null.
'cashRegisterName': 'cash name', // String. Maximum 16 characters. May NOT be null.
'country': 'se', // String. Minimum 2 characters. Maximum 2 characters. May NOT be null.
'corporateId': '345342356', // corporateIdType. May NOT be null.
'installationId': 8764444578 // Integer. May NOT be null.
}
GET /v15/{sellerId}/registrations/stats ¶
sellerId | sellerIdType |
|
|
period | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/registrations/stats HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[ {/*Represents stats for cash registers by total brutto. */
'cashRegisterName': 'Cash22', // cashRegisterNameType. May NOT be null.
'total': 1200 //Total stats by sales brutto. . Integer. Minimum 0.
} ]
[ {/*
'total': 1200 //
} ]
Description | |
---|---|
ValidationJsonException |
|
GET /v15/restaurants/{sellerId} ¶
sellerId | sellerIdType |
|
Request
Response
GET /v15/restaurants/se9876543210 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{/*Same set of field as in Restaurant allowed to be in restaurant info. */
'country': 'se', // countryType. May NOT be null.
'corporateId': '9876543210', // corporateIdType. May NOT be null.
'name': 'Super Restaurant', // String. Minimum 1 characters. Maximum 96 characters. May NOT be null.
'city': 'Stockholm', // String. Minimum 1 characters. Maximum 255 characters.
'address': 'Street 194/144', // String. Minimum 1 characters. Maximum 500 characters.
'phone': '', // String. Minimum 1 characters. Maximum 96 characters.
'workHours': '8', // String.
'description': '', // String.
'averageBill': 150, // Integer.
'menu': [ {/*Extended category info for restaurant which contains list of products and images. */
'name': '', // String. Maximum 96 characters. May NOT be null.
'products': [ { 'deleted': 'false', //True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'barcode': '012345678912', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'netto': 100, //Regular field . Integer. May NOT be null.
'tax': '0-2U0Z', //Regular field . String. May NOT be null.
'salesUnit': 'Piece', //Regular field . salesUnitType. May NOT be null.
'countedInPrice': 'false', //Regular field . May NOT be null.
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
} ], // List of objects.
'images': ['PRODUCT1.PNG', 'PRODUCT2.PNG'] // A complex object.
} ], // List of objects.
'images': ['MAIN.PNG', 'SECONDARY.PNG'], // A complex object.
'custom': '' // String. Maximum 65535 characters.
}
{/*
'corporateId': '9876543210', // corporateIdType. May NOT be null.
'name': 'Super Restaurant', // String. Minimum 1 characters. Maximum 96 characters. May NOT be null.
'city': 'Stockholm', // String. Minimum 1 characters. Maximum 255 characters.
'address': 'Street 194/144', // String. Minimum 1 characters. Maximum 500 characters.
'phone': '', // String. Minimum 1 characters. Maximum 96 characters.
'workHours': '8', // String.
'description': '', // String.
'averageBill': 150, // Integer.
'menu': [ {/*
'products': [ { 'deleted': 'false', //
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //
'barcode': '012345678912', //
'netto': 100, //
'tax': '0-2U0Z', //
'salesUnit': 'Piece', //
'countedInPrice': 'false', //
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
} ], // List of objects.
'images': ['PRODUCT1.PNG', 'PRODUCT2.PNG'] // A complex object.
} ], // List of objects.
'images': ['MAIN.PNG', 'SECONDARY.PNG'], // A complex object.
'custom': '' // String. Maximum 65535 characters.
}
Description | |
---|---|
NotFoundJsonException |
|
PUT /v15/restaurants/{sellerId} ¶
sellerId | sellerIdType |
|
Request
Response
PUT /v15/restaurants/se9876543210 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Same set of field as in Restaurant allowed to be in restaurant info. */
'country': 'se', // countryType. May NOT be null.
'corporateId': '9876543210', // corporateIdType. May NOT be null.
'name': 'Super Restaurant', // String. Minimum 1 characters. Maximum 96 characters. May NOT be null.
'city': 'Stockholm', // String. Minimum 1 characters. Maximum 255 characters.
'address': 'Street 194/144', // String. Minimum 1 characters. Maximum 500 characters.
'phone': '', // String. Minimum 1 characters. Maximum 96 characters.
'workHours': '8', // String.
'description': '', // String.
'averageBill': 150, // Integer.
'menu': [ {/*Extended category info for restaurant which contains list of products and images. */
'name': '', // String. Maximum 96 characters. May NOT be null.
'products': [ { 'deleted': 'false', //True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'barcode': '012345678912', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'netto': 100, //Regular field . Integer. May NOT be null.
'tax': '0-2U0Z', //Regular field . String. May NOT be null.
'salesUnit': 'Piece', //Regular field . salesUnitType. May NOT be null.
'countedInPrice': 'false', //Regular field . May NOT be null.
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
} ], // List of objects.
'images': ['PRODUCT1.PNG', 'PRODUCT2.PNG'] // A complex object.
} ], // List of objects.
'images': ['MAIN.PNG', 'SECONDARY.PNG'], // A complex object.
'custom': '' // String. Maximum 65535 characters.
}
'corporateId': '9876543210', // corporateIdType. May NOT be null.
'name': 'Super Restaurant', // String. Minimum 1 characters. Maximum 96 characters. May NOT be null.
'city': 'Stockholm', // String. Minimum 1 characters. Maximum 255 characters.
'address': 'Street 194/144', // String. Minimum 1 characters. Maximum 500 characters.
'phone': '', // String. Minimum 1 characters. Maximum 96 characters.
'workHours': '8', // String.
'description': '', // String.
'averageBill': 150, // Integer.
'menu': [ {/*
'products': [ { 'deleted': 'false', //
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //
'barcode': '012345678912', //
'netto': 100, //
'tax': '0-2U0Z', //
'salesUnit': 'Piece', //
'countedInPrice': 'false', //
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
} ], // List of objects.
'images': ['PRODUCT1.PNG', 'PRODUCT2.PNG'] // A complex object.
} ], // List of objects.
'images': ['MAIN.PNG', 'SECONDARY.PNG'], // A complex object.
'custom': '' // String. Maximum 65535 characters.
}
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
NotFoundJsonException |
|
ForbiddenJsonException |
|
GET /v15/restaurants ¶
orderBy | Query string. Optional | sellerFieldsType |
|
orderDesc | Query string. Optional | boolean |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/restaurants HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[ {/*Same set of field as in Restaurant allowed to be in restaurant info. */
'country': 'se', // countryType. May NOT be null.
'corporateId': '9876543210', // corporateIdType. May NOT be null.
'name': 'Super Restaurant', // String. Minimum 1 characters. Maximum 96 characters. May NOT be null.
'city': 'Stockholm', // String. Minimum 1 characters. Maximum 255 characters.
'address': 'Street 194/144', // String. Minimum 1 characters. Maximum 500 characters.
'phone': '', // String. Minimum 1 characters. Maximum 96 characters.
'workHours': '8', // String.
'description': '', // String.
'averageBill': 150, // Integer.
'menu': [ {/*Extended category info for restaurant which contains list of products and images. */
'name': '', // String. Maximum 96 characters. May NOT be null.
'products': [ { 'deleted': 'false', //True if entity was deleted. Only possible if return diff . May NOT be null.
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'barcode': '012345678912', //Regular field . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'netto': 100, //Regular field . Integer. May NOT be null.
'tax': '0-2U0Z', //Regular field . String. May NOT be null.
'salesUnit': 'Piece', //Regular field . salesUnitType. May NOT be null.
'countedInPrice': 'false', //Regular field . May NOT be null.
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
} ], // List of objects.
'images': ['PRODUCT1.PNG', 'PRODUCT2.PNG'] // A complex object.
} ], // List of objects.
'images': ['MAIN.PNG', 'SECONDARY.PNG'], // A complex object.
'custom': '' // String. Maximum 65535 characters.
} ]
[ {/*
'corporateId': '9876543210', // corporateIdType. May NOT be null.
'name': 'Super Restaurant', // String. Minimum 1 characters. Maximum 96 characters. May NOT be null.
'city': 'Stockholm', // String. Minimum 1 characters. Maximum 255 characters.
'address': 'Street 194/144', // String. Minimum 1 characters. Maximum 500 characters.
'phone': '', // String. Minimum 1 characters. Maximum 96 characters.
'workHours': '8', // String.
'description': '', // String.
'averageBill': 150, // Integer.
'menu': [ {/*
'products': [ { 'deleted': 'false', //
'identifier': '0-2U12', // identifierType. May NOT be null.
'name': 'Product 1', //
'barcode': '012345678912', //
'netto': 100, //
'tax': '0-2U0Z', //
'salesUnit': 'Piece', //
'countedInPrice': 'false', //
'description': '', // String. Maximum 1024 characters. May be null.
'custom': '' // String. Maximum 65535 characters. May be null.
} ], // List of objects.
'images': ['PRODUCT1.PNG', 'PRODUCT2.PNG'] // A complex object.
} ], // List of objects.
'images': ['MAIN.PNG', 'SECONDARY.PNG'], // A complex object.
'custom': '' // String. Maximum 65535 characters.
} ]
GET /v15/{sellerId}/treasurers/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
GET /v15/se9876543210/treasurers/0-2U0Z HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'deleted': false, //True if entity was deleted . Boolean. May NOT be null.
'identifier': '0-2U0Z', // identifierType. May NOT be null.
'name': 'test', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'ssn': '123423567', //Social security number of user . String. Maximum 16 characters. May NOT be null.
'custom': '' // String. Maximum 65535 characters.
}
{ 'deleted': false, //
'identifier': '0-2U0Z', // identifierType. May NOT be null.
'name': 'test', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'ssn': '123423567', //
'custom': '' // String. Maximum 65535 characters.
}
Description | |
---|---|
VersionConflictJsonException |
|
NotFoundJsonException |
|
PUT /v15/{sellerId}/treasurers/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
PUT /v15/se9876543210/treasurers/0-2U0Z HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{
'deleted': false, // True if entity was deleted . Boolean. May NOT be null.
'identifier': '0-2U0Z', // identifierType. May NOT be null.
'name': 'test', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'ssn': '123423567', //Social security number of user . String. Maximum 16 characters. May NOT be null.
'custom': '' // String. Maximum 65535 characters.
}
'identifier': '0-2U0Z', // identifierType. May NOT be null.
'name': 'test', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'ssn': '123423567', //
'custom': '' // String. Maximum 65535 characters.
}
HTTP/1.1 201 CREATED or HTTP/1.1 204 NO CONTENT
Description | |
---|---|
VersionConflictJsonException |
|
POST /v15/{sellerId}/treasurers ¶
sellerId | sellerIdType |
|
Request
Response
POST /v15/se9876543210/treasurers HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{
'deleted': false, // True if entity was deleted . Boolean. May NOT be null.
'identifier': '0-2U0Z', // identifierType. May NOT be null.
'name': 'test', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'ssn': '123423567', //Social security number of user . String. Maximum 16 characters. May NOT be null.
'custom': '' // String. Maximum 65535 characters.
}
'identifier': '0-2U0Z', // identifierType. May NOT be null.
'name': 'test', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'ssn': '123423567', //
'custom': '' // String. Maximum 65535 characters.
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
/* Generated unique identifier */
{/*Methods called "new" will return the identifier of newly created entity by using this class */
'identifier': '0-2U20' // identifierType. May NOT be null.
}
{/*
}
Description | |
---|---|
VersionConflictJsonException |
|
DELETE /v15/{sellerId}/treasurers/{identifier} ¶
sellerId | sellerIdType |
|
|
identifier | identifierType |
|
Request
Response
DELETE /v15/se9876543210/treasurers/0-2U0Z HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
NotFoundJsonException |
GET /v15/{sellerId}/treasurers-diff/{versionFrom}/{versionTo} ¶
sellerId | sellerIdType |
|
|
versionFrom | integer |
|
|
versionTo | integer |
|
Request
Response
GET /v15/se9876543210/treasurers-diff/0/9999 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'deleted': false, //True if entity was deleted . Boolean. May NOT be null.
'identifier': '0-2U0Z', // identifierType. May NOT be null.
'name': 'test', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'ssn': '123423567', //Social security number of user . String. Maximum 16 characters. May NOT be null.
'custom': '' // String. Maximum 65535 characters.
}
{ 'deleted': false, //
'identifier': '0-2U0Z', // identifierType. May NOT be null.
'name': 'test', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'ssn': '123423567', //
'custom': '' // String. Maximum 65535 characters.
}
GET /v15/{sellerId}/treasurers ¶
sellerId | sellerIdType |
|
|
orderBy | Query string. Optional | sellerFieldsType |
|
orderDesc | Query string. Optional | boolean |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/treasurers HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'deleted': false, //True if entity was deleted . Boolean. May NOT be null.
'identifier': '0-2U0Z', // identifierType. May NOT be null.
'name': 'test', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'ssn': '123423567', //Social security number of user . String. Maximum 16 characters. May NOT be null.
'custom': '' // String. Maximum 65535 characters.
}
{ 'deleted': false, //
'identifier': '0-2U0Z', // identifierType. May NOT be null.
'name': 'test', // String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'ssn': '123423567', //
'custom': '' // String. Maximum 65535 characters.
}
GET /v15/{sellerId}/bookings/{id} ¶
sellerId | sellerIdType |
|
|
id | integer |
|
Request
Response
GET /v15/se9876543210/bookings/1 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'id': 1, // Integer.
'bookingDate': 1410421778118, // Date: amount of milliseconds since UNIX epoch. May NOT be null.
'persons': 4, // Integer. May NOT be null.
'description': 'no solt in all dishes', // String. Maximum 1024 characters.
'contactInfo': {/*Information about person. */
'name': 'Stefan', // Name of person who makes activation . String. May NOT be null.
'phone': '56745325', //Phone number of person who requests activation . String. May NOT be null.
'email': 'test@test.se' //Email of person who requests activation . String. May NOT be null.
} // A complex object. May NOT be null.
}
{ 'id': 1, // Integer.
'bookingDate': 1410421778118, // Date: amount of milliseconds since UNIX epoch. May NOT be null.
'persons': 4, // Integer. May NOT be null.
'description': 'no solt in all dishes', // String. Maximum 1024 characters.
'contactInfo': {/*
'phone': '56745325', //
'email': 'test@test.se' //
} // A complex object. May NOT be null.
}
Description | |
---|---|
NotFoundJsonException |
|
ForbiddenJsonException |
|
PUT /v15/{sellerId}/bookings/{id} ¶
sellerId | sellerIdType |
|
|
id | integer |
|
Request
Response
PUT /v15/se9876543210/bookings/1 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{
'id': 1, // Integer.
'bookingDate': 1410421778118, // Date: amount of milliseconds since UNIX epoch. May NOT be null.
'persons': 4, // Integer. May NOT be null.
'description': 'no solt in all dishes', // String. Maximum 1024 characters.
'contactInfo': {/*Information about person. */
'name': 'Stefan', // Name of person who makes activation . String. May NOT be null.
'phone': '56745325', //Phone number of person who requests activation . String. May NOT be null.
'email': 'test@test.se' //Email of person who requests activation . String. May NOT be null.
} // A complex object. May NOT be null.
}
'bookingDate': 1410421778118, // Date: amount of milliseconds since UNIX epoch. May NOT be null.
'persons': 4, // Integer. May NOT be null.
'description': 'no solt in all dishes', // String. Maximum 1024 characters.
'contactInfo': {/*
'phone': '56745325', //
'email': 'test@test.se' //
} // A complex object. May NOT be null.
}
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
NotFoundJsonException |
|
ForbiddenJsonException |
|
VersionConflictJsonException |
|
POST /v15/{sellerId}/bookings ¶
sellerId | sellerIdType |
|
Request
Response
POST /v15/se9876543210/bookings HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{
'id': null, // Integer.
'bookingDate': 1410421778118, // Date: amount of milliseconds since UNIX epoch. May NOT be null.
'persons': 4, // Integer. May NOT be null.
'description': 'no solt in all dishes', // String. Maximum 1024 characters.
'contactInfo': {/*Information about person. */
'name': 'Stefan', // Name of person who makes activation . String. May NOT be null.
'phone': '56745325', //Phone number of person who requests activation . String. May NOT be null.
'email': 'test@test.se' //Email of person who requests activation . String. May NOT be null.
} // A complex object. May NOT be null.
}
'bookingDate': 1410421778118, // Date: amount of milliseconds since UNIX epoch. May NOT be null.
'persons': 4, // Integer. May NOT be null.
'description': 'no solt in all dishes', // String. Maximum 1024 characters.
'contactInfo': {/*
'phone': '56745325', //
'email': 'test@test.se' //
} // A complex object. May NOT be null.
}
HTTP/1.1 201 CREATED
Description | |
---|---|
NotFoundJsonException |
|
DELETE /v15/{sellerId}/bookings/{id} ¶
sellerId | sellerIdType |
|
|
id | integer |
|
Request
Response
DELETE /v15/se9876543210/bookings/1 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
NotFoundJsonException |
|
ForbiddenJsonException |
|
VersionConflictJsonException |
|
GET /v15/{sellerId}/bookings ¶
sellerId | sellerIdType |
|
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/bookings HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'id': 1, // Integer.
'bookingDate': 1410421778118, // Date: amount of milliseconds since UNIX epoch. May NOT be null.
'persons': 4, // Integer. May NOT be null.
'description': 'no solt in all dishes', // String. Maximum 1024 characters.
'contactInfo': {/*Information about person. */
'name': 'Stefan', // Name of person who makes activation . String. May NOT be null.
'phone': '56745325', //Phone number of person who requests activation . String. May NOT be null.
'email': 'test@test.se' //Email of person who requests activation . String. May NOT be null.
} // A complex object. May NOT be null.
}
{ 'id': 1, // Integer.
'bookingDate': 1410421778118, // Date: amount of milliseconds since UNIX epoch. May NOT be null.
'persons': 4, // Integer. May NOT be null.
'description': 'no solt in all dishes', // String. Maximum 1024 characters.
'contactInfo': {/*
'phone': '56745325', //
'email': 'test@test.se' //
} // A complex object. May NOT be null.
}
POST /v15/{sellerId}/sales ¶
sellerId | sellerIdType |
Request
Response
POST /v15/se9876543210/sales HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{
'sellerIdentifier': 'se9876543210', // . String. Minimum 1 characters. Maximum 32 characters. May NOT be null.
'saleState': 'Open', // . saleStateType. May NOT be null.
'refund': true, // . Boolean. May NOT be null.
'refundFor': 10, // . Integer. May be null.
'absoluteDiscount': 0, // . Integer. May NOT be null.
'relativeDiscount': 50, // . Integer. May NOT be null.
'vanillaBrutto': 100, // . Integer. May NOT be null.
'discount': 100, // . Integer. May NOT be null.
'brutto': 50, // . Integer. May NOT be null.
'vat': 25, // . Integer. May NOT be null.
'controlUnitId': '123456', // . String. May be null.
'treasurer': '0-ABCD', // . String. May be null.
'close': 1414800000001, // . Date: amount of milliseconds since UNIX epoch. May be null.
'saleProducts': [ { 'productIdentifier': 'PRODUCT1', // . String. May NOT be null.
'deltaUnit': false, // . Boolean. May NOT be null.
'delta': 10, // . Integer. May NOT be null.
'absoluteDiscount': 0, // . Integer. May NOT be null.
'relativeDiscount': 50, // . Integer. May NOT be null.
'vat': 25, // . Integer.
'netto': 100, // . Integer.
'brutto': 125, // . Integer.
'vanillaBrutto': 125, // . Integer.
'discount': 50, // . Integer.
'created': 1414800000001 // . Date: amount of milliseconds since UNIX epoch.
} ], // List of objects.
'prints': [ { 'receiptNumber': 1234, // . Integer.
'printType': 'Normal', // . printType.
'deliveryType': 'Print', // . deliveryType.
'controlNumber': '123456789', // . String.
'created': 1414800000001, // . Integer.
'printed': false // . Boolean.
} ], // List of objects.
'payments': [ { 'paymentType': 'Cash', // . paymentType.
'amount': 100, // . Integer.
'paymentState': 'SENDING' // . paymentStateType.
} ], // List of objects.
'vatRateSums': [ { 'vatRate': 50, // . Integer.
'vanillaVat': 5000, // . Integer.
'vanillaNetto': 5000, // . Integer.
'vanillaBrutto': 10000, // . Integer.
'vat': 500, // . Integer.
'netto': 500, // . Integer.
'brutto': 1000 // . Integer.
} ] // List of objects.
}
'saleState': 'Open', //
'refund': true, //
'refundFor': 10, //
'absoluteDiscount': 0, //
'relativeDiscount': 50, //
'vanillaBrutto': 100, //
'discount': 100, //
'brutto': 50, //
'vat': 25, //
'controlUnitId': '123456', //
'treasurer': '0-ABCD', //
'close': 1414800000001, //
'saleProducts': [ { 'productIdentifier': 'PRODUCT1', //
'deltaUnit': false, //
'delta': 10, //
'absoluteDiscount': 0, //
'relativeDiscount': 50, //
'vat': 25, //
'netto': 100, //
'brutto': 125, //
'vanillaBrutto': 125, //
'discount': 50, //
'created': 1414800000001 //
} ], // List of objects.
'prints': [ { 'receiptNumber': 1234, //
'printType': 'Normal', //
'deliveryType': 'Print', //
'controlNumber': '123456789', //
'created': 1414800000001, //
'printed': false //
} ], // List of objects.
'payments': [ { 'paymentType': 'Cash', //
'amount': 100, //
'paymentState': 'SENDING' //
} ], // List of objects.
'vatRateSums': [ { 'vatRate': 50, //
'vanillaVat': 5000, //
'vanillaNetto': 5000, //
'vanillaBrutto': 10000, //
'vat': 500, //
'netto': 500, //
'brutto': 1000 //
} ] // List of objects.
}
HTTP/1.1 201 CREATED
Content-Type: application/json;charset=UTF-8
{/*Methods called "new" will return the identifier of newly created entity by using this class
Generated unique identifier */
'identifier': '0-2U0Z' // identifierType. May NOT be null.
}
{/*
}
Description | |
---|---|
VersionConflictJsonException |
|
ReceiptNotPrintedJsonException |
|
DayClosedJsonException |
|
GET /v15/{sellerId}/sales ¶
sellerId | sellerIdType | ||
cashRegisterName | Query string. Optional | string |
|
period | Query string. Optional | string |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/sales HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
GET /v15/{sellerId}/sales/{identifier}/receipt ¶
sellerId | sellerIdType | ||
identifier | identifierType |
|
Request
Response
GET /v15/se9876543210/sales/40/receipt HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
POST /v15/{sellerId}/sales/{identifier}/receipt ¶
sellerId | sellerIdType | ||
identifier | identifierType |
|
Request
Response
POST /v15/se9876543210/sales/40/receipt HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 201 CREATED
Description | |
---|---|
ReceiptAlreadyPrintedJsonException |
|
POST /v15/{sellerId}/sales/{saleId}/copy ¶
sellerId | sellerIdType | ||
saleId | identifierType |
|
Request
Response
POST /v15/se9876543210/sales/40/copy HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 201 CREATED
Description | |
---|---|
ReceiptAlreadyPrintedJsonException |
|
GET /v15/{sellerId}/days ¶
sellerId | sellerIdType | ||
cashRegisterName | Query string. Optional | string |
|
period | Query string. Optional | string |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/days HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'id': 0, // . Integer. May NOT be null.
'date': 1414200000 // . Integer. May NOT be null.
}
{ 'id': 0, //
'date': 1414200000 //
}
GET /v15/{sellerId}/days/{dayId}/report ¶
sellerId | sellerIdType | ||
dayId | identifierType |
|
Request
Response
GET /v15/se9876543210/days/1/report HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
POST /v15/{sellerId}/days/{dayId}/report ¶
sellerId | sellerIdType | ||
dayId | identifierType |
|
Request
Response
POST /v15/se9876543210/days/1/report HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 201 CREATED
Description | |
---|---|
DayNotClosedJsonException |
|
POST /v15/{sellerId}/days/current ¶
sellerId | sellerIdType |
Request
Response
POST /v15/se9876543210/days/current HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 201 CREATED
Description | |
---|---|
ReceiptNotPrintedJsonException |
|
DayClosedJsonException |
|
GET /v15/{sellerId}/e-journals/{cashRegisterName} ¶
sellerId | sellerIdType | ||
cashRegisterName | cashRegisterNameType |
Request
Response
GET /v15/se9876543210/e-journals/Cash22 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
GET /v15/{sellerId}/sales/stats ¶
sellerId | sellerIdType | ||
cashRegisterName | Query string. Optional | string |
|
period | Query string. Optional | string |
|
Request
Response
GET /v15/se9876543210/sales/stats HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{ 'total': 1200, //Total stats by sales brutto. . Integer. Minimum 0.
'amountOfSales': 100, //Total amount of sales. . Integer. Minimum 0.
'amountOfProducts': 150, //Total amount of sold products. . Integer. Minimum 0.
'bruttoStats': {'2014-12-01T00:00:00.000+0000':424500} //Date-to-brutto stats grouped by some period (i.e. 'day' or 'hour'). Date has format: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'. . A complex object. May NOT be null.
}
{ 'total': 1200, //
'amountOfSales': 100, //
'amountOfProducts': 150, //
'bruttoStats': {'2014-12-01T00:00:00.000+0000':424500} //
}
GET /v15/installations/{productionNumber}/build-infoes ¶
productionNumber | string |
Request
Response
GET /v15/installations/TEST100000000000000000081/build-infoes HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[ {/*Information about android device taken from
android.os.Build.
*/
'name': 'KEY', // String. Maximum 25 characters. May NOT be null.
'value': 'VALUE', // String. Maximum 1024 characters. May NOT be null.
'installation': 'TEST100000000000000000081' // String. May NOT be null.
} ]
[ {/*
'value': 'VALUE', // String. Maximum 1024 characters. May NOT be null.
'installation': 'TEST100000000000000000081' // String. May NOT be null.
} ]
Description | |
---|---|
NotFoundJsonException |
|
ForbiddenJsonException |
|
GET /v15/kd-facets ¶
controlUnit | Query string. Optional | string |
|
seller | Query string. Optional | string |
|
cashRegisterName | Query string. Optional | string |
|
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
Request
Response
GET /v15/kd-facets HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[ {/*
Represents a log entity with information about/pospluses/kd. May contain exception information.
*/
'activation': 42, // Integer.
'brutto': 5000, // Integer.
'kdDate': 1414800000001, // Date: amount of milliseconds since UNIX epoch. May NOT be null.
'vatRateToSum': {'6':1000}, //A javascript object. The key - tax value. The value - the sum. E.g. 20.12 SEK splitted between 12.05 SEK for VAT 6% and 10.07 SEK
for VAT 12% will do {'6': 1205, '12': 1007}
. A complex object. May NOT be null.
'receiptNumber': 1, //Autoincrement receipt number within one POS terminal . Integer.
'printType': 'Normal', // printTypeEnum. May NOT be null.
'refund': false, // Boolean.
'errorMessage': 'Command kd 201411061916 1234567897 C1415276184016 0 normal 0,00 998,99 0,06;10,00 0,03;0,08 0,00;0,00 0,00;0,00 failed with response -1 K34P72NUH7A3HST7HY7EF6RUWJLLWVOC;MKFXCN7ENWYJS4KRP3JJ3KG64M 0x1ACB', // String.
'errorStackTrace': 'com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:67)' // String.
} ]
[ {/*
'brutto': 5000, // Integer.
'kdDate': 1414800000001, // Date: amount of milliseconds since UNIX epoch. May NOT be null.
'vatRateToSum': {'6':1000}, //
'receiptNumber': 1, //
'printType': 'Normal', // printTypeEnum. May NOT be null.
'refund': false, // Boolean.
'errorMessage': 'Command kd 201411061916 1234567897 C1415276184016 0 normal 0,00 998,99 0,06;10,00 0,03;0,08 0,00;0,00 0,00;0,00 failed with response -1 K34P72NUH7A3HST7HY7EF6RUWJLLWVOC;MKFXCN7ENWYJS4KRP3JJ3KG64M 0x1ACB', // String.
'errorStackTrace': 'com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:67)' // String.
} ]
Description | |
---|---|
InconsistentDataJsonException |
|
PUT /v15/users/{username} ¶
username |
Request
Response
PUT /v15/users/username HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: t.srv4pos.com
{/* Non-public information of user for super admins. It has password hash. */
'deleted': 'false', // True if entity was deleted. .
'username': 'username', //Regular field. . String. Minimum 1 characters. Maximum 50 characters. May NOT be null.
'email': 'mail@username.com', //User's email. . String. Minimum 6 characters. Maximum 50 characters. Regular expression
/^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
. May NOT be null.
'role': 'ROLE_SOFTWARE_VENDOR_ADMIN', // roleType. May NOT be null.
'softwareVendor': null, //
If role == ROLE_HYPER_ADMIN, then null.
If role == ROLE_SOFTWARE_VENDOR_ADMIN, then not null.
. Integer. May be null.
'password': '9999' // String. Maximum 200 characters. May NOT be null.
}
'username': 'username', //
'email': 'mail@username.com', //
'role': 'ROLE_SOFTWARE_VENDOR_ADMIN', // roleType. May NOT be null.
'softwareVendor': null, //
'password': '9999' // String. Maximum 200 characters. May NOT be null.
}
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
NotFoundJsonException |
|
DELETE /v15 ¶
Request
Response
DELETE /v15 HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 204 NO CONTENT
Description | |
---|---|
NotFoundJsonException |
|
ReferenceNotFoundJsonException |
|
GET /v15/users ¶
firstResult | Query string. Optional | integer |
|
maxResults | Query string. Optional | integer |
|
like | Query string. Optional | string |
|
Request
Response
GET /v15/users HTTP/1.1
Accept: application/json
Host: t.srv4pos.com
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[ {/*Non-public information of user for super admins. It has password hash. */
'deleted': 'false', // True if entity was deleted. .
'username': 'username', //Regular field. . String. Minimum 1 characters. Maximum 50 characters. May NOT be null.
'email': 'mail@username.com', //User's email. . String. Minimum 6 characters. Maximum 50 characters. Regular expression
/^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
. May NOT be null.
'role': 'ROLE_SOFTWARE_VENDOR_ADMIN', // roleType. May NOT be null.
'softwareVendor': null, //
If role == ROLE_HYPER_ADMIN, then null.
If role == ROLE_SOFTWARE_VENDOR_ADMIN, then not null.
. Integer. May be null.
'password': '9999' // String. Maximum 200 characters. May NOT be null.
} ]
[ {/*
'username': 'username', //
'email': 'mail@username.com', //
'role': 'ROLE_SOFTWARE_VENDOR_ADMIN', // roleType. May NOT be null.
'softwareVendor': null, //
'password': '9999' // String. Maximum 200 characters. May NOT be null.
} ]