Pular para o conteúdo principal

Criar Proposta E-commerce

POST /proposal/create

HTTP
POST /proposal/create/ecommerce HTTP/1.1
Host: {{url}}
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{token}}

Rota de criação de proposta do tipo e-commerce.

Atributos para criação de proposta

CampoTipoDescriçãoObrigatório
billingCodenumberCódigo do faturamento. Pode ser recuperado na rota de listagem de faturamentos.
productCodenumberCódigo do produto.
customerobjectEste é o objeto referente aos dados do cliente.
fullNamestringNome completo do cliente. Necessário enviar ao menos duas palavras e não permite o envio de números.
cpfstringCPF do cliente, necessário ser um CPF válido.
birthDatestringData de nascimento do cliente, o formato deverá ser AAAA-MM-DD.É necessário enviar uma data válida.
genderstringGenero do cliente, os valores validos são "Masculino" ou "Feminino".
addressobjectEste é o objeto referente aos dados de endereço do cliente.
zipCodestringCep do endereço, o formato deverá ser somente numeros, exemplo: 70150900.
addressstringRua do endereço.
numberstringNumero da residencia do endereço.
neighborhoodstringBairro do endereço.
citystringCidade do endereço.
statestringEstado do endereço, o formato deverá ser a abreviação do estado, exemplo: MG.
complementobjectComplemento do endereço

Requisição

Body
{
"billingCode": 6,
"productCode": 2,
"customer": {
"cpf": "67962845007",
"birthDate": "1990-01-01",
"fullName": "Teste Usuario Ecommerce Postam",
"gender": "Masculino"
},
"address": {
"zipCode": "12345678",
"city": "São Paulo",
"state": "SP",
"address": "Rua completo Ecommerce Postman",
"number": 123,
"neighborhood": "Bairro Teste",
"complement": "Complemento Teste"
}
}

Resposta

201
{
"message": "Proposta ecommerce: VAF440 criada",
"status": "success",
"document": [
{
"id": 440,
"identificador": "VAF440",
"id_jave": null,
"valor": 0,
"cpf_cnpj_parceiro": "00000000000000",
"id_representante": 8,
"id_cliente": 345,
"key_documento": null,
"key_assinatura_requisicao": null,
"reenvios": 0,
"status": "NOVO",
"alterado_por": "teste@teste.com.br",
"alterado_em": "2024-07-29T16:31:59.287Z",
"criado_em": "2024-07-29T16:31:59.287Z",
"cnpj_associacao": null,
"cnpj_federacao": null,
"tipo_envio": "sms",
"reenvio_notificacao": 0,
"fluxo": null,
"codigo_Associado": null,
"id_motivacao": 168,
"id_produto": 2,
"id_gravacao": null,
"id_convite": null,
"assinatura_eletronica": null,
"codigo_faturamento": 6
}
],
"rowsAffected": [
1
]
}

Errors

CódigoReferênciaExplicação
400BAD REQUESTO servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico.
401UNAUTHORIZEDO servidor não autorizou a requisição. Access Token inválido.
403FORBIDDENO servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso.
404NOT FOUNDO servidor não encontrou o recurso ou não está disposto a divulgar sua existência.
422UNPROCESSABLE ENTITYO servidor não conseguiu processar as informações contidas na requisição.