Pular para o conteúdo principal

Remover um produto da ordem

DELETEhttps://carchost.fieldcontrol.com.br/orders/{id}/products-v2/{productId}

Remove um produto da ordem de serviço e recalcula os totais. Em contas com o módulo de controle de estoque, devolve a quantidade ao depósito informado no corpo.

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

Requisição​

Parâmetros de caminho

idstringobrigatório

Identificador da ordem de serviço.

Exemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

productIdstringobrigatório

Identificador do produto (não do item da ordem).

Exemplo: MzYzMjgxZGEtNzIxMS00ZTU5LTg0MzMtYjc5Y2UyYTEwYzk0OjIyOTE1.

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.

storageobject

Depósito que recebe o produto de volta. Obrigatório em contas com o módulo de controle de estoque.

Campos de storage
idstringobrigatório
descriptionstring

Descrição gravada na movimentação de estoque.

Respostas

  • 204

    Removido. Sem corpo.

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

  • 404

    Ordem inexistente. Sem corpo.

  • 422

    Produto não adicionado à ordem (message: product doesn't exist in order; não há 404) ou, com controle de estoque, depósito ausente (resourceValidationErr). Identificador da ordem inválido: uriValidationErr.

  • 429

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

  • 500

    Erro inesperado no servidor.