documentUnlink

A mutation DocumentUnlink desfaz o vínculo de um document com um carrinho aberto ou com um produto do carrinho.

O document não é removido: ele continua existindo e pode ser vinculado de novo. Para remover o document, use DocumentDelete. Desvincular um document que não está vinculado não muda nada.

Parâmetros

ArgumentoTipoObrigatórioDescrição
idString!SimIdentificador do document, em hash
checkoutIdUuid!SimCarrinho aberto do qual desvincular o document
productVariantIdLongNãoProduto do carrinho do qual desvincular o document. Sem ele, desfaz o vínculo com o carrinho
customerAccessTokenStringNãoToken de acesso do cliente, como nas demais mutations de carrinho
recaptchaTokenStringNãoToken do Google reCAPTCHA. Obrigatório quando a loja exige reCAPTCHA para esta mutation

Campos de retorno

A mutation retorna o carrinho (Checkout) atualizado, com os mesmos campos da query Checkout, incluindo documentIds no carrinho e nos produtos.

Exemplo

mutation {
  documentUnlink(
    id: "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDF9"
    checkoutId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    productVariantId: 354968
  ) {
    checkoutId
    products {
      productVariantId
      documentIds
    }
  }
}
Mostrar resposta
{
  "data": {
    "documentUnlink": {
      "checkoutId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "products": [
        {
          "productVariantId": 354891,
          "documentIds": ["eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDF9"]
        },
        {
          "productVariantId": 354968,
          "documentIds": []
        }
      ]
    }
  }
}
🚧

O vínculo só pode ser desfeito com o carrinho aberto. Depois que o pedido é finalizado, o vínculo do pedido não muda.

Códigos de erro

CódigoMensagemDescrição
WDC110Não é possível vincular ou desvincular documentos de um carrinho finalizadoO carrinho já virou pedido
WDC111O produto não está no carrinhoO productVariantId informado não está no carrinho
REC104Token recaptcha é obrigatórioA loja exige reCAPTCHA para esta mutation e o recaptchaToken não foi informado