---
schema_version: "1"
id: 7e9e7a33e61471e7db5a42bf6aeb37484f1b56fecdb01c278ccecbf4febd957d
title: Get Availability Action
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/platform/264-0-0/flow_ref_elements_oci_actions_get_availability.md
canonical_url: https://help.salesforce.com/s/articleView?id=platform.flow_ref_elements_oci_actions_get_availability.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 97f9d608cc812de60020b36019f4a0651e5115a035b5ac16064c898909b38f7f
description: In Omnichannel Inventory, get inventory availability data for one or more products at one or more inventory locations or location groups.
products:
  - Flow Builder
  - Salesforce Platform
release: "264"
---
# Get Availability Action

In Omnichannel Inventory, get inventory availability data for one or more products at one or more inventory locations or location groups.

### Required Editions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small edition"><colgroup><col></colgroup><tbody><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Available in: Lightning Experience</td></tr><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;"><a href="https://help.salesforce.com/s/articleView?id=platform.flow_ref_supported_editions.htm&amp;release=264.0.0&amp;type=5" title="Learn about the editions and user interfaces that support Flow Builder. Some Flow Builder features integrate with other Salesforce products that require additional licenses.">View supported editions.</a></td></tr><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">This feature requires the Salesforce Omnichannel Inventory add-on. To purchase, contact your Salesforce account executive.</td></tr></tbody></table>

In Flow Builder, add an Action element to your flow. Select the **Omnichannel Inventory Service** category, and search for **Omnichannel Inventory Service Get Availability**.

![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-platform-platform_automation-264-0-0-production-enus/60568438-ec7e-4665-acd1-7c80dcbe60d5/images/icon_note.png)

Note Set the flow’s runtime API version to 52.0 or later.

Set Input Values

Use values from earlier in the flow to set the inputs.

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col style="width:17.006802721088434%">
          <col style="width:82.99319727891157%">
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d319460e93">Input Parameter</th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d319460e96">Description</th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Input Parameter" class="slds-cell-wrap" style="vertical-align:top;" headers="d319460e93 ">
              <strong class="uicontrol">Omnichannel Inventory Service Get Availability
                Input</strong>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d319460e96 ">
              <p>This input is an Apex-defined variable of class <a href="https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_connectapi_input_o_c_i_get_inventory_availability.htm" target="_blank">ConnectApi.OCIGetInventoryAvailabilityInputRepresentation</a>.</p>
              <p>The variable
                has these fields.</p>
              <ul>
                <li><strong class="uicontrol">locationGroupIdentifier</strong>—Optional.
                  Can’t combine with <strong class="uicontrol">locationGroupIdentifiers</strong> or <strong class="uicontrol">locationIdentifiers</strong>. The identifier of a location group to
                  retrieve inventory availability data for. Specifying this value retrieves
                  inventory data for all locations belonging to this group.</li>
                <li><strong class="uicontrol">locationGroupIdentifiers</strong>—Optional;
                  can’t combine with <strong class="uicontrol">locationGroupIdentifier</strong> or <strong class="uicontrol">locationIdentifiers</strong>. A list of up to 100 identifiers of location
                  groups to retrieve inventory availability data for.</li>
                <li><strong class="uicontrol">locationIdentifiers</strong>—Optional;
                  can’t combine with <strong class="uicontrol">locationGroupIdentifier</strong> or <strong class="uicontrol">locationGroupIdentifiers</strong>. A list of up to 100 identifiers of
                  locations to retrieve inventory availability data for.</li>
                <li><strong class="uicontrol">stockKeepingUnit</strong>—Optional; can’t
                  combine with <strong class="uicontrol">stockKeepingUnits</strong>. The
                  SKU of a product to retrieve inventory availability data for. Specifying a SKU
                  with no locations or location groups returns availability data for that SKU at
                  all inventory locations that aren’t assigned to location groups.</li>
                <li><strong class="uicontrol">stockKeepingUnits</strong>—Optional; can’t
                  combine with <strong class="uicontrol">stockKeepingUnit</strong>. A
                  list of up to 100 SKUs of products to retrieve inventory availability data
                  for.</li>
                <li><strong class="uicontrol">useCache</strong>—Optional. Fetch the
                  inventory data from the cache. The default value is <code>true</code>.</li>
              </ul>
            </td>

          </tr>
        </tbody>
      </table>

Store Output Values

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col style="width:17.513134851138354%">
          <col style="width:82.48686514886164%">
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d319460e191">Output Parameter</th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d319460e194">Description</th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Output Parameter" class="slds-cell-wrap" style="vertical-align:top;" headers="d319460e191 ">
              <strong class="uicontrol">Omnichannel Inventory Service Get Availability
                Output</strong>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d319460e194 ">
              <p>This input is an Apex-defined variable of class <a href="https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_connectapi_output_o_c_i_get_inventory_availability_output.htm" target="_blank">ConnectApi.OCIGetInventoryAvailabilityOutputRepresentation</a>.</p>
              <p>The variable
                has these fields.</p>
              <ul>
                <li><strong class="uicontrol">locationGroups</strong>—A list of Apex-defined variables of class
                  <a href="https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_connectapi_output_o_c_i_location_group_availability_output.htm" target="_blank">ConnectApi.OCILocationGroupAvailabilityOutputRepresentation</a>. Each
                  variable represents availability data for one location group and has these fields.<ul>
                    <li><strong class="uicontrol">inventoryRecords</strong>—A list of Apex-defined variables of
                      class <a href="https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_connectapi_output_o_c_i_inventory_record_output.htm" target="_blank">ConnectApi.OCIInventoryRecordOutputRepresentation</a>. Each variable
                      represents the availability of one product and has these fields.<ul>
                        <li><strong class="uicontrol">availableToFulfill</strong>—The
                          Available To Fulfill quantity.</li>
                        <li><strong class="uicontrol">availableToOrder</strong>—The
                          Available To Order quantity.</li>
                        <li><strong class="uicontrol">effectiveDate</strong>—The
                          effective date of the inventory.</li>
                        <li><strong class="uicontrol">futures</strong>—A list of
                          Apex-defined variables of class <a href="https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_connectapi_output_o_c_i_future_inventory_output.htm" target="_blank">ConnectApi.OCIFutureInventoryOutputRepresentation</a>. Each
                          variable represents one future restock and has these fields.<ul>
                            <li><strong class="uicontrol">expectedDate</strong>—Date when
                              the future inventory is expected.</li>
                            <li><strong class="uicontrol">quantity</strong>—Quantity of
                              the future inventory.</li>
                          </ul>
                        </li>
                        <li><strong class="uicontrol">onHand</strong>—The On Hand
                          quantity.</li>
                        <li><strong class="uicontrol">reserved</strong>—The Reserved
                          quantity.</li>
                        <li><strong class="uicontrol">safetyStockCount</strong>—The
                          Safety Stock Count.</li>
                        <li><strong class="uicontrol">stockKeepingUnit</strong>—The SKU
                          of the product.</li>
                      </ul>
                    </li>
                    <li><strong class="uicontrol">locationGroupIdentifier</strong>—The
                      identifier of the location group.</li>
                  </ul>
                </li>
                <li><strong class="uicontrol">locations</strong>—A list of Apex-defined variables of class <a href="https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_connectapi_output_o_c_i_location_availability_output.htm" target="_blank">ConnectApi.OCILocationAvailabilityOutputRepresentation</a>. Each variable
                  represents availability data for one location and has these fields.<ul>
                    <li><strong class="uicontrol">inventoryRecords</strong>—A list of Apex-defined variables of
                      class <a href="https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_connectapi_output_o_c_i_inventory_record_output.htm" target="_blank">ConnectApi.OCIInventoryRecordOutputRepresentation</a>. Each variable
                      represents the availability of one product and has these fields.<ul>
                        <li><strong class="uicontrol">availableToFulfill</strong>—The
                          Available To Fulfill quantity.</li>
                        <li><strong class="uicontrol">availableToOrder</strong>—The
                          Available To Order quantity.</li>
                        <li><strong class="uicontrol">effectiveDate</strong>—The
                          effective date of the inventory.</li>
                        <li><strong class="uicontrol">futures</strong>—A list of
                          Apex-defined variables of class <a href="https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_connectapi_output_o_c_i_future_inventory_output.htm" target="_blank">ConnectApi.OCIFutureInventoryOutputRepresentation</a>. Each
                          variable represents one future restock and has these fields.<ul>
                            <li><strong class="uicontrol">expectedDate</strong>—Date when
                              the future inventory is expected.</li>
                            <li><strong class="uicontrol">quantity</strong>—Quantity of
                              the future inventory.</li>
                          </ul>
                        </li>
                        <li><strong class="uicontrol">onHand</strong>—The On Hand
                          quantity.</li>
                        <li><strong class="uicontrol">reserved</strong>—The Reserved
                          quantity.</li>
                        <li><strong class="uicontrol">safetyStockCount</strong>—The
                          Safety Stock Count.</li>
                        <li><strong class="uicontrol">stockKeepingUnit</strong>—The SKU
                          of the product.</li>
                      </ul>
                    </li>
                    <li><strong class="uicontrol">locationIdentifier</strong>—The
                      identifier of the location.</li>
                  </ul>
                </li>
              </ul>
            </td>

          </tr>
        </tbody>
      </table>

To set up the Omnichannel Inventory Service Get Availability Input:

- Use Assignment elements to set the **locationGroupIdentifier**, **locationGroupIdentifiers**, or **locationIdentifiers** field value, **stockKeepingUnit** or **stockKeepingUnits** field value, and **useCache** field value on a **ConnectApi.OCIGetInventoryAvailabilityInputRepresentation** variable.
- Use the **ConnectApi.OCIGetInventoryAvailabilityInputRepresentation** variable in the action input.

#### See Also

- [Add and Edit Elements](https://help.salesforce.com/s/articleView?id=platform.flow_build_elements.htm&release=264.0.0&type=5 "Use elements to define actions that the flow can run. When they’re on the canvas, connect them to create the order in which they run.")