Vtex Enqueueneworder 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": "EnqueueNewOrder",
"method": "POST",
"path": "/api/order-integration/orders",
"summary": "VTex New Order Integration",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"marketplaceOrderId": "{{$guid}}",
"marketplaceOrderStatus": "NEW",
"marketplacePaymentValue": 3025,
"connectorName": "SkyHub",
"connectorEndpoint": "https://connector-endpoint.com/api/vtex",
"allowFranchises": false,
"pickupAccountName": "",
"items": [
{
"id": "1",
"price": 975,
"quantity": 1
}
],
"clientProfileData": {
"email": "email@email.com.br",
"firstName": "John",
"lastName": "Doe",
"phone": "99999999999",
"document": "99999999999",
"corporateDocument": null,
"corporatePhone": null,
"corporateName": null,
"tradeName": null,
"stateInscription": null
},
"shippingData": {
"logisticsInfo": [
{
"price": 2050,
"selectedDeliveryChannel": "delivery",
"selectedSla": "Express",
"lockTTL": "1d",
"shippingEstimate": "2d",
"deliveryIds": {
"warehouseId": "AR1"
}
}
],
"selectedAddresses": [
{
"addressType": "Residential",
"addressId": "1",
"receiverName": "John Doe",
"postalCode": "81020-235",
"city": "Curitiba",
"state": "PR",
"country": "BRA",
"street": "Rua Eduardo Carlos Pereira",
"number": "4125",
"neighborhood": "Port\u00e3o",
"complement": "101",
"geoCoordinates": {
"latitude": "-29.5",
"longitude": "-45.8"
}
}
],
"isFob": true,
"isMarketplaceFulfillment": true
},
"invoiceData": {
"userPaymentInfo": {
"paymentMethods": [
"creditCardPaymentGroup"
]
}
},
"customData": {
"customApps": [
{
"id": "marketplace-integration",
"major": 1,
"fields": {
"marketplacePaymentMethod": "credit card"
}
}
]
}
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"marketplaceOrderId": null,
"accountName": "grocery1",
"code": "SOI003",
"flow": "PlaceOrder",
"success": true,
"operationId": null,
"errors": null,
"fields": null,
"message": "Order successfully enqueued"
}
},
{
"status": "default",
"contentType": "application/json",
"example": {
"marketplaceOrderId": null,
"accountName": "grocery1",
"code": "SOI003",
"flow": "PlaceOrder",
"success": true,
"operationId": null,
"errors": null,
"fields": null,
"message": "Order successfully enqueued"
}
}
]
}