Detalhes

Descrição dos campos

CampoRequeridoUnicoTipo do CampoMax CaracteresDescrição
idInt4ID do pedido
referece_codeVarchar64Código de referência no marketplace
erp_codeVarchar64Código de referência ou código da grade no ERP
customerInt4ID do cliente
billing_detail_nameVarchar100Nome do cliente
billing_detail_documentVarchar100Documento do cliente
billing_detail_addressVarchar100Endereço
billing_detail_numberVarchar100Número
billing_detail_complementVarchar100Complemento
billing_detail_neighborhoodVarchar100Bairro
billing_detail_cityVarchar100Cidade
billing_detail_stateVarchar100Estado
billing_detail_postcodeVarchar100CEP
billing_detail_phoneVarchar100Telefone
billing_detail_emailVarchar100E-mail do cliente
billing_detail_referenceVarchar100
shipping_detail_nameVarchar100Nome do cliente
shipping_detail_documentVarchar100Documento do cliente
shipping_detail_addressVarchar100Endereço
shipping_detail_numberVarchar100Número
shipping_detail_complementVarchar100Complemento
shipping_detail_neighborhoodVarchar100Bairro
shipping_detail_cityVarchar100Cidade
shipping_detail_stateVarchar100Estado
shipping_detail_postcodeVarchar100CEP
shipping_detail_phoneVarchar100Telefone
shipping_detail_emailVarchar100E-mail do cliente
shipping_totalNumeric10,2Custo do envio
shipping_discountNumeric10,2Desconto no envio
shipping_delivery_dateDateData de entrega
shipping_flagVarchar
shipping_freeBooleanFrete Grátis
shipping_typeVarchar50Tipo de entrega
shipping_nameVarcharNome da entrega
shipment_idInt4ID da entrega
shipping_delivery_dateDateData de entrega
pickup_storeInt4ID da loja para retirada
item_totalNumeric10,2Total do pedido em itens
discount_totalNumeric10,2Total de desconto
discountsDescontos
totalNumericTotal do pedido
payment_methodVarchar50Forma de pagamento
institutionVarchar50Instituição Financeira
installmentsInt450Parcelas
capturedBoolean1Informa se o pedido esta capturado
statusVarchar50Status do pedido
channelInt450Código do canal de compra
observationVarcharTexto de observação
transaction_idVarchar150Código da transação
panVarchar100PAN da transação
nsuVarchar100NSU da transação
card_maskVarchar25Cartão mascarado
ip_addrressInetIP da transação
weddinglistInt4ID da lista de presente
sellerInt4ID do vendedor
add_dateDateData de criação
scheduled_delivery_timeDateData e hora da entrega agendada
itemsListLista de items do pedido
items.orderInt4ID do pedido
items.skuInt4ID do item
items.descriptionVarchar200Descrição do item
items.quantityInt4Quantidade do item
items.unit_priceNumeric10,2Preço unitário
items.total_priceNumeric10,2Preço total
items.discountNumeric10,2Desconto no item
items.is_giftBooleanInforma se o item é presente
trackersListLista de códigos de rastreio
trackers.idInt4ID do código de rastreio
trackers.orderInt4ID do pedido
trackers.codeVarchar100Código do Rastreio
trackers.statusVarchar50Status do pedido
invoicesListLista de notas fiscais
invoice_file_xmlFileNota Fiscal XML
invoice_file_pdfFileNota Fiscal PDF
trackers.idInt4ID da nota fiscal
trackers.orderInt4ID do pedido
trackers.keyVarchar100Código da Nota Fiscal
trackers.date_issueDateData de emissão (yyyy-mm-ddTHH:ii:ss)
trackers.seriesVarchar50Serie da Nota Fiscal
trackers.totalNumeric10,2Total da Nota Fiscal
dockInt4Doca
dock_stockInt4Doca Estoque
extra_dataObjectExtra Data
couponsListCupons

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

CampoDescrição
0Convertize
1Lista de presente
2Marketplace
3Televendas
4Mercado Livre
5Magazine Luiza
6Submarino
7Shoptime
8Americanas
10Via Varejo
11Walmart
12Buscape
13Rakuten
14Netshoes
15Zattini
16Zoom
17SkyHub
18IntegraCommerce
19Assinatura
20Application
21Plugg.to

Descrição Status

CampoDescrição
PENPedido Realizado
DLPPagamento na Entrega
CEPPagamento Recebido
CANMCancelado
AADFAguardando Análise
RETDisponível para Retirada
ETPEntregue a Transportadora
PECSEntregue
PNAPagamento não Aprovado
PECPagamento em Contestação
PCDChargeback
PDVPagamento Devolvido
PEDPagamento em Disputa
PDPNPagamento Disponível
PESEm Separação
FATFaturado
DESAUDestinatário ausente
SPENSaiu para entrega
EXTLPagamento Externo
ERRORErro no pedido

Descrição Método de Pagamento

CampoDescrição
DebitoBancarioDébito em Conta
BoletoBoleto Bancário
DepositoDeposito em Conta
IntermediaryIntermediador
CartaoDeCreditoCartão de Crédito
CartaoDeDebitoCartão de Débito
marketplacePagamento Marketplace
OutrosOutros
OrcamentoOrçamento
PrivateLabelPrivateLabel
GiftCardVale Presente
DeliverypayPagar na entrega
PayPalPayPal
PicPayPicPay
AmeAme
PIXPIX
POSMaquininha POS

Descrição Instituição Financeira

CampoDescrição
VisaVisa
AmexAmerican Express
MastercardMasterCard
DinersDiners Club
BancodobrasilBanco do Brasil
BradescoBradesco
ItauItaú
BancorealBanco Real
UnibancoUnibanco
AuraAura
HipercardHipercard
PaggoOi Paggo
BanrisulBanrisul
SantanderSantander
HsbcHSBC
DiscoverDiscover
EloElo
PaypalPaypal
PicPayPicPay
PagseguroPagseguro
PLENOCardPLENOCard
PersonalcardPersonalCard
JcbJCB
BrasilcardBrasilCard
FORTBRASILFORTBRASIL
CARDBANCARDBAN
VALECARDVALECARD
CabalCabal
MaisMais!
AvistaAvista
GRANDCARDGRANDCARD
SorocredSorocred
CaixaCaixa
HiperHiper
PagarmePagar.me
MelicardCartão Mercado Livre
SodexoSodexo
VrVr
AleloAlelo