afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/InventoryReservation.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "field_reference"
  ],
  "title": "InventoryReservation - Data API",
  "description": "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.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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"
    }
  },
  "special_access_rules": "This object is available only if a B2B Commerce, D2C Commerce, B2C Commerce, or Salesforce Order Management license is enabled.\n\nThis object is available only if a B2B Commerce,\n         D2C Commerce,\n         B2C\n         Commerce, or Salesforce Order Management license is enabled.",
  "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.\n\n- **InventoryReservationOwnerSharingRule**: Sharing rules are available for the object.\n- **InventoryReservationShare**: Sharing is available for the object.",
  "field_reference": {
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "ErrorCode": {
      "field_label": "Error Code",
      "type": "string",
      "length": "255"
    },
    "ErrorMessage": {
      "field_label": "Error Message",
      "type": "textarea",
      "length": "2000"
    },
    "Id": {
      "field_label": "Inventory Reservation ID",
      "type": "id",
      "length": "18"
    },
    "InventoryReservationName": {
      "field_label": "Inventory Reservation Number",
      "type": "string",
      "length": "255"
    },
    "IsAsyncOperationInProgress": {
      "field_label": "Async Operation in Progress",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsSuccess": {
      "field_label": "Latest Operation Succeeded",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "ReservationDate": {
      "field_label": "Reservation Date",
      "type": "datetime"
    },
    "ReservationDurationInSeconds": {
      "field_label": "Reservation Duration in Seconds",
      "type": "int",
      "digits": "9"
    },
    "ReservationIdentifier": {
      "field_label": "Reservation Identifier",
      "type": "string",
      "length": "255"
    },
    "ReservationSourceId": {
      "field_label": "Reservation Source ID",
      "type": "reference",
      "length": "18"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}