1. Access
-
HTTP Basic Authentication basicAuth
2. Endpoints
2.1. AuthenticationService
2.1.1. authenticationService.authenticate
POST /com.gk_software.pos.api.service.security.AuthenticationService/authenticate
Performs a login based on passed data in AuthenticationRequest.
Description
Performs a login based on passed data in AuthenticationRequest.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The AuthenticationRequest object. ComGkSoftwarePosApiServiceSecurityAuthenticationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error. |
2.1.2. authenticationService.updatePassword
POST /com.gk_software.pos.api.service.security.AuthenticationService/updatePassword
Update the operator password
Description
Update the operator password
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The UpdatePasswordRequest object. ComGkSoftwarePosApiServiceSecurityUpdatePasswordRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.2. AuthorizationService
2.3. BillDocWebService
2.3.1. billDocWebService.getInvoiceData
POST /com.gk_software.pos.api.service.communication.ws.billdoc.BillDocWebService/getInvoiceData
Method that allows retrieving of invoice data using the invoice number.
Description
Method that allows retrieving of invoice data using the invoice number.
WssbRfcBillDocRead
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The BillDocRequest object. ComGkSoftwarePosApiServiceCommunicationWsBilldocBillDocRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceCommunicationWsBilldocBillDocResponse |
500 |
in case of any error. |
2.4. CouponingService
2.4.1. couponService.checkCoupons
POST /com.gk_software.pos.api.service.coupon.CouponingService/checkCoupons
Executes a verification of the given coupons.
Description
Executes a verification of the given coupons.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The checkCoupons request object ComGkSoftwarePosApiServiceCouponCheckCouponsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.4.2. couponService.returnCoupons
POST /com.gk_software.pos.api.service.coupon.CouponingService/returnCoupons
Executes a return/redeem of coupons.
Description
This method executes a return/redeem operation of the coupons in the current transaction
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The returnCoupons request object ComGkSoftwarePosApiServiceCouponReturnCouponsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.5. CustomerByIdWebService
2.5.1. customerByIdWebService.searchCustomerById
POST /com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerByIdWebService/searchCustomerById
Search customer by customer id
Description
Search customer by customer id
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CustomerWebserviceRequest including customer identifier and web service config ComGkSoftwarePosApiServiceCommunicationWsCustomerByIdCustomerWebserviceRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceCommunicationWsCustomerByIdCustomerWebServiceResultSAPERP |
500 |
|
2.6. CustomerOperationService
2.6.1. customerOperationService.createCustomer
POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/createCustomer
Create new customer in given data provider with specified details.
Description
Create new customer in given data provider with specified details.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the UpdateCustomerRequest ComGkSoftwarePosApiServiceCommunicationWsOperationUpdateCustomerRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.6.2. customerOperationService.findCustomerById
POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerById
Search customer by given ID.
Description
Search customer by given ID.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FindCustomerByIdRequest ComGkSoftwarePosApiServiceCommunicationWsOperationFindCustomerByIdRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case an error occurs. |
2.6.3. customerOperationService.findCustomerByPartyIdentification
POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerDataByPartyIdentification
Find customer list by given party identification.
Description
Find customer list by given party identification.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FindCustomerByPartyIdentificationRequest ComGkSoftwarePosApiServiceCommunicationWsOperationFindCustomerByPartyIdentificationRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.6.4. customerOperationService.findCustomerContactViewListByFilter
POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerContactViewListByFilter
Search customer by filter.
Description
Search customer by filter.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The SearchCustomerRequest including the search criteria ComGkSoftwarePosApiServiceCommunicationWsCustomerSearchByCriteriaSearchCustomerRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
List[ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerContactView] |
500 |
in case of any error. |
2.6.5. customerOperationService.findCustomerData
POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerDataById
Search customer by given ID.
Description
Search customer by given ID.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FindCustomerDataRequest ComGkSoftwarePosApiServiceCommunicationWsOperationFindCustomerDataRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.6.6. customerOperationService.updateCustomer
POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/updateCustomer
Update customer in given data provider with specified details.
Description
Update customer in given data provider with specified details.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The UpdateCustomerRequest ComGkSoftwarePosApiServiceCommunicationWsOperationUpdateCustomerRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error. |
2.6.7. findLastCustomerId
POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findLastCustomerId
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.6.8. mapCustomerDOToCustomerData
POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/mapCustomerDOToCustomerData
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.7. CustomerTransactionService
2.7.1. customerTransactionService.createAndAddOrUpdateRetailTransactionCustomer
POST /com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/createAndAddOrUpdateRetailTransactionCustomer
Assign customer to current transaction by adding or updating existing customer.
Description
Assign customer to current transaction by adding or updating existing customer.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CustomerAssignmentRequest, it customer data required for assignment ComGkSoftwarePosApiServiceTransactionCustomerCustomerAssignmentRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
2.7.2. customerTransactionService.createAndAddRetailTransactionCustomer
POST /com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/createAndAddRetailTransactionCustomer
Assign customer to current transaction
Description
Assign customer to current transaction
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CustomerAssignmentRequest, it consist of data required for assignment ComGkSoftwarePosApiServiceTransactionCustomerCustomerAssignmentRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
2.7.3. customerTransactionService.registerCustomer
POST /com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/registerCustomer
Registers a customer to current transaction.
Description
Registers a customer to current transaction.Following steps are done dependent on config/request values:
-
Search for customer if searchDatabase=true (Local DB)
-
Assign customer to transaction {@link #createAndAddOrUpdateRetailTransactionCustomer(CustomerAssignmentRequest)}
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CustomerRegistrationRequest ComGkSoftwarePosApiServiceTransactionCustomerCustomerRegistrationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of error |
2.7.4. customerTransactionService.removeCustomerFromTransaction
POST /com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/removeCustomerFromTransaction
Remove customer from current transaction
Description
Remove customer from current transaction
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CustomerRemovalRequest ComGkSoftwarePosApiServiceTransactionCustomerCustomerRemovalRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
2.7.5. customerTransactionService.removeCustomerFromTransactionByTypeCode
POST /com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/removeCustomerFromTransactionByTypeCode
Remove customer from current transaction for given address type code.
Description
Remove customer from current transaction for given address type code.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The addressTypdeCode [String] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
2.8. DataPrivacyLogService
2.8.1. dataPrivacyLogService.storeCustomerDataChangedDataEvent
POST /com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerDataChangedDataEvent
Stores a data privacy event log by the given StoreCustomerDataChangedDataEventRequest when customer data is changed.
Description
Stores a data privacy event log by the given StoreCustomerDataChangedDataEventRequest when customer data is changed.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The StoreCustomerDataChangedDataEventRequest object ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerDataChangedDataEventRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
0 |
successful operation |
2.8.2. dataPrivacyLogService.storeCustomerDataCreatedDataEvent
POST /com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerDataCreatedDataEvent
Stores a data privacy event log by the given StoreCustomerDataCreatedDataEventRequest when customer data is created.
Description
Stores a data privacy event log by the given StoreCustomerDataCreatedDataEventRequest when customer data is created.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The StoreCustomerDataCreatedDataEventRequest object ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerDataCreatedDataEventRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
0 |
successful operation |
2.8.3. dataPrivacyLogService.storeCustomerDataReadDataEvent
POST /com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerDataReadDataEvent
Stores a data privacy event log by the given StoreCustomerDataReadDataEventRequest when customer data is read.
Description
Stores a data privacy event log by the given StoreCustomerDataReadDataEventRequest when customer data is read.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The StoreCustomerDataReadDataEventRequest object ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerDataReadDataEventRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
0 |
successful operation |
2.8.4. dataPrivacyLogService.storeCustomerSearchCriteriaEvent
POST /com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerSearchCriteriaEvent
Stores a data privacy event log by the given StoreCustomerSearchCriteriaEventRequest when customer data is se…
Description
Stores a data privacy event log by the given StoreCustomerSearchCriteriaEventRequest when customer data is searchedby criteria.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The StoreCustomerSearchCriteriaEventRequest ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerSearchCriteriaEventRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
0 |
successful operation |
2.9. Default
2.9.1. consolidateTransaction
POST /com.gk_software.pos.api.service.transaction.consolidation.ConsolidationService/consolidateTransaction
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.9.2. customerCardCodeConverterService.convertCodeToCustomerCardCode
POST /com.gk_software.pos.api.service.customer.CustomerCardCodeConverterService/convertCodeToCustomerCardCode
Obtains CustomerCardCode from given strings.
Description
Obtains CustomerCardCode from given strings.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
List of strings with aztec codes [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.9.3. customerCardCodeConverterService.convertCustomerCardCodeToCode
POST /com.gk_software.pos.api.service.customer.CustomerCardCodeConverterService/convertCustomerCardCodeToCode
Obtains list of aztec codes parsed from given CustomerCardCode.
Description
Obtains list of aztec codes parsed from given CustomerCardCode.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CustomerCardCode containing the information about customer card ComGkSoftwarePosFlowLibsCustomerCustomerCardCode |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
List[[String]] |
500 |
In case that the operation fails for any reason |
2.10. DigitalReceiptService
2.10.1. digitalReceiptService.processDigitalReceipt
POST /com.gk_software.pos.api.service.digital_receipt.DigitalReceiptService/processDigitalReceipt
This method sends, uploads or stores the digital combined PDF receipts.
Description
This method sends, uploads or stores the digital combined PDF receipts.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The processDigitalReceipt request object ComGkSoftwarePosApiServiceDigitalReceiptProcessDigitalReceiptRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceDigitalReceiptProcessDigitalReceiptResponse |
500 |
In case that the operation fails for any reason |
2.11. DynamicTableauService
2.11.1. dynamicTableauService.FindDynamicTableauItemListUpdateViewsByCriteria
POST /com.gk_software.pos.api.service.tableau.DynamicTableauDataService/FindDynamicTableauItemListUpdateViewsByCriteria
Find dynamic tableau item list update views by criteria.
Description
Find dynamic tableau item list update views by criteria.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FindDynamicTableauItemListUpdateViewsRequest object ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListUpdateViewsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListUpdateViewsResponse |
500 |
In case that the operation fails for any reason |
2.11.2. dynamicTableauService.FindDynamicTableauItemListViewsByCriteria
POST /com.gk_software.pos.api.service.tableau.DynamicTableauDataService/FindDynamicTableauItemListViewsByCriteria
Find dynamic tableau item list views by criteria.
Description
Find dynamic tableau item list views by criteria.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FindDynamicTableauItemListViewsRequest object ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListViewsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListViewsResponse |
500 |
In case that the operation fails for any reason |
2.12. EventLogService
2.12.1. eventLogService.searchEventLog
POST /com.gk_software.pos.api.service.event_log.EventLogService/searchEventLog
Searches for event log messages meeting the given search criteria.
Description
Searches for event log messages meeting the given search criteria.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The EventLogSearchParameters. ComGkSoftwareGkrApiEventchannelDtoEventLogSearchParameters |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.12.2. eventLogService.storeEventLog
POST /com.gk_software.pos.api.service.event_log.EventLogService/storeEventLog
Stores the given event log messages.
Description
Stores the given event log messages.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The EventLogStoreRequest containing the event log messages to be stored. ComGkSoftwareGkrApiEventchannelDtoEventLogStoreRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
0 |
successful operation |
2.13. EwicItemCategoryService
2.13.1. ewicItemCategoryService.findWicCategoryByKey
POST /com.gk_software.pos.api.service.ewic.EwicItemCategoryService/findWicCategoryByKey
Find eWIC item category
Description
Find eWIC item category
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the benefits request ComGkSoftwarePosApiServiceEwicEwicItemSubcategoryBenefitsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
if an error occurs while attempting to read master data |
2.13.2. ewicItemCategoryService.getBasketMatchingPrescription
POST /com.gk_software.pos.api.service.ewic.EwicItemCategoryService/getBasketMatchingPrescription
Gets the items which match the prescription
Description
Gets the items which match the prescription
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the basket request ComGkSoftwarePosApiServiceEwicEwicBasketRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceEwicEwicMatchingPrescriptionResult |
500 |
if an error occurs while attempting to get the basket |
2.13.3. ewicItemCategoryService.resetNTEItemPrice
POST /com.gk_software.pos.api.service.ewic.EwicItemCategoryService/resetNTEItemPrice
Reset the Item Price with NTE Price
Description
Reset the Item Price with NTE Price
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error |
2.14. ExternalCartService
2.14.1. externalCartService.addItemToExternalCartForCustomer
POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/addItemToExternalCartForCustomer
Adds an item to a customer cart
Description
Adds an item to a customer cart
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartLineItemRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.14.2. externalCartService.addItemToExternalCartForCustomer_1
POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/addItemToExternalCartForCustomer
Adds an item to a customer cart
Description
Adds an item to a customer cart
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartLineItemRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.14.3. externalCartService.createExternalCartForAnonymous
POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/createExternalCartForAnonymous
Creates a session cart for anonymous
Description
Creates a session cart for anonymous
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.14.4. externalCartService.createExternalCartForAnonymous_2
POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/createExternalCartForAnonymous
Creates a session cart for anonymous
Description
Creates a session cart for anonymous
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.14.5. externalCartService.createExternalCartForCustomer
POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/createExternalCartForCustomer
Creates a new cart for a customer
Description
Creates a new cart for a customer
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.14.6. externalCartService.createExternalCartForCustomer_3
POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/createExternalCartForCustomer
Creates a new cart for a customer
Description
Creates a new cart for a customer
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.14.7. externalCartService.getExternalCart
POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/getExternalCart
Get cart by customerID and cartID
Description
Get cart by customerID and cartID
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.14.8. externalCartService.getExternalCart_4
POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/getExternalCart
Get cart by customerID and cartID
Description
Get cart by customerID and cartID
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.14.9. externalCartService.getExternalCartsForCustomer
POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/getExternalCartsForCustomer
Get Cart list by customerID
Description
Get Cart list by customerID
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
List[ComGkSoftwarePosApiServiceExternalCartExternalCartData] |
2.14.10. externalCartService.getExternalCartsForCustomer_5
POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/getExternalCartsForCustomer
Get Cart list by customerID
Description
Get Cart list by customerID
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
List[ComGkSoftwarePosApiServiceExternalCartExternalCartData] |
2.14.11. externalCartService.mergeAnonymousCart
POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/mergeAnonymousCart
Merges an anonymous cart to a customer cart
Description
Merges an anonymous cart to a customer cart
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.14.12. externalCartService.mergeAnonymousCart_6
POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/mergeAnonymousCart
Merges an anonymous cart to a customer cart
Description
Merges an anonymous cart to a customer cart
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.15. ExternalCustomerService
2.15.1. externalCustomerService.addAddress
POST /com.gk_software.pos.api.service.external.customer.ExternalCustomerService/addAddress
Adds new address to existing external customer.
Description
Adds new address to existing external customer.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCustomerAddressRequest containing the new address ComGkSoftwarePosApiServiceExternalCustomerExternalCustomerAddressRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.15.2. externalCustomerService.addAddress_1
POST /com.gk_software.pos.api.service.external.customer.ExternalCustomerServiceDelegate/addAddress
Adds new address to existing external customer.
Description
Adds new address to existing external customer.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCustomerAddressRequest containing the new address ComGkSoftwarePosApiServiceExternalCustomerExternalCustomerAddressRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.15.3. externalCustomerService.findCustomer
POST /com.gk_software.pos.api.service.external.customer.ExternalCustomerService/findCustomer
Search for external customer for given criteria.
Description
Search for external customer for given criteria.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCustomerDetailsRequest containing lookup information ComGkSoftwarePosApiServiceExternalCustomerExternalCustomerDetailsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.15.4. externalCustomerService.findCustomer_2
POST /com.gk_software.pos.api.service.external.customer.ExternalCustomerServiceDelegate/findCustomer
Search for external customer for given criteria.
Description
Search for external customer for given criteria.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCustomerDetailsRequest containing lookup information ComGkSoftwarePosApiServiceExternalCustomerExternalCustomerDetailsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.16. ExternalItemQueryService
2.16.1. externalItemQueryService.getItemImageUrl
POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryService/getItemImageUrl
Gets the external item image url.
Description
Gets the external item image url.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.16.2. externalItemQueryService.getItemImageUrl_1
POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryServiceDelegate/getItemImageUrl
Gets the external item image url.
Description
Gets the external item image url.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.16.3. externalItemQueryService.getItemInformation
POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryService/getItemInformation
Gets the external item information pos item id.
Description
Gets the external item information pos item id.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiModelDomAppItemInformationItemInformation |
2.16.4. externalItemQueryService.getItemInformation_2
POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryServiceDelegate/getItemInformation
Gets the external item information pos item id.
Description
Gets the external item information pos item id.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiModelDomAppItemInformationItemInformation |
2.16.5. externalItemQueryService.getPosUOMItemDO
POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryService/getPosUOMItemDO
Get PosUOMItemDO from external item service by ExternalItemInformationRequest
Description
Get PosUOMItemDO from external item service by ExternalItemInformationRequest
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.16.6. externalItemQueryService.getPosUOMItemDO_3
POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryServiceDelegate/getPosUOMItemDO
Get PosUOMItemDO from external item service by ExternalItemInformationRequest
Description
Get PosUOMItemDO from external item service by ExternalItemInformationRequest
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.16.7. externalItemQueryService.searchItemInformationList
POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryService/searchItemInformationList
Find external item list by filter.
Description
Find external item list by filter.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalItemSearchRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemSearchRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
List[ComGkSoftwarePosApiModelDomAppItemInformationItemInformation] |
2.16.8. externalItemQueryService.searchItemInformationList_4
POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryServiceDelegate/searchItemInformationList
Find external item list by filter.
Description
Find external item list by filter.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalItemSearchRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemSearchRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
List[ComGkSoftwarePosApiModelDomAppItemInformationItemInformation] |
2.17. ExternalOrderService
2.17.1. externalOrderService.addDeliveryCostsToTransaction
POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/addDeliveryCostsToTransaction
Adds delivery costs line item to the POS Transaction
Description
Adds delivery costs line item to the POS Transaction
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
2.17.2. externalOrderService.addDeliveryCostsToTransaction_1
POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/addDeliveryCostsToTransaction
Adds delivery costs line item to the POS Transaction
Description
Adds delivery costs line item to the POS Transaction
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
2.17.3. externalOrderService.preCalculateOrderWithDeliveryCosts
POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/preCalculateOrderWithDeliveryCosts
Calculates the delivery costs for the current order in preparation
Description
Calculates the delivery costs for the current order in preparation
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.17.4. externalOrderService.preCalculateOrderWithDeliveryCosts_2
POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/preCalculateOrderWithDeliveryCosts
Calculates the delivery costs for the current order in preparation
Description
Calculates the delivery costs for the current order in preparation
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.17.5. externalOrderService.setDeliveryAddress
POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/setDeliveryAddress
Sets a delivery address to an order in preparation
Description
Sets a delivery address to an order in preparation
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The DeliveryAddressRequest object ComGkSoftwarePosApiServiceExternalOrderDeliveryAddressRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
0 |
successful operation |
2.17.6. externalOrderService.setDeliveryAddress_3
POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/setDeliveryAddress
Sets a delivery address to an order in preparation
Description
Sets a delivery address to an order in preparation
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The DeliveryAddressRequest object ComGkSoftwarePosApiServiceExternalOrderDeliveryAddressRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
0 |
successful operation |
2.17.7. externalOrderService.setDeliveryMode
POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/setDeliveryMode
Sets a delivery model to an order in preparation
Description
Sets a delivery model to an order in preparation
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The DeliveryModeRequest object ComGkSoftwarePosApiServiceExternalOrderDeliveryModeRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
0 |
successful operation |
2.17.8. externalOrderService.setDeliveryMode_4
POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/setDeliveryMode
Sets a delivery model to an order in preparation
Description
Sets a delivery model to an order in preparation
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The DeliveryModeRequest object ComGkSoftwarePosApiServiceExternalOrderDeliveryModeRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
0 |
successful operation |
2.17.9. externalOrderService.setPaymentDetails
POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/setPaymentDetails
Sets payment details (like billing address)
Description
Sets payment details (like billing address)
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PaymentDetailsRequest object ComGkSoftwarePosApiServiceExternalOrderPaymentDetailsRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
0 |
successful operation |
2.17.10. externalOrderService.setPaymentDetails_5
POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/setPaymentDetails
Sets payment details (like billing address)
Description
Sets payment details (like billing address)
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PaymentDetailsRequest object ComGkSoftwarePosApiServiceExternalOrderPaymentDetailsRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
0 |
successful operation |
2.17.11. externalOrderService.simulateOrder
POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/simulateOrder
Checks if the prepared order is valid for invocation
Description
Checks if the prepared order is valid for invocation
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.17.12. externalOrderService.simulateOrder_6
POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/simulateOrder
Checks if the prepared order is valid for invocation
Description
Checks if the prepared order is valid for invocation
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.18. FuelService
2.18.1. fuelService.createDispenserTotalsList
POST /com.gk_software.pos.api.service.fuel.FuelService/createDispenserTotalsList
Create EOD Total transaction.
Description
Create EOD Total transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The createDispenserTotalsList request ComGkSoftwarePosApiServiceFuelDispenserTotalRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case createDispenserTotalsList fails |
2.18.2. fuelService.createFuelPriceChangeList
POST /com.gk_software.pos.api.service.fuel.FuelService/createFuelPriceChangeList
Create Fuel Price Change transaction.
Description
Create Fuel Price Change transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FuelPriceChangeRequest request ComGkSoftwarePosApiServiceFuelFuelPriceChangeRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case createFuelPriceChangeList fails |
2.18.3. fuelService.findFuellingPointList
POST /com.gk_software.pos.api.service.fuel.FuelService/findFuellingPointList
Find FuellingPointDO list.
Description
Find FuellingPointDO list.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
List[ComGkSoftwareGkrApiServerMdPetrolDtoDomFuellingPointDO] |
500 |
in case findFuellingPointList fails |
2.18.4. fuelService.findGradeList
POST /com.gk_software.pos.api.service.fuel.FuelService/findGradeList
Find grade list.
Description
Find grade list.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case findGradeList fails |
2.18.5. fuelService.findNozzleList
POST /com.gk_software.pos.api.service.fuel.FuelService/findNozzleList
Find nozzle list.
Description
Find nozzle list.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case findNozzleList fails |
2.18.6. fuelService.findPetrolItem
POST /com.gk_software.pos.api.service.fuel.FuelService/findPetrolItem
Get itemId from NozzleId and fuelingPointId.
Description
Get itemId from NozzleId and fuelingPointId.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case find petrol item fails |
2.18.7. fuelService.findPetrolItem_1
POST /com.gk_software.pos.api.service.fuel.FuelService/findPetrolItemGrade
Get itemId from GradeId.
Description
Get itemId from GradeId.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case find petrol item fails |
2.18.8. fuelService.findTankList
POST /com.gk_software.pos.api.service.fuel.FuelService/findTankList
Find tank list.
Description
Find tank list.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case findTankList fails |
2.19. GiftCertificateTransactionService
2.19.1. giftCertificateTransactionService.cancelAllGiftCertLineItemsOnCurrentTransaction
POST /com.gk_software.pos.api.service.transaction.gift_certificate.GiftCertificateTransactionService/cancelAllGiftCertLineItemsOnCurrentTransaction
Cancels all gift certificate line items on a currently active transaction
Description
Cancels all gift certificate line items on a currently active transaction
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
{@link CancelGiftCertTransactionRequest}, request containing data about gift certificate to cancel. ComGkSoftwarePosApiServiceStoredValueServerCancelGiftCertTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
If the cancellation of gift certificate line item fails |
2.19.2. giftCertificateTransactionService.createAndAddGiftCertificateLineItem
POST /com.gk_software.pos.api.service.transaction.gift_certificate.GiftCertificateTransactionService/createAndAddGiftCertificateLineItem
Creates a gift certificate line item.
Description
Creates a gift certificate line item.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The GiftCertificateRegistrationRequest, contains data of gift certificate ComGkSoftwarePosApiServiceTransactionGiftCertificateGiftCertificateRegistrationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
If the line item cannot be registered |
2.20. GkrSvsPrepaidServerService
2.20.1. gkrSvsPrepaidServerService.acquirePrepaidPin
POST /com.gk_software.pos.api.service.prepaid.GkrSvsPrepaidServerService/acquirePrepaidPin
Calls \"acquire prepaid pin\" on underlying prepaid service.
Description
Calls \"acquire prepaid pin\" on underlying prepaid service. For each containing prepaid item a prepaid PIN is sold. The PIN status on the server is set to “sold”.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PrepaidPinRequest containing the prepaid items. PrepaidPinRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error. |
2.21. HospitalityService
2.21.1. hospitalityService.activateHospitalityReceipt
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/activateHospitalityReceipt
This method will activate or deactivate hospitality receipt.
Description
This method will activate or deactivate hospitality receipt
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The activateHospitalityReceipt request object ComGkSoftwarePosApiServiceHospitalityActivateHospitalityReceiptRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
In case that the operation fails for any reason |
2.21.2. hospitalityService.addLineItemCourseNumber
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/addLineItemCourseNumber
Adds course number to line item.
Description
Adds course number to line item.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The 'add line item course number' request object ComGkSoftwarePosApiServiceHospitalityAddLineItemCourseNumberRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
In case that the operation fails for any reason |
2.21.3. hospitalityService.changeTableOwner
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/changeTableOwner
This method will change the table owner of the given tables.
Description
This method will change the table owner of the given tables.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The 'change table owner' request object ComGkSoftwarePosApiServiceHospitalityChangeTableOwnerRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceHospitalityChangeTableOwnerResponse |
500 |
In case that the operation fails for any reason |
2.21.5. hospitalityService.createOrRetrieveTransaction
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/createOrRetrieveTransaction
Create or retrieve a transaction.
Description
Create or retrieve a transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The createOrRetrieveTransaction request ComGkSoftwarePosApiServiceHospitalityCreateOrRetrieveTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceHospitalityCreateOrRetrieveTransactionRequest |
500 |
In case that the operation fails for any reason |
2.21.6. hospitalityService.deleteLineItemCourseNumber
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/deleteLineItemCourseNumber
Deletes course number from line item.
Description
Deletes course number from line item.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The 'delete line item course number' request object ComGkSoftwarePosApiServiceHospitalityDeleteLineItemCourseNumberRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
In case that the operation fails for any reason |
2.21.8. hospitalityService.finalizeMovementTransactions
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/finalizeMovementTransactions
This method will finalize all transactions (of type movement).
Description
This method will finalize all transactions (of type movement)
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The finalizeMovementTransactions request object ComGkSoftwarePosApiServiceHospitalityFinalizeMovementTransactionsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.21.9. hospitalityService.isLineItemAddedOrVoided
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/isLineItemAddedOrVoided
It is checked, if line items were added or if already ordered line items were voided belated.
Description
It is checked, if line items were added or if already ordered line items were voided belated.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The isLineItemAddedOrVoided request ComGkSoftwarePosApiServiceHospitalityIsLineItemAddedOrVoidedRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceHospitalityPreparePrintOrderDataResponse |
500 |
In case that the operation fails for any reason |
2.21.10. hospitalityService.loadComboMealItems
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/loadComboMealItems
This method will load combo meal items.
Description
load combo meal items.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The 'load combo leam items' request object ComGkSoftwarePosApiServiceHospitalityLoadComboMealItemsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceHospitalityLoadComboMealItemsResponse |
500 |
In case that the operation fails for any reason |
2.21.11. hospitalityService.loadCondiments
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/loadCondiments
This method will load condiments.
Description
This method will load condiments.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The 'load conditments' request object ComGkSoftwarePosApiServiceHospitalityLoadCondimentsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.21.12. hospitalityService.loadTableStatus
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/loadTableStatus
Load the table status.
Description
Load the table status.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The loadTableStatus request object ComGkSoftwarePosApiServiceHospitalityLoadTableStatusRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceHospitalityLoadTableStatusResponse |
500 |
In case that the operation fails for any reason |
2.21.13. hospitalityService.moveLineItems
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/moveLineItems
This method will move line item(s) from one transaction to another.
Description
This method will move line item(s) from one transaction to another.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The moveLineItems request object ComGkSoftwarePosApiServiceHospitalityMoveLineItemsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.21.14. hospitalityService.preparePrintOrderData
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/preparePrintOrderData
Prepares print order related data.
Description
Prepares print order related data.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The preparePrintOrderData request object ComGkSoftwarePosApiServiceHospitalityPreparePrintOrderDataRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceHospitalityPreparePrintOrderDataResponse |
500 |
In case that the operation fails for any reason |
2.21.15. hospitalityService.recoverTransaction
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/recoverTransaction
This method will recover a hospitality related transaction
Description
This method will recover a hospitality related transaction
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The recoverTransaction request object ComGkSoftwarePosApiServiceHospitalityRecoverTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceHospitalityRecoverTransactionResponse |
500 |
In case that the operation fails for any reason |
2.21.16. hospitalityService.registerCondiments
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/registerCondiments
Register condiments.
Description
Register condiments.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The 'register condiment' request object ComGkSoftwarePosApiServiceHospitalityRegisterCondimentsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
In case that the operation fails for any reason |
2.21.17. hospitalityService.resetToFoodOrderTransaction
POST /com.gk_software.pos.api.service.hospitality.HospitalityService/resetToFoodOrderTransaction
Resets the current transaction to a food order transaction.
Description
Resets the current transaction to a food order transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The resetToFoodOrderTransaction request object ComGkSoftwarePosApiServiceHospitalityResetToFoodOrderTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceHospitalityCreateOrRetrieveTransactionRequest |
500 |
In case that the operation fails for any reason |
2.22. ItemQueryService
2.22.1. itemQueryService.findPosUOMItemSearchViewListByFilter
POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/findPosUOMItemSearchViewListByFilter
Find pos uom item search view list by filter.
Description
Find pos uom item search view list by filter.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ItemSearchRequest object ComGkSoftwarePosApiServiceMasterdataItemBlItemSearchRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.22.2. itemQueryService.getInformationStockInfo
POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/getInformationStockInfo
Gets the stock details for given POS items. For each requested ID an ItemInformation object containing
Description
Gets the stock details for given POS items. For each requested ID an ItemInformation object containingthe details is returned.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The InformationStockInfoRequest object ComGkSoftwarePosApiServiceMasterdataItemInformationStockInfoRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
List[ComGkSoftwarePosApiModelDomAppItemInformationItemInformation] |
2.22.3. itemQueryService.getItemInformationPosItemId
POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/getItemInformationPosItemId
Gets the item information for an item with specified POS item id.
Description
Gets the item information for an item with specified POS item id.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ItemInformationRequest ComGkSoftwarePosApiServiceMasterdataItemItemInformationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiModelDomAppItemInformationItemInformation |
2.22.4. itemQueryService.getItemInformationStockInfo
POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/getItemInformationStockInfo
Gets the stock info prepared for an item with specified POS item id.
Description
Gets the stock info prepared for an item with specified POS item id.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the ItemInformationStockInfoRequest object ComGkSoftwarePosApiServiceMasterdataItemItemInformationStockInfoRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiModelDomAppItemInformationItemInformation |
2.22.5. itemQueryService.getItemPriceNoCache
POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/getItemPriceNoCache
Get price from ItemId no cache.
Description
Get price from ItemId no cache.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ItemId String [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.22.6. itemQueryService.loadItemDOByKey
POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadItemDOByKey
Loads item master data for specified POS itemDO key.
Description
Loads item master data for specified POS item ID.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the POS itemDO key ComGkSoftwarePosApiServiceMasterdataItemLoadItemDOByKeyRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.22.7. itemQueryService.loadItemDOByPosItemId
POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadItemDOByPosItemId
Loads item master data for specified POS item ID.
Description
Loads item master data for specified POS item ID.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the POS item ID [String] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.22.8. itemQueryService.loadItemDOListByPosItemIdList
POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadItemDOListByPosItemIdList
Loads list of items for the specified POS item IDs.
Description
Loads list of items for the specified POS item IDs.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
List of POS item IDs [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.22.9. itemQueryService.loadSimplePosUomItemDO
POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadSimplePosUomItemDO
Loads item data for given item ID and returns it in form of SimplePosUomItemDO.
Description
Loads item data for given item ID and returns it in form of SimplePosUomItemDO.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The item ID [String] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.23. LayawayService
2.23.1. layawayService.calculatePaymentPlan
POST /com.gk_software.pos.api.service.layaway.LayawayService/calculatePaymentPlan
Adds a payment plan to transaction.
Description
Adds a payment plan to transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PaymentPlanRequest object ComGkSoftwarePosApiServiceLayawayPaymentPlanRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.23.2. layawayService.createCompleteVoidTransaction
POST /com.gk_software.pos.api.service.layaway.LayawayService/createCompleteVoidTransaction
Creates a new void transaction (complete layaway void) for the given request.
Description
Creates a new void transaction (complete layaway void) for the given request.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreateCompleteVoidTransactionRequest request object ComGkSoftwarePosApiServiceLayawayCreateCompleteVoidTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
The exception is thrown if an unexpected error occurs. |
2.23.3. layawayService.createCustomerTransaction
POST /com.gk_software.pos.api.service.layaway.LayawayService/createCustomerTransaction
Creates a new transaction with customer for the given request.
Description
Creates a new transaction with customer for the given request.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreateCustomerTransactionRequest request object ComGkSoftwarePosApiServiceLayawayCreateCustomerTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
The exception is thrown if an unexpected error occurs. |
2.23.4. layawayService.createDownPaymentAndFeeLineItem
POST /com.gk_software.pos.api.service.layaway.LayawayService/createDownPaymentAndFeeLineItem
Creates a new layaway down payment and fee line item for the given request.
Description
Creates a new layaway down payment and fee line item for the given request.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The DownPaymentAndFeeLineItemRequest object ComGkSoftwarePosApiServiceLayawayDownPaymentAndFeeLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
The exception is thrown if an unexpected error occurs. |
2.23.5. layawayService.createDownPaymentTransaction
POST /com.gk_software.pos.api.service.layaway.LayawayService/createDownPaymentTransaction
Creates a new layaway down payment transaction for the given request.
Description
Creates a new layaway down payment transaction for the given request.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The DownPaymentTransactionRequest object ComGkSoftwarePosApiServiceLayawayDownPaymentTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
The exception is thrown if an unexpected error occurs. |
2.23.6. layawayService.createFinalPaymentTransaction
POST /com.gk_software.pos.api.service.layaway.LayawayService/createFinalPaymentTransaction
Creates a final payment transaction for the given request.
Description
Creates a create final payment transaction for the given request.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FinalPaymentTransactionRequest object ComGkSoftwarePosApiServiceLayawayFinalPaymentTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
The exception is thrown if an unexpected error occurs. |
2.23.7. layawayService.createLayawayExtendTransaction
POST /com.gk_software.pos.api.service.layaway.LayawayService/createLayawayExtendTransaction
Creates a new layaway extend transaction for the given request.
Description
Creates a new layaway extend transaction for the given request.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The createLayawayExtendTransaction request object ComGkSoftwarePosApiServiceLayawayCreateLayawayExtendTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
The exception is thrown if an unexpected error occurs. |
2.23.8. layawayService.createPartialVoidTransaction
POST /com.gk_software.pos.api.service.layaway.LayawayService/createPartialVoidTransaction
Creates a new void transaction (partial layaway void) for the given request.
Description
Creates a new void transaction (partial layaway void) for the given request.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreatePartialVoidTransactionRequest request object ComGkSoftwarePosApiServiceLayawayCreatePartialVoidTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
The exception is thrown if an unexpected error occurs. |
2.23.9. layawayService.createRetrieveMoneyTransaction
POST /com.gk_software.pos.api.service.layaway.LayawayService/createRetrieveMoneyTransaction
Creates a new retrieve money transaction for the given request.
Description
Creates a new retrieve money transaction for the given request.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreateRetrieveMoneyTransactionRequest request object ComGkSoftwarePosApiServiceLayawayCreateRetrieveMoneyTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
The exception is thrown if an unexpected error occurs. |
2.23.10. layawayService.findLayawayByCriteria
POST /com.gk_software.pos.api.service.layaway.LayawayService/findLayawayByCriteria
Find a Layaway by criteria.
Description
Find a Layaway by criteria.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FindLayawayByCriteriaRequest object ComGkSoftwarePosApiServiceLayawayFindLayawayByCriteriaRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceLayawayFindLayawayByCriteriaResponse |
500 |
In case that the operation fails for any reason |
2.23.11. layawayService.findLayawayListByCriteria
POST /com.gk_software.pos.api.service.layaway.LayawayService/findLayawayListByCriteria
Find layaway list by criteria.
Description
Find layaway list by criteria.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FindLayawayListByCriteriaRequest object ComGkSoftwarePosApiServiceLayawayFindLayawayListByCriteriaRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceLayawayFindLayawayListByCriteriaResponse |
500 |
In case that the operation fails for any reason |
2.23.12. layawayService.openScopedTxForLayaway
POST /com.gk_software.pos.api.service.layaway.LayawayService/openScopedTxForLayaway
Creates a scoped transaction with given information in the request object (e.g. the layaway)
Description
Creates a scoped transaction with given information in the request object (e.g. the layaway). SaleReturnLineItems of the layaway and other needed information will be copied to the transaction
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The open transaction request object ComGkSoftwarePosApiServiceLayawayOpenScopedTxForLayawayRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
The exception is thrown if an unexpected error occurs. |
2.23.13. layawayService.validateLayaway
POST /com.gk_software.pos.api.service.layaway.LayawayService/validateLayaway
Validate Layaway.
Description
Validate Layaway.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ValidateLayawayRequest object ComGkSoftwarePosApiServiceLayawayValidateLayawayRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.24. LineItemService
2.24.1. lineItemService.activateTaxExempt
POST /com.gk_software.pos.api.service.transaction.LineItemService/activateTaxExempt
Activates tax exempt for line item
Description
Activates tax exempt for line item
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ActivateTaxExemptRequest object ComGkSoftwarePosApiServiceTransactionActivateTaxExemptRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error. |
2.24.2. lineItemService.addOrderInformationToItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/addOrderInformationToItem
Retrieves the last registered item and adds information about the active order to it.
Description
Retrieves the last registered item and adds information about the active order to it.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
request ComGkSoftwarePosApiServiceTransactionSalesOrderPosition |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that setting of price fails for any reason. |
2.24.3. lineItemService.addRetailTransactionLineItemComment
POST /com.gk_software.pos.api.service.transaction.LineItemService/addRetailTransactionLineItemComment
Adds comment to line item.
Description
Adds comment to line item.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
In case that the operation fails for any reason |
2.24.4. lineItemService.addSubtotalLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/addSubtotalLineItem
Creates and adds subtotal line item to the active transaction.
Description
Creates and adds subtotal line item to the active transaction.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
if the transaction operation failed exception |
2.24.5. lineItemService.cancelGiftCertLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/cancelGiftCertLineItem
Cancels successful booked gift certificate line items by call of stored value service.
Description
Cancels successful booked gift certificate line items by call of stored value service.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CancelGiftCertLineItemRequest object ComGkSoftwarePosApiServiceTransactionCancelGiftCertLineItemRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case of any error |
2.24.6. lineItemService.checkPriceLimitExceeded
POST /com.gk_software.pos.api.service.transaction.LineItemService/checkPriceLimitExceeded
Checks whether a price change is inside of defined limits (absolute and percental).
Description
Checks whether a price change is inside of defined limits (absolute and percental).
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CheckPriceLimitRequest object. ComGkSoftwarePosApiServiceTransactionCheckPriceLimitRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
PRICE_DIFFERENCE_POSITION_LIMIT_EXCEEDED in case of price position limit exceeded |
2.24.7. lineItemService.checkQuantityInputProhibited
POST /com.gk_software.pos.api.service.transaction.LineItemService/checkQuantityInputProhibited
Checks if quantity input is prohibited by selling rule for selected line item throws exception in case of prohibition
Description
Checks if quantity input is prohibited by selling rule for selected line item throws exception in case of prohibition
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CheckQuantityInputProhibitedRequest object ComGkSoftwarePosApiServiceTransactionCheckQuantityInputProhibitedRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
with causing exception as cause. |
2.24.8. lineItemService.checkQuantityInputProhibitedByItemSellingRule
POST /com.gk_software.pos.api.service.transaction.LineItemService/checkQuantityInputProhibitedByItemSellingRule
Checks if quantity input is prohibited by selling rule for selected line item throws exception in case of prohibition.
Description
Checks if quantity input is prohibited by selling rule for selected line item throws exception in case of prohibition.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The line item key ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemKey |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
with causing exception as cause. |
2.24.9. lineItemService.clearItemTraceableUnitIDs
POST /com.gk_software.pos.api.service.transaction.LineItemService/clearItemTraceableUnitIDs
Clears the ItemTraceableUnitID for all items in the current transaction.
Description
Clears the ItemTraceableUnitID for all items in the current transaction.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
If the transaction cannot be updated |
2.24.10. lineItemService.createAndAddCustomerAccountPaymentItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddCustomerAccountPaymentItem
Creates new line item for customer account payment
Description
Creates new line item for customer account payment
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RegisterCustomerAccountPaymentRequest object. ComGkSoftwarePosApiServiceTransactionRegisterCustomerAccountPaymentRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that request fails for any reason. |
2.24.11. lineItemService.createAndAddDownpaymentLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddDownpaymentLineItem
Creates a new line item for a down payment.
Description
Creates a new line item for a down payment.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreateDownpaymentLineItemRequest object. ComGkSoftwarePosApiServiceTransactionCreateDownpaymentLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that setting of price fails for any reason. |
2.24.12. lineItemService.createAndAddInvoicePaymentLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddInvoicePaymentLineItem
Creates a new line item for an invoice payment.
Description
Creates a new line item for an invoice payment.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreateInvoicePaymentLineItemRequest object. ComGkSoftwarePosApiServiceTransactionCreateInvoicePaymentLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that setting of price fails for any reason. |
2.24.13. lineItemService.createAndAddLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/createMerchandiseCategorySaleItem
Creates and add a merchandise category sale line item to currently active transaction.
Description
Creates and add a merchandise category sale line item to currently active transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreateLineItemRequest object ComGkSoftwarePosApiServiceTransactionCreateLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error. |
2.24.14. lineItemService.createAndAddPayInOutLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddPayInOutLineItem
Creates and adds a pay-in/pay-out line item to the currently active transaction. The entered reason-specific data is …
Description
Creates and adds a pay-in/pay-out line item to the currently active transaction. The entered reason-specific data is saved with theline item.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PayInOutLineItemRequest object ComGkSoftwarePosApiServiceTransactionPayInOutLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
the transaction operation failed exception |
2.24.15. lineItemService.createAndAddRetailTransactionLineItemExtension
POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddRetailTransactionLineItemExtension
Add key value pair to a line item extension
Description
Add key value pair to a line item extension
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The LineItemExtensionRequest object. ComGkSoftwarePosApiServiceTransactionLineItemExtensionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case an error occurs during the process. |
2.24.16. lineItemService.createAndAddRetrievedSalesOrderItems
POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddRetrievedSalesOrderItems
Creates and adds new line item(s) for retrieved sales order items.
Description
Creates and adds new line item(s) for retrieved sales order items.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The {@link RegisterRetrievedSalesOrderRequest} object. ComGkSoftwarePosApiServiceTransactionRegisterRetrievedSalesOrderRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that setting of price fails for any reason. |
2.24.17. lineItemService.createAndAddSaleReturnLineItemExtension
POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddSaleReturnLineItemExtension
Adds extension record on specified item in transaction.
Description
Adds extension record on specified item in transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The LineItemExtensionRequest the request ComGkSoftwarePosApiServiceTransactionLineItemExtensionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
if the transaction operation failed exception |
2.24.18. lineItemService.createAndAddSaleReturnLineItemExtensions
POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddSaleReturnLineItemExtensions
Adds a list of extension records on sale return line items in transaction.
Description
Adds a list of extension records on sale return line items in transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The LineItemExtensionRequest object ComGkSoftwarePosApiServiceTransactionLineItemExtensionsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
if the transaction operation failed exception |
2.24.19. lineItemService.createAndAddScaleTransactionItems
POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddScaleTransactionItems
Creates new line item(s) for scale transaction items
Description
Creates new line item(s) for scale transaction items
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RegisterScaleTransactionRequest object. ComGkSoftwarePosApiServiceTransactionRegisterScaleTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that during the line item creation an error occurs |
2.24.20. lineItemService.createAndAddWorkerDiscountLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddWorkerDiscountLineItem
Creates and adds a worker discount line item to the currently active transaction.
Description
Creates and adds a worker discount line item to the currently active transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreateWorkerDiscountLineItemRequest object. ComGkSoftwarePosApiServiceTransactionCreateWorkerDiscountLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
the transaction operation failed exception |
2.24.21. lineItemService.deactivateTaxExempt
POST /com.gk_software.pos.api.service.transaction.LineItemService/deactivateTaxExempt
Deactivates tax exempt for line item.
Description
Deactivates tax exempt for line item.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The DeactivateTaxExemptRequest object ComGkSoftwarePosApiServiceTransactionDeactivateTaxExemptRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error. |
2.24.22. lineItemService.deleteRetailTransactionLineItemComment
POST /com.gk_software.pos.api.service.transaction.LineItemService/deleteRetailTransactionLineItemComment
Deletes comment from line item.
Description
Deletes comment from line item.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
In case that the operation fails for any reason |
2.24.23. lineItemService.recalculateTransactionPromotions
POST /com.gk_software.pos.api.service.transaction.LineItemService/recalculateTransactionPromotions
Recalculation to apply temp promotions.
Description
Recalculation to apply temp promotions.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
2.24.24. lineItemService.reduceLineItems
POST /com.gk_software.pos.api.service.transaction.LineItemService/reduceLineItems
Reduces the line items for given line item keys into multiple positions in the currently active transaction according to provided quantity.
Description
Reduces the line items for given line item keys into multiple positions in the currently active transaction according to provided quantity.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ReduceLineItemsRequest object. ComGkSoftwarePosApiServiceTransactionReduceLineItemsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that splitting of positions fails for any reason. |
2.24.25. lineItemService.registerExternalLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/registerExternalLineItem
Adds a line item to the currently active transaction. If the transaction is not opened right now, a new one is create…
Description
Adds a line item to the currently active transaction. If the transaction is not opened right now, a new one is created. Theregistration of the item might fail for several reasons; e.g. the item is not valid of some data is missing. The resultcontains the according information.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RegistrationRequest object. ComGkSoftwarePosApiServiceTransactionRegistrationExternalRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that the registration fails for any reason. |
2.24.26. lineItemService.registerInternalLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/registerInternalLineItem
Adds a internal line item to the currently active transaction. If the transaction is not opened right now, a new one …
Description
Adds a internal line item to the currently active transaction. If the transaction is not opened right now, a new one is created. Theregistration of the item might fail for several reasons; e.g. the item is not valid of some data is missing. The resultcontains the according information.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RegistrationInternalRequest object. ComGkSoftwarePosApiServiceTransactionRegistrationInternalRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that the registration fails for any reason. |
2.24.27. lineItemService.registerLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/registerLineItem
Adds a line item to the currently active transaction. If the transaction is not opened right now, a new one is create…
Description
Adds a line item to the currently active transaction. If the transaction is not opened right now, a new one is created. Theregistration of the item might fail for several reasons; e.g. the item is not valid of some data is missing. The resultcontains the according information.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RegistrationRequest object. ComGkSoftwarePosApiServiceTransactionRegistrationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case that the registration fails for any reason. |
2.24.28. lineItemService.registerServiceFeeLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/registerServiceFeeLineItem
Adds a service fee line item to the currently active transaction.
Description
Adds a service fee line item to the currently active transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RegistrationRequest object. ComGkSoftwarePosApiServiceTransactionRegistrationServiceFeeRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that the registration fails for any reason. |
2.24.29. lineItemService.removeLastLineItemIfOpen
POST /com.gk_software.pos.api.service.transaction.LineItemService/removeLastLineItemIfOpen
Removes the last retail transaction line item of currently active transaction, in case that it is open.
Description
Removes the last retail transaction line item of currently active transaction, in case that it is open.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
if the transaction operation failed exception |
2.24.30. lineItemService.removeLastSaleReturnLineItemIfOpen
POST /com.gk_software.pos.api.service.transaction.LineItemService/removeLastSaleReturnLineItemIfOpen
Removes the last sale return line item of currently active transaction, in case that it is open.
Description
Removes the last sale return line item of currently active transaction, in case that it is open.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
if the transaction operation failed exception |
2.24.31. lineItemService.removeSaleReturnLineItemsExtensions
POST /com.gk_software.pos.api.service.transaction.LineItemService/removeSaleReturnLineItemsExtensions
Removes sale return line extensions containing given keys from given line items.
Description
Removes sale return line extensions containing given keys from given line items.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RemoveLineItemsExtensionsRequest the request ComGkSoftwarePosApiServiceTransactionRemoveLineItemsExtensionsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
if the transaction operation failed exception |
2.24.32. lineItemService.repeatLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/repeatLineItem
Repeat the specified line item.
Description
Repeat the specified line item.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RepeatLineItemRequest object. ComGkSoftwarePosApiServiceTransactionRepeatLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case line item repetition fails for any reason. |
2.24.33. lineItemService.requestPointsRefund
POST /com.gk_software.pos.api.service.transaction.LineItemService/requestPointsRefund
Sends request to refund of loyalty points to respective service.
Description
Sends request to refund of loyalty points to respective service.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The {@link PointsRefundRequest} ComGkSoftwarePosApiServiceTransactionPointsRefundRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error. |
2.24.34. lineItemService.rollbackQuantityAccumulation
POST /com.gk_software.pos.api.service.transaction.LineItemService/rollbackQuantityAccumulation
Rollback the quantity accumulation process.
Description
Rollback the quantity accumulation process.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case an error occurs during the process. |
2.24.35. lineItemService.setCustomFields
POST /com.gk_software.pos.api.service.transaction.LineItemService/setCustomFields
Set line item custom field values on the given line item on the transaction which is associated with the passed sessi…
Description
Set line item custom field values on the given line item on the transaction which is associated with the passed session. Ifthe close position configuration indicates that the previous position should be closed a new line item with the given valuewill be created. The behavior depends on close position configuration of the passed {@link PositionOperationConfig}.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The SetLineItemCustomFieldsRequest object. ComGkSoftwarePosApiServiceTransactionSetLineItemCustomFieldsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that setting of custom fields fails for any reason. |
2.24.36. lineItemService.setLineItemsTaxGroupId
POST /com.gk_software.pos.api.service.transaction.LineItemService/setLineItemsTaxGroupId
Validates and sets the tax group IDs to the related line items according to the request.
Description
Validates and sets the tax group IDs to the related line items according to the request.The tax group IDs are set only if all tax group IDs in the request are successfully validated.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
contains the tax group ids that must be set and the keys to the line items that should be modified. ComGkSoftwarePosApiServiceTransactionStoreLineItemTaxGroupIdRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
An exception is thrown if an error occurs either during the tax group id validation or storage of new changes. |
2.24.37. lineItemService.setPrice
POST /com.gk_software.pos.api.service.transaction.LineItemService/setPrice
Sets/updates the price of the last line item in the currently active transaction. If the close position configuration
Description
Sets/updates the price of the last line item in the currently active transaction. If the close position configurationindicates that the previous position should be closed a new line item with the given value will be created. The behaviordepends on close position configuration of the passed {@link PositionOperationConfig}.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RegistrationRequest object. ComGkSoftwarePosApiServiceTransactionRegistrationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that setting of price fails for any reason. |
2.24.38. lineItemService.setQuantity
POST /com.gk_software.pos.api.service.transaction.LineItemService/setQuantity
Sets/updates the quantity of line item in the currently active transaction. If the close position configuration indic…
Description
Sets/updates the quantity of line item in the currently active transaction. If the close position configuration indicatesthat the previous position should be closed a new line item with the given value will be created. The behavior depends onclose position configuration of the passed {@link PositionOperationConfig}.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The SetQuantityRequest object. ComGkSoftwarePosApiServiceTransactionSetQuantityRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that setting of quantity fails for any reason. |
2.24.39. lineItemService.setRetailTransactionLineItemExtension
POST /com.gk_software.pos.api.service.transaction.LineItemService/setRetailTransactionLineItemExtension
Update or add key value pair to a line item extension
Description
Update or add key value pair to a line item extension
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The LineItemExtensionRequest object. ComGkSoftwarePosApiServiceTransactionLineItemExtensionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case an error occurs during the process. |
2.24.40. lineItemService.setSaleReturnLineItemsExtensions
POST /com.gk_software.pos.api.service.transaction.LineItemService/setSaleReturnLineItemsExtensions
Sets the extension records with provided keys on specified line items in transaction with given values.
Description
Sets the extension records with provided keys on specified line items in transaction with given values.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The LineItemExtensionsRequest the request ComGkSoftwarePosApiServiceTransactionLineItemExtensionsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
if the transaction operation failed exception |
2.24.41. lineItemService.setSalesPersonNumber
POST /com.gk_software.pos.api.service.transaction.LineItemService/setSalesPersonNumber
Sets the sales person number. Sets/updates the workerId of the last line item in the currently active transaction.
Description
Sets the sales person number. Sets/updates the workerId of the last line item in the currently active transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The SalesPersonNumberRequest ComGkSoftwarePosApiServiceTransactionSalesPersonNumberRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error. |
2.24.42. lineItemService.setSerialNumber
POST /com.gk_software.pos.api.service.transaction.LineItemService/setSerialNumber
Sets/updates serial number of last line item in the transaction. If the close position configuration indicates that the
Description
Sets/updates serial number of last line item in the transaction. If the close position configuration indicates that theprevious position should be closed a new line item with the given value will be created. The behavior depends on closeposition configuration of the passed {@link PositionOperationConfig}.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The SetSerialNumberRequest object. ComGkSoftwarePosApiServiceTransactionSetSerialNumberRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that setting of serial number fails for any reason. |
2.24.43. lineItemService.syncLineItemsTraceableUnitID
POST /com.gk_software.pos.api.service.transaction.LineItemService/syncLineItemsItemsTraceableUnitID
Synchronizes the traceable unit id with line items registered in the current transaction in session.
Description
Synchronizes the traceable unit id with line items registered in the current transaction in session.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
contains the tax group ids that must be set and the keys to the line items that should be modified. ComGkSoftwarePosApiServiceTransactionSyncLineItemsTraceableUnitIDRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
An exception is thrown if an error occurs either during the void item process or transaction storage process. |
2.24.44. lineItemService.updateSaleReturnTaxLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/updateSaleReturnTaxLineItem
Overrides tax for line item. Changes taxValue or taxAmount depending on which parameter is null.
Description
Overrides tax for line item. Changes taxValue or taxAmount depending on which parameter is null.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ReturnLineItemRequest object ComGkSoftwarePosApiServiceTransactionReturnLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
if the transaction operation failed exception |
2.24.45. lineItemService.updateSalesOrderItemInformation
POST /com.gk_software.pos.api.service.transaction.LineItemService/updateSalesOrderItemInformation
retrieves the last registered item and adds information about the active order to it.
Description
retrieves the last registered item and adds information about the active order to it.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The {@link UpdateSalesOrderItemRequest} object ComGkSoftwarePosApiServiceTransactionUpdateSalesOrderItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case that setting of price fails for any reason. |
2.24.46. lineItemService.updateSalesOrderSelectedDeliveryItemInformation
POST /com.gk_software.pos.api.service.transaction.LineItemService/updateSalesOrderSelectedDeliveryItemInformation
Update sales order selected delivery item information.
Description
Update sales order selected delivery item information.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the UpdateSalesOrderSelectedDeliveryItemRequest ComGkSoftwarePosApiServiceTransactionUpdateSalesOrderSelectedDeliveryItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error. |
2.24.47. lineItemService.voidLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/voidLineItem
Voids the specified line item.
Description
Voids the specified line item.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The VoidLineItemRequest object ComGkSoftwarePosApiServiceTransactionVoidLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
if the transaction operation failed exception |
2.24.48. lineItemService.voidLineItemBatch
POST /com.gk_software.pos.api.service.transaction.LineItemService/voidLineItemBatch
Voids a batch of line items.
Description
Voids a batch of line items.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The VoidLineItemBatchRequest object ComGkSoftwarePosApiServiceTransactionVoidLineItemBatchRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
if the transaction operation failed exception |
2.24.49. lineItemService.voidPointsLineItems
POST /com.gk_software.pos.api.service.transaction.LineItemService/voidPointsLineItems
Sends request to refund loyalty points and void internally refunded line items.
Description
Sends request to refund loyalty points and void internally refunded line items.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PointsRefundBatchRequest object ComGkSoftwarePosApiServiceTransactionPointsRefundBatchRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error. |
2.24.50. lineItemService.voidTenderLineItem
POST /com.gk_software.pos.api.service.transaction.LineItemService/voidTenderLineItem
Voids the specified tender line item.
Description
Voids the specified tender line item.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The VoidTenderLineItemRequest object ComGkSoftwarePosApiServiceTransactionVoidTenderLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
if the transaction operation failed exception |
2.24.51. posTransactionService.createAndAddRetailTransactionLineItemAssociations
POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddRetailTransactionLineItemAssociations
Creates and adds retail transaction line item associations.
Description
Creates and adds retail transaction line item associations. In case of an error the whole operation is aborted/cancelled, either all associations are created or none.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreateTransactionLineItemAssociationsRequest object. ComGkSoftwarePosApiServiceTransactionCreateTransactionLineItemAssociationsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
In case an error occurs. |
2.25. LoyaltyRewardService
2.25.1. loyaltyRewardService.processLoyaltyRewardCoupon
POST /com.gk_software.pos.api.service.promotion.LoyaltyRewardService/processLoyaltyRewardCoupon
Process active loyalty reward promotions which lead to coupon issuance
Description
Process active loyalty reward promotions which lead to coupon issuance
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error. |
2.25.2. loyaltyRewardService.processLoyaltyRewardCouponByRequest
POST /com.gk_software.pos.api.service.promotion.LoyaltyRewardService/processLoyaltyRewardCouponByRequest
Process active loyalty reward promotions which lead to coupon issuance
Description
Process active loyalty reward promotions which lead to coupon issuance
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error. |
2.25.3. loyaltyRewardService.processLoyaltyRewardGiftCertificate
POST /com.gk_software.pos.api.service.promotion.LoyaltyRewardService/processLoyaltyRewardGiftCertificate
Process active loyalty reward promotions which lead to gift certificate issuance
Description
Process active loyalty reward promotions which lead to gift certificate issuance
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The LoyaltyRewardGiftCertificateRequest object ComGkSoftwarePosApiServicePromotionLoyaltyRewardGiftCertificateRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error. |
2.26. LoyaltySystemService
2.26.1. loyaltySystemService.getCustomerLoyaltyAccounts
GET /com.gk_software.pos.api.service.loyalty.LoyaltySystemService/customer-loyalty-accounts
This method returns the loyalty accounts of a customer.
Description
This method returns the loyalty accounts of a customer.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CustomerLoyaltyAccountsRequest object ComGkSoftwarePosApiServiceLoyaltyTypesCustomerLoyaltyAccountsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceLoyaltyTypesCustomerLoyaltyAccountsResponse |
404 |
Customer not found |
|
500 |
with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR |
2.26.2. loyaltySystemService.getLoyaltyProgram
GET /com.gk_software.pos.api.service.loyalty.LoyaltySystemService/loyalty-programs
This method returns the loyalty program.
Description
This method returns the loyalty program.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The LoyaltyProgramRequest object ComGkSoftwarePosApiServiceLoyaltyTypesLoyaltyProgramRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceLoyaltyTypesLoyaltyProgramResponse |
500 |
with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR |
2.26.3. loyaltySystemService.redeemPoints
POST /com.gk_software.pos.api.service.loyalty.LoyaltySystemService/redeemPoints
This method redeems points.
Description
This method redeems points.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PointsRedemptionRequest object ComGkSoftwarePosApiServiceLoyaltyTypesPointsRedemptionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceLoyaltyTypesPointsRedemptionResponse |
400 |
Not enough points |
|
404 |
Customer account not found |
|
500 |
with ErrorCodes WS_INTERNAL_ERROR, WS_CONNECTION_ERROR |
2.26.4. loyaltySystemService.refundPoints
POST /com.gk_software.pos.api.service.loyalty.LoyaltySystemService/refundPoints
This method refunds points.
Description
This method refunds points.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PointsRefundRequest object ComGkSoftwarePosApiServiceLoyaltyTypesPointsRefundRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
404 |
Redemption not found |
|
500 |
with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR |
2.27. MasterDataService
2.27.1. masterDataService.findAllScaleDomains
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findAllScaleDomains
Finds all scale domains available for given business unit group id.
Description
Finds all scale domains available for given business unit group id.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The business unit group ID [Long] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
List[ComGkSoftwareGkrApiServerMdScaleDomainDtoDomScaleDomainDO] |
2.27.2. masterDataService.findBusinessUnitDOListByFilter
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findBusinessUnitDOListByFilter
Gets a list of BusinessUnitDO object for the given filter.
Description
Gets a list of BusinessUnitDO object for the given filter.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The BusinessUnitByFilterRequest object ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitListByFilterRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitDOListByFilterResult |
2.27.3. masterDataService.findBusinessUnitTextListByReceiptTextId
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findBusinessUnitTextListByReceiptTextId
Method find BusinessUnitText by businessUnitID and receiptTextID.
Description
Method find BusinessUnitText by businessUnitID and receiptTextID.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The BusinessUnitTextRequest object ComGkSoftwarePosApiServiceMasterdataBusinessUnitTextRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiServiceMasterdataBusinessUnitTextResponse |
2.27.4. masterDataService.findBusinessUnitViewListByFilter
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findBusinessUnitViewListByFilter
Gets a list of BusinessUnitView object for the given filter.
Description
Gets a list of BusinessUnitView object for the given filter.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The BusinessUnitByFilterRequest object ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitListByFilterRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitViewListByFilterResult |
2.27.5. masterDataService.findCurrencyRoundingRule
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findCurrencyRoundingRule
Finds currency rounding rule
Description
Finds currency rounding rule
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CurrencyRoundingRuleRequest request ComGkSoftwarePosApiServiceMasterdataCurrencyRoundingRuleRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwareGkrApiServerMdCurrencyRoundingRuleDtoDomCurrencyRoundingRuleDO |
2.27.6. masterDataService.findCustomer
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomer
Finds customer according to customer identifier
Description
Finds customer according to customer identifier
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The customer ID [String] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.7. masterDataService.findCustomerContactViewListByFilter
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomerContactViewListByFilter
Finds customers overview according to criteria in filter object
Description
Finds customers overview according to criteria in filter object
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CustomerContactViewRequest object ComGkSoftwarePosApiServiceMasterdataCustomerContactViewRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiServiceMasterdataCustomerContactViewResult |
2.27.8. masterDataService.findCustomerListByPartyIdentification
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomerListByPartyIdentification
Finds customers according to party identifier
Description
Finds customers according to party identifier
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The party identification [String] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.9. masterDataService.findCustomerTenderGroups
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomerTenderGroups
Returns a list of customer tender groups matching the given customer group code.
Description
Returns a list of customer tender groups matching the given customer group code.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The customer tender group code [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
List[ComGkSoftwareGkrApiServerMdCustomerTenderRuleDtoDomCustomerTenderGroupDO] |
2.27.10. masterDataService.findMHGChildren
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findMHGroupSubGroups
Gets a merchandise hierarchy group by filter
Description
Gets a merchandise hierarchy group by filter
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The MHGroupRequest object ComGkSoftwarePosApiServiceMasterdataMHGroupRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.11. masterDataService.findMHGroup
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findMHGroup
Gets a merchandise hierarchy group by ID
Description
Gets a merchandise hierarchy group by ID
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The merchandise hierarchy group ID [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.12. masterDataService.findOperator
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findOperator
Finds the operator object for the given id
Description
Finds the operator object for the given id
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The operator id [String] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwareSweeSesApiServerUmOperatorDtoSoAbstractOperatorSO |
2.27.13. masterDataService.findSalesRestriction
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findSalesRestriction
Gets SalesRestrictionSO by ID.
Description
Gets SalesRestrictionSO by ID.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.14. masterDataService.findScaleDomain
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findScaleDomain
Finds ScaleDomain by scaleDomainRequest
Description
Finds ScaleDomain by scaleDomainRequest
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The scale domain request ComGkSoftwarePosApiServiceMasterdataScaleDomainRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.15. masterDataService.findTenderAdjustmentRules
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderAdjustmentRules
Gets a list of TenderAdjustmentRuleDO objects for the given tender type codes.
Description
Gets a list of TenderAdjustmentRuleDO objects for the given tender type codes.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The TenderAdjustmentRuleRequest object ComGkSoftwarePosApiServiceMasterdataTenderAdjustmentRuleRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiServiceMasterdataTenderAdjustmentRuleResult |
2.27.16. masterDataService.findTenderByCurrencyAndClassCode
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderByCurrencyAndClassCode
Searches for a tender by currency ID and tender class code
Description
Searches for a tender by currency ID and tender class code
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The TenderRequest} object ComGkSoftwarePosApiServiceMasterdataTenderRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.17. masterDataService.findTenderByCurrencyAndGroupCode
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderByCurrencyAndGroupCode
Searches for a tender by currency ID and tender group code
Description
Searches for a tender by currency ID and tender group code
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The TenderRequest object ComGkSoftwarePosApiServiceMasterdataTenderRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.18. masterDataService.findTenderByTypeCode
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderByTypeCode
Searches for a tender by tender type code
Description
Searches for a tender by tender type code
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The tender type code [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.19. masterDataService.findUnitOfMeasure
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findUnitOfMeasure
Finds unit of measure for given code
Description
Finds unit of measure for given code
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The unit of measure code [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.20. masterDataService.findWorker
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findWorkerDO
Gets the WorkerDO for the given criteria
Description
Gets the WorkerDO for the given criteria
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The WorkerRequest object ComGkSoftwarePosApiServiceMasterdataWorkerRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.21. masterDataService.getBaseClientMasterData
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getBaseClientMasterData
Returns base client master data.
Description
Returns base client master data.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The BaseClientMasterDataRequest object. ComGkSoftwarePosApiServiceMasterdataBaseClientMasterDataRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwarePosApiServiceMasterdataBaseClientMasterDataResult |
2.27.22. masterDataService.getBusinessUnit
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getBusinessUnit
Get business unit for given ID.
Description
Get business unit for given ID.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The business unit ID [String] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.23. masterDataService.getCalculationModuleVersion
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getCalculationModuleVersion
Returns the calculation module version that is certified by the PTB.
Description
Returns the calculation module version that is certified by the PTB.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.24. masterDataService.getCurrencies
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getCurrencies
Get the available currencies for the business unit group which is associated with the current session.
Description
Get the available currencies for the business unit group which is associated with the current session.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.25. masterDataService.getCurrenciesAndExchangeRates
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getCurrenciesAndExchangeRates
Get the available currencies and corresponding exchange rates which are related to the default currency of the busine…
Description
Get the available currencies and corresponding exchange rates which are related to the default currency of the business unitgroup which is associated to the current session.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.26. masterDataService.getCurrenciesForBusinessUnit
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getCurrenciesForBusinessUnit
Get the available currencies for given business unit ID.
Description
Get the available currencies for given business unit ID.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The business unit ID [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.27. masterDataService.getDefaultCurrency
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getDefaultCurrency
Get the default currency for the business unit group which is associated with the current session.
Description
Get the default currency for the business unit group which is associated with the current session.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.28. masterDataService.getDefaultCurrencyForBusinessUnit
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getDefaultCurrencyForBusinessUnit
Get the default currency for the for the business unit group which is associated with given business unit.
Description
Get the default currency for the for the business unit group which is associated with given business unit.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The business unit ID [String] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.29. masterDataService.getDenominations
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getDenominations
Gets available DenominationDO.
Description
Gets available DenominationDO.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The DenominationRequest object ComGkSoftwarePosApiServiceMasterdataDenominationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.30. masterDataService.getDiscountInfoIcons
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getDiscountInfoIcons
Returns a list of promotions for a given item
Description
Returns a list of promotions for a given item
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PromotionItemRequest object ComGkSoftwarePosApiServiceMasterdataPromotionItemRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.31. masterDataService.getEndDateTimestampExtension
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getEndDateTimestampExtension
Returns transaction extension for end date timestamp
Description
Returns transaction extension for end date timestamp
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.32. masterDataService.getExchangeRatesForCurrency
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getExchangeRatesForCurrency
Get the available currencies and corresponding exchange rates which are related to the given currency of the business…
Description
Get the available currencies and corresponding exchange rates which are related to the given currency of the business unitgroup which is associated to the current session.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The code of the currency [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.27.33. masterDataService.getGiftCertificateClass
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getGiftCertificateClass
Gets the gift certificate class
Description
Gets the gift certificate class
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The gc type code [String] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
ComGkSoftwareGkrApiServerMdGiftCertificateClassDtoDomGiftCertificateClassDO |
2.27.34. masterDataService.getPromotion
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getPromotion
Gets the data for the given promotion.
Description
Gets the data for the given promotion.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ID of the promotion. [Long] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.35. masterDataService.getPromotionByExternalId
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getPromotionByExternalId
Gets the data for the given external promotion ID.
Description
Gets the data for the given external promotion ID.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ID of the promotion. [String] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.36. masterDataService.getReasonCodeGroup
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getReasonCodeGroup
Gets the reason code group with the given ID.
Description
Gets the reason code group with the given ID.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The group ID [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.37. masterDataService.getSimpleTaxList
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getSimpleTaxList
Returns a consolidated tax list with simple data structure TAX_GROUP_ID = percent value.
Description
Returns a consolidated tax list with simple data structure TAX_GROUP_ID = percent value.Used for fiscalization!
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the business unit group ID [Long] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.38. masterDataService.getSimpleTaxValue
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getSimpleTaxValue
Returns a consolidated tax percent value for the given tax group ID.
Description
Returns a consolidated tax percent value for the given tax group ID.Used for fiscalization!
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The tax group ID [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.39. masterDataService.getTenders
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getTenders
Gets all available tenders.
Description
Gets all available tenders.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.40. masterDataService.getTendersByRequest
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getTendersByRequest
Get all tenders associated to a reason.
Description
Get all tenders associated to a reason.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The TenderRequest object ComGkSoftwarePosApiServiceMasterdataTenderRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.41. masterDataService.getTimePeriods
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getTimePeriods
Get available TimePeriods for a given internalTimeGroupId (of a timegroup)
Description
Get available TimePeriods for a given internalTimeGroupId(of a timegroup)
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The internal time group id [Long] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.42. masterDataService.isImmediateVoidingAllowed
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/isImmediateVoidingAllowed
Searches for a tender by given tender type code and returns immediateVoidingAllowedFlag.
Description
Searches for a tender by given tender type code and returns immediateVoidingAllowedFlag.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The tender type code [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.43. masterDataService.isPosUOMItemAvailable
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/isPosUOMItemAvailable
Checks whether an PosUOMItemDO with the specified POS item ID exists or not.
Description
Checks whether an PosUOMItemDO with the specified POS item ID exists or not.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The POS item ID [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.27.44. masterDataService.isPromotionAvailable
POST /com.gk_software.pos.api.service.masterdata.MasterDataService/isPromotionAvailable
Checks whether a promotion with given external promotion ID exists.
Description
Checks whether a promotion with given external promotion ID exists.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The external promotion ID [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
successful operation |
2.28. PayablesAccountWebService
2.28.1. payablesAccountWebService.getAccountBalance
POST /com.gk_software.pos.api.service.communication.ws.payables_account.PayablesAccountWebService/getAccountBalance
Queries the customer account balancing in the ERP service.
Description
Queries the customer account balancing in the ERP service. It gives the current status of a customer account, i.e. the (positive or negative) open amount.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The account balance request containing the necessary information for the balance request, as web service configuration, customer id and accounting area. ComGkSoftwarePosApiServiceCommunicationWsPayablesAccountAccountBalanceRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceCommunicationWsPayablesAccountAccountBalanceResult |
500 |
The exception is thrown if an unexpected error occurs, i.e.:
|
2.29. PaymentService
2.29.1. paymentService.addCashChangeAmountAlreadyPaidExtensions
POST /com.gk_software.pos.api.service.payment.PaymentService/addCashChangeAmountAlreadyPaidExtensions
Adds the cash change amount already paid extensions.
Description
Adds the cash change amount already paid extensions.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the config ComGkSoftwarePosApiModelConfigProcessActionPositionOperationConfig |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error |
2.29.2. paymentService.addTerminalPrintoutsToLineItem
POST /com.gk_software.pos.api.service.payment.PaymentService/addTerminalPrintoutsToLineItem
Appends merchant and/or customer terminal receipts to line item.
Description
Appends merchant and/or customer terminal receipts to line item.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the request ComGkSoftwarePosApiServicePaymentAddTerminalPrintoutsToLineItemRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.3. paymentService.calculateChangeAfterGivenAmount
POST /com.gk_software.pos.api.service.payment.PaymentService/calculateChangeAfterGivenAmount
Calculates the change once the given amount is accounted.
Description
Calculates the change once the given amount is accounted.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The amount that will be payed or received to be considered during change calculation. [Double] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
If any error occurs. |
2.29.4. paymentService.cancelPayment
POST /com.gk_software.pos.api.service.payment.PaymentService/cancelPayment
Cancel payment mode before moving to registration mode
Description
Cancel payment mode before moving to registration mode
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
including error code TRANSACTION_NOT_FOUND |
2.29.5. paymentService.checkLimits
POST /com.gk_software.pos.api.service.payment.PaymentService/checkLimits
Checks an entered payment amount according to minimum and maximum accepted amount of the tender
Description
Checks an entered payment amount according to minimum and maximum accepted amount of the tender
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The AmountValidationRequest object ComGkSoftwarePosApiServicePaymentAmountValidationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.6. paymentService.checkMaxDenominationDifference
POST /com.gk_software.pos.api.service.payment.PaymentService/checkMaxDenominationDifference
Checks an entered payment amount according to maximum denomination difference for the used currency
Description
Checks an entered payment amount according to maximum denomination difference for the used currency
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The AmountValidationRequest object ComGkSoftwarePosApiServicePaymentAmountValidationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.7. paymentService.createChangeAndGetPaymentAmounts
POST /com.gk_software.pos.api.service.payment.PaymentService/createChangeAndGetPaymentAmounts
Calculates the change amount and creates a change tender line item in case of overpayment for the transaction which is
Description
Calculates the change amount and creates a change tender line item in case of overpayment for the transaction which isassociated with the current session
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PaymentRequest object ComGkSoftwarePosApiServicePaymentPaymentRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.29.8. paymentService.createTenderExchangeTransaction
POST /com.gk_software.pos.api.service.payment.PaymentService/createTenderExchangeTransaction
Creates and prepares the transaction for tender exchange for finalization.
Description
Creates and prepares the transaction for tender exchange for finalization.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PaymentRequest for the tender exchange. ComGkSoftwarePosApiServicePaymentPaymentRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.29.9. paymentService.filterPerTender
POST /com.gk_software.pos.api.service.payment.PaymentService/filterPerTender
Filter per tender. Several checks are executed on all tenders of the TenderCollection. In case that a check a…
Description
Filter per tender. Several checks are executed on all tenders of the TenderCollection. In case that a check applieson a tender the tender will be forbidden.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FilterPerTenderRequest request ComGkSoftwarePosApiServicePaymentFilterPerTenderRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
If any error occurs. |
2.29.10. paymentService.getCustomerExclusiveTenderGroupCode
POST /com.gk_software.pos.api.service.payment.PaymentService/getCustomerExclusiveTenderGroupCode
Get the tender group code if there exists an customer exclusive tender.
Description
Get the tender group code if there exists an customer exclusive tender.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The customer id to check the tenders for [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.11. paymentService.getExclusiveCustomerTender
POST /com.gk_software.pos.api.service.payment.PaymentService/getExclusiveCustomerTender
Get the exclusive customer tender, if there exists one.
Description
Get the exclusive customer tender, if there exists one.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.12. paymentService.getFoodStampsTotal
POST /com.gk_software.pos.api.service.payment.PaymentService/getFoodStampsTotal
Calculates the sum of all items allowed for payment with Foods stamps.
Description
Calculates the sum of all items allowed for payment with Foods stamps.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
indicates whether discounts should be considered [Boolean] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.13. paymentService.getOpenTotal
POST /com.gk_software.pos.api.service.payment.PaymentService/getOpenTotal
Get transaction open total
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The base iso currency code [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.29.14. paymentService.getPaymentAmounts
POST /com.gk_software.pos.api.service.payment.PaymentService/getPaymentAmounts
Calculates the change amount for the transaction which is associated with the current session
Description
Calculates the change amount for the transaction which is associated with the current session
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PaymentRequest object ComGkSoftwarePosApiServicePaymentPaymentRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.29.15. paymentService.getSpecialReturnAmountLookupKey
POST /com.gk_software.pos.api.service.payment.PaymentService/getSpecialReturnAmountLookupKey
Get the lookup key for the return amounts processing
Description
Get the lookup key for the return amounts processing
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the request ComGkSoftwarePosApiServicePaymentSpecialReturnAmountLookupKeyRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
If any error occurs. |
2.29.16. paymentService.getTenderExchangeAmounts
POST /com.gk_software.pos.api.service.payment.PaymentService/getTenderExchangeAmounts
Calculates the amounts after tender exchange.
Description
Calculates the amounts after tender exchange.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PaymentRequest for the tender exchange. ComGkSoftwarePosApiServicePaymentPaymentRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.17. paymentService.getTenderPayableAmount
POST /com.gk_software.pos.api.service.payment.PaymentService/getTenderPayableAmount
Gets the tender payable amount
Description
Gets the tender payable amount
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PaymentRequest object ComGkSoftwarePosApiServicePaymentPaymentRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.18. paymentService.getTotalTenderAmount
POST /com.gk_software.pos.api.service.payment.PaymentService/getTotalTenderAmount
Calculates the total tender amount (given payments) for the transaction which is associated with the current session
Description
Calculates the total tender amount (given payments) for the transaction which is associated with the current session
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.29.19. paymentService.getTotalTenderAmountForTender
POST /com.gk_software.pos.api.service.payment.PaymentService/getTotalTenderAmountForTender
Calculates the total tender amount (given payments) of a specific tender for the transaction which is associated with…
Description
Calculates the total tender amount (given payments) of a specific tender for the transaction which is associated with thecurrent session
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
Tender to be checked ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.29.20. paymentService.isReplaceSubtotalRequired
POST /com.gk_software.pos.api.service.payment.PaymentService/isReplaceSubtotalRequired
Checks whether the subtotal rounding should be replaced.
Description
Checks whether the subtotal rounding should be replaced.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.21. paymentService.isTenderAllowedForAllCustomer
POST /com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForAllCustomer
Checks whether a tender is allowed for all customers in general according to default settings.
Description
Checks whether a tender is allowed for all customers in general according to default settings.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the tender type code [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.22. paymentService.isTenderAllowedForCustomer
POST /com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForCustomer
Checks whether a tender is allowed for customer of customers assigned to the current transaction.
Description
Checks whether a tender is allowed for customer of customers assigned to the current transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the tender type code [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.23. paymentService.isTenderAllowedForCustomerGroup
POST /com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForCustomerGroup
Checks whether a tender is allowed for customer groups of customers assigned to the current transaction.
Description
Checks whether a tender is allowed for customer groups of customers assigned to the current transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the tender type code [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.24. paymentService.isTenderAllowedForSaleReturnLineItemReason
POST /com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForSaleReturnLineItemReason
Checks whether a tender is allowed for sale return line item reasons of items with the given item type in current
Description
Checks whether a tender is allowed for sale return line item reasons of items with the given item type in currenttransaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the sale return line item item type [String] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.25. paymentService.markTenderAuthorizationForBackOfficeCancellation
POST /com.gk_software.pos.api.service.payment.PaymentService/markTenderAuthorizationForBackOfficeCancellation
Marks the tender authorization as invalid so that the backoffice agent can roll back the started payment.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The tender authorization object ComGkSoftwareGkrApiTxpoolDtoTenderAuthorization |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
In case that the operation fails for any reason. |
2.29.26. paymentService.reduceTaxableAmountForFoodStamp
POST /com.gk_software.pos.api.service.payment.PaymentService/reduceTaxableAmountForFoodStamp
Calculates the sum of all items minus amount allowed for payment with Foods stamps.
Description
Calculates the sum of all items minus amount allowed for payment with Foods stamps.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the amount [Double] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.27. paymentService.reduceTaxableAmountForWicVoucher
POST /com.gk_software.pos.api.service.payment.PaymentService/reduceTaxableAmountForWicVoucher
Calculates the sum of all items minus amount allowed for payment with Wic Voucher.
Description
Calculates the sum of all items minus amount allowed for payment with Wic Voucher.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the amount [Double] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
in case of any error |
2.29.28. paymentService.registerCashPayment
POST /com.gk_software.pos.api.service.payment.PaymentService/registerCashPayment
Adds a tender line item to transaction which is associated with the current session. If there is a cashback value >…
Description
Adds a tender line item to transaction which is associated with the current session. If there is a cashback value > 0 acashback tender line item with appropriate value will be added to the transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CashPaymentRequest object ComGkSoftwarePosApiServicePaymentCashPaymentRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.29.29. paymentService.registerCashTenderLineItem
POST /com.gk_software.pos.api.service.payment.PaymentService/registerCashTenderLineItem
Register cash tender line item
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The amount [Double] |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.29.30. paymentService.registerCashTenderLineItemInRecovery
POST /com.gk_software.pos.api.service.payment.PaymentService/registerCashTenderLineItemInRecovery
Register cash tender line item
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The amount [Double] |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
In case that the operation fails for any reason |
2.29.31. paymentService.registerCheckPayment
POST /com.gk_software.pos.api.service.payment.PaymentService/registerCheckPayment
Adds a TenderLineItem with check payment information to the transaction
Description
Adds a TenderLineItem with check payment information to the transaction
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CheckPaymentRequest object ComGkSoftwarePosApiServicePaymentCheckPaymentRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that access to transaction data fails. |
2.29.32. paymentService.registerCreditPayment
POST /com.gk_software.pos.api.service.payment.PaymentService/registerCreditPayment
Adds a tender line item to transaction which is associated with the current session.
Description
Adds a tender line item to transaction which is associated with the current session.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreditPaymentRequest object ComGkSoftwarePosApiServicePaymentCreditPaymentRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.29.33. paymentService.registerGiftCertificatePayment
POST /com.gk_software.pos.api.service.payment.PaymentService/registerGiftCertificatePayment
Adds a TenderLineItem with gift certificate payment information to the transaction
Description
Adds a TenderLineItem with gift certificate payment information to the transaction
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The GiftCertificatePaymentRequest object ComGkSoftwarePosApiServicePaymentGiftCertificatePaymentRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that access to transaction data fails. |
2.29.34. paymentService.registerGiftCertificateSpvPayment
POST /com.gk_software.pos.api.service.payment.PaymentService/registerGiftCertificateSpvPayment
Adds a SaleReturnLineItem with single purpose voucher information to the transaction
Description
Adds a SaleReturnLineItem with gift certificate single purpose voucher payment information to the transaction
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The GiftCertificateSpvPaymentRequest object ComGkSoftwarePosApiServicePaymentGiftCertificateSpvPaymentRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that access to transaction data fails. |
2.29.35. paymentService.registerMobilePayment
POST /com.gk_software.pos.api.service.payment.PaymentService/registerMobilePayment
Registers a payment position with custom tenderClassCode for mobile payment
Description
Registers a payment position with custom tenderClassCode for mobile payment
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PaymentRequest for the tender exchange ComGkSoftwarePosApiServicePaymentPaymentRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.29.36. paymentService.registerPointsPayment
POST /com.gk_software.pos.api.service.payment.PaymentService/registerPointsPayment
Adds a tender line item to transaction which is associated with the current session. If there is a cashback value >…
Description
Adds a tender line item to transaction which is associated with the current session. If there is a cashback value > 0 acashback tender line item with appropriate value will be added to the transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The PointsPaymentRequest object ComGkSoftwarePosApiServicePaymentPointsPaymentRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that the operation fails for any reason |
2.29.37. paymentService.registerTerminalPayment
POST /com.gk_software.pos.api.service.payment.PaymentService/registerTerminalPayment
Adds a CreditDebitCard TenderLineItem to the transaction which is associated with current session.
Description
Adds a CreditDebitCard TenderLineItem to the transaction which is associated with current session.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The TerminalPaymentRequest object. ComGkSoftwarePosApiServicePaymentTerminalPaymentRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
In case that access to transaction data fails. |
2.29.38. paymentService.resetTaxForEwicTender
POST /com.gk_software.pos.api.service.payment.PaymentService/reduceTaxableAmountForEwic
Calculates the sum of all items minus amount allowed for payment with eWIC.
Description
Calculates the sum of all items minus amount allowed for payment with eWIC.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
the request ComGkSoftwarePosApiServicePaymentReduceTaxableAmountRequest |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.39. paymentService.updateTerminalTenderAuthorization
POST /com.gk_software.pos.api.service.payment.PaymentService/updateTerminalTenderAuthorization
Updates terminal tender authorization with basic payment data.
Description
Updates terminal tender authorization with basic payment data.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The TerminalPaymentRequest object ComGkSoftwarePosApiServicePaymentTerminalPaymentRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
In case that access to transaction data fails. |
2.29.40. paymentService.validateAmount
POST /com.gk_software.pos.api.service.payment.PaymentService/validateAmount
Validate an entered payment amount
Description
Validate an entered payment amount
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The AmountValidationRequest object ComGkSoftwarePosApiServicePaymentAmountValidationRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
500 |
in case of any error |
2.29.41. posTransactionService.removeTerminalPaymentDataInVoiding
POST /com.gk_software.pos.api.service.payment.PaymentService/removeTerminalPaymentDataInVoiding
Removes payment data from the voided tx after tender line items are created and this data is not more needed.
Description
Removes payment data from the voided tx after tender line items are created and this data is not more needed.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The voided transaction. ComGkSoftwareGkrApiTxpoolDtoTransaction |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServiceTransactionTransactionOperationResult |
500 |
Only in case of an unexpected error. |
2.30. PosFrontendService
2.30.1. posFrontendService.finishCustomerSession
POST /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/finishCustomerSession
This method updates customer session after the sales transaction is paid - points are updated, used coupons are redeemed, unused coupons are unblocked.
Parameters
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Successful operation response. |
|
500 |
with ErrorCodes WS_CONNECTION_ERROR, WS_CUSTOMER_NOT_FOUND_ERROR, WS_INTERNAL_ERROR |
2.30.2. posFrontendService.getCustomerLoyaltyAccounts
GET /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/customer-loyalty-accounts
This method returns the loyalty accounts of a customer.
Description
This method returns the loyalty accounts of a customer.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CustomerLoyaltyAccountsRequest object ComGkSoftwarePosApiServicePosFrontendServiceCustomerLoyaltyAccountsRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServicePosFrontendServiceCustomerLoyaltyAccountsResponse |
404 |
Customer not found |
|
500 |
with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR |
2.30.3. posFrontendService.getLoyaltyProgram
GET /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/loyalty-programs
This method returns the loyalty program.
Description
This method returns the loyalty program.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The LoyaltyProgramRequest object ComGkSoftwarePosApiServicePosFrontendServiceLoyaltyProgramRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
ComGkSoftwarePosApiServicePosFrontendServiceLoyaltyProgramResponse |
500 |
with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR |
2.30.4. posFrontendService.redeemPoints
POST /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/redeemPoints
This method redeems points.
Description
This method redeems points.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RedeemPointsRequest object ComGkSoftwarePosApiServicePosFrontendServiceRedeemPointsRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success |
|
400 |
Not enough points |
|
404 |
Customer account not found |
|
500 |
with ErrorCodes WS_INTERNAL_ERROR, WS_CONNECTION_ERROR |
2.30.5. posFrontendService.startCustomerSession
POST /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/startCustomerSession
This method provides customer loyalty accounts, coupons of the customer, promotions for base point factor, tier multilicator promotions and tier rewards promotions. Additionally, the coupons are marked as blocked for the current sales transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The StartCustomerSessionRequest object ComGkSoftwarePosApiServicePosFrontendServiceStartCustomerSessionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Successful operation response. |
ComGkSoftwarePosApiServicePosFrontendServiceStartCustomerSessionResponse |
404 |
Customer not found |
|
500 |
with ErrorCodes WS_CONNECTION_ERROR, WS_CUSTOMER_NOT_FOUND_ERROR, WS_INTERNAL_ERROR |
2.30.6. posFrontendService.voidPointsRedemption
POST /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/voidPointsRedemption
This method voids the points redemption of a customer.
Description
This method voids the points redemption of a customer.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The VoidPointsRedemptionRequest object ComGkSoftwarePosApiServicePosFrontendServiceVoidPointsRedemptionRequest |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |