Skip to main content

Store Transfers

1. Overview​

The Store Transfer API orchestrates the end-to-end process of moving inventory between two store locations. It provides a structured workflow to ensure that stock is accurately tracked from the moment a request is made until the items are received at their destination.

The process involves two primary roles:

  • Requesting Store: The location that initiates the transfer request to receive items.
  • Shipping Store: The location that fulfills the request by sending items.

2. The Transfer Lifecycle​

A store transfer progresses through three distinct phases, each handled by one of the participating stores.

Phase 1: Request & Reservation (Requesting Store)​

The lifecycle begins when the requesting store identifies a need for stock from another location.

  1. Creation: The requesting store creates a new Store Transfer document, specifying the designated shipping store. At this stage, the transfer is a draft and is not visible to the shipping store.
  2. Item Entry: The requesting store adds the desired products and quantities to the draft.
  3. Submission: The requesting store finalizes and submits the request.

Key Effect: Upon submission, the requested quantities are immediately placed in a 'reserved' state within the shipping store's inventory system. Reserved stock is protected and cannot be sold or allocated to other outbound operations, ensuring it is available for this transfer.

Phase 2: Fulfillment & Shipping (Shipping Store)​

Once submitted, the request becomes visible to the shipping store, which then prepares the items for dispatch.

  1. Picking: The shipping store's staff picks the requested items from their stock.
  2. Quantity Adjustment: During this step, the shipping store can modify the quantities being sent. This is a critical feature to handle discrepancies, such as insufficient stock to fulfill the original request completely.
  3. Shipment Confirmation: The shipping store confirms the transfer is shipped. This is a pivotal, irreversible action with several automated effects:
    • The Store Transfer document is locked and can no longer be edited.
    • A corresponding Goods Received document is automatically generated for the requesting store, awaiting the physical delivery.
    • The shipped items are formally deducted from the shipping store's stock-on-hand, consuming the previously reserved quantities.

Phase 3: Reception & Stock-In (Requesting Store)​

The final phase occurs when the physical shipment arrives at the requesting store.

  1. Receiving: Using the pre-generated Goods Received document, the store staff verifies the delivery against the items listed.
  2. Receiving Adjustment: If the received quantities differ from what was shipped (e.g., due to damage in transit), the store can adjust the numbers on the Goods Received document to reflect reality.
  3. Closing: The store closes the Goods Received document to finalize the process.

Final Inventory Impact: Closing the Goods Received document officially adds the received items to the requesting store's stock-on-hand, making them available for sale and completing the transfer lifecycle.

3. API Reference​

The OpenAPI specification is the definitive source for all technical details: