- Criado por Alexandre Claudino ontem às 6:02 PM
POST /customers
Descrição
O endpoint POST /customers
é utilizado para incluir novos registros na tabela CLIENTES_VAREJO
. Este serviço permite cadastrar informações detalhadas de novos clientes.
Parâmetros
Este endpoint não requer parâmetros na URL.
Corpo da Requisição
O corpo da requisição deve ser enviado no formato JSON e deve conter os seguintes campos:
{ "RgIe": "string", "CustomerType": "string", "CustomerName": "string", "CpfCnpj": "string", "Country": "string", "ZipCode": "string", "Neighbourhood": "string", "City": "string", "AdditionalAddress": "string", "Number": "string", "Street": "string", "State": "string", "IsIndividual": true, "Gender": "string", "Telephone": "string", "TelephoneDistrictNumber": "string", "Email": "string", "NickName": "string", "DateOfBirth": "2024-07-22T13:14:48.344Z", "Contact": { "Company": "string", "CompanyName": "string", "ContactAddresses": [ { "AddressDescription": "string", "Country": "string", "ZipCode": "string", "City": "string", "Neighbourhood": "string", "State": "string", "Number": "string", "Street": "string", "AdditionalAddress": "string", "IsMainAddress": true } ] } }
Descrição dos Campos
- RgIe: RG ou IE do cliente.
- CustomerType: Tipo de cliente.
- CustomerName: Nome do cliente.
- CpfCnpj: CPF ou CNPJ do cliente.
- Country: País.
- ZipCode: CEP.
- Neighbourhood: Bairro.
- City: Cidade.
- AdditionalAddress: Complemento do endereço.
- Number: Número do endereço.
- Street: Rua.
- State: Estado.
- IsIndividual: Indica se o cliente é pessoa física (true/false).
- Gender: Gênero.
- Telephone: Telefone.
- TelephoneDistrictNumber: DDD do telefone.
- Email: Email.
- NickName: Apelido.
- DateOfBirth: Data de nascimento.
- Contact: Informações de contato, que incluem:
- Company: Empresa.
- CompanyName: Nome da empresa.
- ContactAddresses: Lista de endereços de contato, contendo:
- AddressDescription: Descrição do endereço.
- Country: País.
- ZipCode: CEP.
- City: Cidade.
- Neighbourhood: Bairro.
- State: Estado.
- Number: Número do endereço.
- Street: Rua.
- AdditionalAddress: Complemento do endereço.
- IsMainAddress: Indica se é o endereço principal (true/false).
Respostas
Sucesso (200)
{ "backOfficeId": "string" }
Essa resposta indica que a inclusão do registro foi bem-sucedida e retorna o backOfficeId
do cliente recém-criado.
Não autorizado (401)
Indica que a requisição não foi autorizada. Certifique-se de que você possui as credenciais adequadas para acessar este endpoint.
Erro Interno (500)
{ "erro": "string", "stackTrace": "string" }
Indica que ocorreu um erro interno no servidor durante o processamento da requisição. O campo erro
fornece uma descrição do erro, e stackTrace
pode conter informações adicionais para diagnóstico.
GET /customers/{email}
Descrição
O endpoint GET /customers/{email}
é utilizado para pesquisar informações de um cliente com base no seu endereço de e-mail. Este serviço retorna os dados completos do cliente correspondente ao e-mail fornecido.
Parâmetros
Parâmetros na URL
- email (obrigatório): Endereço de e-mail do cliente.
Respostas
Sucesso (200)
[ { "CustomerName": "string", "CpfCnpj": "string", "Email": "string", "CustomerId": "string", "CustomerType": "string", "ContactId": "string", "BranchId": "string", "RgIe": "string", "Country": "string", "ZipCode": "string", "Neighbourhood": "string", "City": "string", "AdditionalAddress": "string", "Number": "string", "Street": "string", "State": "string", "IsIndividual": true, "RegisterDate": "2024-07-22T13:20:43.909Z", "DateOfBirth": "2024-07-22T13:20:43.909Z", "Gender": "string", "Telephone": "string", "TelephoneDistrictNumber": "string", "Mobile": "string", "MobileDistrictNumber": "string", "StreetType": "string", "NickName": "string", "HasNewsletter": "string", "HasNoCredit": true, "HasSPCRegister": true, "IsBlockedOnB2C": true, "FaxNumber": "string", "CreditLimit": 0, "TotalCreditLimit": 0, "Observation": "string", "Status": 0, "HasNoCheckAnalysis": true, "MaritalStatus": 0, "Profession": "string", "CustomerExecutionStatus": 0, "UpdateDate": "2024-07-22T13:20:43.909Z", "BillingAddressId": 0, "Branch": { "BranchId": "string", "BranchCode": "string" }, "Contact": { "ContactId": "string", "ContactName": "string", "Email": "string", "Company": "string", "IsIndividual": true, "CpfCnpj": "string", "Gender": "string", "DateOfBirth": "2024-07-22T13:20:43.909Z", "IsRetailCustomer": true, "RegisterDate": "2024-07-22T13:20:43.909Z", "CompanyName": "string", "IsSystemUser": true, "IsThirdPartyCustomer": true, "IntegratesEmail": true, "IntegratesEmailWithCrm": true, "ExchangeWorkflow": true, "ExchangeCrm": true, "Telephone": "string", "Address": "string", "TelephoneInternationalDistrictNumber": "string", "TelephoneDistrictNumber": "string", "ZipCode": "string", "City": "string", "ContactAddresses": [ { "AddressId": 0, "AddressDescription": "string", "Country": "string", "ZipCode": "string", "Neighbourhood": "string", "City": "string", "AdditionalAddress": "string", "Number": "string", "Street": "string", "State": "string", "IsMainAddress": true, "ContactId": "string", "IsBillingAddress": true } ] } } ]
Essa resposta indica que a pesquisa foi bem-sucedida e retorna os dados completos do cliente correspondente ao e-mail fornecido.
Não autorizado (401)
Indica que a requisição não foi autorizada. Certifique-se de que você possui as credenciais adequadas para acessar este endpoint.
Erro Interno (500)
{ "erro": "string", "stackTrace": "string" }
Indica que ocorreu um erro interno no servidor durante o processamento da requisição. O campo erro
fornece uma descrição do erro, e stackTrace
pode conter informações adicionais para diagnóstico.
GET /customers/transferDate/{date}
Descrição
O endpoint GET /customers/transferDate/{date}
é utilizado para pesquisar registros de clientes com base na data de alteração (data_para_transferencia). Este serviço retorna uma lista de clientes que foram alterados na data especificada.
Parâmetros
Parâmetros na URL
- date (obrigatório): Data de alteração dos registros, no formato
string($date-time)
.
Parâmetros de Query
- page_size (opcional): Quantidade de registros por página. Tipo:
integer
. - current_page (opcional): Página corrente. Tipo:
integer
.
Respostas
Sucesso (200)
{ "Pagination": { "TotalCount": 0, "PageSize": 0, "CurrentPage": 0 }, "Items": [ { "CustomerName": "string", "CpfCnpj": "string", "Email": "string", "CustomerId": "string", "CustomerType": "string", "ContactId": "string", "BranchId": "string", "RgIe": "string", "Country": "string", "ZipCode": "string", "Neighbourhood": "string", "City": "string", "AdditionalAddress": "string", "Number": "string", "Street": "string", "State": "string", "IsIndividual": true, "RegisterDate": "2024-07-22T13:41:28.032Z", "DateOfBirth": "2024-07-22T13:41:28.032Z", "Gender": "string", "Telephone": "string", "TelephoneDistrictNumber": "string", "Mobile": "string", "MobileDistrictNumber": "string", "StreetType": "string", "NickName": "string", "HasNewsletter": "string", "HasNoCredit": true, "HasSPCRegister": true, "IsBlockedOnB2C": true, "FaxNumber": "string", "CreditLimit": 0, "TotalCreditLimit": 0, "Observation": "string", "Status": 0, "HasNoCheckAnalysis": true, "MaritalStatus": 0, "Profession": "string", "CustomerExecutionStatus": 0, "UpdateDate": "2024-07-22T13:41:28.032Z", "BillingAddressId": 0, "Branch": { "BranchId": "string", "BranchCode": "string" }, "Contact": { "ContactId": "string", "ContactName": "string", "Email": "string", "Company": "string", "IsIndividual": true, "CpfCnpj": "string", "Gender": "string", "DateOfBirth": "2024-07-22T13:41:28.032Z", "IsRetailCustomer": true, "RegisterDate": "2024-07-22T13:41:28.032Z", "CompanyName": "string", "IsSystemUser": true, "IsThirdPartyCustomer": true, "IntegratesEmail": true, "IntegratesEmailWithCrm": true, "ExchangeWorkflow": true, "ExchangeCrm": true, "Telephone": "string", "Address": "string", "TelephoneInternationalDistrictNumber": "string", "TelephoneDistrictNumber": "string", "ZipCode": "string", "City": "string", "ContactAddresses": [ { "AddressId": 0, "AddressDescription": "string", "Country": "string", "ZipCode": "string", "Neighbourhood": "string", "City": "string", "AdditionalAddress": "string", "Number": "string", "Street": "string", "State": "string", "IsMainAddress": true, "ContactId": "string", "IsBillingAddress": true } ] } } ] }
Essa resposta indica que a pesquisa foi bem-sucedida e retorna uma lista de clientes alterados na data especificada, juntamente com informações paginadas.
Requisição Mal formada (400)
Indica que a requisição está mal formada. Certifique-se de que todos os parâmetros obrigatórios foram incluídos corretamente.
{ "erro": "string", "stackTrace": "string" }
Não autorizado (401)
Indica que a requisição não foi autorizada. Certifique-se de que você possui as credenciais adequadas para acessar este endpoint.
Erro Interno (500)
{ "erro": "string", "stackTrace": "string" }
Indica que ocorreu um erro interno no servidor durante o processamento da requisição.json. O campo erro
fornece uma descrição do erro, e stackTrace
pode conter informações adicionais para diagnóstico.
Exemplo do Swagger: