commerce/catalog/admin/softallocations

The Soft Allocations resource allows you to temporarily hold a product from inventory while a shopper is filling out payment information. You create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete.

Note:  You must enable and implement custom Arc.js actions in order for soft allocations to fully work on your site.

JSON Example

SoftAllocation Properties

Property Description
allocationId

type: int

The unique identifier of the soft allocation product reservation. Use this identifier to target the soft allocation in your custom Arc.js action.

allowsBackOrder

type: bool

Specifies whether to allow for product back orders.

auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

expiresAt

type: DateTime

Specifies the date and time in UTC format that the soft allocation expires.

locationCode

type: string

The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned.

productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

quantity

type: int

The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations.

referenceId

type: string

The unique identifier of the reference that the soft allocation is linked to.

referenceItemId

type: string

The unique identifier of the item within the reference.

rootProductId

type: int

The root of the product's unique identifier, or the product code.

updateInRepository

type: bool

Specifies whether to update the inventory with the soft allocation quantity.

Operations

Operation Name Request URI Description
AddSoftAllocations POST 

Creates a new soft allocation for a product. This places a hold on the product inventory for the quantity specified during the ordering process.

ConvertToProductReservation POST convert

Converts a set of existing soft product allocations into product reservations.

DeleteSoftAllocation DELETE %7bsoftAllocationId%7d

Deletes a soft allocation. You might delete a soft allocation when an order or cart is not processed in order to return the product quantity back to inventory.

GetSoftAllocation GET %7bsoftAllocationId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a soft allocation.

GetSoftAllocations GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of sof allocations according to any specified filter criteria and sort options.

RenewSoftAllocations POST renew

Updates the expiration time for a set of soft allocations in a non-transactional batch.

UpdateSoftAllocations PUT 

Updates a soft allocation. This updates a hold on the product inventory for the quantity specified during the ordering process.