Salesforce Docs Portal

Transfer Reservation Action

In Omnichannel Inventory, transfer one or more inventory reservations between locations or location groups. This action reduces the reserved quantity at the source and increases it at the destination. It doesn’t change physical quantities.

Required Editions

Available in: Lightning Experience
View supported editions.
This feature requires the Salesforce Omnichannel Inventory add-on. To purchase, contact your Salesforce account executive.

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

Note
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.

Input Parameter Description
Omnichannel Inventory Service Transfer Reservation Input

This input is an Apex-defined variable of class ConnectApi.OCITransferReservationInputRepresentation.

The variable has these fields.

  • allOrNothingTransferId—Optional. Controls whether a single failed transfer cancels all other transfers in the transferRecords list.
    • To allow some transfers in the transferRecords list to succeed when others fail, don’t set this value.
    • To cancel all the transfers in the transferRecords list when any of them fail, set this value to a UUID. The ID must be unique, but isn’t otherwise used.
  • transferRecords—A list of up to 100 Apex-defined variables of class ConnectApi.OCITransferReservationSingleInputRepresentation. Each variable represents an inventory transfer and has these fields.
    • actionRequestId—A UUID that identifies the request. To identify which actions succeeded or failed, use the action request IDs in the output variables.
    • externalRefId—Optional. The external reference ID.
    • fromLocationGroupIdentifier—The identifier of the location group transferring the reservation. Either fromLocationGroupIdentifier or fromLocationIdentifier is required, but not both.
    • fromLocationIdentifier—The identifier of the location transferring the reservation. Either fromLocationIdentifier or fromLocationGroupIdentifier is required, but not both.
    • ignoreAvailabilityCheck—If true, force the transfer even if the receiving location doesn’t have sufficient available inventory. The default value is false.
    • quantity—The quantity of the product reservation to transfer.
    • stockKeepingUnit—The Stock Keeping Unit (SKU) of the product reservation to transfer.
    • toLocationGroupIdentifier—The identifier of the location group receiving the reservation. Either toLocationGroupIdentifier or toLocationIdentifier is required, but not both.
    • toLocationIdentifier—The identifier of the location receiving the reservation. Either toLocationIdentifier or toLocationGroupIdentifier is required, but not both.

Store Output Values

Output Parameter Description
Omnichannel Inventory Service Transfer Reservation Output

This value is an Apex-defined variable of class ConnectApi.OCITransferReservationOutputRepresentation.

The variable has these fields.

  • errors—A list of Apex-defined variables of class ConnectApi.OCITransferReservationErrorOutputRepresentation. Each variable represents a returned error and has these fields.
    • details—An Apex-defined variable of class ConnectApi.OCITransferReservationSingleOutputRepresentation. Each variable represents a returned error and includes the fields from the input:
      • actionRequestId—A UUID that identifies the failed request.
      • externalRefId—The external reference ID.
      • fromLocationGroupIdentifier—The identifier of the location group transferring the reservation.
      • fromLocationIdentifier—The identifier of the location transferring the reservation.
      • ignoreAvailabilityCheck—Whether this call ignored availability data at the location that received the reservation.
      • quantity—The quantity of the product reservation to transfer.
      • stockKeepingUnit—The SKU of the product reservation to transfer.
      • toLocationGroupIdentifier—The identifier of the location group intended to receive the reservation.
      • toLocationIdentifier—The identifier of the location intended to receive the reservation.
    • errorCode—The error code.
    • message—Details of the error, if available.
  • success—Indicates whether the transfer succeeded.

To set up the Omnichannel Inventory Service Transfer Reservation Input:

  • For each reservation to transfer, use Assignment elements to set the actionRequestId, externalRefId, fromLocationGroupIdentifier or fromLocationIdentifier, quantity, stockKeepingUnit, and toLocationGroupIdentifier or toLocationIdentifier field values on a ConnectApi.OCITransferReservationSingleInputRepresentation variable.
  • Use Assignment elements to add the ConnectApi.OCITransferReservationSingleInputRepresentation variables to the transferRecords field on a ConnectApi.OCITransferReservationInputRepresentation variable.
  • Use an Assignment element to set the allOrNothingTransferId field on the ConnectApi.OCITransferReservationInputRepresentation variable.
  • Use the ConnectApi.OCITransferReservationInputRepresentation variable in the action input.

See Also