Wiki source code of Pedidos
Version 5.1 by WBS Tecnologia on 2021/01/14 16:58
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | (% class="jumbotron" %) | ||
2 | ((( | ||
3 | (% class="container" %) | ||
4 | ((( | ||
5 | = Catálogo de Produtos = | ||
6 | |||
7 | Abaixo detalhes sobre os campos e informações de produtos | ||
8 | ))) | ||
9 | ))) | ||
10 | |||
11 | (% class="row" %) | ||
12 | ((( | ||
13 | (% class="col-xs-12 col-sm-8" %) | ||
14 | ((( | ||
15 | = Pedido = | ||
16 | |||
17 | |=Nome|=Descrição | ||
18 | |Cabecalho|((( | ||
19 | Cabeçalho do Pedido | ||
20 | ))) | ||
21 | |EnderecoDeCobranca|((( | ||
22 | Endereço de Cobrança | ||
23 | ))) | ||
24 | |EnderecoDeEntrega|((( | ||
25 | Endereço de Entrega | ||
26 | ))) | ||
27 | |Faturas|((( | ||
28 | Faturas vinculadas ao pedido | ||
29 | ))) | ||
30 | |Itens|((( | ||
31 | Itens do Pedido | ||
32 | ))) | ||
33 | |||
34 | = Cabecalho = | ||
35 | |||
36 | |=Nome|=Descrição | ||
37 | |AtualizadoEm|((( | ||
38 | Quando o pedido foi Atualizado | ||
39 | ))) | ||
40 | |ChaveERP|((( | ||
41 | Chave de importação. Para uso interno do Winbooks. | ||
42 | ))) | ||
43 | |ChaveNFE|((( | ||
44 | Utilizado para gravar o número da chave da NF-e ou NFC-e emitida. | ||
45 | ))) | ||
46 | |Classificacao|((( | ||
47 | Campo livre para ser utilizado como classificação da origem da venda. Normalmente é usado quando a Editora tem mais de um selo. (Essa informação será é de interesse do usuário do sistema). | ||
48 | ))) | ||
49 | |Codigo|((( | ||
50 | Código do Pedido do B2C/B2B deve ser preenchido pelo Integrador | ||
51 | ))) | ||
52 | |CriadoEm|((( | ||
53 | Quando esse pedido foi criado no site | ||
54 | ))) | ||
55 | |EmpresaId| | ||
56 | |ExpedidoEm|((( | ||
57 | Quando o pacote foi expedido | ||
58 | ))) | ||
59 | |Id|((( | ||
60 | Numero do Pedido na Plataforma API | ||
61 | ))) | ||
62 | |Observacoes|((( | ||
63 | Utilizado para inserir observações de texto livre, para serem importadas. (Essas informações devem ser aquelas de interesse do usuário do Winbooks. Portanto, não serão informadas da Nota Fiscal emitida). | ||
64 | ))) | ||
65 | |Rastreio|((( | ||
66 | Após a expedição, se existir número de protocolo ou de código de rastreio registrado, este número será gravado nesse campo. | ||
67 | ))) | ||
68 | |Situacao|((( | ||
69 | Situação do Pedido | ||
70 | |||
71 | * 0 - Reservado | ||
72 | * 1,2 - Processando | ||
73 | * 3 - Aguardando Pagamento | ||
74 | * 4 - Em Separação | ||
75 | * 5 - Faturado | ||
76 | * 6 - Expedido | ||
77 | ))) | ||
78 | |TipoDeConsumidor|((( | ||
79 | * 0 - Para pessoa física ou pessoa jurídica que comprar para Consumidor Final, ou seja, não vai revender os produtos; | ||
80 | * 1 - Para pessoa jurídica que vai revender os produtos. | ||
81 | ))) | ||
82 | |TipoDeEnvio|((( | ||
83 | Tipo de Envio Consulte a API de Tipo de Envio para listar todos os tipos de envio disponivéis. | ||
84 | ))) | ||
85 | |TipoDeFrete|((( | ||
86 | Tipo de Frete | ||
87 | |||
88 | * 0 - Contratação do Frete por conta do Remetente (CIF); | ||
89 | * 1 - Contratação do Frete por conta do Destinatário (FOB); | ||
90 | * 2 - Contratação do Frete por conta de Terceiros; | ||
91 | * 3 - Transporte Próprio por conta do Remetente; | ||
92 | * 4 - Transporte Próprio por conta do Destinatário; | ||
93 | * 9 - Sem cobrança de frete. | ||
94 | ))) | ||
95 | |TipoDeImportacao|((( | ||
96 | Tipo de Importação do Pedido Status do pedido para importação para o Winbooks: | ||
97 | |||
98 | * 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); | ||
99 | * 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); | ||
100 | * 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). | ||
101 | ))) | ||
102 | |UsarEmbalagemPresente|((( | ||
103 | * 1 - O pedido deve ser embrulhado para presente; | ||
104 | * 2 - O pedido NÃO deve ser embrulhado para presente. | ||
105 | ))) | ||
106 | |ValorDeDesconto|((( | ||
107 | Utilizado para inserir valor de desconto em reais. | ||
108 | |||
109 | Esse valor será rateado proporcionalmente ao itens, seguindo o layout da NF-e. | ||
110 | |||
111 | Ex.: R$ 10,00 para um pedido com 2 produtos = R$ 5,00 de desconto para cada item. | ||
112 | ))) | ||
113 | |ValorDoFrete|((( | ||
114 | Valor do Frete do Pedido | ||
115 | ))) | ||
116 | |ValorTotal|((( | ||
117 | Total do Pedido: (Valor dos Itens - Desconto) + Frete | ||
118 | ))) | ||
119 | |||
120 | = Endereco = | ||
121 | |||
122 | |=Nome|=Descrição | ||
123 | |Apelido|((( | ||
124 | Nome fantasia ou apelido. | ||
125 | ))) | ||
126 | |AtualizadoEm|((( | ||
127 | Quando o endereço foi atualizado | ||
128 | ))) | ||
129 | |Bairro|((( | ||
130 | Bairro | ||
131 | ))) | ||
132 | |CEP|((( | ||
133 | Cep (não informar caracteres especiais: ponto, traços, etc. Separar os últimos três dígitos com espaço). | ||
134 | |||
135 | Ex.: 13050 544. | ||
136 | ))) | ||
137 | |Cidade|((( | ||
138 | Cidade | ||
139 | ))) | ||
140 | |CnpjCpf|((( | ||
141 | Número do CPF com 11 dígitos ou CNPJ com 14 dígitos (não informar caracteres especiais: ponto, traços, etc.). | ||
142 | |||
143 | Ex.: CPF = 99999999999 | ||
144 | |||
145 | CNPJ = 99999999999999). | ||
146 | ))) | ||
147 | |Complemento|((( | ||
148 | Complemento do endereço. | ||
149 | ))) | ||
150 | |Destinatario|((( | ||
151 | Nome para entrega do pedido quando for diferente do nome do cliente. | ||
152 | ))) | ||
153 | |Email|((( | ||
154 | eMail (caso tenha mais de um e-mail, informar separado por ";".) | ||
155 | ))) | ||
156 | |LinhaDeEndereco|((( | ||
157 | Endereço (logradouro e nº separados por ","). Ex.: Rua Pedreira, 595. | ||
158 | ))) | ||
159 | |Nome|((( | ||
160 | Nome do cliente. | ||
161 | ))) | ||
162 | |Pais|((( | ||
163 | País | ||
164 | ))) | ||
165 | |Profissao|((( | ||
166 | Profissão do cliente ou pessoa que receberá o pedido. | ||
167 | ))) | ||
168 | |RegTributario|((( | ||
169 | Regime Tributário do Cliente: | ||
170 | |||
171 | * 1 - Simples Nacional; | ||
172 | * 2 - Simples Nacional-excesso de sublimite da receita bruta; | ||
173 | * 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). | ||
174 | ))) | ||
175 | |RgIE|((( | ||
176 | Número da Inscrição Estadual ou RG (não informar caracteres especiais: ponto, traços, etc.). | ||
177 | |||
178 | Se o cliente for PJ e não possuir Inscrição Estadual, informar "ISENTO". Se o cliente for PF, esse campo não é obrigatório. | ||
179 | ))) | ||
180 | |TelefoneFixo|((( | ||
181 | Telefone Fixo: DDD + Número (separar os blocos de dígitos com espaço. O DDD deve ter três dígitos). | ||
182 | |||
183 | Ex.: 019 3227 1198. | ||
184 | ))) | ||
185 | |TelefoneMovel|((( | ||
186 | Telefone Celular: DDD + Número (separar os blocos de dígitos com espaço. O DDD deve ter três dígitos). | ||
187 | |||
188 | Ex.: 019 99431 7762 ou 031 8531 3685. | ||
189 | ))) | ||
190 | |Tipo|((( | ||
191 | * 1 - Para pessoa física (PF); | ||
192 | * 2- Para pessoa jurídica (PJ). | ||
193 | ))) | ||
194 | |UF|((( | ||
195 | Estado (Sigla) | ||
196 | ))) | ||
197 | |||
198 | = Fatura = | ||
199 | |||
200 | |=Descrição | ||
201 | |((( | ||
202 | Data de aprovação ou recebimento, constatado pelo EC. Ex.: data da confirmação da aprovação da compra pela administradora do cartão de crédito do cliente. | ||
203 | ))) | ||
204 | |((( | ||
205 | Quando foi atualizado | ||
206 | ))) | ||
207 | |((( | ||
208 | Para Cartões - Código de autorização da transação. Este número não é único e pode se repetir. Para efeito de conciliação deverá ser combinado com outras chaves como o NSU, data e valor da venda, número do cartão, meio de captura e número lógico do terminal. | ||
209 | ))) | ||
210 | |((( | ||
211 | Para Boletos - Nosso Número, quando for Boleto emitido pelo site/aplicativo. | ||
212 | ))) | ||
213 | |((( | ||
214 | Forma de Pagamento Consulte a API de Formas de Pagamento para obter a lista ou criar formas de pagamento | ||
215 | ))) | ||
216 | |((( | ||
217 | Para Cartões - NSU/DOC ou TID. (NSU/DOC: Número sequencial, também conhecido como DOC (número do documento), gerado no PDV ou POS que identifica a transação no dia em que ela foi realizada); (TID: Identificação da transação realizada no comércio eletrônico ou mobile payment). | ||
218 | ))) | ||
219 | |((( | ||
220 | Numero da Parcela | ||
221 | ))) | ||
222 | |((( | ||
223 | Para Cartões - Número do cartão truncado (substituir todos os dígitos dos blocos centrais por "*", para segurança). Ex. 520132~*~*~*~*~*~*0831. | ||
224 | ))) | ||
225 | |((( | ||
226 | Para Cartões - Número do resumo de operação ou número do lote. Contêm informações referentes a um grupo de vendas em uma determinada data. | ||
227 | ))) | ||
228 | |((( | ||
229 | Valor da Parcela | ||
230 | ))) | ||
231 | |((( | ||
232 | Quando a fatura vence. | ||
233 | ))) | ||
234 | |(Sobrescreve Entidade.Versao.) | ||
235 | |||
236 | = Item do Pedido = | ||
237 | |||
238 | |=Nome|=Descrição | ||
239 | |AtualizadoEm|((( | ||
240 | Quando o Item foi Atualizado | ||
241 | ))) | ||
242 | |CodigoDeBarras|((( | ||
243 | Código de Barras do Produto (Não é obrigatório se o Id do Produto for preenchido) | ||
244 | ))) | ||
245 | |Desconto|((( | ||
246 | Valor do desconto do produto (Esse valor será somado com o valor do desconto rateado do campo "Desconto do Pedido [ValorDeDesconto]", caso tenha sido informado). | ||
247 | |||
248 | Ex.: R$ 15,00 de desconto para o produto 1. | ||
249 | |||
250 | Se tiver sido informado o desconto rateado em reais, conforme exemplificado no "ValorDeDesconto" da Entidade de Pedidos, será somado o valor de R$ 5,00. Assim, o total do desconto do produto 1 será R$ 20,00). | ||
251 | ))) | ||
252 | |Id|((( | ||
253 | Id do Numero do Item do Pedido | ||
254 | ))) | ||
255 | |ProdutoId|((( | ||
256 | Id do Produto (Não é obrigatório se o Código de Barras for preenchido) | ||
257 | ))) | ||
258 | |Quantidade|((( | ||
259 | Quantidade de Examples para o Produto | ||
260 | ))) | ||
261 | |ValorUnitario|((( | ||
262 | Valor Unitário do Produto | ||
263 | ))) | ||
264 | |||
265 | = Forma de Pagamento = | ||
266 | |||
267 | |AltCodigo|((( | ||
268 | Código Alternativo | ||
269 | ))) | ||
270 | |AtualizadoEm| | ||
271 | |Codigo|((( | ||
272 | Código ID da Forma de Pagamento no Site/Aplicativo | ||
273 | ))) | ||
274 | |CodigoInterno| | ||
275 | |Descricao|((( | ||
276 | Descrição da Forma de Pagamento acima. Ex.: Boleto Bancário. | ||
277 | ))) | ||
278 | |[[Tipo>>path:da341145-4205-e0b5-019a-eea3ca049ad0.htm]]|((( | ||
279 | Tipo da forma de pagamento | ||
280 | |||
281 | * 1 - CHEQUE | ||
282 | * 2 - DINHEIRO | ||
283 | * 3 - CARTAO | ||
284 | * 4 - OUTROS | ||
285 | * 5 - BOLETO | ||
286 | * 6 - DARF NORMAL | ||
287 | * 7 - DARF SIMPLES | ||
288 | * 8 - CONTA CORRENTE | ||
289 | * 9 - DOC | ||
290 | * 10 - GARE | ||
291 | * 11 - GNRE | ||
292 | * 12 - GPS | ||
293 | * 13 - IPTU | ||
294 | * 14 - IPVA | ||
295 | * 15 - ORDEM PAGAMENTO | ||
296 | * 16 - CONTA CORRENTE REAL | ||
297 | * 17 - SALARIOS | ||
298 | * 18 - TED | ||
299 | * 19 - DDA | ||
300 | ))) | ||
301 | ))) | ||
302 | |||
303 | F | ||
304 | |||
305 | (% class="col-xs-12 col-sm-4" %) | ||
306 | ((( | ||
307 | {{box title="**Índice**"}} | ||
308 | {{toc/}} | ||
309 | {{/box}} | ||
310 | |||
311 | |||
312 | |||
313 | ))) | ||
314 | ))) | ||
315 | |||
316 | = = | ||
317 | |||
318 | |||
319 | |||
320 |