Vtex Order Placement Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "order-placement",
"method": "POST",
"path": "/pvt/orders",
"summary": "VTex Order placement",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"marketplaceOrderId": "1138342255777-01",
"marketplaceServicesEndpoint": "https://marketplaceservicesendpoint.myvtex.com/",
"marketplacePaymentValue": 2499,
"items": [
{
"id": "123456789abc",
"quantity": 1,
"seller": "seller-example",
"commission": 0,
"freightCommission": 0,
"price": 2499,
"bundleItems": [
{
"id": 12,
"quantity": 2
},
{
"id": 5,
"quantity": 1
}
],
"itemsAttachment": [
{
"id": "attachment-1",
"name": "Product Manual",
"url": "https://example.com/manual.pdf"
}
],
"attachments": [
{
"id": "attachment-2",
"name": "Product Image",
"url": "https://example.com/image.jpg"
}
],
"priceTags": [
{
"identifier": "1234abc-5678b-1234c",
"isPercentual": false,
"name": "discount@name-1234abc-5678b-1234c",
"rawValue": 12,
"value": 1200
}
],
"measurementUnit": "g",
"unitMultiplier": 1,
"isGift": false
}
],
"paymentData": null,
"clientProfileData": {
"email": "customer@examplemail.com",
"firstName": "first-name",
"lastName": "last-name",
"documentType": "cpf",
"document": "123456789",
"phone": "+55110988887777",
"corporateName": null,
"tradeName": null,
"corporateDocument": null,
"stateInscription": null,
"corporatePhone": null,
"isCorporate": false
},
"shippingData": {
"address": {
"addressType": "residential",
"receiverName": "receiver-name",
"addressId": "Home",
"postalCode": "12345-000",
"city": "Rio de Janeiro",
"state": "Rio de Janeiro",
"country": "BRA",
"street": "Praia de Botafogo",
"number": "300",
"neighborhood": "Botafogo",
"complement": "3rd floor",
"reference": "Grey building",
"geoCoordinates": [
"49.334934",
"25.401705"
]
},
"logisticsInfo": [
{
"itemIndex": 0,
"selectedSla": "Express",
"lockTTL": "8d",
"shippingEstimate": "7d",
"price": 1099,
"deliveryWindow": {
"startDateUtc": "2016-04-20T08:00:00+00:00",
"endDateUtc": "2016-04-20T12:00:00+00:00",
"listPrice": 10
}
}
],
"updateStatus": "updated"
},
"marketingData": {
"utmSource": "Facebook",
"utmMedium": "CPC",
"utmCampaign": "Black friday",
"utmiPage": "utmi_page-example",
"utmiPart": "utmi_part-exmaple",
"utmiCampaign": "utmi_campaign-exmaple"
},
"openTextField": "open-text-example"
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"marketplaceOrderId": "959311095",
"orderId": "7890",
"followUpEmail": "seller@example.com",
"items": [
{
"id": "2002495",
"quantity": 1,
"seller": "1",
"commission": 0,
"freightCommission": 0,
"price": 2499,
"bundleItems": [],
"itemAttachment": {
"name": null,
"content": {}
},
"attachments": [],
"priceTags": [],
"measurementUnit": "g",
"unitMultiplier": 1,
"isGift": false
}
],
"clientProfileData": {
"email": "customer@examplemail.com.br",
"firstName": "John",
"lastName": "Smith",
"documentType": "taxpayer registration number",
"document": "33333333333",
"phone": "+55110988887777",
"corporateName": null,
"tradeName": null,
"corporateDocument": null,
"stateInscription": null,
"corporatePhone": null,
"isCorporate": false,
"userProfileId": null
},
"shippingData": {
"address": {
"addressType": "residencial",
"receiverName": "John Smith",
"addressId": "Home",
"postalCode": "12345-000",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BRA",
"street": "Praia de Botafogo",
"number": "300",
"neighborhood": "Botafogo",
"complement": "3rd floor",
"reference": "Grey building",
"geoCoordinates": [
"49.334934",
"25.401705"
]
},
"logisticsInfo": [
{
"itemIndex": 0,
"selectedSla": "Express",
"lockTTL": "8d",
"shippingEstimate": "7d",
"price": 1099,
"deliveryWindow": {
"startDateUtc": "2016-04-20T08:00:00+00:00",
"endDateUtc": "2016-04-20T12:00:00+00:00",
"listPrice": 10
}
}
]
},
"customData": {
"openTextField": null,
"marketingData": {
"utmSource": "buscape",
"utmMedium": "",
"utmCampaign": "freeshipping",
"utmiPage": "_",
"utmiPart": "BuscaFullText",
"utmiCampaign": "artscase for iphone 5"
}
},
"paymentData": null,
"allowMultipleDeliveries": true
}
}
]
}