List storages

GEThttps://carchost.fieldcontrol.com.br/storages-v2

Lists the account's storages, with pagination, filters and sorting. The list does not include storageProducts. Requires the inventory control module.

Requires the X-Api-Key and User-Agent headers. Limit: 1 request per second (learn more).

Request

Query parameters

limitinteger

Number of items per page.

From 1 to 100.Default: 10.

offsetinteger

Number of items to skip.

From 0 to 200000.Default: 0.

qstring

Filters in the field:value format, separated by spaces (how to filter). The accepted filters are in the table below.

Example: name:central archived:false.

Filter	What it does
name	Part of the storage name, case-insensitive. Up to 50 characters.
name_eq	Storage name, exactly as registered. Up to 50 characters.
description	Part of the description, case-insensitive. Up to 100 characters.
employee_id	Identifier of the employee in charge.
archived	true for archived, false for active.

sortstring

Sorting. The - prefix reverses the order.

Accepted values: id, created_at, -created_at.Default: id.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Responses

• 200

  List of storages.

• 401

  API key missing (Missing API Key) or invalid (Invalid API Key). See Authentication.

• 403

  Account blocked (Account blocked), expired (Account expired) or on a plan that does not allow integration (Account plan not allowed). See Authentication.

• 422

  Invalid filter, pagination or sorting (parametersValidationErr). Account without the inventory control module: resourceNotAllowed.

• 429

  Limit of 1 request per second exceeded. See Rate limit.

• 500

  Unexpected server error.