Create Order

Order creation method

Request body example

"receiver_name": "Andre",
    "receiver_lastname": "Teste2",
    "receiver_address_number": "440",
    "receiver_address": "Rua do Bosque",
    "receiver_address_complement": "Ap 22",
    "receiver_address_reference": "Prox a padaria",
    "receiver_city": "São Paulo",
    "receiver_state": "SP",
    "receiver_email": "[email protected]",
    "receiver_zipcode": "4457-115",
    "receiver_phone": "9911-22111",
    "receiver_phone2_area": "21",
    "receiver_phone2": "9911-22112",
    "receiver_neighborhood": "Barra funda",
    "receiver_phone_area": "11",
    "payer_name": "Luizo",
    "payer_lastname": "Santos",
    "payer_address": "Rua do Bosque",
    "payer_address_number": "440",
    "payer_address_complement": "Ap 22",
    "payer_additional_info": "Prox a padaria",
    "payer_neighborhood": "Mooca",
    "payer_city": "São Paulo",
    "payer_state": "SP",
    "payer_zipcode": "4457-115",
    "payer_phone_area": "11",
    "payer_phone": "2233-1111",
    "payer_phone2_area": "21",
    "payer_phone2": "2233-1111",
    "payer_tax_id": "000.000.000-00",
    "payer_document": "22.211.221",
    "payer_company_name": "EMPRESA LTDA",
    "sale_intermediary": "22211221000121",
    "payment_intermediary": "20231221000121",
    "intermediary_seller_id": "[email protected]",
    "payer_country": "BR",
    "payer_email": "[email protected]",
    "total_paid": "18",
    "payer_gender": "male",
    "shipping": 10.21,
    "subtotal": 18.21,
    "delivery_type": "standard",
    "discount": 0.0,
    "total": 18,
    "ack": false,
    "user_client_id": "129",
    "status": "pending",
    "channel": "Pluggto",
    "channel_account": "ThirdLevel",
    "original_id": "2949334455-A",
    "external": "2949334455-A",  
    "expected_send_date": "2016-11-05",
    "expected_delivery_date": "2016-11-05",
    "receiver_schedule_date": "2016-11-05",
    "receiver_schedule_period": "morning",
    "stock_code": "warehouse_1",
    "price_code": "price_reseller",
    "auto_reserve": true,
    "payments": [
        {
            "payment_type": "credit",
            "payment_method": "Nome do método como enviado pelo canal de venda",
            "payment_installments": 3,
            "payment_total": 100,
            "payment_quota": 30,
            "payment_interest": 3
        }
    ],
    "shipments": [
        {
            "shipping_company": "Correios",
            "shipping_method": "PAC",
            "track_code": "11111",
            "track_url": "http://correios.com.br",
            "estimate_delivery_date": "2016-11-05",
            "date_shipped": "2016-11-01",
            "date_delivered": "2016-11-05",
            "date_cancelled": "2016-12-01",
            "nfe_key": "44444444444444444444444444444",
            "nfe_link": "http://nfe.com.br/nsaasa",
            "nfe_number": "12",
            "nfe_serie": "1",
            "nfe_date": "2016-11-01",
            "cfops": "String com todos CFOPs do pedido",
            "documents": [
                {
                    "url": "http://www.etiqueta.com.br",
                    "external": "http://www.etiqueta.com.br",
                    "type": "label|packing_list|invoice"
                }
            ],
            "issues": [
                {
                    "description": "Atrasa na entrega",
                    "date": "2016-11-04"
                }
            ],
            "shipping_items": [
                {
                    "sku": "136-CT997",
                    "quantity": 1
                },
                {
                    "sku": "136-D0004",
                    "quantity": 5
                },
                {
                    "sku": "136-D0002",
                    "quantity": 5
                }
            ]
        }
    ],
    "items": [
        {
            "quantity": 3,
            "sku": "4544646464",
            "price": 30,
            "discount": 0,
            "total": 90,
            "name": "Camiseta Básica Azul",
            "stock_code": "136",
            "commission": {
                "fixed": 4,
                "tax": 2,
                "total_charged": 10
            },
            "variation": {
                "sku": "variacao-1"
            },
            "supplier_id": "136"
        },
        {
            "quantity": 1,
            "sku": "5464647976546",
            "price": 10,
            "total": 10,
            "name": "PRODUTO XYZ",
            "supplier_id": "136",
            "commission": {
                "fixed": 4,
                "tax": 2,
                "total_charged": 10
            }
        }
    ]
}

Request object has the following properties:

AttributeTypeDescription
receiver_namestringReceiver name
receiver_lastnamestringReceiver lastname
receiver_address_numberstringReceiver address numbe
receiver_addressstringReceiver address
receiver_address_complementstringReceiver address complement
receiver_address_referencestringReceiver address reference
receiver_citystringReceiver city
receiver_statestringReceiver state
receiver_emailstringReceiver email
receiver_zipcodestringReceiver zipcode
receiver_phonestringReceiver phone
receiver_phone2_areastringReceiver phone2 area
receiver_phone2stringReceiver phone2
receiver_neighborhoodstringReceiver neighborhood
receiver_phone_areastringReceiver phone area
payer_namestringPayer name
payer_lastnamestringPayer lastname
payer_addressstringPayer address
payer_address_numberstringPayer address number
payer_address_complementstringPayer address complement
payer_additional_infostringPayer additional info
payer_neighborhoodstringPayer neighborhood
payer_citystringPayer city
payer_statestringPayer state
payer_zipcodestringPayer zipcode
payer_phone_areastringPayer phone area
payer_phonestringPayer phone
payer_phone2_areastringPayer phone(2) area
payer_phone2stringPayer phone2
payer_tax_idstringPayer's CPF or Inscrição Estadual (i.e)
payer_documentstringPayer's RG or CNPJ
payer_company_namestringPaying company name
payer_countrystringPayer country
payer_emailstringPayer email
payer_genderstringPayer's Gender
Values:
male
female
n/a
total_paidnumberTotal paid by buyer
shippingnumberShipping paid
subtotalnumberSubtotal
discountnumberDiscount
totalnumberTotal
ackbooleanOrder receipt confirmation field
statusstringOrder status
sale_intermediarystringCNPJ of the sales intermediary
payment_intermediarystringCNPJ of the payment intermediary
intermediary_seller_idstringSeller ID, User or email that identifies the seller in the marketplace
payment_installmentsintegerNumber of installments
user_client_idstringPlugg.to user ID
original_idstringoriginal order number (Enter your system number)
expected_send_datestringExpected send date
expected_delivery_datestringExpected delivery date
receiver_schedule_datestringReceiver schedule date
receiver_schedule_periodstringReceiver schedule period
Values:
morning
afternoon
night
stock_codestringProduct stock table name
price_codestringProduct price table name
auto_reservebooleanReserves product inventory by sending the value as "true"
paymentsobjectArray with payment information
shipmentsobjectArray with shipping information
shipping_companystringShipping company
shipping_methodstringShipping method
track_codestringTracking code
externalstringInform the order number
delivery_typestringstandard
express
onehour
pickup
economy
guaranteed
scheduled
international
fulfillment
currencystring'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
channelstringOrder sales channel
channel_accountstringChannel account
label_typestringLabel type
Values:
manual
third_contract
fulfillment
own_contract
pickup_store
drop_shipping
payment_quotanumberValue of installments
payment_interestnumberPayment interest
Language
Click Try It! to start a request and see the response here!