Skip to main content
1

Create the transfer

To transfer items from one FBO account to another, send a request to the transfers endpoint. The required fields are fromFboAccountId and toFboAccountId from list FBO accounts, and items. Each item needs an inventory item id and reason.
Omit approve. The response returns a status of pending_approval. The approve field can be used to confirm the transfer in this call. Set it to true and the response returns a status of completed, or processing when Beach still has work to finish the transfer. Confirm a pending_approval transfer later with the confirm endpoint.During pending_approval the inventory status stays in_vault. Cancel with the cancel endpoint while the status is pending_approval or processing.
In most cases, an approved transfer is completed immediately. In rare cases, the response is processing. Continue to step 3 to handle it.
2

Optional: Confirm a deferred transfer

While the status is pending_approval, the items stay on the source account. Send a request to the confirm endpoint to approve it. The response returns a status of completed or, in rare cases, processing.
3

Optional: Handle a processing transfer

If the transfer returns processing, Beach still has work to finish it. Cancel is available until an item starts moving. The transfer.status_changed webhook arrives with a toStatus of completed or rejected. completed means every item is in_vault on the destination account. rejected means the items stay on the source account.