GET /api/v2/stock_transfers/{stock_transfer_id}.json
Retrieves a specific stock transfer

Supported Formats

json

Errors

Code Description
404 Stock transfer not found.

Examples

{
  "id": 1,
  "note": "Display this in the store window.",
  "sequential_id": 1000,
  "transferred_by": "Jane Doe",
  "from_location_id": 905684977,
  "to_location_id": 48752903,
  "created_at": "2021-02-05T16:41:38.000Z",
  "sent_at": "2021-02-05T16:41:57.000Z",
  "received_at": "2021-02-05T16:42:20.000Z",
  "stock_transfer_reason": "Display case",
  "archived": true,
  "forecast_type": "last_days",
  "restock_for": 7,
  "tracking_number": "112345Z2345",
  "stock_transfer_items": [
    {
      "id": 1,
      "inventory_item_id": 808950810,
      "product_title": "Shirt",
      "variant_title": "Medium",
      "quantity": 6,
      "status": "received",
      "received_at": "2021-02-05T16:42:20.000Z",
      "updated_at": "2021-02-05T16:42:20.000Z"
    }
  ]
}

Params

Param name Description
stock_transfer_id
required

The ID of the stock transfer

Validations:

  • Must be a Integer

Returns

Code: 200

Description:

A stock transfer

Param name Description
id
required

A unique numeric identifier for the stock transfer.

Validations:

  • Must be a Integer
note
required

An optional note that can be attached to the stock transfer.

Validations:

  • Must be a String
sequential_id
required

A sequential identifier for the stock transfer.

Validations:

  • Must be a String
transferred_by
required

The name of the staff member written in the stock transfer’s “Employee” field.

Validations:

  • Must be a String
from_location_id
required

The identifier for the Shopify Location that inventory is coming from.

Validations:

  • Must be a Integer
to_location_id
required

The identifier for the Shopify Location that inventory is going to.

Validations:

  • Must be a Integer
created_at
required

The date and time when the stock transfer was created.

Validations:

  • Must be a String
updated_at
required

The date and time when the stock transfer was last updated.

Validations:

  • Must be a String
sent_at
required

The date and time when the stock transfer was sent. If this property is null, the stock transfer has not been sent yet.

Validations:

  • Must be a String
received_at
required

The date and time when the first stock transfer item was received. If this property is null, no stock transfer items have been received yet.

Validations:

  • Must be a String
reason
required

An optional string that can be attached to a stock transfer to explain why it was created. Merchants can add new reasons to their Stocky account in Preferences > Stock transfers.

Validations:

  • Must be a String
archived
required

Indicates whether the stock transfer has been archived or not.

Validations:

  • Must be one of: true, false, 1, 0.
forecast_type
required

The type of forecasting used to create the stock transfer. Valid values:

  • last_days: based on the destination’s demand but limited to the stock available at the source,

  • fill_shelves: brings inventory levels at the destination up to the maximum stock level but limited to the stock available at the source,

  • fill_shelves_if_min: brings inventory levels at the destination up to the maximum stock level only if below the minimum stock level but limited to the stock available at the source

Validations:

  • Must be a String
restock_for
required

The number of days of sales history used to estimate demand at the destination; only applies when ‘forecast_type` is `last_days`.

Validations:

  • Must be a Integer
tracking_number
required

The tracking number for the stock transfer.

Validations:

  • Must be a String
stock_transfer_item
required

A list of stock transfer items.

Validations:

  • Must be a Hash
stock_transfer_item[id]
required

A unique numeric identifier for the stock transfer item.

Validations:

  • Must be a Integer
stock_transfer_item[inventory_item_id]
required

The identifier for the Shopify InventoryItem associated with the stock transfer item.

Validations:

  • Must be a Integer
stock_transfer_item[product_title]
required

The name of the product.

Validations:

  • Must be a String
stock_transfer_item[variant_title]
required

The title of the product variant.

Validations:

  • Must be a String
stock_transfer_item[quantity]
required

The number of items being transferred.

Validations:

  • Must be a Integer
stock_transfer_item[status]
required

The status of the stock transfer item. Valid values:

  • not_transferred,

  • sent,

  • send_failed,

  • received,

  • receive_failed,

  • restocked,

  • restock_failed,

  • rejected,

  • syncing,

  • failed,

  • inventory_tracking_not_set

Validations:

  • Must be a String
stock_transfer_item[received_at]
required

The date and time when the stock transfer item was received. If this property is null, the item has not been received yet.

Validations:

  • Must be a String
stock_transfer_item[updated_at]
required

The date and time when the stock transfer item was last modified.

Validations:

  • Must be a DateTime