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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "field_reference"
  ],
  "title": "InventoryItemReservation - Data API",
  "description": "Used to store inventory item reservation information for a specific product and location. This object is available in API version 60.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Available only for orgs with the multicurrency feature enabled. ISO code for the currency of the inventory items. Possible values are: EUR—Euro USD—U.S. Dollar The default value is USD."
    },
    "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."
    },
    "InventoryItemReservationName": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "Name of the inventory item reservation (autogenerated, for example: PIR-0033)."
    },
    "InventoryReservationId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of the inventory reservation. This field is a relationship field.",
      "relationship_name": "InventoryReservation",
      "relationship_type": "Lookup",
      "refers_to": "InventoryReservation"
    },
    "ItemReservationSourceId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The ID of the entity associated with the inventory item reservation. This field is a relationship field.",
      "relationship_name": "ItemReservationSource",
      "relationship_type": "Lookup",
      "refers_to": "CartItem"
    },
    "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 might have only accessed this record or list view (LastReferencedDate) but not viewed it."
    },
    "ProductId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The ID of the product on the inventory item reservation. This field is unique within your organization. This field is a relationship field.",
      "relationship_name": "Product",
      "relationship_type": "Lookup",
      "refers_to": "Product2"
    },
    "Quantity": {
      "type": "double",
      "properties": "Create, Filter, Sort, Update",
      "description": "Number of products on the inventory item reservation."
    },
    "ReservedAtLocationId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The location or location group where the inventory item reservation originated. This field is a polymorphic relationship field.",
      "relationship_name": "ReservedAtLocation",
      "relationship_type": "Lookup",
      "refers_to": "Location, LocationGroup"
    },
    "StockKeepingUnit": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The stock keeping unit (SKU) of the reserved item."
    }
  },
  "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, B2C Commerce or Salesforce Order Management license is enabled.",
  "field_reference": {
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "ErrorCode": {
      "field_label": "Error Code",
      "type": "string",
      "length": "255"
    },
    "ErrorMessage": {
      "field_label": "Error Message",
      "type": "textarea",
      "length": "2000"
    },
    "Id": {
      "field_label": "Inventory Item Reservation ID",
      "type": "id",
      "length": "18"
    },
    "InventoryItemReservationName": {
      "field_label": "Inventory Item Reservation Number",
      "type": "string",
      "length": "255"
    },
    "InventoryReservationId": {
      "field_label": "Inventory Reservation ID",
      "type": "reference",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "ItemReservationSourceId": {
      "field_label": "Item Reservation Source ID",
      "type": "reference",
      "length": "18"
    },
    "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"
    },
    "ProductId": {
      "field_label": "Product ID",
      "type": "reference",
      "length": "18"
    },
    "Quantity": {
      "field_label": "Quantity",
      "type": "double",
      "precision": "18",
      "scale": "0"
    },
    "ReservedAtLocationId": {
      "field_label": "Reserved At Location ID",
      "type": "reference",
      "length": "18"
    },
    "StockKeepingUnit": {
      "field_label": "Stock Keeping Unit",
      "type": "string",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale"
  ]
}