List part units

GEThttps://carchost.fieldcontrol.com.br/part-units

Lists the account's part units, with pagination, filters and sorting.

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: status:available partId:YjJjM2Q0ZTUtZjZhNy04OTAxLWJjZGUtZjEyMzQ1Njc4OTAxOjIyOTE1.

Filter	What it does
code	Part of the unit code, case-insensitive.
status	Unit status (e.g. available, installed, discarded).
usageCondition	Usage condition (new, semi_new, used, refurbished, defective).
partId	Part identifier.
storageId	Storage identifier.
equipmentId	Identifier of the equipment where it is installed.
externalId	Unit identifier in your system, exactly as registered.
archived	true for archived, false for active.

sortstring

Sorting. The - prefix reverses the order.

Accepted values: id, -id, code, -code, status, -status, value, -value, created_at, -created_at, updated_at, -updated_at.Default: id.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Responses

• 200

  List of part units.

• 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 pagination or sorting (parametersValidationErr).

• 429

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

• 500

  Unexpected server error.