Newer Version Available

This content describes an older version of this product. View Latest

InventoryReservation

Stores information about the status of cart inventory reservations in B2B and D2C Commerce. This object is available in API version 60.0 and later.

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.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

This object is available only if a B2B Commerce, D2C Commerce, B2C Commerce, or Salesforce Order Management license is enabled.

Fields

Field Details
ErrorCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The error code if the reservation isn’t successful.
ErrorMessage
Type
textarea
Properties
Create, Nillable, Update
Description
If an error occurred, this field contains the error message.
InventoryReservationName
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Name of the inventory reservation (autogenerated, for example: PIR-0033).
IsAsyncOperationInProgress
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.
IsSuccess
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.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, the user could have only accessed this record or list view (LastReferencedDate) but not viewed it.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The user who owns the inventory reservation.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ReservationDate
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The timestamp when the inventory reservation was created.
ReservationDurationInSeconds
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The total duration of the inventory reservation in seconds.
ReservationIdentifier
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The unique identifier (text value) for the reservation.
ReservationSourceId
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
Lookup
Refers To
Export_FOI__c, WebCart

Associated Objects

This object has these 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 and later.

InventoryReservationOwnerSharingRule
Sharing rules are available for the object.
InventoryReservationShare
Sharing is available for the object.