Basket Content

The basket contains the sales transaction and further attributes. Important basket attributes are described in the following table. The complete basket structure is visible in the Basket Service API.

Attribute Description
id Unique basket identification.
businessUnitId Unique retailer-assigned identifier for a retail store, distribution center or administration center (internal identifier).
customerId Unique ID of the customer.
status Basket status. See values and meaning in the Basket Status Diagram chapter below.
createdTimestampUTC UTC timestamp of when the basket was created.
modifiedTimestampUTC UTC timestamp of when the basket was modified.
problemLevel

Problem level of the basket.

Values:

  • Empty - no problem
  • MEDIUM - at least one medium problem with the basket
  • CRITICAL - at least one critical problem with the basket; the problem can be solved by a full rescan only

For more details, see the Problem Handling chapter.
clientType

Type of the client where the basket is registered.

Values: SCANLESS, SELF_SCANNING, POS, SELF_CHECKOUT
checkoutStatus

Result of the checkout. Information for the client if the payment is possible and how to handle the transaction.

Values:

  • READY_TO_PAY - the transaction is ready to be paid
  • SUSPENDED_WITH_PROBLEMS - the transaction has been suspended because of problems with item registration, fraud detection etc.
  • SUSPENDED_WITHOUT_PROBLEMS - the transaction has been suspended without problems
  • CANCELED - the basket has been canceled in the checkout process because it contained no items
  • PENDING_WITH_PROBLEMS - the transaction contains problems, cannot be paid, but the problems can be resolved by an employee
externalClientId Unique client ID, e.g. mobile device ID, workstation ID, webshop session ID, etc.
workstationId Unique identifier of the workstation. If not filled, the workstation of the Basket Service is used.
basketVersion Sequence number representing the basket version. Increases after each basket action is processed.
basketType

Basket type corresponding to the retail transaction type.

Values: SALE
businessType

Type of retailer business.

Values: RETAIL
transaction

Complete sales transaction.

The transaction.transactionID is filled with the ID of the basket.