List all stock transfers

How to fetch a collection of stock transfers via API

To fetch a collection of stock transfers, send a GET request to the /api/stock_transfers endpoint.

Request

GET https://yourdomain.commercelayer.io/api/stock_transfers

Example

Request

The following request fetches a collection of stock transfers:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/stock_transfers/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Response

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of stock transfers can be sorted by the following fields:

Attributes

• number

• status

• quantity

• on_hold_at

• picking_at

• in_transit_at

• completed_at

• cancelled_at

• id

• created_at

• updated_at

• reference

• reference_origin

Relationships

• sku

• shipment

• line_item

• stock_reservation

Filterable fields

The list of stock transfers can be filtered by the following fields:

Attributes

• number

• status

• quantity

• on_hold_at

• picking_at

• in_transit_at

• completed_at

• cancelled_at

• id

• created_at

• updated_at

• reference

• reference_origin

• metadata

Relationships

• sku

• origin_stock_location

• destination_stock_location

• shipment

• line_item

• stock_reservation

• attachments

• events