Get order modifications details
This endpoint retrieves detailed information about a specific order modification. So after creating multiple modifications, you can get information on each one of them by its changeRequestId, the unique identification code generated by the Create order modifications endpoint.
The successful status code is 200 OK, and its response body schema is very similar to the Create order modifications endpoint, with some additional fields:
-
status: The modification request status in the workflow, which progresses in the following order:
- waiting-acknowledgement
- waiting-confirmation
- done
- canceled
-
inProgress: When set as true, the order is still progressing in the order flow, when set as false, it is complete, whether by cancellation or because the customer received it.
-
logs: Lists the workflow processing logs.
If you want information about all the modifications made to an order, use the Get order modifications history endpoint.
Permissions
Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:
| Product | Category | Resource |
|---|---|---|
| Checkout | CheckoutResources | Orders Full Access |
| OMS | OMS access | Cancel order |
| OMS | OMS access | Change order |
You can create a custom role with that resource or use one of the following predefined roles:
| Role | Resource |
|---|---|
| Checkout Admin | Orders Full Access |
| OMS - Full access | <p>Cancel order</p><p>Change order</p> |
| IntegrationProfile - Fulfillment Oms | <p>Cancel order</p><p>Change order</p> |
| IntegrationProfile - Fulfillment Gateway | Cancel order |
| IntegrationProfile - Fulfillment Gateway Oms | <p>Cancel order</p><p>Change order</p> |
| inStore Sales Person | <p>Cancel order</p><p>Change order</p> |
❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys.
To learn more about machine authentication at VTEX, see Authentication overview.
Path parameters
Order ID of the order you wish to get the modification detail.
Once you make an order modification, you generate a requestId code that identifies the modifications made to that order. This field should be filled with that code. There are no limits to modifications you can perform using the same changeRequestId, and we recommend keeping all modifications of a given order grouped by the same changeRequestId, so you will have a unified modification history.
Query parameters
Name of the VTEX account that created the order.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Response
OK
Example response
{
"replace": [
{
"from": {
"paymentData": {
"transactions": [
"creditcard"
]
}
},
"to": {
"items": [
{
"uniqueId": "40E763F4378E4F40AD1FE915FE1078E1",
"id": "3",
"productId": "7",
"productRefId": "smallcup",
"refId": "356",
"ean": "8745121641680",
"name": "Small cup of coffee with pink logo",
"skuName": "Small blue cup",
"modalType": "GLASS",
"priceValidUntil": "2023-03-01T22:58:28.143",
"price": 600,
"listPrice": 600,
"manualPrice": 6500,
"manualPriceAppliedBy": "4cc81d44-e42e-464b-8199-1e883bf4ab6b",
"sellingPrice": 600,
"rewardValue": 50,
"additionalInfo": {
"brandName": "Special coffee cup",
"brandId": "2000001",
"productClusterId": "135,137,143,518,1272",
"commercialConditionId": "5"
},
"preSaleDate": "2023-01-01T00:00:00.0000000+00:00",
"productCategoryIds": "/2/",
"productCategories": {
"2": "Clothes"
},
"quantity": 1,
"seller": "1",
"imageUrl": "http://store.com.br/ids/155419-55-55//cupcoffee.png?v=6368858582363",
"detailUrl": "/cup-coffee/p",
"availability": "available",
"measurementUnit": "un",
"unitMultiplier": 1,
"manufacturerCode": "manf-00005"
}
],
"paymentData": {
"transactions": [
"creditcard"
]
},
"shippingData": {
"logisticsInfo": [
{
"selectedSla": "Normal",
"addressId": "9ec276fd3a604eb1aa151b5333ca5db7",
"slas": [
{
"id": "Normal",
"deliveryChannel": "delivery",
"name": "Normal",
"deliveryIds": [
{
"courierId": "1c083bf",
"warehouseId": "1_1",
"dockId": "1",
"courierName": "Donkey",
"quantity": 1,
"kitItemDetails": [],
"accountCarrierName": null
}
],
"shippingEstimate": "3bd",
"shippingEstimateDate": "2023-07-27T17:52:18.6483116Z",
"lockTTL": "1bd",
"deliveryWindow": {
"startDateUtc": "2024-03-14T00:00:00+00:00",
"endDateUtc": "2024-03-14T23:59:59+00:00"
},
"price": 600,
"listPrice": 600,
"pickupStoreInfo": {
"dockId": "dockAjs28"
},
"pickupPointId": "pup215rkw",
"pickupDistance": 1,
"polygonName": "114 - Polanco _ H-05",
"transitTime": "3bd"
}
],
"shipsTo": [
"BRA"
],
"itemId": "3",
"deliveryChannels": [
{
"id": "delivery"
}
],
"price": 600,
"listPrice": 600,
"shippingEstimate": "2023-07-29T17:52:18.6483116Z",
"dockEstimate": "1bd",
"shippingEstimateDate": "3bd",
"lockTTL": "1bd",
"deliveryCompany": "Correios",
"polygonName": "114 - Polanco _ H-05",
"transitTime": "3bd",
"sellingPrice": 600,
"deliveryIds": [
{
"courierId": "1c083bf",
"warehouseId": "1_1",
"dockId": "1",
"courierName": "Donkey",
"quantity": 1,
"kitItemDetails": [],
"accountCarrierName": null
}
],
"pickupPointId": "pup215rkw",
"pickupStoreInfo": {
"dockId": "dockAjs28"
}
}
]
}
}
}
]
}