Skip to main content

Create a part unit

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

Registers a physical unit of a part, optionally already in a storage.

Requires the X-Api-Key, User-Agent and Content-Type: application/json headers. Limit: 1 request per second (learn more).

Request​

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Request body

JSON, sent with the Content-Type: application/json header.

partIdstringrequired

Part identifier.

codestringrequired

Unit code (e.g. serial number).

descriptionstring

Unit description.

usageConditionstring

Usage condition.

Accepted values: new, semi_new, used, refurbished, defective.Default: new.

valuenumber

Unit value.

storageIdstring

Entry storage. With a storage, the API records an entry movement and the unit becomes available (or under_review in a triage storage); without a storage, it becomes available.

externalIdstring

Unit identifier in your system.

archivedboolean

Archives the unit.

Default: false.

Responses

  • 201

    Part unit created.

  • 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 body (resourceValidationErr): partId or code missing (reason: missing required field), nonexistent part or storage, invalid usageCondition, or status field sent (reason: transition field not allowed in create/update).

  • 429

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

  • 500

    Unexpected server error.