Skip to main content

Update a part unit

PUThttps://carchost.fieldcontrol.com.br/part-units/{id}

Updates the registration data of a part unit. Send only the fields that will change. The status changes through the action endpoints.

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

Request​

Path parameters

idstringrequired

Part unit identifier.

Example: YzNkNGU1ZjYtYTdiOC05MDEyLWNkZWYtMTIzNDU2Nzg5MDEyOjIyOTE1.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Request body

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

partIdstring

Part identifier.

codestring

Unit code.

descriptionstring

Unit description.

usageConditionstring

Usage condition.

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

valuenumber

Unit value.

storageIdstring

Storage. On update, it only changes the link, without recording a movement.

externalIdstring

Unit identifier in your system.

archivedboolean

Archives the unit.

Responses

  • 200

    Part unit updated.

  • 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.

  • 404

    Resource not found. The response body is empty.

  • 422

    Invalid body, with the same rules as creation (resourceValidationErr). An invalid identifier in the URL also returns this error, with property: '@.id'.

  • 429

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

  • 500

    Unexpected server error.