Vtex Createchange 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": "Createchange",
"method": "PATCH",
"path": "/api/order-system/orders/{changeOrderId}/changes",
"summary": "VTex Create order change",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"reason": "The client wants to change a weighable product.",
"replace": [
{
"from": {
"items": [
{
"id": "1",
"quantity": 1
}
]
},
"to": {
"items": [
{
"id": "1",
"quantity": 1,
"measurementUnit": "kg",
"unitMultiplier": 1
}
],
"shippingData": {
"logisticsInfo": [
{
"itemIndex": 0,
"slaId": "Normal",
"deliveryChannel": "delivery",
"addressId": "12334048475146857",
"price": 1000
}
]
}
}
}
]
}
}
],
"responseExamples": [
{
"status": "202",
"contentType": "application/json",
"example": {
"requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46",
"workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a",
"reason": "The client did not like the size.",
"manualDiscountValue": 0,
"manualIncrementValue": 0,
"totalChangeValue": 0,
"totals": [],
"add": null,
"remove": null,
"replace": [
{
"from": {
"paymentData": {
"transactions": []
},
"items": [
{
"id": "31",
"quantity": 1,
"price": null,
"measurementUnit": null,
"unitMultiplier": 0,
"sellingPrice": null,
"name": null,
"detailUrl": null,
"imageUrl": null
}
],
"shippingData": {
"logisticsInfo": []
}
},
"to": {
"items": [
{
"uniqueId": "40E763F4378E4F40AD1FE915FE1078E1",
"id": "1",
"productId": null,
"productRefId": null,
"refId": null,
"ean": null,
"name": null,
"skuName": null,
"modalType": null,
"parentItemIndex": null,
"parentAssemblyBinding": null,
"assemblies": [],
"priceValidUntil": null,
"tax": 0,
"price": null,
"listPrice": null,
"manualPrice": null,
"manualPriceAppliedBy": null,
"sellingPrice": null,
"rewardValue": 0,
"isGift": false,
"additionalInfo": {
"dimension": null,
"brandName": null,
"brandId": null,
"offeringInfo": null,
"offeringType": null,
"offeringTypeId": null,
"categoriesIds": null,
"productClusterId": null,
"commercialConditionId": null
},
"preSaleDate": null,
"productCategoryIds": null,
"productCategories": {},
"quantity": 1,
"seller": null,
"sellerChain": [
null
],
"imageUrl": null,
"detailUrl": null,
"components": [],
"bundleItems": [],
"attachments": [],
"attachmentOfferings": [],
"offerings": [],
"priceTags": [],
"availability": null,
"measurementUnit": "un",
"unitMultiplier": 1,
"manufacturerCode": null,
"priceDefinition": null
}
],
"paymentData": {
"transactions": []
},
"receiptData": null,
"shippingData": {
"logisticsInfo": [
{
"itemIndex": 0,
"selectedSla": "Lenta",
"selectedDeliveryChannel": "delivery",
"addressId": "9ec276fd3a604eb1aa151b5333ca5db6",
"slas": [
{
"id": "Lenta",
"deliveryChannel": "delivery",
"name": "Lenta",
"deliveryIds": [],
"shippingEstimate": null,
"shippingEstimateDate": null,
"lockTTL": null,
"availableDeliveryWindows": [],
"deliveryWindow": null,
"price": 600,
"listPrice": 600,
"tax": 0,
"pickupStoreInfo": {
"isPickupStore": false,
"friendlyName": null,
"address": null,
"additionalInfo": null,
"dockId": null
},
"pickupPointId": null,
"pickupDistance": null,
"polygonName": null,
"transitTime": null
}
],
"shipsTo": [],
"itemId": "1",
"deliveryChannels": [],
"price": 600,
"listPrice": 600,
"shippingEstimate": null,
"dockEstimate": null,
"shippingEstimateDate": null,
"lockTTL": null,
"deliveryCompany": null,
"polygonName": null,
"transitTime": null,
"sellingPrice": 600,
"deliveryIds": [],
"deliveryWindow": null,
"pickupPointId": null,
"pickupStoreInfo": {
"isPickupStore": false,
"friendlyName": null,
"address": null,
"additionalInfo": null,
"dockId": null
},
"pickupDistance": null
}
]
}
}
}
],
"date": "2023-07-27T17:52:18.6483116Z",
"origin": {
"account": "qastore",
"orderId": "v12772213qst-02",
"component": "MarketplaceComponent"
},
"settings": {
"customPaymentSystemsAllowed": []
}
}
}
]
}