Endereço
Seu guia para a integração V5!
O ponto de extremidade de importação 'Endereço' pode ser usado para adicionar endereços de fornecedores e clientes, que podem então ser usados para Remessa e receber. Os endereços também podem ser adicionados como 'endereços de sites' que são usados para Transferências.
Guias de integração vinculados:
Este guia se concentrará em como usar esse ponto de extremidade 'Endereço', tanto por meio da importação de CSV quanto usando JSON por meio da API V5.
Conteúdo
1. Layout do Centro de Controle
Em termos de como podemos relacionar o endpoint de endereço com o que vemos no V5 Control Center, veremos a tabela 'Customer' aqui. A tabela 'Supplier' funcionaria exatamente da mesma forma, já que tanto fornecedores quanto clientes compartilham o mesmo endpoint 'Client'.
2. Links API
Para saber mais sobre as definições desta classe de banco de dados 'Endereço', consulte o seguinte link:
3. Guia de campo de endereço
3.1. Chaves primárias
Para importar por meio do ponto de extremidade 'Endereço', a chave primária é:
Nome - O nome exclusivo para este endereço
3.2. Os campos obrigatórios
Outros campos necessários para criar uma entrada válida no V5:
Formato – o tipo de endereço, que deve ser 0 para uso com Clientes e 1 para uso como endereço de site para Transferências (modlink).
Código_do_cliente – Se adicionar um endereço de cliente, isso será necessário para vincular ao cliente/fornecedor.
3.3. Campos Adicionais
Line1 - A primeira linha do endereço.
Line2 - A segunda linha do endereço.
Line3 - A terceira linha do endereço.
Cidade – A cidade onde o endereço está localizado.
Estado – O estado em que o endereço está localizado.
País – O país em que o endereço está localizado.
Zip – O código postal do endereço.
Contato – Um nome de contato para o endereço.
Tel – Número de telefone associado ao endereço.
E-mail – Endereço de e-mail associado ao endereço.
Endereços de entrega (se diferentes do endereço inserido usando os detalhes acima) e contatos/detalhes de recall de emergência também podem ser adicionados aqui, mas usaremos apenas os pontos de dados acima em nosso exemplo.
4. Conjunto de dados de exemplo
Para esta peça, procuraremos adicionar um endereço ao cliente mostrado no painel CC acima. Este cliente foi adicionado ao sistema anteriormente usando o 'Clientes' ponto final.
5. Metodologia
5.1. JSON – Importar
'Endereço' importar Endpoint/URI –
http://host:port/V5-API/api/integrate/import/address
amostras:
Usando o endpoint 'Address', podemos estruturar um arquivo de importação para as adições acima assim:
Este arquivo JSON de amostra pode ser baixado aqui..
Depois de publicar isso no sistema, podemos ver que este endereço foi adicionado ao cliente 'CUS01':
5.2. CSV - Importar
Como clientes/fornecedores podem ter vários endereços atribuídos a eles, vamos simplesmente adicionar outro endereço ao cliente 'CUS01' que adicionamos no exemplo JSON acima.
Para importações de CSV, primeiro precisamos construir um arquivo de cabeçalho para nossas importações.
Nome do arquivo de definição de cabeçalho/coluna: “endereço.csvh”
Os arquivos de cabeçalho completos devem ser colocados em: “ \SG Control Center\gateway\import\column_defs”
Nome do arquivo CSV de importação: “endereço-datahora.csv”
Os CSVs para importação devem ser colocados em: “ \SG Control Center\gateway\importar”
amostras:
Arquivo de cabeçalho:
Um arquivo de cabeçalho de exemplo pode ser visto abaixo. Usaremos os mesmos campos que usamos para a importação JSON.
Para mais informações sobre como estruturamos esses arquivos, consulte o página principal de integração. Este arquivo de cabeçalho de amostra pode ser baixado aqui..
Arquivo de importação CSV:
Podemos então usar a ordem definida de pontos de dados no cabeçalho para estruturar nosso arquivo de importação. Observe que essa primeira linha pode ser ignorada pelo Control Center e, portanto, pode ser mantida no arquivo ao enviar para importação. Um exemplo de importação com base em nossos requisitos acima ficaria assim:
Este arquivo de importação de amostra pode ser baixado aqui..
Podemos então soltar esse arquivo em nossa pasta de importação, conforme definido acima, e quando a importação estiver concluída, poderemos ver que esse endereço foi adicionado ao mesmo cliente.
