post https://api.plugg.to/orders
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:
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_city | string | Receiver city |
receiver_state | string | Receiver state |
receiver_email | string | Receiver email |
receiver_zipcode | string | Receiver zipcode |
receiver_phone | string | Receiver phone |
receiver_phone2_area | string | Receiver phone2 area |
receiver_phone2 | string | Receiver phone2 |
receiver_neighborhood | string | Receiver neighborhood |
receiver_phone_area | string | Receiver phone area |
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_zipcode | string | Payer zipcode |
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_tax_id | string | Payer's CPF or CNPJ |
payer_document | string | Payer's RG or Inscrição Estadual (i.e) |
payer_company_name | string | Paying company name |
payer_country | string | Payer country |
payer_email | string | Payer email |
payer_gender | string | Payer's Gender Values: male female n/a |
total_paid | number | Total paid by buyer |
shipping | number | Shipping paid |
subtotal | number | Subtotal |
discount | number | Discount |
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 |
payment_installments | integer | Number of installments |
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 |
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 |
payment_quota | number | Value of installments |
payment_interest | number | Payment interest |