Descrição dos campos
| Campo | Requerido | Unico | Tipo do Campo | Max Caracteres | Descrição |
|---|---|---|---|---|---|
| id | ✅ | Int4 | ID do pedido | ||
| referece_code | Varchar | 64 | Código de referência no marketplace | ||
| erp_code | Varchar | 64 | Código de referência ou código da grade no ERP | ||
| customer | ✅ | Int4 | ID do cliente | ||
| billing_detail_name | ✅ | Varchar | 100 | Nome do cliente | |
| billing_detail_document | ✅ | Varchar | 100 | Documento do cliente | |
| billing_detail_address | ✅ | Varchar | 100 | Endereço | |
| billing_detail_number | ✅ | Varchar | 100 | Número | |
| billing_detail_complement | ✅ | Varchar | 100 | Complemento | |
| billing_detail_neighborhood | ✅ | Varchar | 100 | Bairro | |
| billing_detail_city | ✅ | Varchar | 100 | Cidade | |
| billing_detail_state | ✅ | Varchar | 100 | Estado | |
| billing_detail_postcode | ✅ | Varchar | 100 | CEP | |
| billing_detail_phone | ✅ | Varchar | 100 | Telefone | |
| billing_detail_email | ✅ | Varchar | 100 | E-mail do cliente | |
| billing_detail_reference | ✅ | Varchar | 100 | ||
| shipping_detail_name | ✅ | Varchar | 100 | Nome do cliente | |
| shipping_detail_document | ✅ | Varchar | 100 | Documento do cliente | |
| shipping_detail_address | ✅ | Varchar | 100 | Endereço | |
| shipping_detail_number | ✅ | Varchar | 100 | Número | |
| shipping_detail_complement | ✅ | Varchar | 100 | Complemento | |
| shipping_detail_neighborhood | ✅ | Varchar | 100 | Bairro | |
| shipping_detail_city | ✅ | Varchar | 100 | Cidade | |
| shipping_detail_state | ✅ | Varchar | 100 | Estado | |
| shipping_detail_postcode | ✅ | Varchar | 100 | CEP | |
| shipping_detail_phone | ✅ | Varchar | 100 | Telefone | |
| shipping_detail_email | ✅ | Varchar | 100 | E-mail do cliente | |
| shipping_total | ✅ | Numeric | 10,2 | Custo do envio | |
| shipping_discount | ✅ | Numeric | 10,2 | Desconto no envio | |
| shipping_delivery_date | ✅ | Date | Data de entrega | ||
| shipping_flag | ✅ | Varchar | |||
| shipping_free | ✅ | Boolean | Frete Grátis | ||
| shipping_type | ✅ | Varchar | 50 | Tipo de entrega | |
| shipping_name | ✅ | Varchar | Nome da entrega | ||
| shipment_id | ✅ | Int4 | ID da entrega | ||
| shipping_delivery_date | ✅ | Date | Data de entrega | ||
| pickup_store | ✅ | Int4 | ID da loja para retirada | ||
| item_total | ✅ | Numeric | 10,2 | Total do pedido em itens | |
| discount_total | ✅ | Numeric | 10,2 | Total de desconto | |
| discounts | ✅ | Descontos | |||
| total | ✅ | Numeric | Total do pedido | ||
| payment_method | ✅ | Varchar | 50 | Forma de pagamento | |
| institution | ✅ | Varchar | 50 | Instituição Financeira | |
| installments | ✅ | Int4 | 50 | Parcelas | |
| captured | Boolean | 1 | Informa se o pedido esta capturado | ||
| status | ✅ | Varchar | 50 | Status do pedido | |
| channel | ✅ | Int4 | 50 | Código do canal de compra | |
| observation | Varchar | Texto de observação | |||
| transaction_id | Varchar | 150 | Código da transação | ||
| pan | Varchar | 100 | PAN da transação | ||
| nsu | Varchar | 100 | NSU da transação | ||
| card_mask | Varchar | 25 | Cartão mascarado | ||
| ip_addrress | Inet | IP da transação | |||
| weddinglist | Int4 | ID da lista de presente | |||
| seller | Int4 | ID do vendedor | |||
| add_date | Date | Data de criação | |||
| scheduled_delivery_time | Date | Data e hora da entrega agendada | |||
| items | ✅ | List | Lista de items do pedido | ||
| items.order | ✅ | Int4 | ID do pedido | ||
| items.sku | ✅ | Int4 | ID do item | ||
| items.description | ✅ | Varchar | 200 | Descrição do item | |
| items.quantity | ✅ | Int4 | Quantidade do item | ||
| items.unit_price | ✅ | Numeric | 10,2 | Preço unitário | |
| items.total_price | ✅ | Numeric | 10,2 | Preço total | |
| items.discount | ✅ | Numeric | 10,2 | Desconto no item | |
| items.is_gift | ✅ | Boolean | Informa se o item é presente | ||
| trackers | List | Lista de códigos de rastreio | |||
| trackers.id | ✅ | Int4 | ID do código de rastreio | ||
| trackers.order | ✅ | Int4 | ID do pedido | ||
| trackers.code | ✅ | Varchar | 100 | Código do Rastreio | |
| trackers.status | ✅ | Varchar | 50 | Status do pedido | |
| invoices | List | Lista de notas fiscais | |||
| invoice_file_xml | File | Nota Fiscal XML | |||
| invoice_file_pdf | File | Nota Fiscal PDF | |||
| trackers.id | ✅ | Int4 | ID da nota fiscal | ||
| trackers.order | ✅ | Int4 | ID do pedido | ||
| trackers.key | ✅ | Varchar | 100 | Código da Nota Fiscal | |
| trackers.date_issue | ✅ | Date | Data de emissão (yyyy-mm-ddTHH:ii:ss) | ||
| trackers.series | ✅ | Varchar | 50 | Serie da Nota Fiscal | |
| trackers.total | ✅ | Numeric | 10,2 | Total da Nota Fiscal | |
| dock | Int4 | Doca | |||
| dock_stock | Int4 | Doca Estoque | |||
| extra_data | Object | Extra Data | |||
| coupons | List | Cupons |
Modelo de JSON
{
"id": 298,
"uuid": "1fd8fa89-eeee-333c-9999-33c83109c5ad",
"reference_code": null,
"erp_code": null,
"customer": 110,
"billing_detail_name": "Rita De Cássia",
"billing_detail_document": "99999999999",
"billing_detail_ie": null,
"billing_detail_address": "R MAESTRO JOAQUIM RANGEL",
"billing_detail_number": "795",
"billing_detail_complement": "SALA 1",
"billing_detail_neighborhood": "AT BOA VISTA",
"billing_detail_city": "RIBEIRÃO PRETO",
"billing_detail_state": "SP",
"billing_detail_postcode": "14025610",
"billing_detail_phone": "1199999999",
"billing_detail_email": "[email protected]",
"billing_detail_reference": "Ribeirão Shopping",
"shipping_detail_name": "Rita De Cássia",
"shipping_detail_document": "99999999999",
"shipping_detail_address": "R MAESTRO JOAQUIM RANGEL",
"shipping_detail_number": "795",
"shipping_detail_complement": "SALA 1",
"shipping_detail_neighborhood": "AT BOA VISTA",
"shipping_detail_city": "RIBEIRÃO PRETO",
"shipping_detail_state": "SP",
"shipping_detail_postcode": "14025610",
"shipping_detail_phone": "1199999999",
"shipping_detail_email": "[email protected]",
"shipping_detail_reference": "Ribeirão Shopping",
"shipping_total": "0.00",
"shipping_discount": "0.00",
"shipping_delivery_date": "2023-08-16",
"shipping_flag": "",
"shipping_free": "",
"shipping_type": "Correios Pac",
"shipping_name": "Correios Pac",
"shipment_id": null,
"pickup_store": null,
"pickup_store__erp_code": null,
"item_total": "150.00000",
"discount_total": "0.00000",
"total": "150.00000",
"payment_method": "Boleto",
"institution": "",
"installments": 1,
"captured": false,
"status": "CANM",
"channel":3,
"observation": null,
"transaction_id": null,
"pan": null,
"nsu": null,
"card_mask": null,
"ip_addrress": "000.000.00.00",
"weddinglist": null,
"seller": 5,
"add_date": "2023-06-07T11:35:19.427104",
"scheduled_delivery_time": null,
"update_date": "2023-06-13T00:00:00.420562",
"items": [
{
"id": 333,
"order": 298,
"sku": 109,
"kit": null,
"description": "Produto de Teste",
"quantity": 1,
"cost_price": null,
"unit_price": "50.00000",
"total_price": "50.00000",
"discount": "0.00000",
"loyalty_price": null,
"is_gift": false,
"ean_13": null,
"reference_code": null,
"delivery_time": null,
"shipping_type": null,
"offers": [
{
"unit_discount": 0.0,
"description": "Oferta para Selo Grátis",
"title": "[SELO] - FRETE GRÁTIS",
"priority": 0,
"discount": 0.0,
"accumulate": false,
"id": 222
}
],
"weight": 0.25,
"height": 6.0,
"width": 10.0,
"depth": 6.0,
"image_big": "https://io.convertiez.com.br/m/{ENVIRONMENT}/shop/products/images/78/big/miniatura-fiat-500_153.jpg",
"services": null,
"extra_data": {
"offers": {
"2": {
"222": {
"description": "Oferta para Selo Grátis",
"title": "[SELO] - FRETE GRÁTIS",
"priority": 0,
"discount": 0.0,
"accumulate": false,
"type": 2,
"id": 222
}
}
}
}
},
{
"id": 334,
"order": 298,
"sku": 110,
"kit": null,
"description": "Calice Pink",
"quantity": 2,
"cost_price": null,
"unit_price": "50.00000",
"total_price": "100.00000",
"discount": "0.00000",
"loyalty_price": null,
"is_gift": false,
"ean_13": null,
"reference_code": null,
"delivery_time": "10",
"shipping_type": null,
"offers": [],
"weight": 0.05,
"height": 20.0,
"width": 8.0,
"depth": 8.0,
"image_big": "https://io.convertiez.com.br/m/{ENVIRONMENT}/shop/products/images/79/big/calice-pink_154.jpg",
"services": null,
"extra_data": null
}
],
"trackers": [],
"invoices": [],
"payments": [],
"dock": null,
"dock_stock": null
}
Descrição Channel
| Campo | Descrição |
|---|---|
| 0 | Convertize |
| 1 | Lista de presente |
| 2 | Marketplace |
| 3 | Televendas |
| 4 | Mercado Livre |
| 5 | Magazine Luiza |
| 6 | Submarino |
| 7 | Shoptime |
| 8 | Americanas |
| 10 | Via Varejo |
| 11 | Walmart |
| 12 | Buscape |
| 13 | Rakuten |
| 14 | Netshoes |
| 15 | Zattini |
| 16 | Zoom |
| 17 | SkyHub |
| 18 | IntegraCommerce |
| 19 | Assinatura |
| 20 | Application |
| 21 | Plugg.to |
Descrição Status
| Campo | Descrição |
|---|---|
| PEN | Pedido Realizado |
| DLP | Pagamento na Entrega |
| CEP | Pagamento Recebido |
| CANM | Cancelado |
| AADF | Aguardando Análise |
| RET | Disponível para Retirada |
| ETP | Entregue a Transportadora |
| PECS | Entregue |
| PNA | Pagamento não Aprovado |
| PEC | Pagamento em Contestação |
| PCD | Chargeback |
| PDV | Pagamento Devolvido |
| PED | Pagamento em Disputa |
| PDPN | Pagamento Disponível |
| PES | Em Separação |
| FAT | Faturado |
| DESAU | Destinatário ausente |
| SPEN | Saiu para entrega |
| EXTL | Pagamento Externo |
| ERROR | Erro no pedido |
Descrição Método de Pagamento
| Campo | Descrição |
|---|---|
| DebitoBancario | Débito em Conta |
| Boleto | Boleto Bancário |
| Deposito | Deposito em Conta |
| Intermediary | Intermediador |
| CartaoDeCredito | Cartão de Crédito |
| CartaoDeDebito | Cartão de Débito |
| marketplace | Pagamento Marketplace |
| Outros | Outros |
| Orcamento | Orçamento |
| PrivateLabel | PrivateLabel |
| GiftCard | Vale Presente |
| Deliverypay | Pagar na entrega |
| PayPal | PayPal |
| PicPay | PicPay |
| Ame | Ame |
| PIX | PIX |
| POS | Maquininha POS |
Descrição Instituição Financeira
| Campo | Descrição |
|---|---|
| Visa | Visa |
| Amex | American Express |
| Mastercard | MasterCard |
| Diners | Diners Club |
| Bancodobrasil | Banco do Brasil |
| Bradesco | Bradesco |
| Itau | Itaú |
| Bancoreal | Banco Real |
| Unibanco | Unibanco |
| Aura | Aura |
| Hipercard | Hipercard |
| Paggo | Oi Paggo |
| Banrisul | Banrisul |
| Santander | Santander |
| Hsbc | HSBC |
| Discover | Discover |
| Elo | Elo |
| Paypal | Paypal |
| PicPay | PicPay |
| Pagseguro | Pagseguro |
| PLENOCard | PLENOCard |
| Personalcard | PersonalCard |
| Jcb | JCB |
| Brasilcard | BrasilCard |
| FORTBRASIL | FORTBRASIL |
| CARDBAN | CARDBAN |
| VALECARD | VALECARD |
| Cabal | Cabal |
| Mais | Mais! |
| Avista | Avista |
| GRANDCARD | GRANDCARD |
| Sorocred | Sorocred |
| Caixa | Caixa |
| Hiper | Hiper |
| Pagarme | Pagar.me |
| Melicard | Cartão Mercado Livre |
| Sodexo | Sodexo |
| Vr | Vr |
| Alelo | Alelo |