API Reference

Detalhes

Descrição dos campos

CampoRequeridoÚnicoTipo do CampoMax CaracteresDescrição
id✅Int4ID do pedido
uuidVarcharUUID do pedido
referece_codeVarchar64Código de referência no marketplace
erp_codeVarchar64Código de referência ou código da grade no ERP
customer✅ObjectCliente
billing_detail_name✅Varchar100Nome do cliente
billing_detail_document✅Varchar100Documento do cliente
billing_detail_ieVarcharInscrição estadual
billing_detail_address✅Varchar100Endereço
billing_detail_number✅Varchar100Número
billing_detail_complement✅Varchar100Complemento
billing_detail_neighborhood✅Varchar100Bairro
billing_detail_city✅Varchar100Cidade
billing_detail_state✅Varchar100Estado
billing_detail_postcode✅Varchar100CEP
billing_detail_phone✅Varchar100Telefone
billing_detail_email✅Varchar100E-mail do cliente
billing_detail_reference✅Varchar100Referência do endereço
shipping_detail_name✅Varchar100Nome do cliente
shipping_detail_document✅Varchar100Documento do cliente
shipping_detail_address✅Varchar100Endereço
shipping_detail_number✅Varchar100Número
shipping_detail_complement✅Varchar100Complemento
shipping_detail_neighborhood✅Varchar100Bairro
shipping_detail_city✅Varchar100Cidade
shipping_detail_state✅Varchar100Estado
shipping_detail_postcode✅Varchar100CEP
shipping_detail_phone✅Varchar100Telefone
shipping_detail_email✅Varchar100E-mail do cliente
shipping_detail_referenceReferência do endereço
shipping_total✅Numeric10,2Custo do envio
shipping_total_originalNumeric10,2Custo do envio original
shipping_discount✅Numeric10,2Desconto no envio
shipping_delivery_date✅DateData de entrega
shipping_flag✅Varchar
shipping_free✅BooleanFrete Grátis
shipping_type✅Varchar50Tipo de entrega
shipping_name✅VarcharNome da entrega
shipment_id✅Int4ID da entrega
pickup_storeInt4ID do ponto de retirada
pickup_store__erp_code✅Int4Código do ponto de retirada
pickup_address✅VarcharEndereço da loja para retirada
item_total✅Numeric10,2Total do pedido em itens
discount_total✅Numeric10,2Total de desconto
discounts✅Descontos
total✅NumericTotal do pedido
payment_method✅Varchar50Forma de pagamento
institution✅Varchar50Instituição Financeira
installments✅Int450Parcelas
capturedBoolean1Informa se o pedido esta capturado
status✅Varchar50Status do pedido
channel✅Int450Có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
update_dateDateData de alteração
scheduled_delivery_timeDateData e hora da entrega agendada
items✅ListLista de items do pedido
items.order✅Int4ID do pedido
items.sku✅Int4ID do item
items.product✅Int4ID do produto
items.kitInt4ID do kit
items.description✅Varchar200Descrição do item
items.quantity✅Int4Quantidade do item
items.cost_priceNumeric10,2Preço de custo
items.unit_price✅Numeric10,2Preço unitário
items.total_price✅Numeric10,2Preço total
items.loyalty_priceNumeric10,2Preço para fidelidade
items.discount✅Numeric10,2Desconto no item
items.is_gift✅BooleanInforma se o item é presente
items.ean_13VarcharCódigo de barras
items.reference_codeCódigo de referência
items.delivery_timeVarcharPrazo do preparo
items.shipping_typeTipo do frete
items.offersObjectOferta
items.weightNumericPeso
items.heightNumericAltura
items.widthNumericLargura
items.depthNumericProfundidade
items.image_bigVarcharURL da imagem
items.servicesServiços
items.extra_dataObjectExtra data
items.sellerInt4ID do seller
items.shipping_totalCusto da entrega
items.shipping_nameVarcharNome da entrega
trackersListLista de códigos de rastreio
trackers.id✅Int4ID do código de rastreio
trackers.order✅Int4ID do pedido
trackers.code✅Varchar100Código do Rastreio
trackers.status✅Varchar50Status do pedido
invoicesListLista de notas fiscais
invoice_file_xmlFileNota Fiscal XML
invoice_file_pdfFileNota Fiscal PDF
trackers.id✅Int4ID da nota fiscal
trackers.order✅Int4ID do pedido
trackers.key✅Varchar100Código da Nota Fiscal
trackers.date_issue✅DateData de emissão (yyyy-mm-ddTHH:ii:ss)
trackers.series✅Varchar50Serie da Nota Fiscal
trackers.total✅Numeric10,2Total da Nota Fiscal
dockInt4Doca
dock_stockInt4Doca Estoque
extra_dataObjectExtra Data
couponsListCupons
tagsListTags do pedido

Modelo de JSON

{
    "id": 140,
    "uuid": "1234e567-0000-0000-acbd-8c90e6f29fcd",
    "reference_code": null,
    "erp_code": null,
    "customer": {
        "uuid": "8c8c8c8c-1234-5678-0000-9c4712353a54",
        "id": 6,
        "reference_code": null,
        "email": "[email protected]",
        "document": "00000000000",
        "corporate_document": "",
        "name": "Lucas Silva",
        "corporate_name": null,
        "inscricao_estadual_isento": false,
        "inscricao_estadual": null,
        "fancy_name": null,
        "birthdate": null,
        "gender": 2,
        "blocked": false,
        "newsletter": 0,
        "gdpr_agreement": true,
        "receiver": "Lucas Silva",
        "zipcode": "14025610",
        "address": "R MAESTRO JOAQUIM RANGEL",
        "number": "795",
        "neighborhood": "ALTO BOA VISTA",
        "complement": "sala 1001",
        "city": "RIBEIRÃO PRETO",
        "state": "SP",
        "phone1": "11999999999",
        "phone2": "",
        "reference": null,
        "city_id": "9560",
        "code_ibge": "3543402",
        "add_date": "2017-10-10T15:33:33.251694",
        "change_date": "2022-12-08T17:12:47.206231",
        "limit_credit": null,
        "balance_of_credit": null,
        "group": null,
        "extra_data": null
    },
    "billing_detail_name": "Lucas Silva",
    "billing_detail_document": "00000000000",
    "billing_detail_ie": null,
    "billing_detail_address": "R MAESTRO JOAQUIM RANGEL",
    "billing_detail_number": "795",
    "billing_detail_complement": "sala 1001",
    "billing_detail_neighborhood": "ALTO BOA VISTA",
    "billing_detail_city": "RIBEIRÃO PRETO",
    "billing_detail_state": "SP",
    "billing_detail_postcode": "1425610",
    "billing_detail_phone": "11999999999",
    "billing_detail_email": "[email protected]",
    "billing_detail_reference": "",
    "shipping_detail_name": "Lucas Silva",
    "shipping_detail_document": "00000000000",
    "shipping_detail_address": "R MAESTRO JOAQUIM RANGEL",
    "shipping_detail_number": "795",
    "shipping_detail_complement": "sala 1001",
    "shipping_detail_neighborhood": "ALTO BOA VISTA",
    "shipping_detail_city": "RIBEIRÃO PRETO",
    "shipping_detail_state": "SP",
    "shipping_detail_postcode": "1425610",
    "shipping_detail_phone": "11999999999",
    "shipping_detail_email": "[email protected]",
    "shipping_detail_reference": "",
    "shipping_total": "10.00",
    "shipping_total_original": 8.0,
    "shipping_discount": "0.00",
    "shipping_delivery_date": "2021-09-09",
    "shipping_flag": "",
    "shipping_free": "",
    "shipping_type": "Transportadora Teste",
    "shipping_name": null,
    "shipment_id": null,
    "pickup_store": null,
    "pickup_store__erp_code": null,
    "pickup_address": null,
    "item_total": "240.00000",
    "discount_total": "0.00000",
    "discounts": [],
    "total": "250.00000",
    "payment_method": "CartaoDeCredito",
    "institution": "",
    "installments": 1,
    "captured": false,
    "status": "CANM",
    "channel": 0,
    "observation": "",
    "transaction_id": null,
    "pan": null,
    "nsu": null,
    "card_mask": null,
    "ip_addrress": "100.100.00.00",
    "weddinglist": null,
    "seller": null,
    "add_date": "2021-08-30T10:27:42.613163",
    "scheduled_delivery_time": null,
    "update_date": "2022-05-23T09:58:38.699091",
    "items": [
        {
            "id": 158,
            "order": 140,
            "sku": 77,
            "kit": null,
            "description": "Mesa de Cabeceira",
            "quantity": 1,
            "cost_price": null,
            "unit_price": "240.00000",
            "total_price": "240.00000",
            "loyalty_price": null,
            "discount": "0.00000",
            "is_gift": false,
            "ean_13": "7891991015073",
            "reference_code": "808070705656",
            "delivery_time": "0",
            "shipping_type": null,
            "offers": [],
            "weight": 0.3,
            "height": 5.0,
            "width": 8.0,
            "depth": 9.6,
            "image_big": "https://io.convertiez.com.br/m/{ENVIRONMENT}/shop/products/images/54/big/mesa-de-cabeceira_126.jpg",
            "services": [
              {
                "fields": [
                  {
                    "url": null,
                    "id": 2,
                    "value": "Maria José",
                    "label": "Nome para bordar"
                  }
                ],
                "total_price": 0.0,
                "id": 1,
                "title": "Personalizar"
              }
            ],
            "extra_data": null,
            "seller": null,
            "shipping_total": null,
            "shipping_name": null
        }
    ],
    "trackers": [],
    "invoices": [],
    "payments": [
        {
            "id": 199,
            "uuid": "42223abc-5321-1234-0072-e8888ebbe66b",
            "backend": "getnet",
            "status": "IN_ANALYSIS",
            "payment_method": "Visa",
            "group": "CartaoDeCredito",
            "installments": 4,
            "total": 250.0,
            "tid": "000100200000",
            "pan": "aaa81181-1129-4444-9f5b-0a0586402642",
            "nsu": "123456",
            "card_mask": "401200 **** **** 1212",
            "first6": "401200",
            "last4": "1212",
            "add_date": "2021-08-30T10:27:31.483749",
            "update_date": "2021-08-30T10:44:21.242664",
            "url": "https://{ENVIRONMENT}.my.convertize.com.br/None",
            "due_date": null,
            "observation": "",
            "extra_data": null
        }
    ],
    "dock": null,
    "dock_stock": null,
    "extra_data": {
      "withdrawal_code": "530975"
    },
    "coupons": null,
  	"tags": [
      "Pedido impresso",
      "Funcioário"
      ],
    "total_services": 0
}

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

Updated over 1 year ago

Did this page help you?

Updated over 1 year ago

Did this page help you?