Novos campos CPF / CNPJ na API REST

Português do Brasil Discussões Perguntas técnicas frequentes

Topic summary

Tópico central: o novo campo de CPF/CNPJ no checkout do Shopify não é retornado na REST API de Orders. Usuários buscam forma de expor ou adicionar esse dado via REST.

Achados: via GraphQL é possível ler o CPF/CNPJ em Order.localizationExtensions (purpose TAX, title CPF/CNPJ, value). Há exemplo de query e resposta que retornam o valor corretamente.

Workaround: foi possível gravar manualmente o CPF/CNPJ no pedido usando a mutation orderUpdate e a key TAX_CREDENTIAL_BR em localizationExtensions. Implementado com Postman e em PHP (Laravel/Guzzle).

Limitações/discordância: o workaround apenas “força” um valor no pedido e não resolve a leitura do valor coletado no checkout via REST. Não há indicação de suporte do campo na REST API.

Status e próximos passos: sem solução oficial. Suporte da Shopify encaminha para um tópico relacionado na Comunidade em inglês, recomenda postar no fórum de API & Tech e consultar a documentação para desenvolvedores. Discussão permanece aberta quanto ao retorno via REST e melhores práticas.

Notas: CPF/CNPJ são identificadores fiscais brasileiros; REST e GraphQL são modelos de API; localizationExtensions armazena dados localizados como identificação fiscal.

Summarized with AI on January 11. AI used: gpt-5.
4

Localizei esse documentação mas nada de retorno via REST

https://shopify.dev/tutorials/get-a-tax-id-using-localization-extensions

{
  order(id: "gid://shopify/Order/1") {
    id
    localizationExtensions(first: 5) {
      edges {
        node {
          countryCode
          purpose
          title
          value
        }
      }
    }
  }
}

Retorno

{
  "data": {
    "order": {
      "id": "gid://shopify/Order/1",
      "localizationExtensions": {
        "edges": [
          {
            "node": {
              "countryCode": "BR",
              "purpose": "TAX",
              "title": "CPF/CNPJ",
              "value": "39053344705"
            }
          }
        ]
      }
    }
  }
}

/ Response

1 Like