发现适用的计划
传递商品的 hsCode 和 shipToCountry 来查找适用的计划。结果是 ComplianceRequirement 节点的分页连接,每个节点指向它触发的 ComplianceProgram。
1
query ComplianceRequirements($filter: ComplianceRequirementFilter!) {2
complianceRequirements(filter: $filter, first: 10) {3
totalCount4
pageInfo {5
hasNextPage6
endCursor7
}8
edges {9
cursor10
node {11
id12
hsCode13
shipToCountry14
shipFromCountry15
program {16
id17
code18
name19
programType20
authority21
jurisdiction22
status23
strictness24
currentVersion {25
id26
version27
status28
}29
}30
}31
}32
}33
}一个需求上的 shipFromCountry 值为 null 意味着该计划适用于任何来源。当您在筛选器中提供 shipFromCountry 时,原产地特定的行和"任何来源"行都会被匹配。
筛选和分页
complianceRequirements 接受 ComplianceRequirementFilter 加上标准游标分页参数(first / after 用于向前分页,last / before 用于向后分页)。
| 筛选字段↕ | 类型↕ | 说明↕ |
|---|---|---|
hsCode | String | 精确 HS 编码匹配。与 hsCodePrefix 互斥。 |
hsCodePrefix | String | 前缀匹配(仅数字和点,最多 12 个字符)。与 hsCode 互斥。 |
shipToCountry | CountryCode | 目的地国家/地区。 |
shipFromCountry | CountryCode | 原产地国家/地区。具有 null 来源("任何来源")的行也会匹配。 |
programTypes | [ComplianceProgramType!] | 仅匹配这些计划类型。空列表 = 无筛选。 |
例如,列出化妆品章 3304 的每个 PGA 要求:
1
query PgaRequirements($filter: ComplianceRequirementFilter!) {2
complianceRequirements(filter: $filter, first: 25) {3
totalCount4
edges {5
node {6
hsCode7
shipToCountry8
program {9
code10
name11
}12
}13
}14
}15
}读取计划的问卷
每个 ComplianceProgram 都公开其 currentVersion——ACTIVE 问卷——以及该版本按显示顺序排列的 questions。每个问题都声明其 answerType、是否 required、其 options(针对选择类型),以及一个可选的 displayCondition 来分支问卷。读取此结构来渲染您自己的 UI 或确切了解进口商必须提供的内容。
1
query QuestionnaireStructure($filter: ComplianceRequirementFilter!) {2
complianceRequirements(filter: $filter, first: 1) {3
edges {4
node {5
program {6
code7
name8
currentVersion {9
version10
status11
questions {12
code13
prompt14
helpText15
answerType16
required17
section18
displayOrder19
optionsSource20
options {21
value22
label23
displayOrder24
}25
displayCondition {26
questionCode27
operator28
values29
}30
}31
}32
}33
}34
}35
}36
}在上面的示例中,contains_color_additives 仅在 intended_use 等于 cosmetic 时显示——这就是 displayCondition 的作用。有关完整的分支模型和动态(optionsSource)选项,请参见 它的工作原理。
GraphQL API ReferenceTypes, inputs, and operations used in this guide
检查合规要求
发现适用于某个商品的合规计划,并读取您需要回答的问卷。
GraphQL
complianceRequirements查询是 Zonos Clarify 的入口点。根据商品的 HS 编码和路线,它返回触发的合规计划,并让您遍历每个计划的完整问卷结构——问题、选项和分支逻辑。使用它来确定货运是否需要合规答案,以及渲染您自己的问卷用户界面。此查询需要
COMPLIANCE_READ作用域。有关验证 API 请求,请参见 OAuth。