List all inventory models

How to fetch a collection of inventory models via API

To fetch a collection of inventory models, send a GET request to the /api/inventory_models endpoint.

Request

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

Example

The following request fetches a collection of inventory models:

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

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

Sortable fields

The list of inventory models can be sorted by the following fields:

Attributes

  • name

  • strategy

  • stock_locations_cutoff

  • stock_reservation_cutoff

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Filterable fields

The list of inventory models can be filtered by the following fields:

Attributes

  • name

  • strategy

  • stock_locations_cutoff

  • stock_reservation_cutoff

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • inventory_stock_locations

  • inventory_return_locations

  • attachments

Last updated