commerce/catalog/admin/productreservations

Use the Product Reservations resource to temporarily hold a product from inventory while a shopper is filling out payment information. You can create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete.

JSON Example

ProductReservation Properties

Property Description
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.

id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

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.

orderId

type: string

Unique identifier of the order associated with the payment.

orderItemId

type: string

Unique identifier of the order item associated with a validation message, order, or return.

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.

Operations

Operation Name Request URI Description
AddProductReservations POST %3fskipInventoryCheck%3d%7bskipInventoryCheck%7d

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

CommitReservations POST commit

Commits a product reservation to decrement the product's inventory by the quantity specified then release the reservation once the order process completed successfully.

DeleteProductReservation DELETE %7bproductReservationId%7d

Deletes a product reservation. For example, delete a reservation when an order is not processed to return the product quantity back to inventory.

GetProductReservation GET %7bproductReservationId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a product reservation.

GetProductReservations 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 product reservations according to any specified filter criteria and sort options.

UpdateProductReservations PUT %3fskipInventoryCheck%3d%7bskipInventoryCheck%7d

Updates an existing product reservation for a product.