Wiki source code of Pedidos - Enviar um Pedido

Last modified by WBS Tecnologia on 2021/10/22 20:49

version	line-number	content
1.1	1	(% class="jumbotron" %)
	2	(((
	3	(% class="container" %)
	4	(((
10.1	5	= Inserir um Pedido na Plataforma =
	6
	7	Neste Método vamos descrever como Inserir um Pedido na Plataforma.
1.1	8	)))
	9	)))
	10
	11	(% class="row" %)
	12	(((
	13	(% class="col-xs-12 col-sm-8" %)
	14	(((
	15	= Detalhes da Rota =
	16
	17	(% class="box infomessage" %)
	18	(((
10.1	19	Rota:/BDIApi/Pedido/Salvar
1.1	20	)))
	21
10.1	22	* Parâmetros:
1.1	23	* Requer Autenticação: Sim
10.1	24	* Método: POST
	25	* Tipo de Retorno: Void \| Pedido
2.1	26	* Headers:
	27	** API_TOKEN: Token de Autenticação
10.1	28	* Corpo/Payload
	29	** JSON do Pedido
1.1	30
	31	== Códigos de Status ==
	32
2.1	33	* 404 = Sem resultados
1.1	34	* 500 = Erro Interno do Servidor
	35	* 200 = OK
	36	* 403 = Acesso Negado, Token de Autenticação Inválido?
	37
	38	= Detalhes da Ação =
	39
10.1	40	Insere um Pedido na Plataforma
1.1	41
2.1	42	=== (% style="font-size:26px" %)Headers(%%) ===
1.1	43
	44	Abaixo segue os headers que devem ou podem ser passados para a ação:
	45
	46	\|=Header\|=Descrição / Validação\|=Valor Padrão
2.1	47	\|API_TOKEN\|[Obrigatório] Token da Autenticação\|
1.1	48
10.1	49	== (% style="font-size:29px" %)Corpo(%%) ==
1.1	50
10.1	51	Este é o Payload do corpo, este JSON representa o pedido a ser inserido na plataforma:
1.1	52
	53	{{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
7.1	54	{
10.1	55	"Cabecalho": {
	56	"Codigo": 13555,
	57	"CriadoEm": "2020-12-19T13:25",
	58	"ValorDoFrete": 5.00,
	59	"TipoDeFrete": 1,
	60	"ValorTotal": 215.00,
	61	"Situacao": 0,
	62	"TipoDeConsumidor": 1,
11.1	63	"TipoDeImportacao": 0,
10.1	64	"Classificacao": "testes",
	65	"Observacoes": "Teste de Observação",
	66	"ValorDeDesconto": 0,
	67	"TipoDeEnvio": 100
	68	},
	69	"Itens": [
	70	{
	71	"Quantidade": 10,
	72	"ValorUnitario": 21.00,
	73	"Desconto": 0,
	74	"CodigoDeBarras": "9788522480432"
	75	}
	76	],
	77	"Faturas": [
	78	{
	79	"NumeroDeParcelas": 1,
	80	"Valor": 215.00,
	81	"AprovadoEm": "2020-12-19T13:35",
	82	"NSU": "TESTE",
	83	"Autorizacao": "0983aisadafs90",
	84	"Resumo": "Teste de Fatura",
	85	"NumeroDoCartao": "XXXXXXXXXXXX5423",
	86	"FormaDePagamentoId": 17
	87	}
	88	],
	89	"EnderecoDeCobranca": {
15.1	90	"RegTributario" : 0,
10.1	91	"Nome": "Marcelo Junior",
	92	"Apelido": "Marcelo Junior",
	93	"Email": "teste@wbstecn.com.br",
	94	"CnpjCpf": "12345678900",
	95	"RgIE": "123456780",
	96	"Tipo": 1,
	97	"Bairro" : "Jd. Nova IP",
	98	"CEP" : "13000056",
	99	"Cidade" : "Minha Cidade",
	100	"Complemento" : "",
	101	"Destinatario" : "Marcelo Junior",
	102	"LinhaDeEndereco" : "Rua dos Opalas",
	103	"Pais" :"Brasil",
	104	"TelefoneFixo" : "19998885664",
	105	"UF" : "SP"
	106	},
	107	"EnderecoDeEntrega": {
15.1	108	"RegTributario" : 0,
10.1	109	"Nome": "Marcelo Junior",
	110	"Apelido": "Marcelo Junior",
	111	"Email": "teste@wbstecn.com.br",
	112	"CnpjCpf": "12345678900",
	113	"RgIE": "123456780",
	114	"Tipo": 1,
	115	"Bairro" : "Jd. Nova IP",
	116	"CEP" : "13000056",
	117	"Cidade" : "Minha Cidade",
	118	"Complemento" : "",
	119	"Destinatario" : "Marcelo Junior",
	120	"LinhaDeEndereco" : "Rua dos Opalas",
	121	"Pais" :"Brasil",
	122	"TelefoneFixo" : "19998885664",
	123	"UF" : "SP"
	124	}
7.1	125	}
1.1	126	{{/code}}
10.1	127
	128	== Campos Obrigatórios e Validações: ==
	129
	130	\|Nome\|Descrição
	131	\|EnderecoDeCobranca\|O Pedido deve ter pelo menos o endereço de Cobrança.
16.1	132	\|EnderecoDeCobranca.Complemento\|Não deve conter mais de 50 caracteres.
15.1	133	\|EnderecoDeCobranca.LinhaDeEndereco\|Não deve conter mais de 100 caracteres.
10.1	134	\|EnderecoDeCobranca.Nome\|Não deve conter mais de 50 caracteres
	135	\|EnderecoDeCobranca.Apelido\|Não deve conter mais de 50 caracteres
12.1	136	\|EnderecoDeCobranca.Tipo\|(((
	137	* 1 - Para pessoa física (PF);
	138	* 2- Para pessoa jurídica (PJ).
	139	)))
14.1	140	\|EnderecoDeCobranca.RegTributario\|(((
	141	* 1 - Simples Nacional;
	142	* 2 - Simples Nacional-excesso de sublimite da receita bruta;
	143	* 3 - Regime Normal (Essa informação é para a emissão da Nota Fiscal. Para pessoa física gravar 0 e para pessoa jurídica informar, se possível, o regime tributário correto. Caso essa informação esteja indisponível, gravar 3)
	144	)))
	145	\|EnderecoDeEntrega\|Se informado respeita as mesmas regras do Endereço de Cobrança, se não informado o Endereço de Cobrança será utilizado no lugar.
	146	\| \|
10.1	147	\|Itens[*].ProdutoId\|Deve ser informado, caso o código de barras não for informado.
	148	\|Itens[*].CodigoDeBarras\|Deve ser informado, caso o Id do produto não for informado.
	149	\|Itens[*].ValorUnitario\|Deve ser maior que 0
	150	\|Itens[*].Quantidade\|Deve ser maior que 0
14.1	151	\|Itens[*].Desconto\|Deve ser maior ou igual há 0
10.1	152	\| \|
	153	\|Cabecalho.Codigo\|Não pode estar em branco
	154	\|Cabecalho.CriadoEm\|Obrigatório informar
	155	\|Cabecalho.ValorDoFrete\|Tem que ser 0 ou maior.
	156	\|Cabecalho.ValorTotal\|Tem que ser 0 ou maior
	157	\|Cabecalho.TipoDeFrete\|Tem que ser informado corretamente!
	158	\|Cabecalho.TipoDeEnvio\|Tem que ser informado o ID recuperado pela API de Tipos de Envio.
14.1	159	\|Cabecalho.TipoDeImportacao\|0 - Importar e Reservar (Todos os pedidos serão importados, independentemente da confirmação de pagamento do cliente por parte do EC. Nessa situação, os produtos ficarão como Reservados para atender esse pedido, aguardando o EC mudar o status para 1); 1 - Importar e/ou Liberar (Serão importados apenas os pedidos que estão com pagamento do cliente confirmado por parte do EC. Nessa situação, os produtos ficarão com a situação de Liberados para atender o pedido); 2 - Cancelar (Após o pedido ter sido importado, ele será cancelado se o EC colocar a situação como 2, desde que não tenha sido emitida nota fiscal).
13.1	160	\|Para mais campos \|[[Consulte>>doc:Web Rest API.BDI API.Pedidos.WebHome]]
10.1	161
	162
1.1	163	)))
	164
	165
	166	(% class="col-xs-12 col-sm-4" %)
	167	(((
	168	{{box title="Índice"}}
	169	{{toc/}}
	170	{{/box}}
	171
	172	{{box}}
	173	Exemplos
	174
	175	* Exemplo de Payload: BAIXAR
	176	* Exemplo de Resultado: BAIXAR
	177	{{/box}}
	178	)))
	179	)))