Criar um produto

POSThttps://carchost.fieldcontrol.com.br/products

Cria um produto.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

namestringobrigatório

Nome do produto.

Até 100 caracteres.

descriptionstring

Descrição do produto.

Até 2000 caracteres.

codestringobrigatório

Código do produto. Deve ser único entre os produtos da conta.

measurestringobrigatório

Unidade de medida. Valores fora desta lista são gravados como unity. kilogram é gravado, mas volta como null nas respostas.

Valores aceitos: unity, centimeter, meter, liter, milliliter, kilogram.

valuenumberobrigatório

Valor unitário do produto.

archivedbooleanobrigatório

Arquiva o produto.

externalobject

Campos de external

idstring

Identificador do produto no seu sistema.

Até 100 caracteres.Aceita: null.

productTypeobjectobrigatório

Tipo do produto, por id ou por name. Com name, a API usa o primeiro tipo da conta cujo nome contém o texto informado, sem diferenciar maiúsculas e minúsculas.

Campos de productType

idstring

Identificador do tipo de produto.

namestring

Nome (ou parte do nome) do tipo de produto.

Respostas

• 201

  Produto criado.

• 401

  Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

• 403

  Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

• 422

  Corpo inválido (resourceValidationErr), code já usado por outro produto da conta (message: product code already exists) ou productType sem id nem name.

• 429

  Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

• 500

  Erro inesperado no servidor. Acontece também quando productType não é enviado.