跳到主要内容

供应商登记信息

在填写中(pending_submission)的审核里更新供应商的名称、邮箱和地址。这些信息保存在 analysis_data 中,只有在审核通过后才会写入供应商(vendor.name、vendor.email、vendor.address)。

提交审核时邮箱为必填项。如果创建时已提供邮箱且您不需要地址,可以跳过此调用。

审核结束后(approved、reproved 或 canceled),这些信息不能再修改(409,VRG000010):如需修改,请开启新的审核。银行账户不依赖审核,仍可编辑。

更新登记信息​

适用范围
角色主机所需权限
管理人manager-api写入
顾问consultant-api有效集成

各主机的 Base URL:环境(主机)。

ENDPOINT
/vendor_registry/analysis/{analysis_key}/analysis_data
方法
PUT

路径参数​

参数类型说明
analysis_keystring审核的 key(UUID)。
Corpo da requisição
{
"name": "AUDITORES EXEMPLO S.A.",
"email": "contato@auditoresexemplo.com.br",
"address": {
"postal_code": "01310-100",
"street": "Avenida Paulista",
"number": "1000",
"complement": "10º andar",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"uf": "SP",
"country": "BRA"
}
}

请求体属性​

三个字段均为必填。调用会一次替换全部三个字段:请始终提交完整的一组。

字段类型必填说明
namestring是姓名或公司名称。最多 255 个字符。
emailstring是供应商的邮箱。最多 255 个字符。
addressobject是地址。参见address 属性。

address 属性​

字段类型必填说明
postal_codestring是邮政编码,1 至 20 个字符。当 country = BRA 时,为 NNNNN-NNN 格式的 CEP。
streetstring是街道,1 至 255 个字符。
numberstring是门牌号,1 至 20 个字符。
complementstring否地址补充信息,1 至 255 个字符。
neighborhoodstring是街区,1 至 255 个字符。
citystring是城市,1 至 255 个字符。
ufstring是州,1 至 20 个字符。当 country = BRA 时,为两个字符的州缩写(SP、RJ、DF...)。
countrystring是ISO 3166-1 alpha-3 国家代码(BRA、USA、PRT...)。

响应​

STATUS
200

响应为审核,结构与创建供应商相同,其中 analysis_data 已更新。

Trecho da resposta
{
"analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
"status": "pending_submission",
"analysis_data": {
"name": "AUDITORES EXEMPLO S.A.",
"document_number": "44.555.666/0001-81",
"email": "contato@auditoresexemplo.com.br",
"address": {
"postal_code": "01310-100",
"street": "Avenida Paulista",
"number": "1000",
"complement": "10º andar",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"uf": "SP",
"country": "BRA"
},
"ai_pending_reasons": null,
"ai_pending_reason_details": null
}
}

错误​

STATUS
409
登记正在 QI Tech 审核中

审核处于 sent_to_analysis、in_manual_analysis 或 in_compliance_analysis。如需修改,请将审核撤出队列或等待审核结果。

{
"title": "Vendor Registration Under Analysis",
"description": "The registration of the vendor 5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57 is under analysis by QI Tech and cannot be changed until the analysis ends.",
"translation": "O cadastro deste fornecedor esta em analise pela QI Tech e nao pode ser alterado ate a analise terminar.",
"code": "VRG000104"
}
审核已结束

审核处于 approved、reproved 或 canceled。请开启新的审核,并在其中更新信息。

{
"title": "Completed Analysis",
"description": "Analysis with key 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 is already completed, it can't be updated.",
"translation": "Analise com chave 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 esta finalizada, nao pode ser atualizada.",
"code": "VRG000010"
}
STATUS
400
国家无效

country 不是 ISO 3166-1 alpha-3 代码(例如 BRA)。

{
"title": "Invalid Address Country",
"description": "Address country 'BR' must be a valid ISO 3166-1 alpha-3 country code.",
"translation": "O pais 'BR' do endereco deve ser um codigo de pais ISO 3166-1 alpha-3 valido.",
"code": "VRG000088"
}
巴西地址的州(UF)无效

当 country 为 BRA 时,uf 不是巴西联邦单位的缩写。

{
"title": "Invalid Brazilian Address Uf",
"description": "Address uf 'XX' must be a valid Brazilian federative unit code when country is BRA.",
"translation": "A UF 'XX' do endereco deve ser uma unidade federativa brasileira valida quando o pais e BRA.",
"code": "VRG000056"
}
巴西地址的 CEP 无效

当 country 为 BRA 时,postal_code 不符合 NNNNN-NNN 格式。

{
"title": "Invalid Brazilian Address Postal Code",
"description": "Address postal_code '01310100' must match the 'NNNNN-NNN' CEP format when country is BRA.",
"translation": "O CEP '01310100' do endereco deve seguir o formato 'NNNNN-NNN' quando o pais e BRA.",
"code": "VRG000057"
}
STATUS
404
未找到审核

该 analysis_key 不存在。如果审核属于您看不到的供应商,错误码为 VRG000014(参见通用错误)。

{
"title": "Analysis not found",
"description": "Analysis with the key 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 was not found.",
"translation": "A analise com a chave 8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13 nao foi encontrada.",
"code": "VRG000007"
}

认证、权限和主机相关的错误:参见 API 错误。

下一步​