DOCS

Verificar requisitos de conformidade

Descubra quais programas de conformidade se aplicam a um item e leia o questionário que você precisará responder.

GraphQL

A consulta complianceRequirements é o ponto de entrada para o Zonos Clarify. Informando o código HS e a rota de um item, ela retorna os programas de conformidade acionados e permite percorrer a estrutura completa do questionário de cada programa — perguntas, opções e lógica de ramificação. Use-a para decidir se um envio precisa de respostas de conformidade e para renderizar sua própria interface de questionário.

Escopo necessário

Esta consulta requer o escopo COMPLIANCE_READ. Consulte OAuth para autenticar solicitações de API.

Descubra os programas aplicáveis 

Informe o hsCode e o shipToCountry de um item para descobrir quais programas se aplicam. O resultado é uma conexão paginada de nós ComplianceRequirement, cada um apontando para o ComplianceProgram que ele aciona.

1query ComplianceRequirements($filter: ComplianceRequirementFilter!) {
2 complianceRequirements(filter: $filter, first: 10) {
3 totalCount
4 pageInfo {
5 hasNextPage
6 endCursor
7 }
8 edges {
9 cursor
10 node {
11 id
12 hsCode
13 shipToCountry
14 shipFromCountry
15 program {
16 id
17 code
18 name
19 programType
20 authority
21 jurisdiction
22 status
23 strictness
24 currentVersion {
25 id
26 version
27 status
28 }
29 }
30 }
31 }
32 }
33}

Um shipFromCountry igual a null em um requisito significa que o programa se aplica independentemente da origem. Quando você informa shipFromCountry no filtro, tanto as linhas específicas de origem quanto as linhas de "qualquer origem" são correspondidas.

Filtragem e paginação 

complianceRequirements aceita um ComplianceRequirementFilter, além dos argumentos padrão de paginação por cursor (first / after para paginação para frente, last / before para paginação para trás).

Campo do filtroTipoNotas
hsCodeStringCorrespondência exata de código HS. Mutuamente exclusivo com hsCodePrefix.
hsCodePrefixStringCorrespondência de prefixo (somente dígitos e pontos, máximo de 12 caracteres). Mutuamente exclusivo com hsCode.
shipToCountryCountryCodePaís de destino.
shipFromCountryCountryCodePaís de origem. Linhas com origem null ("qualquer origem") também são correspondidas.
programTypes[ComplianceProgramType!]Filtra apenas esses tipos de programa. Lista vazia = sem filtro.

Por exemplo, liste todos os requisitos de PGA para o capítulo de cosméticos 3304:

1query PgaRequirements($filter: ComplianceRequirementFilter!) {
2 complianceRequirements(filter: $filter, first: 25) {
3 totalCount
4 edges {
5 node {
6 hsCode
7 shipToCountry
8 program {
9 code
10 name
11 }
12 }
13 }
14 }
15}

Leia o questionário de um programa 

Cada ComplianceProgram expõe sua currentVersion — o questionário ACTIVE — e as questions dessa versão, em ordem de exibição. Cada pergunta declara seu answerType, se é required, suas options (para tipos de seleção) e uma displayCondition opcional que ramifica o questionário. Leia essa estrutura para renderizar sua própria interface ou para entender exatamente o que um importador deve fornecer.

1query QuestionnaireStructure($filter: ComplianceRequirementFilter!) {
2 complianceRequirements(filter: $filter, first: 1) {
3 edges {
4 node {
5 program {
6 code
7 name
8 currentVersion {
9 version
10 status
11 questions {
12 code
13 prompt
14 helpText
15 answerType
16 required
17 section
18 displayOrder
19 optionsSource
20 options {
21 value
22 label
23 displayOrder
24 }
25 displayCondition {
26 questionCode
27 operator
28 values
29 }
30 }
31 }
32 }
33 }
34 }
35 }
36}

No exemplo acima, contains_color_additives só é exibida quando intended_use é igual a cosmetic — é o displayCondition em ação. Para o modelo completo de ramificação e para as opções dinâmicas (optionsSource), consulte Como funciona.

Próximas etapas 

GraphQL API ReferenceTypes, inputs, and operations used in this guide

Esta página foi útil?