itemRegistrationModel

addItem

  • adds items to the basket. This is typically used after a consumer scanned an item barcode. Adding items to a basket requires that a basket was generated upfront.
Method Description
Request addItem
  • quantity: Int -> the quantity of the item you want to add
  • units: Double? -> optional - the units of the item you want to add
  • length: Double? -> optional - the length of the item you want to add
  • width: Double? -> optional - the width of the item you want to add
  • height: Double? -> optional - the height of the item you want to add
  • posItemId: String -> the posItemId of the item you want to add
  • basketId: String? -> the basketId of the basket where you want to add the item to
  • businessUnitId: String? -> the businessUnitId your in
Response
  • ItemRegistrationState.ItemUpdated
  • ItemRegistrationState.ItemError

changeQuantity

  • changes the quantity of an item. Only existing items can be modified.
Method Description
Request changeQuantity
  • quantity: Int -> the quantity of the item you want to add
  • units: Double? -> optional - the units of the item you want to add
  • length: Double? -> optional - the length of the item you want to add
  • width: Double? -> optional - the width of the item you want to add
  • height: Double? -> optional - the height of the item you want to add
  • manualWeightInput: Boolean → new Manual weight input for the item
  • posItemId: String -> the posItemId of the item you want to add
  • basketId: String? -> the basketId of the basket where you want to add the item to
  • businessUnitId: String? -> the businessUnitId your in
  • lineItemKey: Int → the key of the line item you want to change
Response
  • ItemRegistrationState.ItemUpdated
  • ItemRegistrationState.ItemError

removeItem

  • Removes an item from the basket using posItemId and quantity.
Method Description
Request removeItem
  • quantity: Int -> the quantity of the item you want to remove
  • posItemId: String -> the posItemId of the item you want to remove
  • basketId: String? -> the basketId of the basket where you want to remove the item to
  • businessUnitId: String? -> the businessUnitId your in
Response
  • ItemRegistrationState.ItemUpdated
  • ItemRegistrationState.ItemError

removeLineItem

  • Removes an item from the basket using the lineItemKey.
Method Description
Request removeLineItem
  • lineItemKey: Int -> key of the line item you want to remove
  • basketId: String? -> the basketId of the basket where you want to remove the item to
  • businessUnitId: String? -> the businessUnitId your in
Response
  • ItemRegistrationState.ItemUpdated
  • ItemRegistrationState.ItemError

addEmpties

  • Adds an empties receipt in the current basket.
Method Description
Request addEmpties
  • basketId: String -> the basketId where the item is assigned to
  • businessUnitId: String -> the businessUnitId your in
  • createdBy: String -> creator of the empty transaction
  • transactionIdentifier: String -> identifier of the transaction
  • amount: Double? -> amount of the transaction
  • amountReturnables: Double? -> returnable amount
  • amountNonReturnables: Double? -> non returnable amount
  • foreignBusinessUnitId: String? -> foreign business unit id
  • clientBasketVersion: Int? -> basket version of the client
Response
  • ItemRegistrationState.ItemUpdated
  • ItemRegistrationState.ItemError

addScales

  • adds a scale receipt in the current basket.
Method Description
Request addScales
  • basketId: String -> the basketId where the item is assigned to
  • businessUnitId: String -> the businessUnitId your in
  • createdBy: String -> creator of the empty transaction
  • transactionIdentifier: String -> identifier of the transaction
  • amount: Double? -> amount of the transaction
  • offlineLineItems: List<OfflineLineItem>? -> offline line item
  • clientBasketVersion: Int? -> basket version of the client
Response
  • ItemRegistrationState.ItemUpdated
  • ItemRegistrationState.ItemError