Request body example

{
    "receiver_name": "Nome",
    "receiver_lastname": "Sobrenome",
    "receiver_address": "Rua Chico Mendes",
    "receiver_address_number": "105",
    "receiver_address_complement": "Apto 22 bloco C",
    "receiver_address_reference": "Prox a padaria",
    "receiver_neighborhood": "Parque Imperial",
    "receiver_city": "Barueri",
    "receiver_state": "São Paulo",
    "receiver_country": "Brasil",
    "receiver_zipcode": "06462350",
    "receiver_email": "teste@teste.com.br",
    "receiver_phone_area": "11",
    "receiver_phone": "111111111",
    "receiver_phone2_area": "11",
    "receiver_phone2": "111111111",
    "payer_name": "Nome",
    "payer_lastname": "Sobrenome",
    "payer_address": "Rua Chico Mendes",
    "payer_address_number": "105",
    "payer_address_complement": "Apto 22 bloco C",
    "payer_additional_info": "Próximo a padaria",
    "payer_neighborhood": "Parque Imperial",
    "payer_city": "Barueri",
    "payer_state": "São Paulo",
    "payer_country": "Brasil",
    "payer_zipcode": "06462350",
    "payer_email": "teste@teste.com.br",
    "payer_phone_area": "11",
    "payer_phone": "111111111",
    "payer_phone2_area": "11",
    "payer_phone2": "111111111",
    "payer_cpf": "000.000.000-00",
    "payer_cnpj": "00.000.000/0001-00",
    "payer_company_name": "Razão social",
    "payer_tax_id": "00000000000",
    "payment_intermediary": "00.000.000/0001-00",
    "sale_intermediary": "00.000.000/0001-00",
    "intermediary_seller_id": "seller@marketplace",
    "currency": "BRL",
    "delivery_type": "standard",
    "expected_delivery_date": "2024-07-16T03:00:00.000Z",
    "expected_send_date": "2024-07-17T18:08:34.000Z",
    "receiver_schedule_date": "2016-11-05",
    "receiver_schedule_period": "morning",
    "subtotal": 54.81,
    "shipping": 10.99,
    "discount": 0,
    "tax": 0,
    "total": 65.80,
    "total_paid": 66.80,
    "original_id": "200-0008-474654",
    "auto_reserve": true,
    "ack": false,
    "user_client_id": "129",
    "sub_status": "waiting_expedition",
    "status": "pending",
    "channel": "MercadoLivre",
    "channel_account": "Pluggto",
    "commission": {
        "comment": "gold_special",
        "fixed": 0,
        "tax": 24.04,
        "total_charged": 10.68
    },
    "payments": [
        {
            "payment_type": "credit",
            "payment_installments": "2",
            "payment_method": "Pix",
            "payment_authorization_code": "Cod. autorização de pagamento",
            "payment_acquirer_id": "Cod. identificador Pagamento(CNPJ)",
            "payment_card_brand": "Bandeira do banco (caso seja cartão)",
            "payment_total": 66.80,
            "payment_quota": 33.40,
            "payment_interest": 1.00,
            "external": 82624426955
        }
    ],
    "items": [
        {
            "variation": {
                "sku": "1776924"
            },
            "name": "Prancha Chapinha Mallory Ultra Liss Ion 110V Cor Preto",
            "sku": "parent-1631600",
            "original_sku": "parent-1631600",
            "price": 41.83,
            "quantity": 1,
            "discount": 0,
            "tax": 15.22,
            "total": 41.83,
            "price_code": "Preço Saúde 28.06",
            "photo_url": "https://s3-sa-east-1.amazonaws.com/pluggto/5496/5496_74802d0c-764b-46f0-b978-485264535886.png",
            "category": "Beleza > Acessórios para Cabelos > Chapinhas",
            "supplier_id": "136",
            "stock_code": "warehouse_1",
            "place_code": "98",
            "commission": {
                "fixed": 0,
                "tax": 23.02,
                "comment": "gold_special",
                "total_charged": 9.63
            }
        },    
        {
            "name": "Creme De Hidratação Skala Amido Milho 1Kg",
            "sku": "188289",
            "original_sku": "188289",
            "price": 12.98,
            "quantity": 1,
            "discount": 0,
            "tax": 2.30,
            "total": 12.98,
            "place_code": "98",
            "stock_code": "warehouse_1",
            "photo_url": "https://s3-sa-east-1.amazonaws.com/pluggto/5496/5496_74802d0c-764b-46f0-b978-485264535886.png",
            "category": "cabelos > tratamento",
            "commission": {
                "fixed": 0,
                "tax": 3.02,
                "comment": "gold_special",
                "total_charged": 1.05
            }
          }
    ],
    "shipments": [
        {
            "label_type": "own_contract",
            "shipping_company": "Correios",
            "shipping_method": "PAC",
            "estimate_delivery_date": "2024-07-16T03:00:00.000Z"
        }
    ]
}

Request object has the following properties:

Attribute	Type	Description
receiver_name	string	Receiver name
receiver_lastname	string	Receiver lastname
receiver_address_number	string	Receiver address numbe
receiver_address	string	Receiver address
receiver_address_complement	string	Receiver address complement
receiver_address_reference	string	Receiver address reference
receiver_neighborhood	string	Receiver neighborhood
receiver_city	string	Receiver city
receiver_state	string	Receiver state
receiver_country	string	Receiver country
receiver_email	string	Receiver email
receiver_zipcode	string	Receiver zipcode
receiver_phone_area	string	Receiver phone area
receiver_phone	string	Receiver phone
receiver_phone2_area	string	Receiver phone2 area
receiver_phone2	string	Receiver phone2
payer_name	string	Payer name
payer_lastname	string	Payer lastname
payer_address	string	Payer address
payer_address_number	string	Payer address number
payer_address_complement	string	Payer address complement
payer_additional_info	string	Payer additional info
payer_neighborhood	string	Payer neighborhood
payer_city	string	Payer city
payer_state	string	Payer state
payer_country	string	Payer country
payer_zipcode	string	Payer zipcode
payer_email	string	Payer email
payer_phone_area	string	Payer phone area
payer_phone	string	Payer phone
payer_phone2_area	string	Payer phone(2) area
payer_phone2	string	Payer phone2
payer_cpf	string	Payer CPF
payer_tax_id	string	Payer's CPF or Inscrição Estadual (i.e)
payer_cnpj	string	Payer CNPJ
payer_company_name	string	Paying company name
total_paid	number	Total paid by buyer
shipping	number	Shipping paid
subtotal	number	Subtotal
discount	number	Discount
tax	number	Total order tax
total	number	Total
ack	boolean	Order receipt confirmation field
status	string	Order status
sale_intermediary	string	CNPJ of the sales intermediary
payment_intermediary	string	CNPJ of the payment intermediary
intermediary_seller_id	string	Seller ID, User or email that identifies the seller in the marketplace
user_client_id	string	Plugg.to user ID
original_id	string	original order number (Enter your system number)
expected_send_date	string	Expected send date
expected_delivery_date	string	Expected delivery date
receiver_schedule_date	string	Receiver schedule date
receiver_schedule_period	string	Receiver schedule period Values: morning afternoon night
stock_code	string	Product stock table name
price_code	string	Product price table name
auto_reserve	boolean	Reserves product inventory by sending the value as "true"
payments	object	Array with payment information
payment_type	string	credit debit ticket voucher transfer
payment_installments	integer	Number of installments
payment_method	string	Name of payment method
payment_quota	number	Value of installments
payment_interest	number	Payment interest
external	string	Payment transaction ID or NSU
shipments	object	Array with shipping information
shipping_company	string	Shipping company
shipping_method	string	Shipping method
track_code	string	Tracking code
external	string	Inform the order number
delivery_type	string	standard express onehour pickup economy guaranteed scheduled international fulfillment
currency	string	'BRL', // Brasil 'ARS', // Argentina 'VEF', // VENEZUELA 'MXN', // MEXICO 'MXV', // MEXICO 'MCR', // COSTA RICA 'COP', // COLOMBIA 'BOB', // BOLIVIA 'ARS', // EQUADOR 'EUR', // EURO 'UYU', // URUGUAI 'CAD', // CANADA 'CLP', // CHILE 'CRC', // COSTA RICA 'PYG', // GUARANY 'PEN',// PERU 'PAB',// PANAMA 'GBP', // UNITeD KINGTON 'AUD',//AUSTRALIA 'CUP',// CUBA 'CUC',// CUBA 'USD'] // EUA
channel	string	Order sales channel
channel_account	string	Channel account
label_type	string	Label type Values: manual third_contract fulfillment own_contract pickup_store drop_shipping

200200

400400