Skip to main content

Update a product type

PUThttps://carchost.fieldcontrol.com.br/products-types/{id}

Updates a product type. Send the full type: the body follows the same rules as creation.

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

Request​

Path parameters

idstringrequired

Product type identifier.

Example: MmY5ZGE5YzgtZDY3MC00NWJhLTk0MGUtNzQxYjk3ODI0MzllOjIyOTE1.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Request body

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

namestringrequired

Product type name.

Up to 100 characters.

descriptionstring

Product type description.

Up to 2000 characters.

archivedbooleanrequired

Archives the product type.

externalobject
Fields of external
idstring

Product type identifier in your system.

Up to 100 characters.Accepts: null.

Responses

  • 200

    Product type 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.

  • 422

    Invalid identifier, or one from another account, in the URL (uriValidationErr), nonexistent product type (resourceValidationErr with message: products type not found; there is no 404) or invalid body.

    resourceValidationErr →
  • 429

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

  • 500

    Unexpected server error.