Skip to navigation
API ReferenceInventory

Set B2B Reservation Quantity

View as Markdown

Sets the quantity of an inventory item that is reserved for the B2B channel. The reservation drives the b2b_sellable_quantity and d2c_sellable_quantity fields returned by Get All Inventory Levels and Get Inventory Levels. The new value replaces the previous one. Send 0 to remove the reservation.

The inventory item must belong to the caller. This operation requires feature flag PIX.GIS.B2bInventoryReservation to be enabled for the merchant. If the flag is off, or the inventory item does not belong to the caller, the response is 403. The two cases return the same response on purpose.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Request

This endpoint expects an object.
b2b_reservation_quantityintegerRequired
Quantity to reserve for the B2B channel. Must be 0 or greater.
inventory_idintegerRequired
Unique identifier of the inventory item. Must be greater than 0. The item must belong to the caller.

Response

B2B reservation quantity updated
b2b_reservation_quantityintegerOptional
The B2B reservation quantity now stored for the inventory item
inventory_idintegerOptional
Unique identifier of the inventory item that was updated

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error