InventoryReservation
Stores information about the status of cart inventory reservations in B2B and D2C Commerce.
This object only applies to cart inventory reservation APIs in B2B and D2C Commerce. It isn’t related to inventory reservation Connect APIs used with Omnichannel Inventory and Order Management.
If your org is using Omnichannel Inventory as its inventory system, the inventory reservation record related to the cart also represents a reservation in Omnichannel Inventory. If the org uses a different inventory system, the inventory reservation record related to the cart represents a reservation in that inventory system.
Introduced in API version 57.0.
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
- This object is available only if a B2B Commerce, D2C Commerce, B2C Commerce, or Salesforce Order Management license is enabled.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The error code if the reservation isn’t successful.
- Type: textarea
- Properties: Create, Nillable, Update
- Description: If an error occurred, this field contains the error message.
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: Name of the inventory reservation (autogenerated, for example: PIR-0033).
- Type: picklist
- Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 66.0
-
Type: boolean
-
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
-
Description:
Indicates if there’s an async operation in progress that could affect the reservation.
The default value is
false. -
Default value: false
-
Type: boolean
-
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
-
Description:
Indicates whether the most recent inventory system operation was successful.
The default value is
false. -
Default value: false
- Type: datetime
- Properties: Create, Filter, Sort, Update
- Description: The timestamp when the inventory reservation was created.
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The total duration of the inventory reservation in seconds.
- Type: string
- Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
- Description: The unique identifier (text value) for the reservation.
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description:
The ID of the entity associated with the inventory reservation.
This field is a polymorphic relationship field.
-
Relationship name: ReservationSource
-
Relationship type: polymorphic
-
Refers to: CustomEntityDataTemplate, FulfillmentOrder, Order, ReturnOrder, WebCart, WorkOrder
This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.