1. Access
-
HTTP Basic Authentication basicAuth
2. Endpoints
2.1. CommonService
2.1.1. commonService.analyzeBarcode
POST /com.gk_software.selfscanning.api.service.CommonService/analyzeBarcode
Analyzes the barcode value and type passed in by AnalyzeBarcodeRequest.
Description
Analyzes the barcode value and type passed in by AnalyzeBarcodeRequest.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The AnalyzeBarcodeRequest ComGkSoftwareSelfscanningApiServiceAnalyzeBarcodeRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The AnalyzeBarcodeResponse with a list of barcode processing actions. |
|
400 |
Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.1.2. commonService.analyzeBarcode_1
POST /com.gk_software.selfscanning.api.service.CommonServiceDelegate/analyzeBarcode
Analyzes the barcode value and type passed in by AnalyzeBarcodeRequest.
Description
Analyzes the barcode value and type passed in by AnalyzeBarcodeRequest.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The AnalyzeBarcodeRequest ComGkSoftwareSelfscanningApiServiceAnalyzeBarcodeRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The AnalyzeBarcodeResponse with a list of barcode processing actions. |
|
400 |
Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.1.3. commonService.processBarcode
POST /com.gk_software.selfscanning.api.service.CommonService/processBarcode
Analyzes the barcode value and type passed in by ProcessBarcodeRequest. If there is a registered barcode handler for the analyzed barcode processing action(s) then the barcode will be processed too, e.g. as item registration.
Description
Analyzes the barcode value and type passed in by ProcessBarcodeRequest. If there is a registered barcode handler for the analyzed barcode processing action(s) then the barcode will be processed too, e.g. as item registration.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ProcessBarcodeRequest ComGkSoftwareSelfscanningApiServiceProcessBarcodeRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
400 |
Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.1.4. commonService.processBarcode_2
POST /com.gk_software.selfscanning.api.service.CommonServiceDelegate/processBarcode
Analyzes the barcode value and type passed in by ProcessBarcodeRequest. If there is a registered barcode handler for the analyzed barcode processing action(s) then the barcode will be processed too, e.g. as item registration.
Description
Analyzes the barcode value and type passed in by ProcessBarcodeRequest. If there is a registered barcode handler for the analyzed barcode processing action(s) then the barcode will be processed too, e.g. as item registration.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The ProcessBarcodeRequest ComGkSoftwareSelfscanningApiServiceProcessBarcodeRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
400 |
Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.2. LineItemService
2.2.1. lineItemService.registerLineItem
POST /com.gk_software.selfscanning.api.service.LineItemService/registerLineItem
Adds a line item to the currently active transaction.
Description
Adds a line item to the currently active transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RegisterLineItemRequest ComGkSoftwareSelfscanningApiServiceRegisterLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.2.2. lineItemService.registerLineItem_1
POST /com.gk_software.selfscanning.api.service.LineItemServiceDelegate/registerLineItem
Adds a line item to the currently active transaction.
Description
Adds a line item to the currently active transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The RegisterLineItemRequest ComGkSoftwareSelfscanningApiServiceRegisterLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.2.3. lineItemService.setQuantity
POST /com.gk_software.selfscanning.api.service.LineItemService/setQuantity
Sets/updates the quantity in the currently active transaction according to the given SetQuantityRequest.
Description
Sets/updates the quantity in the currently active transaction according to the given SetQuantityRequest.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The SetQuantityRequest ComGkSoftwareSelfscanningApiServiceSetQuantityRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.2.4. lineItemService.setQuantity_2
POST /com.gk_software.selfscanning.api.service.LineItemServiceDelegate/setQuantity
Sets/updates the quantity in the currently active transaction according to the given SetQuantityRequest.
Description
Sets/updates the quantity in the currently active transaction according to the given SetQuantityRequest.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The SetQuantityRequest ComGkSoftwareSelfscanningApiServiceSetQuantityRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.2.5. lineItemService.voidLineItem
POST /com.gk_software.selfscanning.api.service.LineItemService/voidLineItem
Voids line item in the currently active transaction according to the given VoidLineItemRequest.
Description
Voids line item in the currently active transaction according to the given VoidLineItemRequest.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The VoidLineItemRequest ComGkSoftwareSelfscanningApiServiceVoidLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.2.6. lineItemService.voidLineItem_3
POST /com.gk_software.selfscanning.api.service.LineItemServiceDelegate/voidLineItem
Voids line item in the currently active transaction according to the given VoidLineItemRequest.
Description
Voids line item in the currently active transaction according to the given VoidLineItemRequest.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The VoidLineItemRequest ComGkSoftwareSelfscanningApiServiceVoidLineItemRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.3. SessionService
2.3.1. sessionService.endSelfScanningSession
POST /com.gk_software.selfscanning.api.service.SessionService/endSelfScanningSession
Ends a self scanning session. It can either suspend or cancel the current active transaction.
Description
Ends a self scanning session. It can either suspend or cancel the current active transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The EndSessionRequest ComGkSoftwareSelfscanningApiServiceEndSessionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The EndSessionResponse object. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.3.2. sessionService.endSelfScanningSession_1
POST /com.gk_software.selfscanning.api.service.SessionServiceDelegate/endSelfScanningSession
Ends a self scanning session. It can either suspend or cancel the current active transaction.
Description
Ends a self scanning session. It can either suspend or cancel the current active transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The EndSessionRequest ComGkSoftwareSelfscanningApiServiceEndSessionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The EndSessionResponse object. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.3.3. sessionService.startSelfScanningSession
POST /com.gk_software.selfscanning.api.service.SessionService/startSelfScanningSession
Starts a self scanning session.
Description
Starts a self scanning session.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The StartSessionRequest ComGkSoftwareSelfscanningApiServiceStartSessionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The StartSessionResponse object. |
2.3.4. sessionService.startSelfScanningSession_2
POST /com.gk_software.selfscanning.api.service.SessionServiceDelegate/startSelfScanningSession
Starts a self scanning session.
Description
Starts a self scanning session.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The StartSessionRequest ComGkSoftwareSelfscanningApiServiceStartSessionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The StartSessionResponse object. |
2.4. StoredValueServerService
2.4.1. storedValueServerService.sellGiftCertificate
POST /com.gk_software.selfscanning.api.service.StoredValueServerService/sellGiftCertificate
Sells a gift certificate.
Description
Sells a gift certificate.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The GiftCertificateRequestSSC ComGkSoftwareSelfscanningApiServiceGiftCertificateRequestSSC |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.4.2. storedValueServerService.sellGiftCertificate_1
POST /com.gk_software.selfscanning.api.service.StoredValueServerServiceDelegate/sellGiftCertificate
Sells a gift certificate.
Description
Sells a gift certificate.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The GiftCertificateRequestSSC ComGkSoftwareSelfscanningApiServiceGiftCertificateRequestSSC |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.5. TransactionService
2.5.1. transactionService.cancelTransaction
POST /com.gk_software.selfscanning.api.service.TransactionService/cancelTransaction
Cancel an uncompleted transaction which is associated with current session.
Description
Cancel an uncompleted transaction which is associated with current session.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The CancelTransactionResult object. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.5.2. transactionService.cancelTransaction_1
POST /com.gk_software.selfscanning.api.service.TransactionServiceDelegate/cancelTransaction
Cancel an uncompleted transaction which is associated with current session.
Description
Cancel an uncompleted transaction which is associated with current session.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The CancelTransactionResult object. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.5.3. transactionService.createTransaction
POST /com.gk_software.selfscanning.api.service.TransactionService/createTransaction
Creates a new transaction.
Description
Creates a new transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreateTransactionRequest ComGkSoftwareSelfscanningApiServiceCreateTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The CreateTransactionResult object. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.5.4. transactionService.createTransaction_2
POST /com.gk_software.selfscanning.api.service.TransactionServiceDelegate/createTransaction
Creates a new transaction.
Description
Creates a new transaction.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The CreateTransactionRequest ComGkSoftwareSelfscanningApiServiceCreateTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The CreateTransactionResult object. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.5.5. transactionService.failoverTransaction
POST /com.gk_software.selfscanning.api.service.TransactionService/failoverTransaction
Create a failover transaction based on a replay of a transaction log.
Description
Create a failover transaction based on a replay of a transaction log.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FailoverTransactionRequest ComGkSoftwareSelfscanningApiServiceFailoverTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.5.6. transactionService.failoverTransaction_3
POST /com.gk_software.selfscanning.api.service.TransactionServiceDelegate/failoverTransaction
Create a failover transaction based on a replay of a transaction log.
Description
Create a failover transaction based on a replay of a transaction log.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The FailoverTransactionRequest ComGkSoftwareSelfscanningApiServiceFailoverTransactionRequest |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The TransactionOperationResultSSC object. |
ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC |
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.5.7. transactionService.getTransaction
POST /com.gk_software.selfscanning.api.service.TransactionService/getTransaction
Gets the existing transaction (if there exist one) out of the current session.
Description
Gets the existing transaction (if there exist one) out of the current session.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The GetTransactionResult object. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.5.8. transactionService.getTransaction_4
POST /com.gk_software.selfscanning.api.service.TransactionServiceDelegate/getTransaction
Gets the existing transaction (if there exist one) out of the current session.
Description
Gets the existing transaction (if there exist one) out of the current session.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The GetTransactionResult object. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.5.9. transactionService.recoverTransaction
POST /com.gk_software.selfscanning.api.service.TransactionService/recoverTransaction
Recovers the transaction. If there is a customer number assigned to the session, then it will first check for unfinished transactions for the customer. If there is one this transaction will be recovered. In case of existing suspended transaction for the customer this transaction will be loaded. If there is no unfinished nor a suspended transaction or no customer assigned, then a fallback is used to create a new transaction.
Description
Recovers the transaction. If there is a customer number assigned to the session, then it will first check for unfinished transactions for the customer. If there is one this transaction will be recovered. In case of existing suspended transaction for the customer this transaction will be loaded. If there is no unfinished nor a suspended transaction or no customer assigned, then a fallback is used to create a new transaction.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The RecoverTransactionResult object. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
2.5.10. transactionService.recoverTransaction_5
POST /com.gk_software.selfscanning.api.service.TransactionServiceDelegate/recoverTransaction
Recovers the transaction. If there is a customer number assigned to the session, then it will first check for unfinished transactions for the customer. If there is one this transaction will be recovered. In case of existing suspended transaction for the customer this transaction will be loaded. If there is no unfinished nor a suspended transaction or no customer assigned, then a fallback is used to create a new transaction.
Description
Recovers the transaction. If there is a customer number assigned to the session, then it will first check for unfinished transactions for the customer. If there is one this transaction will be recovered. In case of existing suspended transaction for the customer this transaction will be loaded. If there is no unfinished nor a suspended transaction or no customer assigned, then a fallback is used to create a new transaction.
Parameters
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The RecoverTransactionResult object. |
|
401 |
Unauthorized. In case of an invalid session. |
|
429 |
Too many requests. This response is possible if for the assigned session there is already a service request in progress. As service calls may modify transaction data, it is not allowed to have parallel requests for the same session. But there is one exception to this rule. There exists the header flag \"pos_session_read_only_request\". A client can use this flag to indicate that it is sending just a read only service request, e.g. for requesting gift certificate information. In such a case the request will be processed without returning HTTP error code 429. |
3. Models
3.1. ComGkSoftwareSelfscanningApiServiceAnalyzeBarcodeRequest
AnalyzeBarcodeRequest Request object for the analyze barcode operation. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
operationStatus |
String |
The operation status 'OK' or 'NOK'. |
||
statusCode |
String |
Contains the status code in case of unsuccessful operation. |
||
barcodeType |
String |
The barcode type. |
||
value |
String |
The value. |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.2. ComGkSoftwareSelfscanningApiServiceAnalyzeBarcodeResponse
AnalyzeBarcodeResponse Response object for the analyze barcode operation. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
operationStatus |
String |
The operation status 'OK' or 'NOK'. |
||
statusCode |
String |
Contains the status code in case of unsuccessful operation. |
||
actions |
List of ComGkSoftwareSelfscanningApiServiceBarcodeProcessingAction |
A list of barcode processing actions. |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.3. ComGkSoftwareSelfscanningApiServiceBarcodeProcessingAction
BarcodeProcessingAction Object that wraps all necessary information regarding barcode processing. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
processName |
String |
The process name of the process that should handle this barcode action. |
||
reactionName |
String |
The reaction name in the process that should handle this barcode action. |
||
configId |
String |
The identifier of the configuration that should be used for this barcode action. |
||
variables |
Map of [String] |
A map of variables and values. It is taken from the process event that was triggered by the barcode scan and it can contain variables of the process that are filled by the barcode input. |
||
configParameterOverrides |
Map of [String] |
A map of configuration parameters that should be overridden. |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.4. ComGkSoftwareSelfscanningApiServiceCancelTransactionResult
CancelTransactionResult Result object for cancel transaction request. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
operationStatus |
String |
The operation status 'OK' or 'NOK'. |
||
statusCode |
String |
Contains the status code in case of unsuccessful operation. |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.5. ComGkSoftwareSelfscanningApiServiceCreateTransactionRequest
CreateTransactionRequest Request object for the create transaction operation. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.6. ComGkSoftwareSelfscanningApiServiceCreateTransactionResult
CreateTransactionResult Response object for create transaction request. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
operationStatus |
String |
The operation status 'OK' or 'NOK'. |
||
statusCode |
String |
Contains the status code in case of unsuccessful operation. |
||
transaction |
com.gk_software.selfscanning.api.service.TransactionSSC |
|||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.7. ComGkSoftwareSelfscanningApiServiceEndSessionRequest
EndSessionRequest Request object for the end self scanning operation. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cancelTransactionFlag |
X |
Boolean |
A flag to indicate that the current transaction should also be canceled when ending the self scanning session. |
|
endOfTripAnswer |
Boolean |
A flag to indicate whether the end of trip question was answered 'YES' (true) or 'NO' (false) or not even asked (null value). |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.8. ComGkSoftwareSelfscanningApiServiceEndSessionResponse
EndSessionResponse Response object for the end self scanning operation. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
operationStatus |
String |
The operation status 'OK' or 'NOK'. |
||
statusCode |
String |
Contains the status code in case of unsuccessful operation. |
||
transactionCanceledFlag |
X |
Boolean |
A flag to indicate whether the transaction was canceled (true) or not (false). |
|
suspendNumber |
String |
The suspend number under which the self scanning transaction can be retrieved again (e.g. at pay tower or a stationary POS). |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.9. ComGkSoftwareSelfscanningApiServiceFailoverTransactionRequest
FailoverTransactionRequest Request object for handling transaction failover. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
transactionId |
String |
The identifier of the failover transaction. |
||
transactionLog |
String |
The log of all recorded actions and its parameters, that were applied to the original transaction and will be redone on new created transaction on the failover pos-service. |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.10. ComGkSoftwareSelfscanningApiServiceFrequentShopperPointsModifierSSC
FrequentShopperPointsModifierSSC TODO: undocumented
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
retailTransactionLineItemSequenceNumber |
X |
Integer |
int32 |
|
frequentShopperPointsModifierSequenceNumber |
X |
Integer |
int32 |
|
promotionID |
String |
|||
priceDerivationRuleID |
String |
|||
priceDerivationRuleEligibilityID |
String |
|||
triggerSequenceNumber |
Integer |
int32 |
||
eligibilityTypeCode |
String |
|||
frequentShopperPointsEarnedCount |
X |
Double |
double |
|
frequentShopperPointsEarnedAmount |
X |
Double |
double |
|
appliedQuantity |
X |
Double |
double |
|
computationBaseAmount |
X |
Double |
double |
|
externalSystemOriginatorFlag |
X |
Boolean |
||
prorateFrom |
Integer |
int32 |
||
pointsPercentage |
Double |
double |
||
receiptPrinterName |
String |
|||
xXCustom01 |
String |
|||
xXCustom02 |
String |
|||
xXCustom03 |
String |
|||
xXCustom04 |
String |
|||
xXCustom05 |
String |
3.11. ComGkSoftwareSelfscanningApiServiceGetTransactionResult
GetTransactionResult Result object for get transaction request. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
operationStatus |
String |
The operation status 'OK' or 'NOK'. |
||
statusCode |
String |
Contains the status code in case of unsuccessful operation. |
||
transaction |
com.gk_software.selfscanning.api.service.TransactionSSC |
|||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.12. ComGkSoftwareSelfscanningApiServiceGiftCertificateRequestSSC
GiftCertificateRequestSSC Request object for self scanning stored value server service to sell gift certificates. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
configId |
String |
The identifier for the gift certificate sale configuration that should be used. |
||
variables |
Map of [String] |
@deprecated - as of 5.7.1. It is not used by any service. |
||
configParameterOverrides |
Map of [String] |
A map of configuration parameters that should be overridden. |
||
giftCertificateDescription |
String |
The gift certificate description. |
||
giftCertificateQuantity |
Integer |
The quantity for the gift certificate. |
int32 |
|
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.13. ComGkSoftwareSelfscanningApiServiceProcessBarcodeRequest
ProcessBarcodeRequest Request object for the process barcode operation. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
barcodeType |
String |
The identifier of the barcode type. (E.g. 104 == EAN13) |
||
value |
String |
The barcode. |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.14. ComGkSoftwareSelfscanningApiServiceQuantityInputSSC
QuantityInputSSC Object for wrapping quantity input. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
pieces |
Integer |
The pieces. |
int32 |
|
length |
Double |
The length. |
double |
|
width |
Double |
The width. |
double |
|
height |
Double |
The height. |
double |
|
measure |
Double |
The measure. |
double |
|
weight |
Double |
The weight. |
double |
|
manualWeightInput |
Boolean |
The manual weight input. |
||
units |
Double |
The units. |
double |
|
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.15. ComGkSoftwareSelfscanningApiServiceRecoverTransactionResult
RecoverTransactionResult Result object for recover transaction request. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
operationStatus |
String |
The operation status 'OK' or 'NOK'. |
||
statusCode |
String |
Contains the status code in case of unsuccessful operation. |
||
transaction |
com.gk_software.selfscanning.api.service.TransactionSSC |
|||
lastUsedLineItemSequenceNumber |
Integer |
The last used line item sequence number of the transaction on pos-service side. It helps the self scanning client to handle correct item registration to offline transaction and later synchronize again with pos-service self scanning transaction response, because self scanning transaction does not include void line items and there could be visible gaps in sequence numbering that are not resolvable for the client without help from pos-service. |
int32 |
|
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.16. ComGkSoftwareSelfscanningApiServiceRegisterLineItemRequest
RegisterLineItemRequest Request object for the registerItem operation. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
barcode |
String |
The barcode for the line item registration. |
||
quantityInput |
com.gk_software.selfscanning.api.service.QuantityInputSSC |
|||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.17. ComGkSoftwareSelfscanningApiServiceRegistrationDetails
RegistrationDetails Details of item registration. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
mainPOSItemId |
String |
The main POS item identifier. |
||
itemName |
String |
The item name. |
||
usedBarcode |
String |
The used barcode value in case of non successful item registration. In case of successful item registration you will find the unprocessed barcode value at the SaleReturnLineItem.registrationNumber field. |
||
prepaidItem |
X |
Boolean |
A flag to indicate whether the registration is about a prepaid item (true) or not (false). |
|
hasLinkedItems |
X |
Boolean |
A flag to indicate whether the registered item has linked items (true) or not (false). |
|
variantItemsAvailable |
X |
Boolean |
A flag to indicate whether the registered item has item variants available (true) or not (false). |
|
emptiesReturn |
X |
Boolean |
A flag to indicate whether the registered item is an empties return (true) or not (false). |
|
hasInvalidQuantity |
X |
Boolean |
A flag to indicate whether the item registration failed due to invalid quantity (true) or not (false). |
|
price |
X |
Double |
The item price. |
double |
salesRestrictions |
List of ComGkSoftwareSelfscanningApiServiceSalesRestrictionInfo |
List of sales restrictions. |
||
forceQuantityInput |
X |
Boolean |
If set to true the quantity must be entered manually. |
|
quantityInputMethod |
String |
Defines the quantity input method:
|
||
preregisteredQuantity |
Integer |
The pre-registered quantity for the item. |
int32 |
|
uomCode |
String |
The unit of measurement code. |
3.18. ComGkSoftwareSelfscanningApiServiceRetailPriceModifierSSC
RetailPriceModifierSSC TODO: undocumented
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
retailTransactionLineItemSequenceNumber |
X |
Integer |
int32 |
|
retailPriceModifierSequenceNumber |
X |
Integer |
int32 |
|
promotionID |
String |
|||
priceDerivationRuleID |
String |
|||
priceDerivationRuleEligibilityID |
String |
|||
reasonCode |
String |
|||
previousPrice |
Double |
double |
||
percent |
X |
Double |
double |
|
amount |
X |
Double |
double |
|
calculationMethodCode |
String |
|||
adjustmentMethodCode |
String |
|||
newPrice |
Double |
double |
||
eligibilityTypeCode |
String |
|||
extendedAmountBeforeModification |
X |
Double |
double |
|
extendedAmountAfterModification |
X |
Double |
double |
|
appliedQuantity |
X |
Double |
double |
|
triggerSequenceNumber |
Integer |
int32 |
||
reasonDescription |
String |
|||
extraAmount |
X |
Double |
double |
|
roundingAmount |
X |
Double |
double |
|
externalSystemOriginatorFlag |
X |
Boolean |
||
prorateFrom |
Integer |
int32 |
||
calculationBaseAmount |
X |
Double |
double |
|
receiptPrinterName |
String |
|||
xXCustom01 |
String |
|||
xXCustom02 |
String |
|||
xXCustom03 |
String |
|||
xXCustom04 |
String |
|||
xXCustom05 |
String |
3.19. ComGkSoftwareSelfscanningApiServiceRetailTransactionCouponSummarySSC
RetailTransactionCouponSummarySSC Entity RetailTransactionCouponSummarySSC @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
couponNumber |
X |
String |
The coupon number. |
|
inputCount |
X |
Double |
Count of registered coupons. |
double |
appliedCount |
Double |
Number of used coupons. |
double |
|
privilegeType |
String |
Determines how the new price is to be calculated in case that rebate information is given by PrivilegeValue. |
||
privilegeValue |
Double |
Reduction amount, reduction percent or new price amount – depending on the chosen PrivilegeType. |
double |
|
customerID |
String |
A unique system assigned identifier for the Customer. |
||
customerAddressTypeCode |
String |
The customer type code. |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.20. ComGkSoftwareSelfscanningApiServiceRetailTransactionCustomerSSC
RetailTransactionCustomerSSC TODO: undocumented
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
customerID |
String |
|||
firstName |
String |
|||
lastName |
String |
|||
addressTypeCode |
String |
|||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.21. ComGkSoftwareSelfscanningApiServiceRetailTransactionLineItemAssociationSSC
RetailTransactionLineItemAssociationSSC Entity RetailTransactionLineItemAssociationSSC @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
lineItemSequenceNumber |
X |
Integer |
The sequence number of line item. |
int32 |
toTransactionID |
X |
String |
||
toLineItemSequenceNumber |
X |
Integer |
The sequence number of the linked line item. |
int32 |
lineItemAssociationTypeCode |
X |
String |
A retailer assigned code denoting the relationship between the two items. |
|
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.22. ComGkSoftwareSelfscanningApiServiceRetailTransactionLineItemKeySSC
RetailTransactionLineItemKeySSC Entity RetailTransactionLineItemKeySSC @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
businessUnitGroupID |
X |
String |
A unique system assigned identifier for a group of BusinessUnits. |
|
transactionID |
X |
String |
A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. |
|
retailTransactionLineItemSequenceNumber |
X |
Integer |
The sequence number of line item within the context of this RetailTransaction. |
int32 |
3.23. ComGkSoftwareSelfscanningApiServiceRetailTransactionLineItemSSC
RetailTransactionLineItemSSC Entity RetailTransactionLineItemSSC @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
key |
X |
com.gk_software.selfscanning.api.service.RetailTransactionLineItemKeySSC |
||
retailTransactionLineItemTypeCode |
String |
A code to denote the type of retail transaction line item, such as Sale/Return, Void, Tender … |
||
voidFlag |
Boolean |
A boolean indicator that tells if this line item is VOIDED or not. |
||
voidTypeCode |
String |
Describes whether the line item was voided immediately after registering it, voided by another line item or internally voided |
||
saleReturnLineItem |
com.gk_software.selfscanning.api.service.SaleReturnLineItemSSC |
|||
retailTransactionLineItemAssociationList |
List of ComGkSoftwareSelfscanningApiServiceRetailTransactionLineItemAssociationSSC |
Defines a list of line item associations. |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.24. ComGkSoftwareSelfscanningApiServiceSaleReturnLineItemSSC
SaleReturnLineItemSSC Entity SaleReturnLineItemSSC @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
retailTransactionLineItemSequenceNumber |
X |
Integer |
The sequence number of line item within the context of this RetailTransaction. |
int32 |
mainPOSItemID |
String |
The main pos item id |
||
itemID |
String |
A unique identifier for the item |
||
unitOfMeasureCode |
String |
The code used to specify the unit of the item |
||
itemType |
String |
The type code of the line item |
||
subItemType |
String |
The sub type code of the line item |
||
regularUnitPrice |
Double |
The regular per-unit price |
double |
|
actualUnitPrice |
Double |
The actual per-unit price |
double |
|
actualUnitPriceQuantity |
Integer |
The actual unit price quantity. |
int32 |
|
quantity |
Integer |
The single quantity of a line item Piece Item:3 * itemQuantity = 3Units = 1Weight item:3 * 1.234kg * itemQuantity = 3Units = 1.234Item with deposit:3 * six-pack (1 six-pack has 6 * deposit item)six-pack: Quantity = 3, Units = 1deposit: Quantity = 3, Units = 6 |
int32 |
|
units |
Double |
The units of the line item Piece Item:3 * itemQuantity = 3Units = 1Weight item:3 * 1.234kg * itemQuantity = 3Units = 1.234Item with deposit:3 * six-pack (1 six-pack has 6 * deposit item)six-pack: Quantity = 3, Units = 1deposit: Quantity = 3, Units = 6 |
double |
|
extendedAmount |
Double |
The product of multiplying Quantity, Units and ActualUnitPrice. |
double |
|
extendedDiscountAmount |
Double |
The monetary total of all line item discounts that were applied to this Item. |
double |
|
grandExtendedAmount |
Double |
The line item total including taxes and discounts |
double |
|
length |
Double |
The registered length |
double |
|
width |
Double |
The registered width |
double |
|
height |
Double |
The registered height |
double |
|
manualWeightInputFlag |
Boolean |
Describes how the weight was registered |
||
receiptText |
String |
The receipt printout text |
||
registrationNumber |
String |
The complete number which was registered on the POS originally |
||
negativeLineItemFlag |
Boolean |
If this flag is set to true, automatically a negative line item is created when registering this item. Corresponds to ItemSellingRule.NegativeLineItemFlag |
||
discountFlag |
Boolean |
A flag to indicate whether this ITEM can be discounted. Corresponds to Item.DiscountFlag |
||
frequentShopperPointsEligibilityFlag |
Boolean |
A flag to denote that the Item is eligible for frequent shopper points. Corresponds to ItemSellingRule.FrequentShopperPointsEligibilityFlag |
||
prohibitReturnFlag |
Boolean |
A flag to denote whether or not this item may be returned. |
||
taxReceiptPrintCode |
String |
A short code that is printed on a receipt to denote items that are in this TaxableGroup. |
||
taxGroupID |
String |
The id of the taxable TaxableGroup |
||
originalTaxGroupID |
String |
The original id of the taxable group. |
||
retailPriceModifierList |
List of ComGkSoftwareSelfscanningApiServiceRetailPriceModifierSSC |
List of line item discounts. |
||
frequentShopperPointsModifierList |
List of ComGkSoftwareSelfscanningApiServiceFrequentShopperPointsModifierSSC |
List of line item points discounts |
||
quantityInputTypeCode |
String |
Type code for controlling the quantity input. |
||
quantityInputMethod |
String |
Determines how the input of quantity was done. |
||
pOSItemID |
String |
The ID used to identify the item. |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.25. ComGkSoftwareSelfscanningApiServiceSalesRestrictionInfo
SalesRestrictionInfo The sales restriction details. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
salesRestrictionTypeCode |
String |
Sales restriction type code, e.g. AGE, CAGE, TIME. |
||
salesRestrictionValue |
String |
The value of the sales restriction - its content depends on the SalesRestrictionTypeCode. |
||
questionTypeCode |
String |
Type code of the question. |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.26. ComGkSoftwareSelfscanningApiServiceSetQuantityRequest
SetQuantityRequest Request object for the setQuantity operation. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
lineItemKey |
com.gk_software.selfscanning.api.service.RetailTransactionLineItemKeySSC |
|||
quantityInput |
com.gk_software.selfscanning.api.service.QuantityInputSSC |
|||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.27. ComGkSoftwareSelfscanningApiServiceStartSessionRequest
StartSessionRequest Request object for the start self scanning operation. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
businessUnitId |
String |
The business unit identifier. |
||
customerNumber |
String |
The customer number. |
||
customerLocale |
String |
The customer locale (e.g. en_US). |
||
clientVersion |
String |
The client software version. Max. 40 characters. |
||
deviceId |
String |
The device identifier. |
||
removalDate |
String |
The timestamp when the device was removed from the self scanning disposal wall. |
||
beginDateTimestampGreaterOrEquals |
String |
The date time after which the transaction would have been created. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone) |
||
validationCode |
X |
Integer |
The validation code. |
int32 |
autorizationCodeFlag |
X |
Boolean |
The authorization code flag. |
|
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.28. ComGkSoftwareSelfscanningApiServiceStartSessionResponse
StartSessionResponse Response object for the start self scanning operation. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
operationStatus |
String |
The operation status 'OK' or 'NOK'. |
||
statusCode |
String |
Contains the status code in case of unsuccessful operation. |
||
openTransactionFlag |
X |
Boolean |
A flag to indicate whether there is already an open transaction assigned to the customer. As a next step a recovery could be done to continue this transaction. |
|
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.29. ComGkSoftwareSelfscanningApiServiceTransactionOperationResultSSC
TransactionOperationResultSSC The entity TransactionOperationResultSSC contains the result of a service execution and is used for providing transaction updates fields updates for service clients. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
operationStatus |
String |
The operation status 'OK' or 'NOK'. |
||
statusCode |
String |
Contains the status code in case of unsuccessful operation. |
||
transaction |
com.gk_software.selfscanning.api.service.TransactionSSC |
|||
addedOrdModifiedLineItems |
List of ComGkSoftwareSelfscanningApiServiceRetailTransactionLineItemSSC |
The line items added or modified by a service execution. |
||
actions |
List of ComGkSoftwareSelfscanningApiServiceBarcodeProcessingAction |
A list of barcode processing actions that where involved triggering the transaction change operation. |
||
closedLineItems |
List of [Integer] |
The line items closed during a service execution. |
int32 |
|
deletedLineItems |
List of [Integer] |
The line items deleted by a service execution. |
int32 |
|
filtered |
Boolean |
A flag to indicate whether the transaction operation result is filtered (true) or not (false). A filtered result contains only the differences/deltas to the previous transaction status and not the whole transaction (field transaction will be empty). A not filtered result contains the whole updated transaction. |
||
registrationDetails |
com.gk_software.selfscanning.api.service.RegistrationDetails |
|||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.30. ComGkSoftwareSelfscanningApiServiceTransactionSSC
TransactionSSC Entity TransactionSSC @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
businessUnitGroupID |
X |
String |
A unique system assigned identifier for a group of BusinessUnits. |
|
transactionID |
X |
String |
A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. |
|
sequenceNumber |
Integer |
The sequence number of the transaction (incremental number for each workstation). It is formatted according to minimum and maximum value and it could be reset every day to minimum value. So in comparison to InternalSequenceNumber it must not be unique for business unit and workstation.It is used for export, reporting, search and display. |
int32 |
|
beginDateTimestamp |
String |
The time and date a transaction is initiated. |
||
retailTransactionLineItems |
List of ComGkSoftwareSelfscanningApiServiceRetailTransactionLineItemSSC |
list of line items |
||
retailTransactionCouponSummary |
List of ComGkSoftwareSelfscanningApiServiceRetailTransactionCouponSummarySSC |
Defines a list of coupons. |
||
retailTransactionCustomer |
List of ComGkSoftwareSelfscanningApiServiceRetailTransactionCustomerSSC |
|||
subtotal |
Double |
The monetary value of the transaction subtotal without transaction discounts. |
double |
|
subtotalDiscount |
Double |
The monetary value of the transaction subtotal with transaction discounts. |
double |
|
total |
Double |
The monetary value of the transaction total (includes taxes that are not included in prices). |
double |
|
discountTotal |
Double |
double |
||
bonusPointsTotal |
Double |
double |
||
customerLocale |
String |
The custoemr locale. |
||
validationCode |
String |
The validationCode. |
||
iSOCurrencyCode |
String |
The main currency of the store. |
||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |
3.31. ComGkSoftwareSelfscanningApiServiceVoidLineItemRequest
VoidLineItemRequest Request object for the voidLineItem operation. @deprecated - as of 5.25.0. BasketService should be used instead.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
lineItemKey |
com.gk_software.selfscanning.api.service.RetailTransactionLineItemKeySSC |
|||
xXCustom01 |
String |
Customizable information. |
||
xXCustom02 |
String |
Customizable information. |
||
xXCustom03 |
String |
Customizable information. |
||
xXCustom04 |
String |
Customizable information. |
||
xXCustom05 |
String |
Customizable information. |