diff --git a/PostmanCollections/VTEX - Orders API.json b/PostmanCollections/VTEX - Orders API.json index 1320ac46a..888fa9074 100644 --- a/PostmanCollections/VTEX - Orders API.json +++ b/PostmanCollections/VTEX - Orders API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "67a458d0-21f2-4ec7-ad24-fe8b34c93b0c" + "postman_id": "d1dacbca-07cc-40c6-a2e2-fe5c621e48d0" }, "item": [ { - "id": "0df655e6-8738-42d4-8932-207e10928023", + "id": "9f60f401-194d-41c8-bc37-009a362b66b8", "name": "Orders", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "5ef2f550-9ccd-44c9-ab57-b38500ed30e2", + "id": "99bf6ddf-eae1-492b-bab8-70a89d7587d6", "name": "Get order", "request": { "name": "Get order", @@ -77,7 +77,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7a89c3bb-998b-4c78-8ad6-36750a77886b", + "id": "ba3bc35d-7cfa-4bb7-b9c7-925ee9adc7f3", "name": "OK", "originalRequest": { "url": { @@ -145,7 +145,7 @@ { "listen": "test", "script": { - "id": "c5ffb6dc-f15c-4dd5-8def-6226d8bd7ac9", + "id": "45d5361f-6039-43a9-93ef-770c5be6b5b1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/orders/:orderId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -161,7 +161,158 @@ } }, { - "id": "798141b0-3128-4dc4-ab7b-4a6ac9cc8ea5", + "id": "a78949ab-a9d3-42ac-85ee-63d1419149bb", + "name": "Get orders by order group ID", + "request": { + "name": "Get orders by order group ID", + "description": { + "content": "Retrieves details about all orders related to the same purchase by searching by order group ID.\r\n\r\n>⚠️ Throttling: Each VTEX account can make up to 6000 requests per minute.\r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | View order |\r\n| Checkout Admin | View order |\r\n| IntegrationProfile - Fulfillment Oms | View order |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", + "type": "text/plain" + }, + "url": { + "path": [ + "api", + "oms", + "pvt", + "orders", + "order-group", + ":orderGroup" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Order group ID is a code part of the order ID that groupes all orders related to the same purchase. For example, when an order is fullfilled by multiple sellers, each seller has its own order ID (`v71021570str-01` and `v71021570str-02`), but they share the same order group ID (`v71021570str`).", + "type": "text/plain" + }, + "type": "any", + "value": "71021570", + "key": "orderGroup" + } + ] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "9ba944fb-f720-4c69-9907-3f05b65961f1", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "api", + "oms", + "pvt", + "orders", + "order-group", + ":orderGroup" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"orderId\": \"v71425090str-01\",\n \"sequence\": \"71425090\",\n \"marketplaceOrderId\": \"\",\n \"marketplaceServicesEndpoint\": \"http://oms.vtexinternal.com.br/api/oms?an=str\",\n \"sellerOrderId\": \"00-v71425090str-01\",\n \"origin\": \"Marketplace\",\n \"affiliateId\": \"\",\n \"salesChannel\": \"1\",\n \"merchantName\": null,\n \"status\": \"\",\n \"statusDescription\": null,\n \"value\": 5458,\n \"creationDate\": \"2024-10-09T19:25:26.5838646+00:00\",\n \"lastChange\": \"2024-10-09T19:26:29.6119318+00:00\",\n \"orderGroup\": \"v71425090str\",\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total Items\",\n \"value\": 6999\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total Discounts\",\n \"value\": -1750\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total Freight\",\n \"value\": 209,\n \"alternativeTotals\": [\n {\n \"id\": \"AlternativeShippingTotal\",\n \"name\": \"Alternative Shipping Total\",\n \"value\": 2435\n },\n {\n \"id\": \"AlternativeShippingDiscount\",\n \"name\": \"Alternative Shipping Discount\",\n \"value\": -2226\n }\n ]\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total Tax\",\n \"value\": 0\n }\n ],\n \"items\": [\n {\n \"uniqueId\": \"E1CA66F73B8746B19AE2A9CFB2D2D260\",\n \"id\": \"5830010\",\n \"productId\": \"4301268\",\n \"ean\": null,\n \"lockId\": \"00-v71425090str-01\",\n \"itemAttachment\": {\n \"content\": {},\n \"name\": null\n },\n \"attachments\": [],\n \"quantity\": 1,\n \"seller\": \"1\",\n \"name\": \"white cotton shirt M\",\n \"refId\": \"11167127\",\n \"price\": 6999,\n \"listPrice\": 6999,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"priceTags\": [\n {\n \"name\": \"DISCOUNT@MARKETPLACE\",\n \"value\": -1750,\n \"isPercentual\": false,\n \"identifier\": \"026be20b-9839-486e-9e6e-8987a93eb92a\",\n \"rawValue\": -17.5,\n \"rate\": null,\n \"jurisCode\": null,\n \"jurisType\": null,\n \"jurisName\": null\n }\n ],\n \"imageUrl\": \"https://str.vteximg.com.br/files/ids/56901106-200-240/white-cotton-shirt.jpg?v=638108542148100000\",\n \"detailUrl\": \"/white-cotton-shirt/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"params\": [],\n \"offerings\": [],\n \"attachmentOfferings\": [],\n \"sellerSku\": \"5830010\",\n \"priceValidUntil\": null,\n \"commission\": 0,\n \"tax\": 0,\n \"preSaleDate\": null,\n \"additionalInfo\": {\n \"brandName\": \"STR\",\n \"brandId\": \"1\",\n \"categoriesIds\": \"/1000083/1004135/1004138/\",\n \"categories\": [\n {\n \"id\": 1004138,\n \"name\": \"Shirts\"\n },\n {\n \"id\": 1004135,\n \"name\": \"Clothes\"\n },\n {\n \"id\": 1000083,\n \"name\": \"Male fashion\"\n }\n ],\n \"productClusterId\": \"8896,9708,9922,10068,11240,13213,15891,16552,17287,17349,17415,17436,17465,17630,17775,17785,17822,17836,17992,18126,18187,18224,18231,18234,18265,18269,18292,18335,18348,18363,18379,18398,18410,18419,18422,18442,18472,18509,18519,18658,18674,18681,18695,18701,18715,18847,18855,18896,18912,18916,18927,18959,18969,18971,18999,19016,19023,19035,19072,19107,19147,19151,19206,19230,19242,19387,19422,19454,19481,19482,19588,19597,19603,19640,19660,19671,19681,19699,19721,19738,19739\",\n \"commercialConditionId\": \"1\",\n \"dimension\": {\n \"cubicweight\": 0.5208,\n \"height\": 10,\n \"length\": 25,\n \"weight\": 210,\n \"width\": 10\n },\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"measurementUnit\": \"un\",\n \"unitMultiplier\": 1,\n \"sellingPrice\": 5249,\n \"isGift\": false,\n \"shippingPrice\": null,\n \"rewardValue\": 0,\n \"freightCommission\": 0,\n \"priceDefinition\": {\n \"sellingPrices\": [\n {\n \"value\": 5249,\n \"quantity\": 1\n }\n ],\n \"calculatedSellingPrice\": 5249,\n \"total\": 5249,\n \"reason\": null\n },\n \"taxCode\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"callCenterOperator\": null,\n \"serialNumbers\": null,\n \"assemblies\": [],\n \"costPrice\": 6998\n }\n ],\n \"marketplaceItems\": [],\n \"clientProfileData\": {\n \"id\": \"clientProfileData\",\n \"email\": \"cmlsmith@email.com\",\n \"firstName\": \"Camila\",\n \"lastName\": \"Smith\",\n \"documentType\": \"cpf\",\n \"document\": \"15586841755\",\n \"phone\": \"+5521975366533\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"userProfileId\": \"e366889f-9d07-4076-a78d-72af8fdfd7e7\",\n \"userProfileVersion\": null,\n \"customerClass\": null,\n \"customerCode\": null\n },\n \"giftRegistryData\": null,\n \"marketingData\": {\n \"id\": \"marketingData\",\n \"utmSource\": \"delorean\",\n \"utmPartner\": null,\n \"utmMedium\": \"mystr\",\n \"utmCampaign\": \"johnvasconcelosg\",\n \"coupon\": \"\",\n \"utmiCampaign\": \"\",\n \"utmipage\": \"\",\n \"utmiPart\": \"\",\n \"marketingTags\": [\n \"mstr_servicos\",\n \"mstr_delorean\",\n \"mstr_johnvasconcelosg\",\n \"mstr_mystr\",\n \"mobile\",\n \"Delivery\",\n \"STR\"\n ]\n },\n \"ratesAndBenefitsData\": {\n \"id\": \"ratesAndBenefitsData\",\n \"rateAndBenefitsIdentifiers\": [\n {\n \"description\": \"ID\\t518\\nValis purchases\\tMy STR;CRM;POM;\\nWeek\\t202441\\nDate_begin\\t07/10/2024 14:00\\nDate_end\\t22/10/2024\\nName_promotion\\t25%_3PC_W41_07-10-2024\\n\\nValid_for\\tColection\\t19738\\nChannel\\tApp;Site;\\nName_requester\\tJohn Carlos\\nEmail_requester\\tjohn.c@str.com\\nAuthor\\tGuilherme Verner\",\n \"featured\": false,\n \"id\": \"026be20b-9839-486e-9e6e-8987a93eb92a\",\n \"name\": \"25%_3PC_W41_07-10-2024\",\n \"matchedParameters\": {\n \"Seller@CatalogSystem\": \"1|inclusive\"\n },\n \"additionalInfo\": null\n }\n ]\n },\n \"shippingData\": {\n \"id\": \"shippingData\",\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"Camila Smith\",\n \"addressId\": \"968d3b10816145878aa09b320f7e688a\",\n \"versionId\": null,\n \"entityId\": null,\n \"postalCode\": \"21020-402\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Couto\",\n \"number\": \"29\",\n \"neighborhood\": \"Penha\",\n \"complement\": \"Bloco 5 apt 321\",\n \"reference\": \"Next to the Shopping\",\n \"geoCoordinates\": [\n -43.27359390258789,\n -22.835159301757812\n ]\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"itemId\": \"5830010\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"selectedSla\": \"Normal\",\n \"lockTTL\": \"12d\",\n \"price\": 209,\n \"listPrice\": 2435,\n \"sellingPrice\": 209,\n \"deliveryWindow\": null,\n \"deliveryCompany\": \"ASAPLAG_CR\",\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": \"2024-10-11T18:00:00.0000000+00:00\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"name\": \"Normal\",\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": \"2024-10-11T18:00:00.0000000+00:00\",\n \"deliveryWindow\": null,\n \"availableDeliveryWindows\": [],\n \"deliveryIds\": [\n {\n \"courierId\": \"ASAPLAG_CR\",\n \"courierName\": \"ASAPLAG_CR\",\n \"dockId\": \"6\",\n \"quantity\": 1,\n \"warehouseId\": \"1_1\",\n \"accountCarrierName\": \"str\",\n \"kitItemDetails\": []\n }\n ],\n \"listPrice\": 2435,\n \"price\": 209,\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"polygonName\": \"\",\n \"lockTTL\": \"12d\",\n \"pickupPointId\": null,\n \"transitTime\": \"1bd\",\n \"pickupDistance\": 0\n },\n {\n \"id\": \"Gift\",\n \"name\": \"Gift\",\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"deliveryWindow\": null,\n \"availableDeliveryWindows\": [],\n \"deliveryIds\": [\n {\n \"courierId\": \"ASAPLAG_CR_GIFT\",\n \"courierName\": \"ASAPLAG_CR_GIFT\",\n \"dockId\": \"1317c52\",\n \"quantity\": 1,\n \"warehouseId\": \"1_1\",\n \"accountCarrierName\": \"str\",\n \"kitItemDetails\": []\n }\n ],\n \"listPrice\": 4435,\n \"price\": 1399,\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"polygonName\": \"\",\n \"lockTTL\": \"12d\",\n \"pickupPointId\": null,\n \"transitTime\": \"1bd\",\n \"pickupDistance\": 0\n },\n {\n \"id\": \"Pickup at store (CAR)\",\n \"name\": \"Pickup at store (CAR)\",\n \"shippingEstimate\": \"1bd\",\n \"shippingEstimateDate\": null,\n \"deliveryWindow\": null,\n \"availableDeliveryWindows\": [],\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"courierName\": \"Flexible shipping\",\n \"dockId\": \"1\",\n \"quantity\": 1,\n \"warehouseId\": \"1_2\",\n \"accountCarrierName\": \"strcar\",\n \"kitItemDetails\": []\n }\n ],\n \"listPrice\": 0,\n \"price\": 0,\n \"deliveryChannel\": \"pickup-in-point\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": \"{\\\"phoneNumber\\\":\\\"(21) 3317-6791 \\\",\\\"pickupInstructions\\\":\\\"Present document with photo\\\"}\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"CAR\",\n \"versionId\": null,\n \"entityId\": null,\n \"postalCode\": \"21210000\",\n \"city\": \"Rio De Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Avenida Vicente De Carvalho\",\n \"number\": \"909\",\n \"neighborhood\": \"Vicente De Carvalho\",\n \"complement\": \"Store STR Store 101\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.31001,\n -22.84991\n ]\n },\n \"dockId\": null,\n \"friendlyName\": \"STR Carioca Shopping - Pickup at store\",\n \"isPickupStore\": true\n },\n \"polygonName\": \"\",\n \"lockTTL\": \"12d\",\n \"pickupPointId\": \"strcar_CAR\",\n \"transitTime\": \"1bd\",\n \"pickupDistance\": 4.076280117034912\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"deliveryIds\": [\n {\n \"courierId\": \"ASAPLAG_CR\",\n \"courierName\": \"ASAPLAG_CR\",\n \"dockId\": \"6\",\n \"quantity\": 1,\n \"warehouseId\": \"1_1\",\n \"accountCarrierName\": \"str\",\n \"kitItemDetails\": []\n }\n ],\n \"deliveryChannels\": [\n {\n \"id\": \"delivery\",\n \"stockBalance\": 0\n },\n {\n \"id\": \"pickup-in-point\",\n \"stockBalance\": 0\n }\n ],\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"addressId\": \"968d3b10816145878aa09b320f7e688a\",\n \"versionId\": null,\n \"entityId\": null,\n \"polygonName\": \"\",\n \"pickupPointId\": null,\n \"transitTime\": \"1bd\"\n }\n ],\n \"trackingHints\": null,\n \"selectedAddresses\": [\n {\n \"addressId\": \"968d3b10816145878aa09b320f7e688a\",\n \"versionId\": null,\n \"entityId\": null,\n \"addressType\": \"residential\",\n \"receiverName\": \"Camila Smith\",\n \"street\": \"Couto\",\n \"number\": \"29\",\n \"complement\": \"Building 3 apt 321\",\n \"neighborhood\": \"Penha\",\n \"postalCode\": \"21020-402\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"reference\": \"Next to the Shopping\",\n \"geoCoordinates\": [\n -43.27359390258789,\n -22.835159301757812\n ]\n }\n ],\n \"availableAddresses\": [\n {\n \"addressId\": \"968d3b10816145878aa09b320f7e688a\",\n \"versionId\": null,\n \"entityId\": null,\n \"addressType\": \"residential\",\n \"receiverName\": \"Camila Smith\",\n \"street\": \"Couto\",\n \"number\": \"29\",\n \"complement\": \"Building 3 apt 321\",\n \"neighborhood\": \"Penha\",\n \"postalCode\": \"21020-402\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"reference\": \"Next to the Shopping\",\n \"geoCoordinates\": [\n -43.27359390258789,\n -22.835159301757812\n ]\n }\n ],\n \"contactInformation\": []\n },\n \"paymentData\": {\n \"giftCards\": [],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"A599C01B84114016884B143BED05A3GG\",\n \"merchantName\": \"STR\",\n \"payments\": [\n {\n \"id\": \"B004B117C52F405FB2AE82835373186D\",\n \"paymentSystem\": \"125\",\n \"paymentSystemName\": \"Pix\",\n \"value\": 22745,\n \"installments\": 1,\n \"referenceValue\": 22745,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": null,\n \"giftCardId\": null,\n \"giftCardName\": null,\n \"giftCardCaption\": null,\n \"redemptionCode\": null,\n \"group\": \"instantPayment\",\n \"tid\": \"89781829739\",\n \"dueDate\": null,\n \"connectorResponses\": {\n \"Tid\": \"89781829739\",\n \"ReturnCode\": null,\n \"Message\": null,\n \"authId\": \"89781829739\",\n \"nsu\": \"89781829739\",\n \"acquirer\": \"paymarket\"\n },\n \"giftCardProvider\": null,\n \"giftCardAsDiscount\": null,\n \"koinUrl\": null,\n \"accountId\": null,\n \"parentAccountId\": null,\n \"bankIssuedInvoiceIdentificationNumber\": null,\n \"bankIssuedInvoiceIdentificationNumberFormatted\": null,\n \"bankIssuedInvoiceBarCodeNumber\": null,\n \"bankIssuedInvoiceBarCodeType\": null,\n \"billingAddress\": null,\n \"paymentOrigin\": null\n }\n ]\n }\n ]\n },\n \"packageAttachment\": {\n \"packages\": []\n },\n \"sellers\": [\n {\n \"id\": \"1\",\n \"name\": \"STR\",\n \"logo\": \"\",\n \"fulfillmentEndpoint\": \"http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=str\"\n }\n ],\n \"callCenterOperatorData\": null,\n \"followUpEmail\": \"90ea3ef8b6a64b2588f4bc6cb8617acd@ct.vtex.com\",\n \"lastMessage\": null,\n \"hostname\": \"str\",\n \"invoiceData\": null,\n \"changesAttachment\": null,\n \"openTextField\": null,\n \"roundingError\": 0,\n \"orderFormId\": \"066ab2f7f65043a3aa396c749e202fd3\",\n \"commercialConditionData\": null,\n \"isCompleted\": true,\n \"customData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"BRA\",\n \"currencyCode\": \"BRL\",\n \"currencyFormatInfo\": {\n \"CurrencyDecimalDigits\": 2,\n \"CurrencyDecimalSeparator\": \",\",\n \"CurrencyGroupSeparator\": \".\",\n \"CurrencyGroupSize\": 3,\n \"StartsWithCurrencySymbol\": true\n },\n \"currencyLocale\": 1046,\n \"currencySymbol\": \"R$\",\n \"timeZone\": \"E. South America Standard Time\"\n },\n \"allowCancellation\": true,\n \"allowEdition\": false,\n \"isCheckedIn\": false,\n \"marketplace\": {\n \"baseURL\": \"http://oms.vtexinternal.com.br/api/oms?an=str\",\n \"isCertified\": null,\n \"name\": \"str\"\n },\n \"authorizedDate\": null,\n \"invoicedDate\": null,\n \"cancelReason\": null,\n \"itemMetadata\": {\n \"Items\": [\n {\n \"Id\": \"6193892\",\n \"Seller\": \"1\",\n \"Name\": \"oversized tshirt brown\",\n \"SkuName\": \"G\",\n \"ProductId\": \"4451807\",\n \"RefId\": \"11493357\",\n \"Ean\": null,\n \"ImageUrl\": \"https://str.vteximg.com.br/files/ids/58461640-200-240/photo-1.jpg?v=638446429959270000\",\n \"DetailUrl\": \"/oversized-tshirt-brown_e2/p\",\n \"AssemblyOptions\": []\n },\n {\n \"Id\": \"5830010\",\n \"Seller\": \"1\",\n \"Name\": \"oversized tshirt blue\",\n \"SkuName\": \"GG\",\n \"ProductId\": \"4301268\",\n \"RefId\": \"11167127\",\n \"Ean\": null,\n \"ImageUrl\": \"https://str.vteximg.com.br/files/ids/56901106-200-240/1045935-blue.jpg?v=638108542148100000\",\n \"DetailUrl\": \"/oversized-tshirt-blue-1045935-branco/p\",\n \"AssemblyOptions\": []\n }\n ]\n },\n \"subscriptionData\": null,\n \"taxData\": null,\n \"checkedInPickupPointId\": null,\n \"cancellationData\": null,\n \"cancellationRequests\": null,\n \"clientPreferencesData\": {\n \"locale\": \"pt-BR\",\n \"optinNewsLetter\": true\n }\n },\n {\n \"orderId\": \"v71425090str-02\",\n \"sequence\": \"71425091\",\n \"marketplaceOrderId\": \"\",\n \"marketplaceServicesEndpoint\": null,\n \"sellerOrderId\": \"SLR-v71425090str-02\",\n \"origin\": \"Marketplace\",\n \"affiliateId\": \"\",\n \"salesChannel\": \"1\",\n \"merchantName\": null,\n \"status\": \"\",\n \"statusDescription\": null,\n \"value\": 6208,\n \"creationDate\": \"2024-10-09T19:25:26.5841061+00:00\",\n \"lastChange\": \"2024-10-09T19:26:29.6129583+00:00\",\n \"orderGroup\": \"v71425090str\",\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total Items\",\n \"value\": 7999\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total Discounts\",\n \"value\": -2000\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total Freight\",\n \"value\": 209,\n \"alternativeTotals\": [\n {\n \"id\": \"AlternativeShippingTotal\",\n \"name\": \"Alternative Shipping Total\",\n \"value\": 2455\n },\n {\n \"id\": \"AlternativeShippingDiscount\",\n \"name\": \"Alternative Shipping Discount\",\n \"value\": -2246\n }\n ]\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total Tax\",\n \"value\": 0\n }\n ],\n \"items\": [\n {\n \"uniqueId\": \"54638748C4D54F6CBAA738737E65D594\",\n \"id\": \"6229640\",\n \"productId\": \"4460339\",\n \"ean\": null,\n \"lockId\": null,\n \"itemAttachment\": {\n \"content\": {},\n \"name\": null\n },\n \"attachments\": [],\n \"quantity\": 1,\n \"seller\": \"strbar\",\n \"name\": \"cropped brown G\",\n \"refId\": \"11455795\",\n \"price\": 7999,\n \"listPrice\": 7999,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"priceTags\": [\n {\n \"name\": \"discount@price-026be20b-9839-486e-9e6e-8987a93eb92a#5420fe70-7470-4b79-9741-80d951e451b2\",\n \"value\": -2000,\n \"isPercentual\": false,\n \"identifier\": \"026be20b-9839-486e-9e6e-8987a93eb92a\",\n \"rawValue\": -20,\n \"rate\": null,\n \"jurisCode\": null,\n \"jurisType\": null,\n \"jurisName\": null\n }\n ],\n \"imageUrl\": \"https://str.vteximg.com.br/files/ids/58845769-200-240/photo-0.jpg?v=638569102126000000\",\n \"detailUrl\": \"/cropped-brown-1065805_e2/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"params\": [],\n \"offerings\": [],\n \"attachmentOfferings\": [],\n \"sellerSku\": \"6229640\",\n \"priceValidUntil\": \"2044-05-29T14:00:00.0000000+00:00\",\n \"commission\": 0,\n \"tax\": 0,\n \"preSaleDate\": null,\n \"additionalInfo\": {\n \"brandName\": \"C&A\",\n \"brandId\": \"1\",\n \"categoriesIds\": \"/1000003/1004161/1004162/\",\n \"categories\": [\n {\n \"id\": 1004162,\n \"name\": \"Tops\"\n },\n {\n \"id\": 1004161,\n \"name\": \"Clothes\"\n },\n {\n \"id\": 1000003,\n \"name\": \"Women Fashion\"\n }\n ],\n \"productClusterId\": \"8896,9708,9922,10068,11240,11577,13213,14487,15891,18170,18224,19010,19107,19122,19132,19482,19500,19519,19588,19597,19720,19736,19738,19742\",\n \"commercialConditionId\": \"1\",\n \"dimension\": {\n \"cubicweight\": 1,\n \"height\": 100,\n \"length\": 100,\n \"weight\": 200,\n \"width\": 100\n },\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"measurementUnit\": \"un\",\n \"unitMultiplier\": 1,\n \"sellingPrice\": 5999,\n \"isGift\": false,\n \"shippingPrice\": null,\n \"rewardValue\": 0,\n \"freightCommission\": 0,\n \"priceDefinition\": {\n \"sellingPrices\": [\n {\n \"value\": 5999,\n \"quantity\": 1\n }\n ],\n \"calculatedSellingPrice\": 5999,\n \"total\": 5999,\n \"reason\": null\n },\n \"taxCode\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"callCenterOperator\": null,\n \"serialNumbers\": null,\n \"assemblies\": [],\n \"costPrice\": null\n }\n ],\n \"marketplaceItems\": [],\n \"clientProfileData\": {\n \"id\": \"clientProfileData\",\n \"email\": \"cmlsmith@email.com\",\n \"firstName\": \"Camila\",\n \"lastName\": \"Smith\",\n \"documentType\": \"cpf\",\n \"document\": \"15586841755\",\n \"phone\": \"+5521975366533\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"userProfileId\": \"e366889f-9d07-4076-a78d-72af8fdfd7e7\",\n \"userProfileVersion\": null,\n \"customerClass\": null,\n \"customerCode\": null\n },\n \"giftRegistryData\": null,\n \"marketingData\": {\n \"id\": \"marketingData\",\n \"utmSource\": \"delorean\",\n \"utmPartner\": null,\n \"utmMedium\": \"mystr\",\n \"utmCampaign\": \"johnvasconcelosg\",\n \"coupon\": \"\",\n \"utmiCampaign\": \"\",\n \"utmipage\": \"\",\n \"utmiPart\": \"\",\n \"marketingTags\": [\n \"mstr_servicos\",\n \"mstr_delorean\",\n \"mstr_johnvasconcelosg\",\n \"mstr_mystr\",\n \"mobile\",\n \"Delivery\",\n \"STR\"\n ]\n },\n \"ratesAndBenefitsData\": {\n \"id\": \"ratesAndBenefitsData\",\n \"rateAndBenefitsIdentifiers\": [\n {\n \"description\": \"ID\\t518\\nValid purchases in\\tMy STR;CRM;POM;\\nWeek\\t202441\\nDate_begin\\t07/10/2024 14:00\\nDate_end\\t22/10/2024 12:00\\nName_promotion\\t25%_3PC_W41_07-10-2024\\nMecanic\\t25% off\\nSeller\\tSTR\\nValid_for\\tColection\\t19738\\nChannel\\tApp;Site;\\nName_requester\\tJohn Carlos\\nEmail_requester\\tjose.c@str.com\\nAuthor\\tGuilherme Verner\",\n \"featured\": false,\n \"id\": \"026be20b-9839-486e-9e6e-8987a93eb92a\",\n \"name\": \"25%_3PC_W41_07-10-2024\",\n \"matchedParameters\": {\n \"Seller@CatalogSystem\": \"1|inclusive\"\n },\n \"additionalInfo\": null\n }\n ]\n },\n \"shippingData\": {\n \"id\": \"shippingData\",\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"Camila Smith\",\n \"addressId\": \"968d3b10816145878aa09b320f7e688a\",\n \"versionId\": null,\n \"entityId\": null,\n \"postalCode\": \"21020-402\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Couto\",\n \"number\": \"29\",\n \"neighborhood\": \"Penha\",\n \"complement\": \"Building 3 apt 321\",\n \"reference\": \"Next to the Shopping\",\n \"geoCoordinates\": [\n -43.27359390258789,\n -22.835159301757812\n ]\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"itemId\": \"6229640\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"selectedSla\": \"Normal\",\n \"lockTTL\": \"12d\",\n \"price\": 209,\n \"listPrice\": 2455,\n \"sellingPrice\": 209,\n \"deliveryWindow\": null,\n \"deliveryCompany\": \"ASAPLAG_NORMAL\",\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": \"2024-10-11T20:00:00.0000000+00:00\",\n \"slas\": [\n {\n \"id\": \"Pickup at store (BAR)\",\n \"name\": \"Pickup at store (BAR)\",\n \"shippingEstimate\": \"1bd\",\n \"shippingEstimateDate\": null,\n \"deliveryWindow\": null,\n \"availableDeliveryWindows\": [],\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"courierName\": \"Flexible shipping\",\n \"dockId\": \"1\",\n \"quantity\": 1,\n \"warehouseId\": \"1_2\",\n \"accountCarrierName\": \"strbar\",\n \"kitItemDetails\": []\n }\n ],\n \"listPrice\": 0,\n \"price\": 0,\n \"deliveryChannel\": \"pickup-in-point\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": \"{\\\"phoneNumber\\\":\\\"(21) 2107-0063\\\",\\\"pickupInstructions\\\":\\\"Present document with photo\\\"}\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BAR\",\n \"versionId\": null,\n \"entityId\": null,\n \"postalCode\": \"22631004\",\n \"city\": \"Rio De Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Av. Das Americas\",\n \"number\": \"4666\",\n \"neighborhood\": \"Barra Da Tijuca\",\n \"complement\": \"Store STR Store A - BAR 530\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.35817,\n -22.9973\n ]\n },\n \"dockId\": null,\n \"friendlyName\": \"STR Barra Shopping - Pickup at store\",\n \"isPickupStore\": true\n },\n \"polygonName\": \"\",\n \"lockTTL\": \"12d\",\n \"pickupPointId\": \"strbar_BAR\",\n \"transitTime\": \"1bd\",\n \"pickupDistance\": 20.0021915435791\n },\n {\n \"id\": \"Normal\",\n \"name\": \"Normal\",\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": \"2024-10-11T20:00:00.0000000+00:00\",\n \"deliveryWindow\": null,\n \"availableDeliveryWindows\": [],\n \"deliveryIds\": [\n {\n \"courierId\": \"ASAPLAG_NORMAL\",\n \"courierName\": \"ASAPLAG_NORMAL\",\n \"dockId\": \"SFS_BAR\",\n \"quantity\": 1,\n \"warehouseId\": \"1_2\",\n \"accountCarrierName\": \"strbar\",\n \"kitItemDetails\": []\n }\n ],\n \"listPrice\": 2455,\n \"price\": 209,\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"polygonName\": \"\",\n \"lockTTL\": \"12d\",\n \"pickupPointId\": null,\n \"transitTime\": \"1bd\",\n \"pickupDistance\": null\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"deliveryIds\": [\n {\n \"courierId\": \"ASAPLAG_NORMAL\",\n \"courierName\": \"ASAPLAG_NORMAL\",\n \"dockId\": \"SFS_BAR\",\n \"quantity\": 1,\n \"warehouseId\": \"1_2\",\n \"accountCarrierName\": \"strbar\",\n \"kitItemDetails\": []\n }\n ],\n \"deliveryChannels\": [\n {\n \"id\": \"delivery\",\n \"stockBalance\": 0\n },\n {\n \"id\": \"pickup-in-point\",\n \"stockBalance\": 0\n }\n ],\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"addressId\": \"968d3b10816145878aa09b320f7e688a\",\n \"versionId\": null,\n \"entityId\": null,\n \"polygonName\": \"\",\n \"pickupPointId\": null,\n \"transitTime\": \"1bd\"\n }\n ],\n \"trackingHints\": null,\n \"selectedAddresses\": [\n {\n \"addressId\": \"968d3b10816145878aa09b320f7e688a\",\n \"versionId\": null,\n \"entityId\": null,\n \"addressType\": \"residential\",\n \"receiverName\": \"Camila Smith\",\n \"street\": \"Couto\",\n \"number\": \"29\",\n \"complement\": \"Building 3 apt 321\",\n \"neighborhood\": \"Penha\",\n \"postalCode\": \"21020-402\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"reference\": \"Next to the Shopping\",\n \"geoCoordinates\": [\n -43.27359390258789,\n -22.835159301757812\n ]\n }\n ],\n \"availableAddresses\": [\n {\n \"addressId\": \"968d3b10816145878aa09b320f7e688a\",\n \"versionId\": null,\n \"entityId\": null,\n \"addressType\": \"residential\",\n \"receiverName\": \"Camila Smith\",\n \"street\": \"Couto\",\n \"number\": \"29\",\n \"complement\": \"Building 3 apt 321\",\n \"neighborhood\": \"Penha\",\n \"postalCode\": \"21020-402\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"reference\": \"Next to the Shopping\",\n \"geoCoordinates\": [\n -43.27359390258789,\n -22.835159301757812\n ]\n }\n ],\n \"contactInformation\": []\n },\n \"paymentData\": {\n \"giftCards\": [],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"A599C01B84114016884B143BED05A3GG\",\n \"merchantName\": \"STR\",\n \"payments\": [\n {\n \"id\": \"B004B117C52F405FB2AE82835373186D\",\n \"paymentSystem\": \"125\",\n \"paymentSystemName\": \"Pix\",\n \"value\": 22745,\n \"installments\": 1,\n \"referenceValue\": 22745,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": null,\n \"giftCardId\": null,\n \"giftCardName\": null,\n \"giftCardCaption\": null,\n \"redemptionCode\": null,\n \"group\": \"instantPayment\",\n \"tid\": \"89781829739\",\n \"dueDate\": null,\n \"connectorResponses\": {\n \"Tid\": \"89781829739\",\n \"ReturnCode\": null,\n \"Message\": null,\n \"authId\": \"89781829739\",\n \"nsu\": \"89781829739\",\n \"acquirer\": \"paymarket\"\n },\n \"giftCardProvider\": null,\n \"giftCardAsDiscount\": null,\n \"koinUrl\": null,\n \"accountId\": null,\n \"parentAccountId\": null,\n \"bankIssuedInvoiceIdentificationNumber\": null,\n \"bankIssuedInvoiceIdentificationNumberFormatted\": null,\n \"bankIssuedInvoiceBarCodeNumber\": null,\n \"bankIssuedInvoiceBarCodeType\": null,\n \"billingAddress\": null,\n \"paymentOrigin\": null\n }\n ]\n }\n ]\n },\n \"packageAttachment\": {\n \"packages\": []\n },\n \"sellers\": [\n {\n \"id\": \"strbar\",\n \"name\": \"STR Barra Shopping\",\n \"logo\": \"\",\n \"fulfillmentEndpoint\": \"http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=strbar&affiliateId=SLR&sc=1\"\n }\n ],\n \"callCenterOperatorData\": null,\n \"followUpEmail\": \"c76fef8c4de34725aae5ebb429af3768@ct.vtex.com\",\n \"lastMessage\": null,\n \"hostname\": \"str\",\n \"invoiceData\": null,\n \"changesAttachment\": null,\n \"openTextField\": null,\n \"roundingError\": 0,\n \"orderFormId\": \"066ab2f7f65043a3aa396c749e202fd3\",\n \"commercialConditionData\": null,\n \"isCompleted\": true,\n \"customData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"BRA\",\n \"currencyCode\": \"BRL\",\n \"currencyFormatInfo\": {\n \"CurrencyDecimalDigits\": 2,\n \"CurrencyDecimalSeparator\": \",\",\n \"CurrencyGroupSeparator\": \".\",\n \"CurrencyGroupSize\": 3,\n \"StartsWithCurrencySymbol\": true\n },\n \"currencyLocale\": 1046,\n \"currencySymbol\": \"R$\",\n \"timeZone\": \"E. South America Standard Time\"\n },\n \"allowCancellation\": true,\n \"allowEdition\": false,\n \"isCheckedIn\": false,\n \"marketplace\": null,\n \"authorizedDate\": null,\n \"invoicedDate\": null,\n \"cancelReason\": null,\n \"itemMetadata\": {\n \"Items\": [\n {\n \"Id\": \"6229640\",\n \"Seller\": \"1\",\n \"Name\": \"cropped brown G\",\n \"SkuName\": \"GG\",\n \"ProductId\": \"4460339\",\n \"RefId\": \"11455795\",\n \"Ean\": null,\n \"ImageUrl\": \"https://str.vteximg.com.br/files/ids/58845769-200-240/photo-0.jpg?v=638569102126000000\",\n \"DetailUrl\": \"/cropped-brown-1065805_e2/p\",\n \"AssemblyOptions\": []\n }\n ]\n },\n \"subscriptionData\": null,\n \"taxData\": null,\n \"checkedInPickupPointId\": null,\n \"cancellationData\": null,\n \"cancellationRequests\": null,\n \"clientPreferencesData\": {\n \"locale\": \"pt-BR\",\n \"optinNewsLetter\": true\n }\n }\n]", + "cookie": [] + } + ], + "event": [ + { + "listen": "test", + "script": { + "id": "4d406fb0-d9d5-4e84-8156-d844e30ccf49", + "type": "text/javascript", + "exec": [ + "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/orders/order-group/:orderGroup - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", + "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/oms/pvt/orders/order-group/:orderGroup - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", + "// Validate if response has JSON Body \npm.test(\"[GET]::/api/oms/pvt/orders/order-group/:orderGroup - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", + "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"List of orders grouped by the order group ID.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an order related to the order group ID.\",\"properties\":{\"orderId\":{\"type\":\"string\",\"description\":\"Order ID.\"},\"sequence\":{\"type\":\"string\",\"description\":\"Sequence number part of the order ID. For example, in order `v70530116str-01`, the sequence is `70530116`.\"},\"marketplaceOrderId\":{\"type\":[\"string\",\"null\"],\"description\":\"Order ID in the marketplace.\"},\"marketplaceServicesEndpoint\":{\"type\":[\"string\",\"null\"],\"description\":\"Marketplace endpoint for post purchase communication.\"},\"sellerOrderId\":{\"type\":\"string\",\"description\":\"Seller order ID.\"},\"origin\":{\"type\":\"string\",\"description\":\"Order's [origin in the order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).\",\"enum\":[\"Marketplace\",\"Fulfillment\",\"Chain\"]},\"affiliateId\":{\"type\":[\"string\",\"null\"],\"description\":\"Three-letter [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) code configured by the seller to identify a marketplace.\"},\"salesChannel\":{\"type\":\"string\",\"description\":\"Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"For a VTEX store, the merchant's name will be the same as the account name. An external seller can have a `merchantName`, but it will not be an account name.\"},\"status\":{\"type\":\"string\",\"description\":\"[Order status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) in the workflow.\"},\"statusDescription\":{\"type\":[\"string\",\"null\"],\"description\":\"Status description displayed on the VTEX Admin. This field is obsolete and may not return any value.\"},\"value\":{\"type\":\"integer\",\"description\":\"Order total value in cents.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Order creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"lastChange\":{\"type\":\"string\",\"description\":\"Order last change date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Order's group ID, a code part of the order ID that groupes all orders related to the same purchase. For example, in order ID `v71021570str-02`), the order group ID is `v71021570str`.\"},\"totals\":{\"type\":\"array\",\"description\":\"Information about the order totals.\",\"items\":{\"type\":\"object\",\"description\":\"Details about the order totals.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Total ID, which defines what the total is about.\",\"enum\":[\"Items\",\"Discounts\",\"Shipping\",\"Tax\"]},\"name\":{\"type\":\"string\",\"description\":\"Total name.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value in cents.\"},\"alternativeTotals\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about the order alternative totals, when applicable. For example, when there is a discount for items in the marketplace that results in a difference in the `Items` total value, the `alternativeTotals` can retrieve details about it.\",\"items\":{\"type\":\"object\",\"description\":\"Details about the order alternative totals.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Alternative total ID, which can be related to items, discounts, shipping or taxes.\"},\"name\":{\"type\":\"string\",\"description\":\"Alternative total name.\"},\"value\":{\"type\":\"integer\",\"description\":\"Alternative total value in cents.\"}}}}}}},\"items\":{\"type\":\"array\",\"description\":\"Information on order items.\",\"items\":{\"type\":\"object\",\"description\":\"Information on each order item.\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Order item unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number (EAN) of the item.\"},\"lockId\":{\"type\":[\"string\",\"null\"],\"description\":\"[Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) ID.\"},\"attachments\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about [attachments](https://help.vtex.com/en/tutorial/what-is-an-attachment--aGICk0RVbqKg6GYmQcWUm).\",\"items\":{\"type\":\"object\",\"description\":\"Information about a given attachment.\",\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Attachment name.\"},\"content\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom field for attachment content.\",\"additionalProperties\":{\"type\":[\"string\",\"null\"],\"description\":\"Attachment custom field content.\"}}}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Item quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller name. When the store acts both as marketplace and seller, this field corresponds to `1`, because every VTEX store is its own seller 1.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"price\":{\"type\":\"integer\",\"description\":\"Item price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"manualPrice\":{\"type\":[\"integer\",\"null\"],\"description\":\"[Manual price](https://help.vtex.com/en/tutorial/change-the-price-of-an-item-in-the-shopping-cart--7Cd37aCAmtL1qmoZJJvjNf) in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the user who applied the manual price.\"},\"priceTags\":{\"type\":\"array\",\"description\":\"Information about price tags. A price tag is a price modifier, like s discount or a promotion applicable to the item in the order context.\",\"items\":{\"type\":\"object\",\"description\":\"Information about a given price tag.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Price tag name.\"},\"value\":{\"type\":[\"number\",\"null\"],\"description\":\"Price tag value in cents. Discounts correspond to negative numbers.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Defines if the price tag value is applied through a percentage (`true`) or not (`false`).\"},\"identifier\":{\"type\":\"string\",\"description\":\"Price tag identifier.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Price tag raw value.\"},\"rate\":{\"type\":[\"integer\",\"null\"],\"description\":\"Price tag rate.\"},\"jurisCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Juris code.\"},\"jurisType\":{\"type\":[\"string\",\"null\"],\"description\":\"Juris type.\"},\"jurisName\":{\"type\":[\"string\",\"null\"],\"description\":\"Juris name.\"}}}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"components\":{\"type\":[\"array\",\"null\"],\"description\":\"Item components.\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Component name.\"}},\"bundleItems\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about services sold with the item. For example, a gift package.\",\"items\":{\"type\":\"object\",\"description\":\"Information about a given service.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"params\":{\"type\":\"array\",\"description\":\"Array with information about params.\",\"items\":{\"type\":\"string\",\"description\":\"Param name.\"}},\"offerings\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about offerings, which are services related to the item. For example, a warranty or installation.\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the service related to the item.\"}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"Array containing attachments information.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Attachment details.\",\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Attachment name.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Schema of the content declared in the field `attachmentOfferings`.\",\"additionalProperties\":{\"type\":[\"string\",\"null\"],\"description\":\"Attachment schema content.\"}}}}},\"sellerSku\":{\"type\":\"string\",\"description\":\"Seller SKU ID.\"},\"priceValidUntil\":{\"type\":[\"string\",\"null\"],\"description\":\"Item price expiration date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"commission\":{\"type\":\"integer\",\"description\":\"Commission value registered for the seller.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax value in cents.\"},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"additionalInfo\":{\"type\":\"object\",\"description\":\"Item additional information.\",\"properties\":{\"brandName\":{\"type\":\"string\",\"description\":\"Item brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Item brand ID.\"},\"categoriesIds\":{\"type\":\"string\",\"description\":\"Categories IDs.\"},\"categories\":{\"type\":\"array\",\"description\":\"Item [categories](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2gkZDjXRqfsq62TlAkj4uf) information.\",\"items\":{\"type\":\"object\",\"description\":\"Information about a given category.\",\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category name.\"}}}},\"productClusterId\":{\"type\":\"string\",\"description\":\"All product clusters related to the item.\"},\"commercialConditionId\":{\"type\":\"string\",\"description\":\"Commercial condition ID.\"},\"dimension\":{\"type\":\"object\",\"description\":\"Item dimensions.\",\"required\":[\"cubicweight\",\"height\",\"length\",\"weight\",\"width\"],\"properties\":{\"cubicweight\":{\"type\":\"number\",\"description\":\"Item cubic weight.\"},\"height\":{\"type\":\"number\",\"description\":\"Item height.\"},\"length\":{\"type\":\"number\",\"description\":\"Item length.\"},\"weight\":{\"type\":\"number\",\"description\":\"Item weight.\"},\"width\":{\"type\":\"number\",\"description\":\"Item width.\"}}},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Item measurement unit.\"},\"unitMultiplier\":{\"type\":\"number\",\"description\":\"Item unit multiplier.\"},\"sellingPrice\":{\"type\":\"integer\",\"description\":\"Selling price in cents. This field can present rounding discrepancies, so we recommend retrieving pricing information from the `priceDefinition` field.\"},\"isGift\":{\"type\":\"boolean\",\"description\":\"Defines it the item is a gift (`true`) or not (`false`).\"},\"shippingPrice\":{\"type\":[\"integer\",\"null\"],\"description\":\"Item shipping price in cents. This value does not account for the order total shipping price.\"},\"rewardValue\":{\"type\":\"integer\",\"description\":\"Reward value in cents.\"},\"freightCommission\":{\"type\":\"integer\",\"description\":\"Freight commission value in cents.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Item price information.\",\"properties\":{\"sellingPrices\":{\"type\":\"array\",\"description\":\"Item selling prices.\",\"items\":{\"type\":\"object\",\"description\":\"Price value per quantity.\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Item selling price value in cents.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Item quantity.\"}}}},\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item calculated selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Item total price in cents.\"},\"reason\":{\"type\":[\"string\",\"null\"],\"description\":\"Item price definition reason.\"}}},\"taxCode\":{\"type\":[\"string\",\"null\"],\"description\":\" Item tax code.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Ranking number that shows how related items are indexed in between each other. It starts at `0` as the primary item reference and counts up to `1`, `2`, and so on. For example, a customer bought sunglasses and hired a warranty service. Since the sunglasses are index `0`, the warranty service (the [assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)) is index `1` and has the `parentItemIndex` value `0`. This response is `null` for items that are not assembly options.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"When items are indexed in between each other, this field returns the assembly option ID. This response is `null` for items that are not [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH).\"},\"callCenterOperator\":{\"type\":[\"string\",\"null\"],\"description\":\"Identification code of the call center operator that sold the item, when applicable.\"},\"serialNumbers\":{\"type\":[\"string\",\"null\"],\"description\":\"This field identifies the order in the `handling` status in the workflow, and it was used for VTEX internal control.\"},\"assemblies\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about the item customization, when applicable.\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Customization information.\"}},\"costPrice\":{\"type\":[\"integer\",\"null\"],\"description\":\"Item cost price in cents.\"}}}},\"marketplaceItems\":{\"type\":\"array\",\"description\":\"Array with marketplace items information.\",\"items\":{\"type\":\"string\",\"description\":\"Marketplace items.\"}},\"clientProfileData\":{\"type\":\"object\",\"description\":\"Information about the customer profile.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID, the expected value is `clientProfileData`.\"},\"email\":{\"type\":\"string\",\"description\":\"Customer email.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Customer first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Customer last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document identification code informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Customer phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, this field includes the corporate name.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, this field includes the trade name.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, this field includes the corporate document.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, this field includes the state inscription.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, this field includes the company's phone number.\"},\"isCorporate\":{\"type\":\"boolean\",\"description\":\"Defines if the customer is a legal entity (`true`) or not (`false`).\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Customer user profile ID.\"},\"userProfileVersion\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer user profile version.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class identification.\"},\"customerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer code.\"}}},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"[Gift list](https://developers.vtex.com/docs/guides/creating-gift-lists) information.\",\"properties\":{\"giftRegistryId\":{\"type\":\"string\",\"description\":\"Gift list ID.\"},\"giftRegistryType\":{\"type\":\"string\",\"description\":\"[Gift list type](https://help.vtex.com/en/tutorial/creating-a-type-of-list).\"},\"giftRegistryTypeName\":{\"type\":\"string\",\"description\":\"Gift list type name.\"},\"addressId\":{\"type\":\"string\",\"description\":\"Gift list shipping address ID.\"},\"description\":{\"type\":\"string\",\"description\":\"Gift list description.\"}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about marketing and promotions, such as coupon code and [Urchin Tracking Module (UTM)](https://help.vtex.com/en/tutorial/what-are-utm-source-utm-campaign-and-utm-medium--2wTz7QJ8KUG6skGAoAQuii).\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID. The expected value is `marketingData`.\"},\"utmSource\":{\"type\":[\"string\",\"null\"],\"description\":\"A UTM is an Urchin Tracking Module used to track traffic related to your store. This field is an UTM for tracking the traffic source, to know from which site, advertiser, or publication the customer came before reaching your site.\"},\"utmPartner\":{\"type\":[\"string\",\"null\"],\"description\":\"UTM for tracking the partner.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM for tracking the advertising or marketing media used to reach your site, such as banners and newsletters.\"},\"utmCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"UTM for tracking the marketing campaign context.\"},\"coupon\":{\"type\":[\"string\",\"null\"],\"description\":\"Coupon code used by the customer.\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"Internal UTM for tracking the marketing campaign context.\"},\"utmipage\":{\"type\":[\"string\",\"null\"],\"description\":\"A `utmi` is an internal Urchin Tracking Module (UTM) used to track traffic inside your site. This field is an internal UTM for tracking pages.\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"Internal UTM for tracking the partner.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"List of marketing tags valid for the item.\",\"items\":{\"type\":\"string\",\"description\":\"Marketing tag name.\"}}}},\"ratesAndBenefitsData\":{\"type\":\"object\",\"description\":\"Information on promotions and taxes that apply to the order.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID. The expected value is `ratesAndBenefitsData`.\"},\"rateAndBenefitsIdentifiers\":{\"type\":\"array\",\"description\":\"Information about order's promotions and taxes identifiers.\",\"items\":{\"type\":\"object\",\"description\":\"Information about a given promotion or tax.\",\"properties\":{\"description\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion or tax description.\"},\"featured\":{\"type\":\"boolean\",\"description\":\"Defines if the [target audience](https://help.vtex.com/en/tutorial/creating-a-campaign-audience--6cnuDZJzIkIeocewAQQK4K) is featured (`true`) or not (`false`).\"},\"id\":{\"type\":\"string\",\"description\":\"Promotion or tax ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion or tax name.\"},\"matchedParameters\":{\"type\":\"object\",\"description\":\"Informs the criteria and conditions fulfilled so the promotion became valid.\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"Promotion or tax criteria content.\"}},\"additionalInfo\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing the promotion or tax additional information.\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"Additional information.\"}}}}}}},\"shippingData\":{\"type\":\"object\",\"description\":\"Order shipping information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID. The expected value is `shippingData`.\"},\"address\":{\"type\":\"object\",\"description\":\"Shipping address details.\",\"required\":[\"addressType\",\"receiverName\",\"addressId\",\"postalCode\",\"city\",\"state\",\"country\",\"street\",\"number\",\"neighborhood\",\"complement\",\"reference\",\"geoCoordinates\"],\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Shipping address type.\",\"enum\":[\"residential\",\"pickup\"]},\"receiverName\":{\"type\":\"string\",\"description\":\"Full name of the order receiver.\"},\"addressId\":{\"type\":\"string\",\"description\":\"Shipping address ID.\"},\"versionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address version ID.\"},\"entityId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address entity ID.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Shipping address postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"Shipping address city.\"},\"state\":{\"type\":\"string\",\"description\":\"Shipping address state.\"},\"country\":{\"type\":\"string\",\"description\":\"Shipping address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.\"},\"street\":{\"type\":\"string\",\"description\":\"Shipping address street.\"},\"number\":{\"type\":\"string\",\"description\":\"Shipping address number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Shipping address neighborhood.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address complement.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address additional information.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Shipping address pair of geolocation coordinates, first longitude then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Longitude or latitude.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Logistics information regarding order items.\",\"items\":{\"type\":\"object\",\"description\":\"Logistics information about an item.\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Each item in the order is identified by an index. The position starts in `0`, followed by `1`, `2`, and so on.\"},\"itemId\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"selectedDeliveryChannel\":{\"type\":\"string\",\"description\":\"Delivery channel selected by the customer. This field is being deprecated and the information it retrieves can be found in the `deliveryChannel` field.\",\"enum\":[\"delivery\",\"pickup-in-point\"]},\"selectedSla\":{\"type\":\"string\",\"description\":\"Service Level Agreement (SLA), which corresponds to the shipping method selected by the customer, usually like normal or express.\"},\"lockTTL\":{\"type\":\"string\",\"description\":\"Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time.\"},\"price\":{\"type\":\"integer\",\"description\":\"Item shipping price in cents. This value does not correspond to the order total shipping price.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"Item [list price](https://help.vtex.com/en/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/3XcXp0r5WrJvogB8KIX4Kx#list-price) in cents.\"},\"sellingPrice\":{\"type\":\"integer\",\"description\":\"Item selling price in cents.\"},\"deliveryWindow\":{\"type\":[\"string\",\"null\"],\"description\":\"[Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, when applicable.\"},\"deliveryCompany\":{\"type\":\"string\",\"description\":\"[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company name.\"},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate time in days. For instance, three business days is represented `3bd`.\"},\"shippingEstimateDate\":{\"type\":\"string\",\"description\":\"Shipping estimate date, defined after order confirmation, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"slas\":{\"type\":\"array\",\"description\":\"Service Level Agreements (SLA) corresponding to [shipping policies](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"items\":{\"type\":\"object\",\"description\":\"Service Level Agreement (SLA) information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\"},\"name\":{\"type\":\"string\",\"description\":\"[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name.\"},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate time in days. For instance, three business days is represented `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA shipping estimate date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"deliveryWindow\":{\"type\":[\"string\",\"null\"],\"description\":\"[Delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.\"},\"availableDeliveryWindows\":{\"type\":[\"array\",\"null\"],\"description\":\"Available delivery windows information, when applicable.\",\"items\":{\"type\":\"string\",\"description\":\"Information about an available delivery window.\"}},\"deliveryIds\":{\"type\":\"array\",\"description\":\"SLA delivery IDs information.\",\"items\":{\"type\":\"object\",\"description\":\"Information about a delivery ID.\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Carrier ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Carrier name.\"},\"dockId\":{\"type\":\"string\",\"description\":\"[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity of items being delivered.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.\"},\"accountCarrierName\":{\"type\":\"string\",\"description\":\"Account carrier name.\"},\"kitItemDetails\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about [kit](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.\",\"items\":{\"type\":\"string\",\"description\":\"Kit item information.\"}}}}},\"listPrice\":{\"type\":\"integer\",\"description\":\"SLA shipping list price in cents.\"},\"price\":{\"type\":\"integer\",\"description\":\"SLA shipping price in cents. Does not account for the order total shipping price.\"},\"deliveryChannel\":{\"type\":\"string\",\"description\":\"Defines if the delivery channel is delivery or [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\",\"enum\":[\"delivery\",\"pickup-in-point\"]},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information about a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\",\"required\":[\"additionalInfo\",\"address\",\"dockId\",\"friendlyName\",\"isPickupStore\"],\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Defines if the shipping type was pickup (`true`) or not (`false`).\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the pickup point displayed at checkout.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Pickup point address information.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Pickup point address postal code.\"},\"country\":{\"type\":\"string\",\"description\":\"Three-digit country code of the pickup point address in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.\"},\"city\":{\"type\":\"string\",\"description\":\"Pickup point address city.\"},\"state\":{\"type\":\"string\",\"description\":\"Pickup point address state.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Pickup point address neighborhood.\"},\"street\":{\"type\":\"string\",\"description\":\"Pickup point address street.\"},\"number\":{\"type\":\"string\",\"description\":\"Pickup point address number.\"},\"complement\":{\"type\":\"string\",\"description\":\"Pickup point address complement.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point address reference.\"},\"location\":{\"type\":\"object\",\"description\":\"Pickup point geolocation coordinates.\",\"properties\":{\"latitude\":{\"type\":\"number\",\"description\":\"Latitude coordinate.\"},\"longitude\":{\"type\":\"number\",\"description\":\"Longitude coordinate.\"}}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the loading dock related to the pickup point.\"}}},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\"},\"lockTTL\":{\"type\":\"string\",\"description\":\"Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time related to the SLA.\"},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA.\"},\"transitTime\":{\"type\":\"string\",\"description\":\"Number of days the carrier takes in transit to deliver the order. For instance, three business days is represented `3bd`.\"},\"pickupDistance\":{\"type\":[\"number\",\"null\"],\"description\":\"Distance in kilometers between the pickup point and the customer address. The distance is measured as a straight line.\"}}}},\"shipsTo\":{\"type\":\"array\",\"description\":\"List of shipping address countries.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.\"}},\"deliveryIds\":{\"type\":\"array\",\"description\":\"Order delivery IDs information.\",\"items\":{\"type\":\"object\",\"description\":\"Information about a delivery ID.\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Carrier ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Carrier name.\"},\"dockId\":{\"type\":\"string\",\"description\":\"[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity of items being delivered.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.\"},\"accountCarrierName\":{\"type\":\"string\",\"description\":\"Account carrier name.\"},\"kitItemDetails\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about [kit](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.\",\"items\":{\"type\":\"string\",\"description\":\"Kit item information.\"}}}}},\"deliveryChannels\":{\"type\":\"array\",\"description\":\"Delivery channels associated with the sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)).\",\"items\":{\"type\":\"object\",\"description\":\"Delivery channel information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel shipping type.\",\"enum\":[\"delivery\",\"pickup-in-point\"]},\"stockBalance\":{\"type\":\"integer\",\"description\":\"Stock check for SKU availability.\"}}}},\"deliveryChannel\":{\"type\":\"string\",\"description\":\"Defines if the delivery channel is delivery or pickup. This field is deprecated and was replaced by the `deliveryChannels` field.\",\"enum\":[\"delivery\",\"pickup-in-point\"]},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information about a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\",\"required\":[\"additionalInfo\",\"address\",\"dockId\",\"friendlyName\",\"isPickupStore\"],\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Defines if the shipping type was pickup (`true`) or not (`false`).\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the pickup point displayed at checkout.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Pickup point address information.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Pickup point address postal code.\"},\"country\":{\"type\":\"string\",\"description\":\"Three-digit country code of the pickup point address in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.\"},\"city\":{\"type\":\"string\",\"description\":\"Pickup point address city.\"},\"state\":{\"type\":\"string\",\"description\":\"Pickup point address state.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Pickup point address neighborhood.\"},\"street\":{\"type\":\"string\",\"description\":\"Pickup point address street.\"},\"number\":{\"type\":\"string\",\"description\":\"Pickup point address number.\"},\"complement\":{\"type\":\"string\",\"description\":\"Pickup point address complement.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point address reference.\"},\"location\":{\"type\":\"object\",\"description\":\"Pickup point geolocation coordinates.\",\"properties\":{\"latitude\":{\"type\":\"number\",\"description\":\"Latitude coordinate.\"},\"longitude\":{\"type\":\"number\",\"description\":\"Longitude coordinate.\"}}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the loading dock related to the pickup point.\"}}},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address ID.\"},\"versionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address version ID.\"},\"entityId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address entity ID.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\"},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID, when applicable.\"},\"transitTime\":{\"type\":\"string\",\"description\":\"Number of days the carrier takes in transit to deliver the order. For instance, three business days is represented `3bd`.\"}}}},\"trackingHints\":{\"type\":[\"array\",\"null\"],\"description\":\"Order shipping label information.\",\"items\":{\"type\":\"object\",\"description\":\"Shipping label details.\",\"properties\":{\"trackingId\":{\"type\":\"string\",\"description\":\"Order tracking ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) name.\"},\"trackingUrl\":{\"type\":\"string\",\"description\":\"Order tracking URL.\"},\"trackingLabel\":{\"type\":\"string\",\"description\":\"Order tracking label.\"}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Selected adresses information.\",\"items\":{\"type\":\"object\",\"description\":\"Details about a selected adress.\",\"properties\":{\"addressId\":{\"type\":\"string\",\"description\":\"Selected address ID.\"},\"versionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Selected address version ID.\"},\"entityId\":{\"type\":[\"string\",\"null\"],\"description\":\"Selected address entity ID.\"},\"addressType\":{\"type\":\"string\",\"description\":\"Selected adress shipping type.\",\"enum\":[\"residential\",\"pickup\"]},\"receiverName\":{\"type\":\"string\",\"description\":\"Full name of the order receiver.\"},\"street\":{\"type\":\"string\",\"description\":\"Selected address street.\"},\"number\":{\"type\":\"string\",\"description\":\"Selected address number.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Selected address complement.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Selected address neighborhood.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Selected address postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"Selected address city.\"},\"state\":{\"type\":\"string\",\"description\":\"Selected address state.\"},\"country\":{\"type\":\"string\",\"description\":\"Selected address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Selected address additional information.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Selected address pair of geolocation coordinates, first longitude then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Longitude or latitude.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available adresses information.\",\"items\":{\"type\":\"object\",\"description\":\"Details about an available adress.\",\"properties\":{\"addressId\":{\"type\":\"string\",\"description\":\"Available address ID.\"},\"versionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Available address version ID.\"},\"entityId\":{\"type\":[\"string\",\"null\"],\"description\":\"Available address entity ID.\"},\"addressType\":{\"type\":\"string\",\"description\":\"Available adress shipping type.\",\"enum\":[\"residential\",\"pickup\"]},\"receiverName\":{\"type\":\"string\",\"description\":\"Full name of the order receiver.\"},\"street\":{\"type\":\"string\",\"description\":\"Available address street.\"},\"number\":{\"type\":\"string\",\"description\":\"Available address number.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Available address complement.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Available address neighborhood.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Available address postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"Available address city.\"},\"state\":{\"type\":\"string\",\"description\":\"Available address state.\"},\"country\":{\"type\":\"string\",\"description\":\"Available address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Available address additional information.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Available address pair of geolocation coordinates, first longitude then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Longitude or latitude.\"}}}}},\"contactInformation\":{\"type\":[\"array\",\"null\"],\"description\":\"Order contact information.\",\"items\":{\"type\":\"object\",\"description\":\"Order contact details.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Contact ID.\"},\"email\":{\"type\":\"string\",\"description\":\"Contact email.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact last name.\"},\"document\":{\"type\":\"string\",\"description\":\"Contact document number.\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact phone number.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Contact document type.\"}}}}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Payments information.\",\"properties\":{\"giftCards\":{\"type\":[\"array\",\"null\"],\"description\":\"[Gift cards](https://developers.vtex.com/docs/guides/gift-card-integration-guide) information, when applicable.\",\"items\":{\"type\":\"object\",\"description\":\"Gift card details.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Gift card identification.\"},\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card code used by the customer at checkout.\"},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"caption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card loyalty program, when applicable.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"number\",\"description\":\"Gift card current balance. For newly created gift cards, the balance will be `0.0`.\"},\"provider\":{\"type\":\"string\",\"description\":\"Gift card provider name.\"},\"groupName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card group name.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Defines if the gift card is in use (`true`) or not (`false`).\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Defines if the gift card is a special card (`true`) or not (`false`).\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information about the order financial transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Information about a given transaction.\",\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Defines of the transaction is active (`true`) or inactive (`false`).\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Payments information.\",\"items\":{\"type\":\"object\",\"description\":\"Payment details.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment unique identifier.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system ID.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"description\":\"Order total payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Total payment reference value in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the card owner.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first four digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last four digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month in 2-digit format.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year in 4-digit format.\"},\"url\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card code used by the customer at checkout.\"},\"group\":{\"type\":\"string\",\"description\":\"Transaction payment method, which can be credit card, debid card, bank invoice, promissory, gift card or pix (`instantPayment`).\",\"enum\":[\"creditCard\",\"debitCard\",\"bankInvoice\",\"promissory\",\"giftCard\",\"instantPayment\"]},\"tid\":{\"type\":\"string\",\"description\":\"Provider unique identifier for the transaction.\"},\"dueDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment due date in `MM/YY` format.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Payment provider (connector) responses. The fields within this object can vary according to the order payment provider.\",\"properties\":{\"Message\":{\"type\":\"string\",\"description\":\"Provider operational message or error to be logged.\"},\"tid\":{\"type\":\"string\",\"description\":\"Provider unique identifier for the transaction.\"},\"authorizationId\":{\"type\":\"string\",\"description\":\"Provider authorization ID.\"},\"status\":{\"type\":\"string\",\"description\":\"Order payment status in the [transaction flow](https://help.vtex.com/en/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/1xjzgJZvqwaI1rfxLMCC3Y).\"},\"delayToAutoSettle\":{\"type\":\"integer\",\"description\":\"Total time (in seconds) before the auto settle, when the platform makes an automatic call to `/settlements`, regardless if the payment was approved by the merchant's anti-fraud provider. The maximum value allowed is `604800` seconds (7 days).\"},\"ReturnCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Provider operational return code or error to be logged.\"},\"nsu\":{\"type\":\"string\",\"description\":\"Provider unique sequential number for the transaction.\"},\"code\":{\"type\":\"string\",\"description\":\"Provider operational code or error to be logged.\"},\"message\":{\"type\":\"string\",\"description\":\"Provider operational message or error to be logged.\"},\"Tid\":{\"type\":\"string\",\"description\":\"Provider unique identifier for the transaction.\"},\"acquirer\":{\"type\":\"string\",\"description\":\"[Acquirer](https://help.vtex.com/en/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/kdPbEIWf8Xq8tESQvViMB#acquirer) name (mostly used for card payments).\"},\"authId\":{\"type\":\"string\",\"description\":\"Authorization identification.\"},\"paymentId\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"delayToAutoSettleAfterAntifraud\":{\"type\":\"string\",\"description\":\"Total time (in seconds) before the auto settle, when the platform makes an automatic call to `/settlements`. This happens only after the payment was approved by the merchant's anti-fraud provider.\"}}},\"giftCardProvider\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card provider ID.\"},\"giftCardAsDiscount\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the payment has a gift card discount (`true`) or not (`false`).\"},\"koinUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"Koin connector URL.\"},\"accountId\":{\"type\":\"string\",\"description\":\"Identification code of the account where the payment was made.\"},\"parentAccountId\":{\"type\":[\"string\",\"null\"],\"description\":\"When the payment was made in a subaccount, this field retrieves the main account ID.\"},\"bankIssuedInvoiceIdentificationNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Bank issued invoice numeric sequence.\"},\"bankIssuedInvoiceIdentificationNumberFormatted\":{\"type\":[\"string\",\"null\"],\"description\":\"Bank issued invoice numeric sequence formatted as customers see.\"},\"bankIssuedInvoiceBarCodeNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Bank issued invoice bar code number.\"},\"bankIssuedInvoiceBarCodeType\":{\"type\":[\"string\",\"null\"],\"description\":\"Bank issued invoice bar code type.\"},\"billingAddress\":{\"type\":[\"object\",\"null\"],\"description\":\"Billing address information.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Billing address postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"Billing address city.\"},\"state\":{\"type\":\"string\",\"description\":\"Billing address state.\"},\"country\":{\"type\":\"string\",\"description\":\"Billing address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.\"},\"street\":{\"type\":\"string\",\"description\":\"Billing address street.\"},\"number\":{\"type\":\"string\",\"description\":\"Billing address number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Billing address neighborhood.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Billing address complement.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Billing address additional information.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Billing address pair of geolocation coordinates, first longitude then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Longitude or latitude.\"}}}},\"paymentOrigin\":{\"type\":[\"string\",\"null\"],\"description\":\"Type of [wallet](https://help.vtex.com/en/tutorial/what-is-an-e-wallet--4v5wcOe4A0SiaimWM2cU60) used in the payment.\"}}}}}}}}},\"packageAttachment\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about shipping packages, which are created after order invoicing.\",\"properties\":{\"packages\":{\"type\":[\"array\",\"null\"],\"description\":\"List with packages' information.\",\"items\":{\"type\":\"object\",\"description\":\"Package details.\",\"properties\":{\"courier\":{\"type\":\"string\",\"description\":\"Name of the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) responsible for the package shipping.\"},\"description\":{\"type\":[\"string\",\"null\"],\"description\":\"Package description.\"},\"invoiceNumber\":{\"type\":\"string\",\"description\":\"Unique identification code of the package invoice.\"},\"invoiceValue\":{\"type\":\"integer\",\"description\":\"Package invoice value in cents.\"},\"invoiceUrl\":{\"type\":\"string\",\"description\":\"Package invoice URL.\"},\"issuanceDate\":{\"type\":\"string\",\"description\":\"Package invoice issuance date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"trackingNumber\":{\"type\":\"string\",\"description\":\"Package [tracking number](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-).\"},\"invoiceKey\":{\"type\":\"string\",\"description\":\"Package invoice key.\"},\"trackingUrl\":{\"type\":\"string\",\"description\":\"Package tracking URL.\"},\"embeddedInvoice\":{\"type\":\"string\",\"description\":\"Package invoice text in [xml format](https://help.vtex.com/en/tutorial/configuring-xml--tutorials_242). This field is important for stores integrated with [external marketplaces](https://developers.vtex.com/docs/guides/external-marketplace-integration-guide).\"},\"type\":{\"type\":\"string\",\"description\":\"Package invoice type, which can be:\\r\\n- `Output`: Selling order invoice.\\r\\n- `Input`: Returning items invoice.\",\"enum\":[\"Output\",\"Input\"]},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the package.\",\"items\":{\"type\":\"object\",\"description\":\"Package item details.\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Item index of the item position whithin the `items` array. The count starts at `0`.\"},\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Package item quantity.\"},\"price\":{\"type\":\"integer\",\"description\":\"Package item price in cents.\"},\"description\":{\"type\":\"string\",\"description\":\"Package item description.\"},\"unitMultiplier\":{\"type\":\"number\",\"description\":\"Package item unit multiplier.\"}}}},\"courierStatus\":{\"type\":[\"object\",\"null\"],\"description\":\"[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) shipping information.\",\"properties\":{\"deliveredDate\":{\"type\":\"string\",\"description\":\"Package delivery date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"status\":{\"type\":[\"string\",\"null\"],\"description\":\"Defines if a carrier was assigned for order shipping (`ok`) or not (`null`).\"},\"finished\":{\"type\":\"boolean\",\"description\":\"Defines if the carrier has already delivered the package (`true`) or not (`false`).\"},\"data\":{\"type\":\"array\",\"description\":\"Package tracking information.\",\"items\":{\"type\":\"object\",\"description\":\"Package tracking details.\",\"properties\":{\"lastChange\":{\"type\":\"string\",\"description\":\"Date since package tracking last change in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"city\":{\"type\":\"string\",\"description\":\"Package tracking city.\"},\"state\":{\"type\":\"string\",\"description\":\"Package tracking state in two-digit code format.\"},\"description\":{\"type\":\"string\",\"description\":\"Package tracking description.\"},\"createDate\":{\"type\":\"string\",\"description\":\"Package tracking creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"}}}}}},\"cfop\":{\"type\":[\"string\",\"null\"],\"description\":\"[CFOP](https://www.gov.br/receitafederal/pt-br/acesso-a-informacao/acoes-e-programas/facilitacao/anexo-ecf-cfop) (_Código Fiscal de Operação e Prestação_) is a Brazilian fiscal code of operations and services that classifies business transaction types.\"},\"lastChange\":{\"type\":\"string\",\"description\":\"Date since package tracking last change in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"restitutions\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about a value being returned to the customer. This field applies only to invoices with the `Input` type because it relates to returning items.\",\"properties\":{\"refund\":{\"type\":\"object\",\"description\":\"Customer refund details.\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Refund value in cents.\"},\"giftCardData\":{\"type\":[\"string\",\"null\"],\"description\":\"Refund involving a [gift card](https://developers.vtex.com/docs/guides/gift-card-integration-guide).\"},\"items\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about the items being returned.\",\"items\":{\"type\":\"object\",\"description\":\"Returned item details.\",\"properties\":{\"useFreight\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the refund includes freight values (`true`) or not (`false`).\"},\"isCompensation\":{\"type\":\"boolean\",\"description\":\"Defines if there are compensated unit tags in the package (`true`) or not (`false`).\"},\"compensationValue\":{\"type\":\"integer\",\"description\":\"Compensational refund value in cents.\"},\"id\":{\"type\":\"string\",\"description\":\"SKU ID of the returned item.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Number of items being returned.\"},\"price\":{\"type\":\"integer\",\"description\":\"Returned item price in cents.\"},\"description\":{\"type\":\"string\",\"description\":\"Customer reason for returning the item.\"}}}}}}}},\"volumes\":{\"type\":[\"integer\",\"null\"],\"description\":\"Indicates the number of boxes (volumes) needed to contain the package items. For example, two refrigerators do not fit in a single volume, so this field would have value `2`.\"}}}}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information about the sellers associated with the order.\",\"items\":{\"type\":\"object\",\"description\":\"Information about a given seller.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo URL.\"},\"fulfillmentEndpoint\":{\"type\":\"string\",\"description\":\"URL of the endpoint for fulfillment of seller's orders, which the marketplace use to communicate with the seller.\"}}}},\"callCenterOperatorData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about the call center operator responsible for the order.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Call center operator identification code.\"},\"email\":{\"type\":\"string\",\"description\":\"Call center operator email.\"},\"userName\":{\"type\":\"string\",\"description\":\"Call center operator user name.\"}}},\"followUpEmail\":{\"type\":\"string\",\"description\":\"Email of the store employee responsible for managing the order.\"},\"lastMessage\":{\"type\":[\"string\",\"null\"],\"description\":\"Last transactional message sent to the customer.\"},\"hostname\":{\"type\":\"string\",\"description\":\"Main [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Order invoices information.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice address information.\",\"properties\":{\"addressType\":{\"type\":[\"string\",\"null\"],\"description\":\"Invoice address type, which can be `residential`, when the customer gives an address for delivery, or `pickup`, when the customer picks the order at a pickup point.\",\"enum\":[\"residential\",\"pickup\"]},\"receiverName\":{\"type\":[\"string\",\"null\"],\"description\":\"Full name of the order receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Invoice address ID.\"},\"versionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Invoice address version ID.\"},\"entityId\":{\"type\":[\"string\",\"null\"],\"description\":\"Invoice address entity ID.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Invoice address postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"Invoice address city.\"},\"state\":{\"type\":\"string\",\"description\":\"Invoice address state.\"},\"country\":{\"type\":\"string\",\"description\":\"Invoice address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.\"},\"street\":{\"type\":\"string\",\"description\":\"Invoice address street.\"},\"number\":{\"type\":\"string\",\"description\":\"Invoice address number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Invoice address neighborhood.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Invoice address complement.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Invoice address additional information.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Invoice address pair of geolocation coordinates, first longitude then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Longitude or latitude.\"}},\"contactId\":{\"type\":[\"string\",\"null\"],\"description\":\"Contact unique identifier.\"}}},\"userPaymentInfo\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice information regarding payment method.\",\"properties\":{\"paymentMethods\":{\"type\":\"array\",\"description\":\"List of the payment methods used by the customer in the purchase.\",\"items\":{\"type\":\"string\",\"description\":\"Payment method name.\"}}}},\"invoiceSubject\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about the invoice subject.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject phone number.\"}}}}},\"changesAttachment\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about changes in the order.\",\"required\":[\"id\",\"changesData\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Order changes ID.\"},\"changesData\":{\"type\":\"array\",\"description\":\"Order changes details.\",\"items\":{\"required\":[\"reason\",\"discountValue\",\"incrementValue\",\"itemsAdded\",\"itemsRemoved\",\"receipt\"],\"type\":\"object\",\"description\":\"Details about an order change.\",\"properties\":{\"reason\":{\"type\":\"string\",\"description\":\"Text explaining why the order was changed. This information may be shown to the customer in the storefront or transactional emails.\"},\"discountValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Order change discount value in cents.\"},\"incrementValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Order change increment value in cents.\"},\"itemsAdded\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about items added to the order, when applicable.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an item added to the order.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Added item SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Added item SKU name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity of items added.\"},\"price\":{\"type\":\"integer\",\"description\":\"Added item price in cents.\"},\"unitMultiplier\":{\"type\":[\"string\",\"null\"],\"description\":\"Added item unit multiplier.\"}}}},\"itemsRemoved\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about items removed from the order, when applicable.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an item removed from the order.\",\"required\":[\"id\",\"name\",\"quantity\",\"price\",\"unitMultiplier\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Removed item SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Removed item name.\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of removed items.\"},\"price\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Removed item price in cents.\"},\"unitMultiplier\":{\"type\":[\"string\",\"null\"],\"description\":\"Removed item unit multiplier.\"}}}},\"receipt\":{\"required\":[\"date\",\"orderId\",\"receipt\"],\"type\":\"object\",\"description\":\"Order changes receipt information.\",\"properties\":{\"date\":{\"type\":\"string\",\"description\":\"Receipt creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"orderId\":{\"type\":\"string\",\"description\":\"Order ID.\"},\"receipt\":{\"type\":\"string\",\"description\":\"Receipt unique identifier code.\"}}}}}}}},\"openTextField\":{\"type\":[\"object\",\"null\"],\"description\":\"Optional field for additional information.\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"Additional information.\"}},\"roundingError\":{\"type\":\"integer\",\"description\":\"Rounding error total value in cents, when applicable. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount value, which is informed in this field.\"},\"orderFormId\":{\"type\":\"string\",\"description\":\"ID of the [orderForm](https://developers.vtex.com/docs/guides/orderform-fields), the main object processed by the VTEX Checkout.\"},\"commercialConditionData\":{\"type\":[\"string\",\"null\"],\"description\":\"Commercial condition information.\"},\"isCompleted\":{\"type\":\"boolean\",\"description\":\"Defines if the order payment has been settled (`true`) or not (`false`).\"},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields created by the store for the shopping cart. This field is useful for storing data not included in other fields. For example, a message for a gift or a name to be printed in a shirt.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Customizable apps details.\"}}}},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Store preferences in the [Account settings](https://help.vtex.com/en/tutorial/account-details-page--2vhUVOKfCaswqLguT2F9xq) page.\",\"properties\":{\"countryCode\":{\"type\":\"string\",\"description\":\"Country code in three-digit [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.\"},\"currencyCode\":{\"type\":\"string\",\"description\":\"Currency code in [ISO 4217](https://www.iban.com/currency-codes) format.\"},\"currencyFormatInfo\":{\"type\":\"object\",\"description\":\"Currency format settings.\",\"properties\":{\"CurrencyDecimalDigits\":{\"type\":\"integer\",\"description\":\"Number of currency decimal digits.\"},\"CurrencyDecimalSeparator\":{\"type\":\"string\",\"description\":\"Character for currency decimal separation.\"},\"CurrencyGroupSeparator\":{\"type\":\"string\",\"description\":\"Character for currency group separation.\"},\"CurrencyGroupSize\":{\"type\":\"integer\",\"description\":\"Limit of characters that can be grouped for currency groups.\"},\"StartsWithCurrencySymbol\":{\"type\":\"boolean\",\"description\":\"Defines if the prices displayed for customers start with the currency symbol (`true`) or not (`false`).\"}}},\"currencyLocale\":{\"type\":\"integer\",\"description\":\"Currency locale code in [LCID](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a) format.\"},\"currencySymbol\":{\"type\":\"string\",\"description\":\"Currency symbol characters.\"},\"timeZone\":{\"type\":\"string\",\"description\":\"Time zone considered for the store orders.\"}}},\"allowCancellation\":{\"type\":\"boolean\",\"description\":\"Defines if order cancellation is allowed (`true`) or not anymore (`false`).\"},\"allowEdition\":{\"type\":\"boolean\",\"description\":\"Defines if the order can be edited (`true`) or not anymore (`false`).\"},\"isCheckedIn\":{\"type\":\"boolean\",\"description\":\"Defines if the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) (`true`) or not (`false`).\"},\"marketplace\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about the marketplace related to the order.\",\"properties\":{\"baseURL\":{\"type\":\"string\",\"description\":\"Marketplace base URL.\"},\"isCertified\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the marketplace is a [VTEX certified marketplace](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-certified-marketplaces) (`true`) or not (`false`).\"},\"name\":{\"type\":\"string\",\"description\":\"Marketplace name.\"}}},\"authorizedDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Order authorization date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"invoicedDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Order invoice date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"cancelReason\":{\"type\":[\"string\",\"null\"],\"description\":\"Order cancellation reason.\"},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Metadata information about items.\",\"properties\":{\"Items\":{\"type\":\"array\",\"description\":\"Metadata details about items.\",\"items\":{\"type\":\"object\",\"description\":\"Metadata details about a given item\",\"properties\":{\"Id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"Seller\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"Name\":{\"type\":\"string\",\"description\":\"Item name as displayed to customers in the storefront.\"},\"SkuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"ProductId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"RefId\":{\"type\":\"string\",\"description\":\"SKU reference ID.\"},\"Ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number (EAN) of the item.\"},\"ImageUrl\":{\"type\":\"string\",\"description\":\"SKU image URL.\"},\"DetailUrl\":{\"type\":\"string\",\"description\":\"SKU slug.\"},\"AssemblyOptions\":{\"type\":[\"array\",\"null\"],\"description\":\"[Assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) information related to the item, when applicable.\",\"items\":{\"type\":\"object\",\"description\":\"[Assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) details.\",\"properties\":{\"Id\":{\"type\":\"string\",\"description\":\"Assembly option ID.\"},\"Name\":{\"type\":\"string\",\"description\":\"Assembly option name.\"},\"Required\":{\"type\":\"boolean\",\"description\":\"Defines if sending the attachment for the item purchased is required(`true`) or optional (`false`).\"},\"InputValues\":{\"type\":[\"object\",\"null\"],\"description\":\"Assembly option content.\",\"additionalProperties\":{\"type\":[\"string\",\"null\"],\"description\":\"Assembly option value.\"}},\"Composition\":{\"type\":[\"object\",\"null\"],\"description\":\"Assembly option composition.\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"Assembly option composition value.\"}}}}}}}}}},\"subscriptionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about [subscriptions](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453), when applicable.\",\"properties\":{\"subscriptionGroupId\":{\"type\":[\"string\",\"null\"],\"description\":\"Subscription group ID. If this field returns `null` and the `executionCount` is `0`, the order is the first subscription order.\"},\"subscriptions\":{\"type\":[\"array\",\"null\"],\"description\":\"List with subscriptions details.\",\"items\":{\"type\":\"object\",\"description\":\"Subscription details.\",\"properties\":{\"executionCount\":{\"type\":\"integer\",\"description\":\"Position of the order in the subscription cycle. The first order will have the value `0`, the second will have the value `1`, and so on.\"},\"priceAtSubscriptionDate\":{\"type\":[\"number\",\"null\"],\"description\":\"Value of the order when the customer subscribed. Subscriptions created via VTEX Admin or [Subscriptions API](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3) do not have an original order, so this field returns `0.0`.\"},\"itemIndex\":{\"type\":\"integer\",\"description\":\"Each item in the subscription order is identified by an index. The position starts in `0`, followed by `1`, `2`, and so on.\"},\"plan\":{\"type\":\"object\",\"description\":\"Information about the [subscription plan](https://help.vtex.com/en/tutorial/subscription-plans-beta--5kczKRqHEsrs1tYtRcY8wR).\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Plan type.\"},\"frequency\":{\"type\":\"object\",\"description\":\"Information about subscriptions' recurrence.\",\"properties\":{\"periodicity\":{\"type\":\"string\",\"description\":\"Defines the subscription recurrence period.\",\"enum\":[\"DAILY\",\"WEEKLY\",\"MONTHLY\",\"YEARLY\"]},\"interval\":{\"type\":\"integer\",\"description\":\"Time interval configured between subscription orders, which depends on the frequency. For a `DAY` frequency, the value will be days, for `MONTH` it will be months, and so on.\"}}},\"validity\":{\"type\":\"object\",\"description\":\"Information about the period during which the subscription will be valid.\",\"properties\":{\"begin\":{\"type\":\"string\",\"description\":\"Subscription plan beginning date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"end\":{\"type\":[\"string\",\"null\"],\"description\":\"Subscription plan ending date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"}}}}}}}}}},\"taxData\":{\"type\":[\"object\",\"null\"],\"description\":\"Order taxes information.\",\"required\":[\"areTaxesDesignatedByMarketplace\",\"taxInfoCollection\"],\"properties\":{\"areTaxesDesignatedByMarketplace\":{\"type\":\"boolean\",\"description\":\"Defines if the taxes were applied by the marketplace (`true`) or not (`false`).\"},\"taxInfoCollection\":{\"type\":\"array\",\"description\":\"Order taxes details.\",\"items\":{\"type\":\"object\",\"description\":\"Information about a given tax.\",\"required\":[\"itemIndex\",\"sku\",\"priceTags\"],\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Item indexing number.\"},\"sku\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"priceTags\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about order taxes.\",\"properties\":{\"areTaxesDesignatedByMarketplace\":{\"type\":\"boolean\",\"description\":\"Defines if the taxes were designated by the marketplace (`true`) or not (`false`).\"},\"taxInfoCollection\":{\"type\":\"array\",\"description\":\"Array with taxes' details.\",\"items\":{\"type\":\"object\",\"description\":\"Details about a given tax.\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Item index number.\"},\"sku\":{\"type\":\"string\",\"description\":\"Alphanumeric sequence that identifies a SKU.\"},\"priceTags\":{\"type\":\"array\",\"description\":\"Price tags information with the original taxes calculated at order placement.\",\"items\":{\"type\":\"object\",\"description\":\"Information about a given price tag.\",\"properties\":{\"identifier\":{\"type\":\"string\",\"description\":\"Price tag identifier code.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether price tag value is applied through a percentage (`true`) or not (`false`).\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name.\"},\"value\":{\"type\":\"number\",\"description\":\"Price tag value.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Price tag raw value that can contain up to five decimals, separated by a period.\"}}}}}}}}}}}}}},\"checkedInPickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"When the order is created at a physical store which is configured as a pickup point, this field retrieves the pickup point ID.\"},\"cancellationData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about [order cancellation](https://developers.vtex.com/docs/guides/order-canceling-improvements), when applicable.\",\"properties\":{\"requestedByUser\":{\"type\":\"boolean\",\"description\":\"Defines if the order cancellation was requested by the customer (`true`) or not (`false`).\"},\"requestedBySystem\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the order cancellation was made by the system (`true`) or not (`false`). This type of order cancellation happens in [incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294), for example.\"},\"requestedBySellerNotification\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the order cancellation was requested by the seller (`true`) or not (`false`).\"},\"requestedByPaymentNotification\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the order cancellation was requested by the payment gateway (`true`) or not (`false`).\"},\"reason\":{\"type\":\"string\",\"description\":\"Reason why the order was canceled.\"},\"cancellationDate\":{\"type\":\"string\",\"description\":\"Order cancellation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"cancellationRequestId\":{\"type\":\"string\",\"description\":\"ID that identifies the cancellation operation.\"}}},\"cancellationRequests\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about the [seller order cancellation denials](https://developers.vtex.com/docs/guides/order-canceling-improvements), regardless if the cancellation request was made by the marketplace or the customer.\",\"items\":{\"type\":\"object\",\"description\":\"Information about the seller denial to a given order cancellation request.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID that identifies the original cancellation operation made by the marketplaces or its customer care service using the [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/cancel) endpoint.\"},\"reason\":{\"type\":\"string\",\"description\":\"Reason why there was a request to cancel the order.\"},\"cancellationRequestDate\":{\"type\":\"string\",\"description\":\"Date of when the order cancellation request was processed by the platform. The date format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"requestedByUser\":{\"type\":\"boolean\",\"description\":\"Defines if the order cancellation was requested by the customer (`true`) or not (`false`).\"},\"deniedBySeller\":{\"type\":\"boolean\",\"description\":\"Defines if the order cancellation request was [denied by the seller](https://developers.vtex.com/docs/guides/order-canceling-improvements) (`true`) or accepted by the seller (`false`).\"},\"deniedBySellerReason\":{\"type\":[\"string\",\"null\"],\"description\":\"Reason given by the seller for denying the order cancellation.\"},\"cancellationRequestDenyDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date of when the platform processed the seller denial to an order cancellation request. The date format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"}}}},\"clientPreferencesData\":{\"type\":\"object\",\"description\":\"Information about the customer preferences.\",\"properties\":{\"locale\":{\"type\":\"string\",\"description\":\"Language code of the customer preferred language while accessing the store.\"},\"optinNewsLetter\":{\"type\":\"boolean\",\"description\":\"Defines if the customer receives the store's newsletter (`true`) or not (`false`).\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/oms/pvt/orders/order-group/:orderGroup - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + ] + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "efe27118-e34b-47df-bb1e-f7cdaa58c381", "name": "List orders", "request": { "name": "List orders", @@ -404,7 +555,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e10e1991-69f8-4611-b8e8-0b3b22871376", + "id": "d117da99-179b-48e0-91c4-4d76aea857d4", "name": "OK", "originalRequest": { "url": { @@ -661,7 +812,7 @@ { "listen": "test", "script": { - "id": "41207bfb-2ff9-4d8d-8bf7-87314d782010", + "id": "c19c4381-daa3-40f5-ac8d-bd407ef28df6", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/orders - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -677,7 +828,7 @@ } }, { - "id": "7b947569-01ec-414d-b7a9-3ea5015d690b", + "id": "423f8618-4bbd-449f-bbff-9cbefba9f170", "name": "Start handling order", "request": { "name": "Start handling order", @@ -743,7 +894,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f1a35d25-22ce-4e87-8a60-cbaa777e46f7", + "id": "32767af3-d0a7-4706-ad96-dde24dce1a0d", "name": "[No content](https://httpstatuses.com/204)", "originalRequest": { "url": { @@ -801,7 +952,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7b1113d8-3f1b-429d-92d2-15d4760c2353", + "id": "995549bb-2507-48c6-89c4-3f1587a6e702", "name": "[Unauthorized](https://httpstatuses.com/401)", "originalRequest": { "url": { @@ -869,7 +1020,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f2397966-d869-489b-846e-b19378fa4175", + "id": "77fdbb64-628b-447f-8420-50b068d9424f", "name": "[Forbidden](https://httpstatuses.com/403)", "originalRequest": { "url": { @@ -927,7 +1078,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "7a627e67-fd9e-4229-9b4a-b7495aa9e6a3", + "id": "7efbcb18-facc-4904-aab6-0749de2f26c7", "name": "[Not found](https://httpstatuses.com/404)", "originalRequest": { "url": { @@ -985,7 +1136,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1c4c086d-8e09-45c0-a1d4-65921bf719d2", + "id": "3422ede7-1d26-4644-aeb4-fc7dd56510d5", "name": "[Conflict](https://httpstatuses.com/409)", "originalRequest": { "url": { @@ -1053,7 +1204,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "154fa563-49e8-4e79-bb22-1b531c14e4b1", + "id": "a93b2e80-fb31-425a-8aab-9e472a40c168", "name": "[Too many requests](https://httpstatuses.com/429)", "originalRequest": { "url": { @@ -1112,7 +1263,7 @@ { "listen": "test", "script": { - "id": "6e006203-66da-4bf2-b458-237629cda5f3", + "id": "8413e1d0-4f27-4873-9e21-317937508d0e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/start-handling - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1126,7 +1277,7 @@ } }, { - "id": "12c4f0dc-9c53-4e11-a965-cbc4adf54083", + "id": "cd633678-d171-462c-ab8a-e50016bbe6b6", "name": "Cancel order", "request": { "name": "Cancel order", @@ -1205,7 +1356,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4c841e2a-fb7f-41be-ab18-8eed14d1cefd", + "id": "9af2513a-eabf-4a24-adf4-623f53a5980a", "name": "OK", "originalRequest": { "url": { @@ -1286,7 +1437,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "9c2aa839-7152-49d9-84d0-2a5851782eb5", + "id": "76a8e3d4-5583-4014-9465-791558080377", "name": "The credentials are not enabled to access the service.", "originalRequest": { "url": { @@ -1357,7 +1508,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "118fb12f-b410-4a46-bdec-c5a6e5bc51d3", + "id": "6cbbc5df-e951-43e6-92ab-fe954c4db02f", "name": "Value not found.", "originalRequest": { "url": { @@ -1428,7 +1579,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d6b6ec00-b349-4dee-8a15-e6fc93784878", + "id": "29d1187a-4e7d-4f18-ae45-397e16c3e459", "name": "Too many requests.", "originalRequest": { "url": { @@ -1500,7 +1651,7 @@ { "listen": "test", "script": { - "id": "73bf730a-ca88-4fd2-b61d-e0e6cc5cd72b", + "id": "c5d1eb0d-1bb9-4a43-a052-9918b5283d31", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/cancel - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1516,7 +1667,7 @@ } }, { - "id": "3a6ec550-2398-4685-856f-c1bb4da2d898", + "id": "7417b423-88ee-4d6e-85aa-fbb013ef4254", "name": "Register change on order", "request": { "name": "Register change on order", @@ -1595,7 +1746,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "0135791f-197b-46bd-b663-9b1d4b436977", + "id": "af15f485-5495-48e8-920c-1674b13c155d", "name": "OK", "originalRequest": { "url": { @@ -1677,7 +1828,7 @@ { "listen": "test", "script": { - "id": "d32d0c6a-3c5a-4cd8-b7b7-7b55c3e5ea84", + "id": "7cc6539d-c511-4352-923b-5c4e18572803", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/changes - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1693,7 +1844,7 @@ } }, { - "id": "237b3079-9637-485d-a584-d7130faef352", + "id": "b57ae779-8b8f-4ae1-b167-9efc9437485d", "name": "Add log in orders", "request": { "name": "Add log in orders", @@ -1768,7 +1919,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "c44a0a3a-e94c-4547-996f-ee40fd91b617", + "id": "e8df360c-fb6d-4ed7-8701-4e6ee9230ff3", "name": "OK", "originalRequest": { "url": { @@ -1840,7 +1991,7 @@ { "listen": "test", "script": { - "id": "983728db-9d18-4b85-ac81-53b0f86fdc57", + "id": "ee96c8cb-83e9-4b84-8243-8e756d0329df", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/interactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1856,7 +2007,7 @@ "event": [] }, { - "id": "a17e8169-25eb-473d-bec9-46f558a02f52", + "id": "a7e2d61a-7c58-409a-aa61-db983a33a2c6", "name": "Change order (beta)", "description": { "content": "", @@ -1864,7 +2015,7 @@ }, "item": [ { - "id": "4649d7cd-23e2-4bc7-b246-a3585a4616a3", + "id": "55c16872-c945-49dd-9739-1152f483a25b", "name": "Create order change", "request": { "name": "Create order change", @@ -1952,7 +2103,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3030bca6-0eff-4993-a1be-b51fa95e4076", + "id": "d8cab61c-0ac4-44db-a087-5e1be2a01987", "name": "Accepted", "originalRequest": { "url": { @@ -2043,7 +2194,7 @@ { "listen": "test", "script": { - "id": "84be0bf7-9876-44f9-b639-0a3a2f4389bc", + "id": "ed797b94-4585-4a24-952f-ae510816b057", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/order-system/orders/:changeOrderId/changes - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2059,7 +2210,7 @@ } }, { - "id": "b03a9535-41f0-4a33-8ff3-3cf049305ae7", + "id": "537911a6-6757-4f9b-bde8-3efef0354337", "name": "Get order change history", "request": { "name": "Get order change history", @@ -2134,7 +2285,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c2af2f20-6187-42b4-91f1-f1112f7ed897", + "id": "ab260511-ed0e-4fbb-bb7f-3e1938a1ed1d", "name": "OK", "originalRequest": { "url": { @@ -2212,7 +2363,7 @@ { "listen": "test", "script": { - "id": "6a5fac48-f180-4f14-a3cc-051ae2df9da5", + "id": "6e687b2f-5c60-46db-8b5c-0777eeb22372", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/order-system/orders/:changeOrderId/changes - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2228,7 +2379,7 @@ } }, { - "id": "e0fa296e-73fb-4fa1-9dfd-95a6f5d919e9", + "id": "ed876be7-f6cf-4593-a63e-042c6512c188", "name": "Get order change details", "request": { "name": "Get order change details", @@ -2314,7 +2465,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "11703a3d-21f4-4609-a898-633087876f5f", + "id": "57bda29e-352c-4847-b6c8-c9cf95548c50", "name": "OK", "originalRequest": { "url": { @@ -2393,7 +2544,7 @@ { "listen": "test", "script": { - "id": "9b3c6827-183a-4d13-adfe-375d2a748ac4", + "id": "0de5e0cb-d17d-4558-b24e-d475646982e8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/order-system/orders/:changeOrderId/changes/:changeRequestId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2409,7 +2560,7 @@ } }, { - "id": "3bfd22bb-1565-4e0d-a068-929788e95d10", + "id": "3eb5e6dc-f6e4-4217-8674-70d751834492", "name": "Preview order change", "request": { "name": "Preview order change", @@ -2498,7 +2649,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d9834eae-4c31-4f29-9cdd-1e44a6858284", + "id": "8a5691a2-07d4-4677-b383-dfd57d97e53f", "name": "OK", "originalRequest": { "url": { @@ -2590,7 +2741,7 @@ { "listen": "test", "script": { - "id": "ac04b768-6dac-4d48-b091-9bb389c4d789", + "id": "c47d332b-f7f3-4481-ba36-b6e24dfa1888", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/order-system/orders/:changeOrderId/changes/preview - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2606,7 +2757,7 @@ } }, { - "id": "64da8d4a-b1af-4e4f-a211-0bea904c44bc", + "id": "c66cc141-ba7a-4e8a-a767-7d313bf0daae", "name": "Retry order change", "request": { "name": "Retry order change", @@ -2702,7 +2853,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "82c5ec5e-4ea9-4588-b194-f5cdb56c881c", + "id": "83be8a9d-26cf-4fca-bd6f-b5f49a749a0f", "name": "No Content", "originalRequest": { "url": { @@ -2785,7 +2936,7 @@ { "listen": "test", "script": { - "id": "43adbbbc-611e-4725-9006-5dc5981bd85a", + "id": "c8995714-1388-4204-a00a-6cba2cca1b6c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/order-system/orders/:changeOrderId/changes/:changeRequestId/retry - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2799,7 +2950,7 @@ } }, { - "id": "eefec0aa-bae7-47dc-af7e-6710498b3eff", + "id": "55c7afde-8806-4be7-8967-56666a2a1b57", "name": "Cancel order change", "request": { "name": "Cancel order change", @@ -2895,7 +3046,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "ad0b74b5-d5fb-40a2-9e0e-c4a942ac672b", + "id": "458533c5-4c72-4621-8017-b571ecc7efb6", "name": "OK", "originalRequest": { "url": { @@ -2978,7 +3129,7 @@ { "listen": "test", "script": { - "id": "f3637135-60f9-4f4b-b127-97cad2811e2a", + "id": "8561e94d-3889-4e10-ba56-31199e4c3cf2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/order-system/orders/:changeOrderId/changes/:changeRequestId/cancel - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -2991,7 +3142,7 @@ } }, { - "id": "2e5df38a-7336-4a64-a843-6c2ca889b17d", + "id": "c3a27555-1936-49c8-826f-7ea71dce6917", "name": "Update Change order settings", "request": { "name": "Update Change order settings", @@ -3068,7 +3219,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5e47737d-806f-42bb-ac26-4783785b149f", + "id": "1518a7fc-33c4-407f-b1fb-34663f20229d", "name": "OK", "originalRequest": { "url": { @@ -3159,7 +3310,7 @@ { "listen": "test", "script": { - "id": "5bae6621-8e84-47ff-b18b-3ca04dca3b85", + "id": "78c17275-97e3-46fe-afcd-3754e5564a7d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/order-system/orders/changes/settings - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3175,7 +3326,7 @@ } }, { - "id": "24c4adff-d058-4648-afe7-d9a3e22cbc43", + "id": "b6406d64-eb69-4dee-aeeb-53b61bf764f8", "name": "Get Change order settings", "request": { "name": "Get Change order settings", @@ -3239,7 +3390,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "305d7d1e-0f69-4596-9cb5-2daaef01fa5a", + "id": "c8273eef-2c66-4d18-a952-42faa73dd388", "name": "OK", "originalRequest": { "url": { @@ -3317,7 +3468,7 @@ { "listen": "test", "script": { - "id": "8f29f683-62f5-4bb6-9654-243cd257d807", + "id": "02becf65-4f0d-4c7e-8b25-cc30934a40d1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/order-system/orders/changes/settings - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3336,7 +3487,7 @@ "event": [] }, { - "id": "415d2f0c-2d9f-4590-9360-b0dbf1b5f816", + "id": "41c15938-7d01-4aee-9e7f-71028b31ead5", "name": "Invoice", "description": { "content": "", @@ -3344,7 +3495,7 @@ }, "item": [ { - "id": "82ee9d9d-e24d-4801-9156-51dfd8ed1017", + "id": "4cfc8d10-dee2-4551-9c92-26dd7939ecca", "name": "Order invoice notification", "request": { "name": "Order invoice notification", @@ -3423,7 +3574,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3e26bb6c-825b-49cb-8880-9b1754959f95", + "id": "4c8bb6f0-8ac1-466a-8a1b-a2ca9088c6c5", "name": "OK", "originalRequest": { "url": { @@ -3505,7 +3656,7 @@ { "listen": "test", "script": { - "id": "b967fd16-a493-420a-ba88-3f55e6caef4d", + "id": "81af0626-b9a4-4832-b310-b4eb66af7715", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/invoice - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3521,7 +3672,7 @@ } }, { - "id": "85c67954-6d0f-40b2-9d14-1837aa780bcc", + "id": "f3ff1df5-947f-4426-be00-005c9bff91fe", "name": "Update order's partial invoice (send tracking number)", "request": { "name": "Update order's partial invoice (send tracking number)", @@ -3611,7 +3762,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ee5db9d9-715d-41ba-8ac5-833ed438063b", + "id": "09256ec0-8ff0-4b55-abb8-3d0db975eee2", "name": "OK", "originalRequest": { "url": { @@ -3694,7 +3845,7 @@ { "listen": "test", "script": { - "id": "dcb1736d-b81b-4427-b674-96673debb29b", + "id": "0b36267b-f1f9-46ff-a6ac-49c81018e98f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/oms/pvt/orders/:orderId/invoice/:invoiceNumber - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3713,7 +3864,7 @@ "event": [] }, { - "id": "85e44535-650d-4f90-9c85-c96c2bc556fb", + "id": "f443f86f-c53a-40a9-b27e-d66727d7bd16", "name": "Tracking", "description": { "content": "", @@ -3721,7 +3872,7 @@ }, "item": [ { - "id": "112bf879-09bd-4eac-abd0-86a68b11a92a", + "id": "1f67e602-d22a-41c1-93be-c80360e2afe7", "name": "Update order tracking status", "request": { "name": "Update order tracking status", @@ -3812,7 +3963,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5adf7e95-0cc7-458e-981e-f00364cbf7cf", + "id": "2f8655f9-2054-4942-a887-14149c661b82", "name": "OK", "originalRequest": { "url": { @@ -3896,7 +4047,7 @@ { "listen": "test", "script": { - "id": "b2ffff52-55da-414b-989f-3599bc316527", + "id": "a1f7a3f3-bf9e-4a40-b141-382a14fc68ec", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/oms/pvt/orders/:orderId/invoice/:invoiceNumber/tracking - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3915,7 +4066,7 @@ "event": [] }, { - "id": "0b12f1a2-d2cc-47b7-8154-2f74c81f9a1d", + "id": "4bbada0a-667b-4edf-9750-a80e1aab13bc", "name": "Conversation", "description": { "content": "", @@ -3923,7 +4074,7 @@ }, "item": [ { - "id": "015ca8b4-9bfc-4811-8a04-3e98cabbafe4", + "id": "a4e86e15-5eeb-4ae2-9527-6a26993266fe", "name": "Retrieve order conversation", "request": { "name": "Retrieve order conversation", @@ -3989,7 +4140,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c70a361f-24b0-4d98-bf37-47dd8c56806f", + "id": "707d5760-c08a-4fd6-9b54-b7d63ad6c11a", "name": "OK", "originalRequest": { "url": { @@ -4058,7 +4209,7 @@ { "listen": "test", "script": { - "id": "4ade5f6c-cca9-4332-9295-7d1af4f574fb", + "id": "276e46ff-f053-49db-8f22-669a347929dc", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/orders/:orderId/conversation-message - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4077,7 +4228,7 @@ "event": [] }, { - "id": "8c614703-1de9-416b-b0f0-816c003da697", + "id": "cc93fa7f-ec4c-436f-9e28-22a0b652d27a", "name": "Payment", "description": { "content": "", @@ -4085,7 +4236,7 @@ }, "item": [ { - "id": "91dcedf0-9472-4c60-9329-32113ea08049", + "id": "a978a9d1-e087-4e91-9316-f38a4f3773de", "name": "Retrieve payment transaction", "request": { "name": "Retrieve payment transaction", @@ -4151,7 +4302,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "68bad1c9-5104-4025-a11f-a3aaa580a072", + "id": "37174cdf-5fbf-48a0-90e6-b708ad57a7b7", "name": "OK", "originalRequest": { "url": { @@ -4220,7 +4371,7 @@ { "listen": "test", "script": { - "id": "55a197fd-e15e-49fb-a280-2d353e9efada", + "id": "e642afb0-7d05-470d-bc84-4cc034dce94b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/orders/:orderId/payment-transaction - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4236,7 +4387,7 @@ } }, { - "id": "7d777789-b1d6-4a23-901a-adf05713b265", + "id": "b5ddaca1-78c4-4970-bb93-2fd931846ed1", "name": "Send payment notification", "request": { "name": "Send payment notification", @@ -4310,7 +4461,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "1f53fad2-b1cc-4574-802b-6140a5fa04d6", + "id": "329c4d85-4bbd-4344-8c4a-8303a51c4378", "name": "OK", "originalRequest": { "url": { @@ -4370,7 +4521,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "be491006-e1ae-442b-8f86-aef8f120b4e8", + "id": "590bd939-b0f1-4053-a8d3-7c4aa6d8e437", "name": "Bad request.", "originalRequest": { "url": { @@ -4430,7 +4581,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "577feb87-8848-4f89-93ec-85938a1077cf", + "id": "e18201b1-d5fa-4004-ac8b-8a6c3b6f3918", "name": "The credentials are not enabled to access the service.", "originalRequest": { "url": { @@ -4490,7 +4641,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "7c43a84c-0c0d-4772-a86b-6417c8d869b2", + "id": "f62900a2-f297-424a-806a-a43bd6982609", "name": "Value not found.", "originalRequest": { "url": { @@ -4550,7 +4701,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "5557ac1e-c100-4c5f-a5e8-cbbb469cb31f", + "id": "f1f05093-d32b-465c-8570-f3a8dfc1ca2d", "name": "Too many requests.", "originalRequest": { "url": { @@ -4611,7 +4762,7 @@ { "listen": "test", "script": { - "id": "fd373971-1e31-424b-ad18-b802026205f7", + "id": "2d5cf93a-fed3-44ad-85e0-b316ec4615d5", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/payments/:paymentId/payment-notification - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -4627,7 +4778,7 @@ "event": [] }, { - "id": "d1d3ba8f-f5ea-48d7-b4f1-046676bd4ce0", + "id": "d6a26a17-d773-4b89-baa0-a06c661a06a7", "name": "Feed v2 (deprecated)", "description": { "content": "", @@ -4635,7 +4786,7 @@ }, "item": [ { - "id": "4ac62ce5-aecc-4afb-98d1-875611673ae9", + "id": "1eef0113-2559-4b7b-9db9-492a8d729daf", "name": "Get feed order status", "request": { "name": "Get feed order status", @@ -4696,7 +4847,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "5454c850-2c11-4809-af51-a1d13d86c1a5", + "id": "fe739144-b3d7-409f-8e43-f584548d303b", "name": "OK", "originalRequest": { "url": { @@ -4765,7 +4916,7 @@ { "listen": "test", "script": { - "id": "bcfe03fc-2f2f-4012-8890-2ed0d92d8877", + "id": "d5256647-6b80-433d-b8b5-e5832950e8ed", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/feed/orders/status - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -4781,7 +4932,7 @@ "event": [] }, { - "id": "34410f8b-0ef4-49e3-b084-b214ef8836b8", + "id": "52bf2902-68c0-4dcc-8c0c-8a4481b5d916", "name": "Feed v3", "description": { "content": "", @@ -4789,7 +4940,7 @@ }, "item": [ { - "id": "f0a20ffb-583e-40ff-9c46-7a5ae8341c4e", + "id": "384b8dfe-9cf9-4026-b157-cc5676ff61bd", "name": "Get feed configuration", "request": { "name": "Get feed configuration", @@ -4842,7 +4993,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c0212c13-e6ca-46b7-87dd-726aa1bde6e3", + "id": "790f9bc3-18db-4a6f-aaa2-5cb49caa890c", "name": "OK", "originalRequest": { "url": { @@ -4909,7 +5060,7 @@ { "listen": "test", "script": { - "id": "d2c0b0e2-07d9-47d1-a6f7-0a34024b28db", + "id": "376807d3-de18-48bf-8e3a-eefc48ae6443", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/orders/feed/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4925,7 +5076,7 @@ } }, { - "id": "f49aad6f-3f52-4c63-8b2f-820735f16b3d", + "id": "dc839a6b-f289-4069-aa3c-64275cda02fb", "name": "Create or update feed configuration", "request": { "name": "Create or update feed configuration", @@ -4987,7 +5138,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "dbdb762e-125c-4323-b0ff-d4696fa34027", + "id": "faf12f32-fab7-4006-bc22-0226608d719f", "name": "Success", "originalRequest": { "url": { @@ -5056,7 +5207,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "456bb39d-da6c-4cb1-8f8e-76868667681a", + "id": "dd60bf61-8896-478c-91f5-43b304bd2876", "name": "The credentials are not enabled to access the service", "originalRequest": { "url": { @@ -5125,7 +5276,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "213408bf-def6-4299-8ca8-ff7cb85bcf6c", + "id": "7c9a45de-214f-418e-bcf5-d2e09b6940c0", "name": "Value not found", "originalRequest": { "url": { @@ -5194,7 +5345,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "e33ea477-3526-4314-ba31-56bd198b1ba6", + "id": "0bb985eb-3bac-4b64-9563-6dfa1a549c87", "name": "Too many requests", "originalRequest": { "url": { @@ -5264,7 +5415,7 @@ { "listen": "test", "script": { - "id": "d7622d9a-5d87-47ef-ae2c-d8d2c8f4de9a", + "id": "d32183b6-21ac-4907-8f00-d506f9878a21", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/feed/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -5277,7 +5428,7 @@ } }, { - "id": "902353e0-3083-4e21-b46e-049d0af34ff9", + "id": "ef314a7e-8adf-441a-8c64-eb839f871c1b", "name": "Delete feed configuration", "request": { "name": "Delete feed configuration", @@ -5326,7 +5477,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "bf5494b6-ced7-4188-ac92-288952c1698f", + "id": "998fd99b-05f1-4687-8d6d-4812d08e4ff6", "name": "OK", "originalRequest": { "url": { @@ -5382,7 +5533,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "7af1bf43-d3c6-4cce-8608-2ee6ce5608dc", + "id": "4f45af75-5309-415b-a0c2-664589f81a39", "name": "Bad request - Unable to check address / Only https scheme is accepted", "originalRequest": { "url": { @@ -5438,7 +5589,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "55b30e46-9bd0-466b-a75b-e9a9d68b8a86", + "id": "ba264d3f-9f9e-435c-85ed-7a924344d8cd", "name": "The credentials are not enabled to access the service", "originalRequest": { "url": { @@ -5494,7 +5645,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "6574a2d8-54b0-4e07-8d64-fd1e894848b6", + "id": "c6194934-8bae-4980-b0d4-929ae1e73f80", "name": "Value not found", "originalRequest": { "url": { @@ -5550,7 +5701,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "cb9d706a-718a-4a79-8ed2-55d04acc49a0", + "id": "3f667169-2bb6-43d4-9629-1d2a5088113d", "name": "Too many requests", "originalRequest": { "url": { @@ -5607,7 +5758,7 @@ { "listen": "test", "script": { - "id": "be4829eb-cc75-4233-9726-4ea69b96e779", + "id": "455f0891-5a7f-4db5-9e9d-0b71ec4423be", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/orders/feed/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -5620,7 +5771,7 @@ } }, { - "id": "e29771ed-98f9-49aa-a734-ee4dd658e2e9", + "id": "c7e9b27e-e07a-4164-9f61-5fdf0794b1d8", "name": "Retrieve feed items", "request": { "name": "Retrieve feed items", @@ -5682,7 +5833,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "95e78c25-71b8-4251-8e83-08b82815ed20", + "id": "9f0c01cc-c146-44d6-8d1e-ec61ddeb5dd2", "name": "OK", "originalRequest": { "url": { @@ -5758,7 +5909,7 @@ { "listen": "test", "script": { - "id": "0888ddc3-0eb4-4d19-8056-91033343565d", + "id": "c4188d63-3861-4de3-bb65-71edae530027", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/orders/feed - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5774,7 +5925,7 @@ } }, { - "id": "a6fb2f76-e83e-4ca3-bb80-9172e557f26a", + "id": "e2c57f5e-963c-4b14-8f08-d4c2e9997e66", "name": "Commit feed items", "request": { "name": "Commit feed items", @@ -5835,7 +5986,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "cf9ac9e2-13e0-4fc0-bec5-4b4727cc0fd1", + "id": "496c970e-6854-45af-a14d-51092ada7d6b", "name": "OK", "originalRequest": { "url": { @@ -5904,7 +6055,7 @@ { "listen": "test", "script": { - "id": "3d7568a6-74b4-4515-9a78-ea7f804d20ed", + "id": "5e6d2efc-6b2f-4110-bcc8-5dc8aff0781a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/feed - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -5917,7 +6068,7 @@ } }, { - "id": "19791e5c-2bcc-4917-9200-2d59f09efec8", + "id": "87a3d8b9-d65e-4ba5-b4aa-b3e051b46cc7", "name": "Test JSONata expression", "request": { "name": "Test JSONata expression", @@ -5983,7 +6134,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "476d4ec6-0d8d-47b0-8d39-14fbb8c6cc8a", + "id": "3261de5f-89a9-446e-af83-6faa547bde82", "name": "OK", "originalRequest": { "url": { @@ -6063,7 +6214,7 @@ { "listen": "test", "script": { - "id": "2a7eec84-8375-4592-8946-500cdff7bee6", + "id": "d57c44d0-1ed8-4514-a8f9-76baa2c93765", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/expressions/jsonata - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -6082,7 +6233,7 @@ "event": [] }, { - "id": "406eaaef-8058-4562-bb65-e3b624b08645", + "id": "3830594e-1ee6-4846-90df-2d9b8c37cca8", "name": "Order hook", "description": { "content": "", @@ -6090,7 +6241,7 @@ }, "item": [ { - "id": "f9decf6c-27f3-49e3-87c2-e8b331a57972", + "id": "44667690-a42d-4462-a140-8894a361132e", "name": "Get hook configuration", "request": { "name": "Get hook configuration", @@ -6167,7 +6318,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "51aaf47f-6455-45af-8e9b-53171560f6d9", + "id": "caa2d6ad-25bc-4298-8ea4-1631892413e7", "name": "OK", "originalRequest": { "url": { @@ -6252,7 +6403,7 @@ { "listen": "test", "script": { - "id": "589aada5-f762-45e2-b92e-1494f88b88d9", + "id": "70adbef2-0dce-4574-ac40-f459a14d69b8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/orders/hook/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -6265,7 +6416,7 @@ } }, { - "id": "2aee1578-79d6-4dbf-b41d-cd4d26d4d60b", + "id": "3e6b999c-2a65-417a-a78a-5b7bac354135", "name": "Create or update hook configuration", "request": { "name": "Create or update hook configuration", @@ -6331,7 +6482,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "892efc77-bc2d-4c1c-bd7d-33b3589f1fa4", + "id": "21f4b0b6-f8f2-45c8-89d6-a69a64bfbc42", "name": "OK", "originalRequest": { "url": { @@ -6411,7 +6562,7 @@ { "listen": "test", "script": { - "id": "dfd34aab-b334-41a4-8233-8dec47ff24f6", + "id": "9628e0f3-d0cb-4b4f-9f43-99c99d1db58b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/hook/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -6427,7 +6578,7 @@ } }, { - "id": "6fb2de9a-a8cb-4a4c-ae1d-431f2db3d53c", + "id": "38ff9357-18ca-47c8-ad58-6e828c20d116", "name": "Delete hook configuration", "request": { "name": "Delete hook configuration", @@ -6476,7 +6627,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "b67f0c91-2550-40ac-a051-2f1608d17bb3", + "id": "465b07b5-c465-4c18-a2a9-68d4ad06e30f", "name": "Success", "originalRequest": { "url": { @@ -6532,7 +6683,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "05300ebb-0004-46be-9068-011438ea1477", + "id": "97267679-f039-4188-aba0-36c38bad7772", "name": "The credentials are not enabled to access the service", "originalRequest": { "url": { @@ -6588,7 +6739,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "5acbc5eb-f871-4ab0-9dde-bd1c6a29160d", + "id": "2827d5fd-a070-4de9-abaf-932b40367f2d", "name": "Value not found", "originalRequest": { "url": { @@ -6644,7 +6795,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "08f7c85c-0f6f-4c16-ad5a-92e2b771c3c3", + "id": "30ed608e-a4fa-46f1-84cc-16804432d13e", "name": "Too many requests", "originalRequest": { "url": { @@ -6701,7 +6852,7 @@ { "listen": "test", "script": { - "id": "dccdd751-19e3-4ebe-9178-d89852fb742d", + "id": "17dc410b-abf0-4cfb-9dfe-563ef16a885e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/orders/hook/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -6717,7 +6868,7 @@ "event": [] }, { - "id": "3ad44ce4-925c-4897-a996-92a28d1cbe72", + "id": "55a140a8-56cb-432b-affa-1e9888f7e674", "name": "User orders", "description": { "content": "", @@ -6725,7 +6876,7 @@ }, "item": [ { - "id": "c9e9a352-f001-466e-a98e-a777f4dee5f2", + "id": "b221461d-8540-4871-b983-55e854226768", "name": "Retrieve user's orders", "request": { "name": "Retrieve user's orders", @@ -6806,7 +6957,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6c44f85e-a65a-4547-b533-584c97cb53c3", + "id": "d8a5a896-43f8-4da3-8a96-c151c0380847", "name": "OK", "originalRequest": { "url": { @@ -6901,7 +7052,7 @@ { "listen": "test", "script": { - "id": "74c186f4-3de7-4450-9c17-e35e5dc8de69", + "id": "8b3c1a0d-49a4-429e-8555-f2e14a4d3bc0", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/user/orders - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -6917,7 +7068,7 @@ } }, { - "id": "3d6d2196-dff3-466e-a2c8-2bfb4812a11b", + "id": "46968ee3-5246-4107-b5b9-afca3b8be53a", "name": "Retrieve user order details", "request": { "name": "Retrieve user order details", @@ -6992,7 +7143,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8e28553c-eff1-4cac-99d0-5108341ef3d7", + "id": "802deb43-acfb-4172-b166-042ace35cb5c", "name": "OK", "originalRequest": { "url": { @@ -7070,13 +7221,13 @@ { "listen": "test", "script": { - "id": "2d53b86c-020e-47bf-a7de-fcbcc7c6c3c7", + "id": "c68c6956-aacd-4c9f-9427-f85688db41a2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/user/orders/:orderId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/oms/user/orders/:orderId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/oms/user/orders/:orderId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Userorderdetails\",\"required\":[\"orderId\",\"sequence\",\"marketplaceOrderId\",\"marketplaceServicesEndpoint\",\"sellerOrderId\",\"origin\",\"affiliateId\",\"salesChannel\",\"merchantName\",\"status\",\"statusDescription\",\"value\",\"creationDate\",\"lastChange\",\"orderGroup\",\"totals\",\"items\",\"marketplaceItems\",\"clientProfileData\",\"giftRegistryData\",\"marketingData\",\"ratesAndBenefitsData\",\"shippingData\",\"paymentData\",\"packageAttachment\",\"sellers\",\"callCenterOperatorData\",\"followUpEmail\",\"lastMessage\",\"hostname\",\"invoiceData\",\"changesAttachment\",\"openTextField\",\"roundingError\",\"orderFormId\",\"commercialConditionData\",\"isCompleted\",\"customData\",\"storePreferencesData\",\"allowCancellation\",\"allowEdition\",\"isCheckedIn\",\"marketplace\",\"authorizedDate\",\"invoicedDate\",\"cancelReason\",\"itemMetadata\",\"subscriptionData\",\"taxData\",\"checkedInPickupPointId\",\"cancellationData\",\"clientPreferencesData\"],\"type\":\"object\",\"properties\":{\"orderId\":{\"type\":\"string\",\"description\":\"Order ID is a unique code that identifies an order.\"},\"sequence\":{\"type\":\"string\",\"description\":\"Sequence is a six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`.\"},\"marketplaceOrderId\":{\"type\":\"string\",\"description\":\"Marketplace order ID.\"},\"marketplaceServicesEndpoint\":{\"type\":\"string\",\"description\":\"Marketplace services endpoint.\"},\"sellerOrderId\":{\"type\":\"string\",\"description\":\"ID of the seller related to the order. It can be a VTEX seller or an external seller.\"},\"origin\":{\"type\":\"string\",\"description\":\"Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`.\"},\"affiliateId\":{\"type\":\"string\",\"description\":\"Corresponds to the three-digit [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code of the seller responsible for the order.\"},\"salesChannel\":{\"type\":\"string\",\"description\":\"Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Name of the merchant.\"},\"status\":{\"type\":\"string\",\"description\":\"Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).\"},\"statusDescription\":{\"type\":\"string\",\"description\":\"`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value.\"},\"value\":{\"type\":\"integer\",\"description\":\"Order's total amount.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Order's creation date.\"},\"lastChange\":{\"type\":\"string\",\"description\":\"Order's last change date.\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Order's group ID.\"},\"totals\":{\"type\":\"array\",\"items\":{\"required\":[\"id\",\"name\",\"value\"],\"type\":\"object\",\"description\":\"Object about order's totals.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Code that identifies if the information is about `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total amount of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.\"}}},\"description\":\"List with details about orders' totals.\"},\"items\":{\"type\":\"array\",\"items\":{\"required\":[\"uniqueId\",\"id\",\"productId\",\"ean\",\"lockId\",\"itemAttachment\",\"attachments\",\"quantity\",\"seller\",\"name\",\"refId\",\"price\",\"listPrice\",\"manualPrice\",\"priceTags\",\"imageUrl\",\"detailUrl\",\"components\",\"bundleItems\",\"params\",\"offerings\",\"attachmentOfferings\",\"sellerSku\",\"priceValidUntil\",\"commission\",\"tax\",\"preSaleDate\",\"additionalInfo\",\"measurementUnit\",\"unitMultiplier\",\"sellingPrice\",\"isGift\",\"shippingPrice\",\"rewardValue\",\"freightCommission\",\"priceDefinitions\",\"taxCode\",\"parentItemIndex\",\"parentAssemblyBinding\",\"callCenterOperator\",\"serialNumbers\",\"assemblies\",\"costPrice\"],\"type\":\"object\",\"description\":\"Item details.\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID is an alphanumeric sequence that identifies an SKU in a given order.\"},\"id\":{\"type\":\"string\",\"description\":\"Item's SKU ID, which is a unique numerical identifier.\"},\"productId\":{\"type\":\"string\",\"description\":\"ID of the Product associated with the item.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"EAN of the SKU.\"},\"lockId\":{\"type\":\"string\",\"description\":\"Reservation ID.\"},\"itemAttachment\":{\"title\":\"ItemAttachment\",\"description\":\"Information about attachments, if it applies.\",\"required\":[\"content\",\"name\"],\"type\":\"object\",\"properties\":{\"content\":{\"type\":\"object\",\"description\":\"Attachment's custom field for content.\"},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Attachment's name.\"}}},\"attachments\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Attachment details.\"},\"description\":\"Array containing information on attachments.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity of items.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller related to the order.\"},\"name\":{\"type\":\"string\",\"description\":\"Item's name.\"},\"refId\":{\"type\":\"string\",\"description\":\"Product referencial code associated with the item.\"},\"price\":{\"type\":\"integer\",\"description\":\"Item's price.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"Item's list price.\"},\"manualPrice\":{\"type\":[\"string\",\"null\"],\"description\":\"Item's manual price.\"},\"priceTags\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Price modifier.\"},\"description\":\"List of objects with item's price modifiers.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Item's SKU image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"URL slug of the item.\"},\"components\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"A given component.\"},\"description\":\"Item's components.\"},\"bundleItems\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Item offering details.\"},\"description\":\"This field groups offerings (services) related to the item and displays their ID and quantity. A gift package is an example of an offering.\"},\"params\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Param name.\"},\"description\":\"Information about params.\"},\"offerings\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Name of the service related to the item. For example, guarantee or installation.\"},\"description\":\"Item's offerings, which are services related to the item. For example, guarantee or installation.\"},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"type\":\"object\",\"description\":\"Attachment details.\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Schema of the content declared in the field `attachmentOfferings`.\"}}}},\"sellerSku\":{\"type\":\"string\",\"description\":\"SKU ID from the seller perspective.\"},\"priceValidUntil\":{\"type\":[\"string\",\"null\"],\"description\":\"Date until when the price is going to be valid if there is a promotion.\"},\"commission\":{\"type\":\"integer\",\"description\":\"Commission value registered for the seller.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Item's tax.\"},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Item's pre sale date.\"},\"additionalInfo\":{\"title\":\"AdditionalInfo\",\"description\":\"Additional information about the item.\",\"required\":[\"brandName\",\"brandId\",\"categoriesIds\",\"productClusterId\",\"commercialConditionId\",\"dimension\",\"offeringInfo\",\"offeringType\",\"offeringTypeId\"],\"type\":\"object\",\"properties\":{\"brandName\":{\"type\":\"string\",\"description\":\"Item's brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Item's brand ID.\"},\"categoriesIds\":{\"type\":\"string\",\"description\":\"Item's category ID.\"},\"productClusterId\":{\"type\":\"string\",\"description\":\"All product clusters related to the item.\"},\"commercialConditionId\":{\"type\":\"string\",\"description\":\"Commercial conditions ID.\"},\"dimension\":{\"title\":\"Dimension\",\"required\":[\"cubicweight\",\"height\",\"length\",\"weight\",\"width\"],\"type\":\"object\",\"properties\":{\"cubicweight\":{\"type\":\"number\",\"description\":\"Item's cubic weight.\"},\"height\":{\"type\":\"integer\",\"description\":\"Item's height.\"},\"length\":{\"type\":\"integer\",\"description\":\"Item's length.\"},\"weight\":{\"type\":\"integer\",\"description\":\"Item's weight.\"},\"width\":{\"type\":\"integer\",\"description\":\"Item's width.\"}}},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about services related to the item. For example: guarantee or installation.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Item's measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Item's unit multiplier.\"},\"sellingPrice\":{\"type\":\"integer\",\"description\":\"Item's selling price.\"},\"isGift\":{\"type\":\"boolean\",\"description\":\"This field is `true` when the item is a gift in order context and `false` when it is not.\"},\"shippingPrice\":{\"type\":[\"string\",\"null\"],\"description\":\"Item's shipping price.\"},\"rewardValue\":{\"type\":\"integer\",\"description\":\"Item's reward value.\"},\"freightCommission\":{\"type\":\"integer\",\"description\":\"Value of the freight commission.\"},\"priceDefinitions\":{\"type\":\"object\",\"description\":\"Item's price information.\",\"required\":[\"sellingPrices\",\"calculatedSellingPrice\",\"total\"],\"properties\":{\"sellingPrices\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"description\":\"Item value and quantity.\",\"required\":[\"value\",\"quantity\"],\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Total value of items in cents.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity of items.\"}}},\"description\":\"Details on item's selling price.\"},\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value of all item's units in cents.\"}}},\"taxCode\":{\"type\":[\"string\",\"null\"],\"description\":\" Item's tax code.\"},\"parentItemIndex\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"callCenterOperator\":{\"type\":[\"string\",\"null\"],\"description\":\"Call center operator responsible for the order.\"},\"serialNumbers\":{\"type\":[\"string\",\"null\"],\"description\":\"This field identifies the order in the `handling` status in the workflow, and it was used for VTEX internal control.\"},\"assemblies\":{\"type\":[\"array\",\"null\"],\"description\":\"Retrieves information about orders item's customizations.\",\"items\":{\"type\":\"string\",\"description\":\"Customization information.\"}},\"costPrice\":{\"type\":\"integer\",\"description\":\"Item's cost price.\"}}},\"description\":\"Information about order's items.\"},\"marketplaceItems\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Marketplace details object.\"},\"clientProfileData\":{\"title\":\"ClientProfileData\",\"description\":\"Object with information on the client's profile.\",\"required\":[\"id\",\"email\",\"firstName\",\"lastName\",\"documentType\",\"document\",\"phone\",\"corporateName\",\"tradeName\",\"corporateDocument\",\"stateInscription\",\"corporatePhone\",\"isCorporate\",\"userProfileId\",\"customerClass\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID, the expected value is `clientProfileData`.\"},\"email\":{\"type\":\"string\",\"description\":\"Customer's email.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Customer's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Customer's last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document identification code informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Customers's phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, here goes the corporate name.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, here goes the trade name.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, here goes the corporate document.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, here goes the state inscription.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, here goes the corpany's phone number.\"},\"isCorporate\":{\"type\":\"boolean\",\"description\":\"The value is `true` when the customer is a legal entity and `false` when not.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Customer user profile ID.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Identification of the class the customer belongs to.\"}}},\"giftRegistryData\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about gift list, when it applies.\"},\"marketingData\":{\"type\":\"object\",\"description\":\"Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs.\",\"required\":[\"id\",\"utmSource\",\"utmPartner\",\"utmMedium\",\"utmCampaign\",\"coupon\",\"utmiCampaign\",\"utmipage\",\"utmiPart\",\"marketingTags\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID which expected value is `marketingData`.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"Value of the `utm_source` parameter of the URL that led to the request.\"},\"utmPartner\":{\"type\":\"string\",\"description\":\"UTM Source Parameters.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"Value of the `utm_medium` parameter of the URL that led to the request.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"Value of the `utm_campaign` parameter of the URL that led to the request.\"},\"coupon\":{\"type\":\"string\",\"description\":\"Coupon's code information.\"},\"utmiCampaign\":{\"type\":\"string\",\"description\":\"Internal UTM value `utmi_cp`.\"},\"utmipage\":{\"type\":\"string\",\"description\":\"Internal UTM value `utmi_p`.\"},\"utmiPart\":{\"type\":\"string\",\"description\":\"Internal UTM value `utmi_pc`.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions.\",\"items\":{\"type\":\"string\"}}}},\"ratesAndBenefitsData\":{\"title\":\"RatesAndBenefitsData\",\"description\":\"Information on promotions and taxes that apply to the order.\",\"required\":[\"id\",\"rateAndBenefitsIdentifiers\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the rate or benefit.\"},\"rateAndBenefitsIdentifiers\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Information about order's promotions and taxes identifiers.\"}}},\"shippingData\":{\"title\":\"ShippingData\",\"description\":\"Object containing shipping data.\",\"required\":[\"id\",\"address\",\"logisticsInfo\",\"trackingHints\",\"selectedAddresses\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID, the expected value is `shippingData`.\"},\"address\":{\"title\":\"Address\",\"description\":\"Shipping address details.\",\"required\":[\"addressType\",\"receiverName\",\"addressId\",\"versionId\",\"entityId\",\"postalCode\",\"city\",\"state\",\"country\",\"street\",\"number\",\"neighborhood\",\"complement\",\"reference\",\"geoCoordinates\"],\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`, among others.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":\"string\",\"description\":\"Shipping address ID.\"},\"versionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address version ID.\"},\"entityId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address entity ID.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code of the shipping address.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3).\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement to the shipping address when it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to help locate the shipping address, in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"items\":{\"type\":\"number\"},\"description\":\"Array with two numbers with geocoordinates, first longitude then latitude.\"}}},\"logisticsInfo\":{\"type\":\"array\",\"items\":{\"title\":\"LogisticsInfo\",\"required\":[\"itemIndex\",\"selectedSla\",\"lockTTL\",\"price\",\"listPrice\",\"sellingPrice\",\"deliveryWindow\",\"deliveryCompany\",\"shippingEstimate\",\"shippingEstimateDate\",\"slas\",\"shipsTo\",\"deliveryIds\",\"deliveryChannels\",\"deliveryChannel\",\"pickupStoreInfo\",\"addressId\",\"versionId\",\"entityId\",\"polygonName\",\"pickupPointId\",\"transitTime\"],\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index of the item starting from 0.\"},\"selectedSla\":{\"type\":\"string\",\"description\":\"Selected shipping option.\"},\"lockTTL\":{\"type\":\"string\",\"description\":\"Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time.\"},\"price\":{\"type\":\"integer\",\"description\":\"Shipping price for the item in cents. Does not account for the whole order's shipping price.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"SKU's optional price for a specific trade policy.\"},\"sellingPrice\":{\"type\":\"integer\",\"description\":\"Item's selling price.\"},\"deliveryWindow\":{\"type\":[\"string\",\"null\"],\"description\":\"[Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, if it applies to the item.\"},\"deliveryCompany\":{\"type\":\"string\",\"description\":\"[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.\"},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Total shipping estimate time in days. For instance, three business days is represented `3bd`.\"},\"shippingEstimateDate\":{\"type\":\"string\",\"description\":\"Shipping estimate date. It is defined only after the confirmation of the order.\"},\"slas\":{\"type\":\"array\",\"items\":{\"title\":\"Sla\",\"required\":[\"id\",\"name\",\"shippingEstimate\",\"deliveryWindow\",\"price\",\"deliveryChannel\",\"pickupStoreInfo\",\"polygonName\",\"lockTTL\",\"pickupPointId\",\"transitTime\",\"pickupDistance\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the shipping policy.\"},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Total shipping estimate time in days. For instance, three business days is represented `3bd`.\"},\"deliveryWindow\":{\"type\":[\"string\",\"null\"],\"description\":\"[Scheduled delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, if it applies to the item.\"},\"price\":{\"type\":\"integer\",\"description\":\"Shipping price for the item in cents. Does not account for the whole order's shipping price.\"},\"deliveryChannel\":{\"type\":\"string\",\"description\":\"If the delivery channel is `delivery` or `pickup-in-point`.\"},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfo\",\"description\":\"Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\",\"required\":[\"additionalInfo\",\"address\",\"dockId\",\"friendlyName\",\"isPickupStore\"],\"type\":\"object\",\"properties\":{\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the pickup point.\"},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point's address.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the pickup point displayed at checkout.\"},\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"If this field is set `true`, it means the type of shipping is pickup, and if set as `false`, it is not.\"}}},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\"},\"lockTTL\":{\"type\":\"string\",\"description\":\"Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA.\"},\"pickupPointId\":{\"type\":\"string\",\"description\":\"[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA.\"},\"transitTime\":{\"type\":\"string\",\"description\":\"Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`.\"},\"pickupDistance\":{\"type\":\"number\",\"description\":\"Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.\"}}},\"description\":\"Information on Service Level Agreement (SLA), corresponding to [shipping policies](https://help.vtex.com/tutorial/shipping-policy--tutorials_140).\"},\"shipsTo\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3).\"},\"deliveryIds\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryId\",\"description\":\"Information about delivery IDs.\",\"required\":[\"courierId\",\"courierName\",\"dockId\",\"quantity\",\"warehouseId\",\"accountCarrierName\",\"kitItemDetails\"],\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)'s ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Carrier's name.\"},\"dockId\":{\"type\":\"string\",\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity of items.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\"},\"accountCarrierName\":{\"type\":\"string\",\"description\":\"Name of the account's [carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE).\"},\"kitItemDetails\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any.\",\"items\":{\"type\":\"string\"}}}},\"description\":\"Information about delivery IDs.\"},\"deliveryChannels\":{\"type\":\"array\",\"description\":\"List of delivery channels associated with the trade policy.\",\"items\":{\"type\":\"object\",\"required\":[\"id\",\"stockBalance\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel's shipping type, which can be `delivery` or `pickup-in-point`.\"},\"stockBalance\":{\"type\":\"integer\",\"description\":\"Stock check for an SKU availability.\"}}}},\"deliveryChannel\":{\"type\":\"string\",\"description\":\"If the delivery channel is `delivery` or `pickup-in-point`.\"},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfo\",\"description\":\"Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\",\"required\":[\"additionalInfo\",\"address\",\"dockId\",\"friendlyName\",\"isPickupStore\"],\"type\":\"object\",\"properties\":{\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the pickup point.\"},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point's address.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the pickup point displayed at checkout.\"},\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"If this field is set `true`, it means the type of shipping is pickup, and if set as `false`, it is not.\"}}},\"addressId\":{\"type\":\"string\",\"description\":\"Address ID.\"},\"versionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address version ID.\"},\"entityId\":{\"type\":\"string\",\"description\":\"Shipping address entity ID.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\"},\"pickupPointId\":{\"type\":\"string\",\"description\":\"[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)'s ID.\"},\"transitTime\":{\"type\":\"string\",\"description\":\"Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`.\"}}},\"description\":\"Array of objects containing item's logistics information.\"},\"trackingHints\":{\"type\":[\"string\",\"null\"]},\"selectedAddresses\":{\"type\":\"array\",\"items\":{\"title\":\"SelectedAddress\",\"required\":[\"addressId\",\"versionId\",\"entityId\",\"addressType\",\"receiverName\",\"street\",\"number\",\"complement\",\"neighborhood\",\"postalCode\",\"city\",\"state\",\"country\",\"reference\",\"geoCoordinates\"],\"type\":\"object\",\"properties\":{\"addressId\":{\"type\":\"string\",\"description\":\"Selected address ID.\"},\"versionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address version ID of the selected address.\"},\"entityId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address entity ID of the selected address.\"},\"addressType\":{\"type\":\"string\",\"description\":\"Selected adress's shipping type, which can be `pickup`, `residential`, `invoice`, `search`, `inStore`, `commercial` or `giftRegistry`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order in the selected address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the selected address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment of the selected address.\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement to the selected address if it applies.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the selected address.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code of the selected address.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the selected address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the selected address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letters ISO code of the country of the selected address (ISO 3166 ALPHA-3).\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to help locate the selected address.\"},\"geoCoordinates\":{\"type\":\"array\",\"items\":{\"type\":\"number\"},\"description\":\"Array with two numbers with the selected address's geocoordinates, first longitude then latitude.\"}}},\"description\":\"Information about selected adresses.\"}}},\"paymentData\":{\"title\":\"PaymentData\",\"description\":\"Object with information about the payment.\",\"required\":[\"transactions\"],\"type\":\"object\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Array with information about Gift Cards.\",\"items\":{\"type\":\"string\"}},\"transactions\":{\"type\":\"array\",\"items\":{\"title\":\"Transaction\",\"description\":\"Financial transaction details.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"type\":\"object\",\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"When this field is set as `true`, the payment is active, and when it is `false`, the payment is inactive.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"ID of the transaction.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Name of the merchant that will receive the payment.\"},\"payments\":{\"type\":\"array\",\"items\":{\"title\":\"Payment\",\"description\":\"Payment details.\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\",\"giftCardProvider\",\"giftCardAsDiscount\",\"koinUrl\",\"accountId\",\"parentAccountId\",\"bankIssuedInvoiceIdentificationNumber\",\"bankIssuedInvoiceIdentificationNumberFormatted\",\"bankIssuedInvoiceBarCodeNumber\",\"bankIssuedInvoiceBarCodeType\",\"billingAddress\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"VTEX payment ID that can be used as unique identifier.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system's ID.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system's name.\"},\"value\":{\"type\":\"integer\",\"description\":\"Payment's final amount in cents.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Payment's reference value in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the person who owns the card.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Numeric sequence of the card used in the transaction.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Fist digits of the card used in the transaction.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Last digits of the card used in the transaction.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Expire month of the card used in the transaction (2-digits).\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Expire year of the card used in the transaction (4-digits).\"},\"url\":{\"type\":\"string\",\"description\":\"Payment's URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift Card's ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift Card's name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift Card's caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Code for the customer to use the Gift Card.\"},\"group\":{\"type\":\"string\",\"description\":\"Name of the collection the Gift Card belongs to.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Provider's unique identifier for the transaction.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Payment due date, with the format `yyyy-mm-dd`.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Information about the connector responses.\",\"required\":[\"Tid\",\"ReturnCode\",\"Message\",\"authId\"],\"properties\":{\"Tid\":{\"type\":\"string\",\"description\":\"Provider's unique identifier for the transaction.\"},\"ReturnCode\":{\"type\":\"string\",\"description\":\"Provider's operation/error code to be logged.\"},\"Message\":{\"type\":\"string\",\"description\":\"Provider's operation/error message to be logged.\"},\"authId\":{\"type\":\"string\",\"description\":\"Connector's authorization ID.\"}}},\"giftCardProvider\":{\"type\":\"string\",\"description\":\"Gift Card provider's ID.\"},\"giftCardAsDiscount\":{\"type\":\"boolean\",\"description\":\"When this field is set as `true`, the Gift Card is a discount over the price, and when set as `false`, it is not a discount.\"},\"koinUrl\":{\"type\":\"string\",\"description\":\"Payment's account ID.\"},\"accountId\":{\"type\":\"string\",\"description\":\"Payment's account ID.\"},\"parentAccountId\":{\"type\":\"string\",\"description\":\"This field retrieves the main account if the payment was made in a subaccount.\"},\"bankIssuedInvoiceIdentificationNumber\":{\"type\":\"string\",\"description\":\"Numeric sequence that identifies the bank issued invoice.\"},\"bankIssuedInvoiceIdentificationNumberFormatted\":{\"type\":\"string\",\"description\":\"Bank issued invoice ID formatted.\"},\"bankIssuedInvoiceBarCodeNumber\":{\"type\":\"string\",\"description\":\"Number of the bank issued invoice bar code.\"},\"bankIssuedInvoiceBarCodeType\":{\"type\":\"string\",\"description\":\"Type of the bank issued invoice bar code.\"},\"billingAddress\":{\"type\":\"object\",\"description\":\"Billing address information.\"}}},\"description\":\"Detailed information about payment.\"}}},\"description\":\"Information about financial transactions.\"}}},\"packageAttachment\":{\"title\":\"PackageAttachment\",\"description\":\"Package object populated after order invoiced.\",\"required\":[\"packages\"],\"type\":\"object\",\"properties\":{\"packages\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Packages details.\"}}},\"sellers\":{\"type\":\"array\",\"items\":{\"title\":\"Seller\",\"description\":\"Information about the seller associated with the order.\",\"required\":[\"id\",\"name\",\"logo\",\"fulfillmentEndpoint\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID that identifies the seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller's name.\"},\"logo\":{\"type\":\"string\",\"description\":\"URL of the seller's logo.\"},\"fulfillmentEndpoint\":{\"type\":\"string\",\"description\":\"URL of the endpoint for fulfillment of seller's orders.\"}}},\"description\":\"List of all sellers associated with the order.\"},\"callCenterOperatorData\":{\"type\":[\"string\",\"null\"],\"description\":\"Call center operator responsible for the order.\"},\"followUpEmail\":{\"type\":\"string\",\"description\":\"Email of the store's employee responsible for managing the order.\"},\"lastMessage\":{\"type\":[\"string\",\"null\"],\"description\":\"Last sent transactional message.\"},\"hostname\":{\"type\":\"string\",\"description\":\"Account Hostname registered in License Manager.\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information pertinent to the order's invoice.\"},\"changesAttachment\":{\"title\":\"ChangesAttachment\",\"description\":\"Information about changes in the order.\",\"required\":[\"id\",\"changesData\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID, the expect value is `changeAttachment`.\"},\"changesData\":{\"type\":\"array\",\"items\":{\"title\":\"ChangesDatum\",\"required\":[\"reason\",\"discountValue\",\"incrementValue\",\"itemsAdded\",\"itemsRemoved\",\"receipt\"],\"type\":\"object\",\"properties\":{\"reason\":{\"type\":\"string\",\"description\":\"Text explaining why there was a change in the order. This information may be shown to the customer in the UI or transactional emails.\"},\"discountValue\":{\"type\":\"integer\",\"description\":\"Order change discount value.\"},\"incrementValue\":{\"type\":\"integer\",\"description\":\"Order change increment value.\"},\"itemsAdded\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"List of items added to the order.\"},\"itemsRemoved\":{\"type\":\"array\",\"items\":{\"title\":\"ItemsRemoved\",\"required\":[\"id\",\"name\",\"quantity\",\"price\",\"unitMultiplier\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID of the item removed from the order.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the item removed from the order.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity of items removed from the order.\"},\"price\":{\"type\":\"integer\",\"description\":\"Total amount of items removed from the order.\"},\"unitMultiplier\":{\"type\":[\"string\",\"null\"],\"description\":\"Unit multiplier of the item removed from the order.\"}}},\"description\":\"List of items removed from the order.\"},\"receipt\":{\"title\":\"Receipt\",\"description\":\"Information about the receipt for changed orders.\",\"required\":[\"date\",\"orderId\",\"receipt\"],\"type\":\"object\",\"properties\":{\"date\":{\"type\":\"string\",\"description\":\"Date when the receipt was created.\"},\"orderId\":{\"type\":\"string\",\"description\":\"ID of the order.\"},\"receipt\":{\"type\":\"string\",\"description\":\"Receipt's unique identifier code.\"}}}}},\"description\":\"Order change details.\"}}},\"openTextField\":{\"type\":[\"string\",\"null\"],\"description\":\"Optional field with order's additional information. This field must be filled in using the following format: \\n\\r```\\n\\r{\\r\\n \\\"fieldExample\\\": \\\"ValueExample\\\"\\r\\n }\\n\\r```\\n\\r.\"},\"roundingError\":{\"type\":\"integer\",\"description\":\"Rounding error total amount, if it applies. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount amount, which is informed in this field.\"},\"orderFormId\":{\"type\":\"string\",\"description\":\"[Order form](https://developers.vtex.com/docs/guides/orderform-fields) ID.\"},\"commercialConditionData\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about commercial conditions.\"},\"isCompleted\":{\"type\":\"boolean\",\"description\":\"When set as `true`, the order's payment has been settled, and when set as `false`, it has not been settled yet.\"},\"customData\":{\"type\":[\"string\",\"null\"],\"description\":\"Custom information in the order. This field is useful for storing data not included in other fields, for example, a message for a gift or a name to be printed in a shirt.\"},\"storePreferencesData\":{\"title\":\"StorePreferencesData\",\"description\":\"Object with data from the store's configuration - stored in VTEX's License Manager.\",\"required\":[\"countryCode\",\"currencyCode\",\"currencyFormatInfo\",\"currencyLocale\",\"currencySymbol\",\"timeZone\"],\"type\":\"object\",\"properties\":{\"countryCode\":{\"type\":\"string\",\"description\":\"Three letters ISO code of the country (ISO 3166 ALPHA-3).\"},\"currencyCode\":{\"type\":\"string\",\"description\":\"Currency code in ISO 4217. For example, `BRL`.\"},\"currencyFormatInfo\":{\"title\":\"CurrencyFormatInfo\",\"description\":\"Object with currency format details.\",\"required\":[\"CurrencyDecimalDigits\",\"CurrencyDecimalSeparator\",\"CurrencyGroupSeparator\",\"CurrencyGroupSize\",\"StartsWithCurrencySymbol\"],\"type\":\"object\",\"properties\":{\"CurrencyDecimalDigits\":{\"type\":\"integer\",\"description\":\"Quantity of currency decimal digits.\"},\"CurrencyDecimalSeparator\":{\"type\":\"string\",\"description\":\"Defines what currency decimal separator will be applied.\"},\"CurrencyGroupSeparator\":{\"type\":\"string\",\"description\":\"Defines what currency group separator will be applied.\"},\"CurrencyGroupSize\":{\"type\":\"integer\",\"description\":\"Defines how many characters will be grouped.\"},\"StartsWithCurrencySymbol\":{\"type\":\"boolean\",\"description\":\"Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`).\"}}},\"currencyLocale\":{\"type\":\"integer\",\"description\":\"Currency Locale Code in LCID in decimal.\"},\"currencySymbol\":{\"type\":\"string\",\"description\":\"Currency symbol.\"},\"timeZone\":{\"type\":\"string\",\"description\":\"Time zone from where the order was made.\"}}},\"allowCancellation\":{\"type\":\"boolean\",\"description\":\"When set as `true`, the order can be canceled, and when set as `false`, it is no longer possible to cancel the order.\"},\"allowEdition\":{\"type\":\"boolean\",\"description\":\"When set as `true`, the order can be edited, and when set as `false`, it is no longer possible to edit the order.\"},\"isCheckedIn\":{\"type\":\"boolean\",\"description\":\"This field is set `true` when the order was made via inStore and `false` when it was not.\"},\"marketplace\":{\"title\":\"Marketplace\",\"description\":\"Details about the marketplace related to the order.\",\"required\":[\"baseURL\",\"isCertified\",\"name\"],\"type\":\"object\",\"properties\":{\"baseURL\":{\"type\":\"string\",\"description\":\"Marketplace base URL.\"},\"isCertified\":{\"type\":[\"string\",\"null\"],\"description\":\"If is a certified marketplace.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the marketplace.\"}}},\"authorizedDate\":{\"type\":\"string\",\"description\":\"Authorized order date.\"},\"invoicedDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Order's invoice date.\"},\"cancelReason\":{\"type\":[\"string\",\"null\"],\"description\":\"Reason for order cancellation.\"},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Metadata information about the order's items.\",\"required\":[\"Items\"],\"properties\":{\"Items\":{\"type\":\"array\",\"description\":\"Metadata items.\",\"items\":{\"type\":\"object\",\"required\":[\"Id\",\"Seller\",\"Name\",\"SkuName\",\"ProductId\",\"RefId\",\"Ean\",\"ImageUrl\",\"DetailUrl\",\"AssemblyOptions\"],\"properties\":{\"Id\":{\"type\":\"string\",\"description\":\"Item's SKU ID, which is a unique numerical identifier.\"},\"Seller\":{\"type\":\"string\",\"description\":\"Seller ID that identifies the seller the item belongs to.\"},\"Name\":{\"type\":\"string\",\"description\":\"Name of the item as displayed to customers in the storefront.\"},\"SkuName\":{\"type\":\"string\",\"description\":\"Name of the SKU corresponding to the item.\"},\"ProductId\":{\"type\":\"string\",\"description\":\"ID of the Product associated with the item.\"},\"RefId\":{\"type\":\"string\",\"description\":\"Item's reference ID.\"},\"Ean\":{\"type\":\"string\",\"description\":\"EAN of the item.\"},\"ImageUrl\":{\"type\":\"string\",\"description\":\"Item's SKU image URL.\"},\"DetailUrl\":{\"type\":\"string\",\"description\":\"URL slug of the item.\"},\"AssemblyOptions\":{\"type\":\"array\",\"description\":\"Displays information about [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) related to the item, if there are any.\",\"items\":{\"required\":[\"Id\",\"Name\",\"Required\",\"InputValues\",\"Composition\"],\"type\":\"object\",\"properties\":{\"Id\":{\"type\":\"string\",\"description\":\"ID of the attachment related to the order.\"},\"Name\":{\"type\":\"string\",\"description\":\"Name of the attachment related to the order.\"},\"Required\":{\"type\":\"boolean\",\"description\":\"If this field is set as `true`, when the customer purchases the item sending the attachment is required, and when set as `false`, sending the attachment is optional.\"},\"InputValues\":{\"type\":[\"object\",\"null\"],\"description\":\"Displays the attachment's content.\"},\"Composition\":{\"type\":[\"object\",\"null\"],\"description\":\"Displays the attachment's composition.\"}}}}}}}}},\"subscriptionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about [subscriptions](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453).\",\"required\":[\"SubscriptionGroupId\",\"Subscriptions\"],\"properties\":{\"SubscriptionGroupId\":{\"type\":\"string\",\"description\":\"ID of the subscription's group. If this field returns `null` and the `executionCount` is `0`, the order is the first one with subscriptions.\"},\"Subscriptions\":{\"type\":[\"array\",\"null\"],\"description\":\"List with subscriptions and their details.\",\"items\":{\"type\":\"object\",\"required\":[\"ExecutionCount\",\"PriceAtSubscriptionDate\",\"ItemIndex\",\"Plan\"],\"properties\":{\"ExecutionCount\":{\"type\":\"integer\",\"description\":\"Position of the order in the subscription cycle. The first order will have the value `0`, the second will have the value `1`, and so on.\"},\"PriceAtSubscriptionDate\":{\"type\":\"number\",\"description\":\"Price of the order when the customer signed up for subscriptions. Subscriptions created from Admin UI or APIs do not have an original order, so the field returns `0.0`. This field was valid only for Subscriptions v2 and is deprecated in Subscriptions v3.\"},\"ItemIndex\":{\"type\":\"integer\",\"description\":\"Each item in the subscriptions' order is identified by an index. The position starts in`0`, followed by `1`, `2`, and so on.\"},\"Plan\":{\"type\":\"object\",\"description\":\"Information about the subscription's validility and frequency.\",\"required\":[\"type\",\"frequency\",\"validity\"],\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Type of plan.\"},\"frequency\":{\"type\":\"object\",\"description\":\"Information about subscriptions' recurrence.\",\"required\":[\"periodicity\",\"interval\"],\"properties\":{\"periodicity\":{\"type\":\"string\",\"description\":\"Defines the subscriptions recurrence period. The possible values are `DAILY`,`WEEKLY`, `MONTHLY` and `YEARLY`.\"},\"interval\":{\"type\":\"integer\",\"description\":\"Number of the time interval configured between subscription orders, which depends on the periodicity. For a `DAILY` periodicity, the field's value will correspond to days, for `MONTHLY` to months, and so on.\"}}},\"validity\":{\"type\":\"object\",\"description\":\"Information about the period during which the subscription will be valid.\",\"required\":[\"begin\",\"end\"],\"properties\":{\"begin\":{\"type\":\"string\",\"description\":\"Subscriptions' beginning date with the format `yyyy-mm-ddThh:mm:ss`.\"},\"end\":{\"type\":\"string\",\"description\":\"Subscriptions' ending date with the format `yyyy-mm-ddThh:mm:ss`.\"}}}}}}}}}},\"taxData\":{\"type\":\"object\",\"description\":\"Order's tax information.\",\"required\":[\"areTaxesDesignatedByMarketplace\",\"taxInfoCollection\"],\"properties\":{\"areTaxesDesignatedByMarketplace\":{\"type\":\"boolean\",\"description\":\"If the taxes were designated by the marketplace (`true`) or not (`false`).\"},\"taxInfoCollection\":{\"type\":\"array\",\"description\":\"Array with taxes' details.\",\"items\":{\"type\":\"object\",\"required\":[\"itemIndex\",\"sku\",\"priceTags\"],\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Item's indexing number.\"},\"sku\":{\"type\":\"string\",\"description\":\"Alphanumeric sequence that identifies an SKU.\"},\"priceTags\":{\"type\":\"array\",\"description\":\"Price tag information.\",\"items\":{\"type\":\"object\",\"required\":[\"isPercentual\",\"name\",\"rawValue\"],\"properties\":{\"isPercentual\":{\"type\":\"boolean\",\"description\":\"If the tax is a percentage (`true`) or note (`false`).\"},\"name\":{\"type\":\"string\",\"description\":\"Name that identifies the tax.\"},\"rawValue\":{\"type\":\"string\",\"description\":\"The amount that corresponds to the tax.\"}}}}}}}}},\"checkedInPickupPointId\":{\"type\":\"string\",\"description\":\"If the field `isCheckedIn` is set as `true`, the `checkedInPickupPointId` will retrieve the ID of the physical store where the order was made.\"},\"cancellationData\":{\"type\":\"object\",\"description\":\"Information about order cancellation, when it applies.\",\"required\":[\"RequestedByUser\",\"RequestedBySystem\",\"RequestedBySellerNotification\",\"RequestedByPaymentNotification\",\"Reason\",\"CancellationDate\"],\"properties\":{\"RequestedByUser\":{\"type\":\"boolean\",\"description\":\"If the order cancellation was requested by the costumer (`true`) or not (`false`).\"},\"RequestedBySystem\":{\"type\":\"boolean\",\"description\":\"If the order cancellation was made by the system (`true`) or not (`false`). This type of order cancellation happens in [incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294), for example.\"},\"RequestedBySellerNotification\":{\"type\":\"boolean\",\"description\":\"If the order cancellation was requested by the seller (`true`) or not (`false`).\"},\"RequestedByPaymentNotification\":{\"type\":\"boolean\",\"description\":\"If the order cancellation was requested by the payment gateway (`true`) or not (`false`).\"},\"Reason\":{\"type\":\"string\",\"description\":\"The reason why the order was cancelled.\"},\"CancellationDate\":{\"type\":\"string\",\"description\":\"The date when the order was cancelled.\"}}},\"clientPreferencesData\":{\"type\":\"object\",\"description\":\"Information about customer's preferences.\",\"required\":[\"locale\",\"optinNewsLetter\"],\"properties\":{\"locale\":{\"type\":\"string\",\"description\":\"Customer's prefered language while accessing the store.\"},\"optinNewsLetter\":{\"type\":\"boolean\",\"description\":\"When set as `true`, this field indicates customers opted to receive the newsletters, and when set as `false`, it means they did not.\"}}}},\"example\":{\"orderId\":\"v502556llux-01\",\"sequence\":\"502556\",\"marketplaceOrderId\":\"\",\"marketplaceServicesEndpoint\":\"http://oms.vtexinternal.com.br/api/oms?an=luxstore\",\"sellerOrderId\":\"00-v502556llux-01\",\"origin\":\"Marketplace\",\"affiliateId\":\"\",\"salesChannel\":\"1\",\"merchantName\":\"luxstore\",\"status\":\"handling\",\"statusDescription\":\"Preparando Entrega\",\"value\":1160,\"creationDate\":\"2019-01-28T20:09:43.899958+00:00\",\"lastChange\":\"2019-02-06T20:46:11.7010747+00:00\",\"orderGroup\":\"v502556lspt\",\"totals\":[{\"id\":\"Items\",\"name\":\"Total dos Itens\",\"value\":3290},{\"id\":\"Discounts\",\"name\":\"Total dos Descontos\",\"value\":0},{\"id\":\"Shipping\",\"name\":\"Total do Frete\",\"value\":1160},{\"id\":\"Tax\",\"name\":\"Total da Taxa\",\"value\":0},{\"id\":\"Change\",\"name\":\"Total das mudanças\",\"value\":-3290}],\"items\":[{\"uniqueId\":\"87F0945396994B349158C7D9C9941442\",\"id\":\"1234568358\",\"productId\":\"9429485\",\"ean\":null,\"lockId\":\"00-v502556llux-01\",\"itemAttachment\":{\"content\":{},\"name\":null},\"attachments\":[],\"quantity\":1,\"seller\":\"1\",\"name\":\"Bay Max L\",\"refId\":\"BIGHEROBML\",\"price\":3290,\"listPrice\":3290,\"manualPrice\":null,\"priceTags\":[],\"imageUrl\":\"http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000\",\"detailUrl\":\"/bay-max-9429485/p\",\"components\":[],\"bundleItems\":[],\"params\":[],\"offerings\":[],\"attachmentOfferings\":[{\"name\":\"vtex.subscription.weekly\",\"required\":false,\"schema\":{\"vtex.subscription.key.frequency\":{\"MaximumNumberOfCharacters\":7,\"Domain\":[\" 1 week\",\" 2 week\",\" 3 week\",\" 4 week\"]}}}],\"sellerSku\":\"1234568358\",\"priceValidUntil\":null,\"commission\":0,\"tax\":0,\"preSaleDate\":null,\"additionalInfo\":{\"brandName\":\"VTEX\",\"brandId\":\"2000023\",\"categoriesIds\":\"/1/\",\"productClusterId\":\"135,142\",\"commercialConditionId\":\"5\",\"dimension\":{\"cubicweight\":0.7031,\"height\":15,\"length\":15,\"weight\":15,\"width\":15},\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null},\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"sellingPrice\":3290,\"isGift\":false,\"shippingPrice\":null,\"rewardValue\":0,\"freightCommission\":0,\"priceDefinitions\":{\"sellingPrices\":[{\"value\":99,\"quantity\":1}],\"calculatedSellingPrice\":99,\"total\":99},\"taxCode\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"callCenterOperator\":\"callCenterOp5473869\",\"serialNumbers\":\"3\",\"assemblies\":[],\"costPrice\":52}],\"marketplaceItems\":[],\"clientProfileData\":{\"id\":\"clientProfileData\",\"email\":\"rodrigo.cunha@vtex.com.br\",\"firstName\":\"Rodrigo\",\"lastName\":\"Cunha\",\"documentType\":\"cpf\",\"document\":\"11047867702\",\"phone\":\"+5521972321094\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":null,\"corporatePhone\":null,\"isCorporate\":false,\"userProfileId\":\"5a3692de-358a-4bea-8885-044bce33bb93\",\"customerClass\":null},\"giftRegistryData\":null,\"marketingData\":{\"id\":\"marketingData\",\"utmSource\":\"fb\",\"utmPartner\":\"utm partner\",\"utmMedium\":\"utm medium\",\"utmCampaign\":\"christmas\",\"coupon\":\"sale\",\"utmiCampaign\":\" \",\"utmipage\":\" \",\"utmiPart\":\" \",\"marketingTags\":[\"vtex-subscription\"]},\"ratesAndBenefitsData\":{\"id\":\"ratesAndBenefitsData\",\"rateAndBenefitsIdentifiers\":[]},\"shippingData\":{\"id\":\"shippingData\",\"address\":{\"addressType\":\"residential\",\"receiverName\":\"Rodrigo Cunha\",\"addressId\":\"-1425945657910\",\"versionId\":\"e9c3bec2-125d-4b96-a021-316c3aa9f14f\",\"entityId\":\"eabfb564-99d6-40d8-bd6c-bddbd4990aad\",\"postalCode\":\"22250-040\",\"city\":\"Rio de Janeiro\",\"state\":\"RJ\",\"country\":\"BRA\",\"street\":\"Praia de Botafogo\",\"number\":\"518\",\"neighborhood\":\"Botafogo\",\"complement\":\"10\",\"reference\":null,\"geoCoordinates\":[]},\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Normal\",\"lockTTL\":\"10d\",\"price\":1160,\"listPrice\":1160,\"sellingPrice\":1160,\"deliveryWindow\":null,\"deliveryCompany\":\"Todos os CEPS\",\"shippingEstimate\":\"5bd\",\"shippingEstimateDate\":\"2019-02-04T20:33:46.4595004+00:00\",\"slas\":[{\"id\":\"Normal\",\"name\":\"Normal\",\"shippingEstimate\":\"5bd\",\"deliveryWindow\":null,\"price\":1160,\"deliveryChannel\":\"delivery\",\"pickupStoreInfo\":{\"additionalInfo\":null,\"address\":null,\"dockId\":null,\"friendlyName\":null,\"isPickupStore\":false},\"polygonName\":\"region13\",\"lockTTL\":\"12d\",\"pickupPointId\":\"1_VTEX-RJ\",\"transitTime\":\"0d\",\"pickupDistance\":29.861602783203125},{\"id\":\"Expressa\",\"name\":\"Expressa\",\"shippingEstimate\":\"5bd\",\"deliveryWindow\":null,\"price\":1160,\"deliveryChannel\":\"delivery\",\"pickupStoreInfo\":{\"additionalInfo\":null,\"address\":null,\"dockId\":null,\"friendlyName\":null,\"isPickupStore\":false},\"polygonName\":\"region13\",\"lockTTL\":\"12d\",\"pickupPointId\":\"1_VTEX-RJ\",\"transitTime\":\"0d\",\"pickupDistance\":29.861602783203125},{\"id\":\"Quebra Kit\",\"name\":\"Quebra Kit\",\"shippingEstimate\":\"2bd\",\"deliveryWindow\":null,\"price\":1392,\"deliveryChannel\":\"delivery\",\"pickupStoreInfo\":{\"additionalInfo\":null,\"address\":null,\"dockId\":null,\"friendlyName\":null,\"isPickupStore\":false},\"polygonName\":\"region13\",\"lockTTL\":\"12d\",\"pickupPointId\":\"1_VTEX-RJ\",\"transitTime\":\"0d\",\"pickupDistance\":29.861602783203125},{\"id\":\"Sob Encomenda\",\"name\":\"Sob Encomenda\",\"shippingEstimate\":\"32bd\",\"deliveryWindow\":null,\"price\":1392,\"deliveryChannel\":\"delivery\",\"pickupStoreInfo\":{\"additionalInfo\":null,\"address\":null,\"dockId\":null,\"friendlyName\":null,\"isPickupStore\":false},\"polygonName\":\"region13\",\"lockTTL\":\"12d\",\"pickupPointId\":\"1_VTEX-RJ\",\"transitTime\":\"0d\",\"pickupDistance\":29.861602783203125}],\"shipsTo\":[\"BRA\"],\"deliveryIds\":[{\"courierId\":\"197a56f\",\"courierName\":\"Todos os CEPS\",\"dockId\":\"1\",\"quantity\":1,\"warehouseId\":\"1_1\",\"accountCarrierName\":\"recorrenciaqa\",\"kitItemDetails\":[]}],\"deliveryChannels\":[{\"id\":\"delivery\",\"stockBalance\":0}],\"deliveryChannel\":\"delivery\",\"pickupStoreInfo\":{\"additionalInfo\":null,\"address\":null,\"dockId\":null,\"friendlyName\":null,\"isPickupStore\":false},\"addressId\":\"-1425945657910\",\"versionId\":\"e9c3bec2-125d-4b96-a021-316c3aa9f14f\",\"entityId\":\"eabfb564-99d6-40d8-bd6c-bddbd4990aad\",\"polygonName\":\"region56\",\"pickupPointId\":\"1_VTEX-RJ\",\"transitTime\":\"3d\"}],\"trackingHints\":null,\"selectedAddresses\":[{\"addressId\":\"-1425945657910\",\"versionId\":\"e9c3bec2-125d-4b96-a021-316c3aa9f14f\",\"entityId\":\"eabfb564-99d6-40d8-bd6c-bddbd4990aad\",\"addressType\":\"residential\",\"receiverName\":\"Rodrigo Cunha\",\"street\":\"Praia de Botafogo\",\"number\":\"518\",\"complement\":\"10\",\"neighborhood\":\"Botafogo\",\"postalCode\":\"22250-040\",\"city\":\"Rio de Janeiro\",\"state\":\"RJ\",\"country\":\"BRA\",\"reference\":null,\"geoCoordinates\":[]}]},\"paymentData\":{\"transactions\":[{\"isActive\":true,\"transactionId\":\"418213DE29634837A63DD693A937A696\",\"merchantName\":\"luxstore\",\"payments\":[{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{\"Tid\":\"94857956\",\"ReturnCode\":\"200\",\"Message\":\"logMessage\",\"authId\":\"857956\"},\"giftCardProvider\":\"presentCard\",\"giftCardAsDiscount\":false,\"koinUrl\":\"koinURL\",\"accountId\":\"5BC5C6B417FE432AB971B1D399F190C9\",\"parentAccountId\":\"5BC5C6B417FE432AB971B1D399F190C9\",\"bankIssuedInvoiceIdentificationNumber\":\"23797770100000019003099260100022107500729050\",\"bankIssuedInvoiceIdentificationNumberFormatted\":\"32534.95739 75945.24534 54395.734214 5\",\"bankIssuedInvoiceBarCodeNumber\":\"325349573975945245345439573421443986734065\",\"bankIssuedInvoiceBarCodeType\":\"i25\",\"billingAddress\":{}}]}]},\"packageAttachment\":{\"packages\":[]},\"sellers\":[{\"id\":\"1\",\"name\":\"Lux Store\",\"logo\":\"https://sellersLogo/images.png\",\"fulfillmentEndpoint\":\"http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName\"}],\"callCenterOperatorData\":null,\"followUpEmail\":\"7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br\",\"lastMessage\":null,\"hostname\":\"luxstore\",\"invoiceData\":null,\"changesAttachment\":{\"id\":\"changeAttachment\",\"changesData\":[{\"reason\":\"Blah\",\"discountValue\":3290,\"incrementValue\":0,\"itemsAdded\":[],\"itemsRemoved\":[{\"id\":\"1234568358\",\"name\":\"Bay Max L\",\"quantity\":1,\"price\":3290,\"unitMultiplier\":null}],\"receipt\":{\"date\":\"2019-02-06T20:46:04.4003606+00:00\",\"orderId\":\"v502556llux-01\",\"receipt\":\"029f9ab8-751a-4b1e-bf81-7dd25d14b49b\"}}]},\"openTextField\":null,\"roundingError\":0,\"orderFormId\":\"caae7471333e403f959fa5fd66951340\",\"commercialConditionData\":null,\"isCompleted\":true,\"customData\":null,\"storePreferencesData\":{\"countryCode\":\"BRA\",\"currencyCode\":\"BRL\",\"currencyFormatInfo\":{\"CurrencyDecimalDigits\":2,\"CurrencyDecimalSeparator\":\",\",\"CurrencyGroupSeparator\":\".\",\"CurrencyGroupSize\":3,\"StartsWithCurrencySymbol\":true},\"currencyLocale\":1046,\"currencySymbol\":\"R$\",\"timeZone\":\"E. South America Standard Time\"},\"allowCancellation\":true,\"allowEdition\":false,\"isCheckedIn\":false,\"marketplace\":{\"baseURL\":\"http://oms.vtexinternal.com.br/api/oms?an=luxstore\",\"isCertified\":null,\"name\":\"luxstore\"},\"authorizedDate\":\"2019-01-28T20:33:04+00:00\",\"invoicedDate\":null,\"cancelReason\":\"The size was too big.\",\"itemMetadata\":{\"Items\":[{\"Id\":\"18\",\"Seller\":\"1\",\"Name\":\"Cat food\",\"SkuName\":\"Cat food\",\"ProductId\":\"6\",\"RefId\":\"105\",\"Ean\":\"43673557\",\"ImageUrl\":\"http://store.vteximg.com.br/ids/155392-55-55/AlconKOI.jpg?v=635918402228600000\",\"DetailUrl\":\"/catfood/p\",\"AssemblyOptions\":[{\"Id\":\"vtex.subscription.plan-ana\",\"Name\":\"vtex.subscription.plan-ana\",\"Required\":false,\"InputValues\":{\"vtex.subscription.key.frequency\":{\"MaximumNumberOfCharacters\":8,\"Domain\":[\"4 month\",\"1 month\"]}},\"Composition\":{}}]}]},\"subscriptionData\":{\"SubscriptionGroupId\":\"A64AC73C0FB8693A7ADB4AC69CA4FD5F\",\"Subscriptions\":[{\"ExecutionCount\":724,\"PriceAtSubscriptionDate\":100,\"ItemIndex\":0,\"Plan\":{\"type\":\"RECURRING_PAYMENT\",\"frequency\":{\"periodicity\":\"DAILY\",\"interval\":1},\"validity\":{\"begin\":\"2022-01-10T00:00:00.0000000+00:00\",\"end\":\"2024-02-03T00:00:00.0000000+00:00\"}}}]},\"taxData\":{\"areTaxesDesignatedByMarketplace\":true,\"taxInfoCollection\":[{\"itemIndex\":0,\"sku\":\"COLOCAR_O_SKUID\",\"priceTags\":[{\"isPercentual\":false,\"name\":\"Taxes (Magazine Luisa)\",\"rawValue\":\"COLOCAR_O_VALOR_SEM_DECIMAL\"}]}]},\"checkedInPickupPointId\":\"storeNameExample_901\",\"cancellationData\":{\"RequestedByUser\":true,\"RequestedBySystem\":false,\"RequestedBySellerNotification\":false,\"RequestedByPaymentNotification\":false,\"Reason\":\"Item was too big in the client.\",\"CancellationDate\":\"2022-10--05T15:40:33\"},\"clientPreferencesData\":{\"locale\":\"en-US\",\"optinNewsLetter\":false}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/oms/user/orders/:orderId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Userorderdetails\",\"required\":[\"orderId\",\"sequence\",\"marketplaceOrderId\",\"marketplaceServicesEndpoint\",\"sellerOrderId\",\"origin\",\"affiliateId\",\"salesChannel\",\"merchantName\",\"status\",\"statusDescription\",\"value\",\"creationDate\",\"lastChange\",\"orderGroup\",\"totals\",\"items\",\"marketplaceItems\",\"clientProfileData\",\"giftRegistryData\",\"marketingData\",\"ratesAndBenefitsData\",\"shippingData\",\"paymentData\",\"packageAttachment\",\"sellers\",\"callCenterOperatorData\",\"followUpEmail\",\"lastMessage\",\"hostname\",\"invoiceData\",\"changesAttachment\",\"openTextField\",\"roundingError\",\"orderFormId\",\"commercialConditionData\",\"isCompleted\",\"customData\",\"storePreferencesData\",\"allowCancellation\",\"allowEdition\",\"isCheckedIn\",\"marketplace\",\"authorizedDate\",\"invoicedDate\",\"cancelReason\",\"itemMetadata\",\"subscriptionData\",\"taxData\",\"checkedInPickupPointId\",\"cancellationData\",\"clientPreferencesData\"],\"type\":\"object\",\"properties\":{\"orderId\":{\"type\":\"string\",\"description\":\"Order ID is a unique code that identifies an order.\"},\"sequence\":{\"type\":\"string\",\"description\":\"Sequence is a six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`.\"},\"marketplaceOrderId\":{\"type\":\"string\",\"description\":\"Marketplace order ID.\"},\"marketplaceServicesEndpoint\":{\"type\":\"string\",\"description\":\"Marketplace services endpoint.\"},\"sellerOrderId\":{\"type\":\"string\",\"description\":\"ID of the seller related to the order. It can be a VTEX seller or an external seller.\"},\"origin\":{\"type\":\"string\",\"description\":\"Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`.\"},\"affiliateId\":{\"type\":\"string\",\"description\":\"Corresponds to the three-digit [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code of the seller responsible for the order.\"},\"salesChannel\":{\"type\":\"string\",\"description\":\"Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Name of the merchant.\"},\"status\":{\"type\":\"string\",\"description\":\"Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).\"},\"statusDescription\":{\"type\":\"string\",\"description\":\"`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value.\"},\"value\":{\"type\":\"integer\",\"description\":\"Order's total amount.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Order's creation date.\"},\"lastChange\":{\"type\":\"string\",\"description\":\"Order's last change date.\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Order's group ID.\"},\"totals\":{\"type\":\"array\",\"items\":{\"required\":[\"id\",\"name\",\"value\"],\"type\":\"object\",\"description\":\"Object about order's totals.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Code that identifies if the information is about `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total amount of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.\"}}},\"description\":\"List with details about orders' totals.\"},\"items\":{\"type\":\"array\",\"items\":{\"required\":[\"uniqueId\",\"id\",\"productId\",\"ean\",\"lockId\",\"itemAttachment\",\"attachments\",\"quantity\",\"seller\",\"name\",\"refId\",\"price\",\"listPrice\",\"manualPrice\",\"priceTags\",\"imageUrl\",\"detailUrl\",\"components\",\"bundleItems\",\"params\",\"offerings\",\"attachmentOfferings\",\"sellerSku\",\"priceValidUntil\",\"commission\",\"tax\",\"preSaleDate\",\"additionalInfo\",\"measurementUnit\",\"unitMultiplier\",\"sellingPrice\",\"isGift\",\"shippingPrice\",\"rewardValue\",\"freightCommission\",\"priceDefinitions\",\"taxCode\",\"parentItemIndex\",\"parentAssemblyBinding\",\"callCenterOperator\",\"serialNumbers\",\"assemblies\",\"costPrice\"],\"type\":\"object\",\"description\":\"Item details.\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID is an alphanumeric sequence that identifies an SKU in a given order.\"},\"id\":{\"type\":\"string\",\"description\":\"Item's SKU ID, which is a unique numerical identifier.\"},\"productId\":{\"type\":\"string\",\"description\":\"ID of the Product associated with the item.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"EAN of the SKU.\"},\"lockId\":{\"type\":\"string\",\"description\":\"Reservation ID.\"},\"itemAttachment\":{\"title\":\"ItemAttachment\",\"description\":\"Information about attachments, if it applies.\",\"required\":[\"content\",\"name\"],\"type\":\"object\",\"properties\":{\"content\":{\"type\":\"object\",\"description\":\"Attachment's custom field for content.\"},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Attachment's name.\"}}},\"attachments\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Attachment details.\"},\"description\":\"Array containing information on attachments.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity of items.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller related to the order.\"},\"name\":{\"type\":\"string\",\"description\":\"Item's name.\"},\"refId\":{\"type\":\"string\",\"description\":\"Product referencial code associated with the item.\"},\"price\":{\"type\":\"integer\",\"description\":\"Item's price.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"Item's list price.\"},\"manualPrice\":{\"type\":[\"string\",\"null\"],\"description\":\"Item's manual price.\"},\"priceTags\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Price modifier.\"},\"description\":\"List of objects with item's price modifiers.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Item's SKU image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"URL slug of the item.\"},\"components\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"A given component.\"},\"description\":\"Item's components.\"},\"bundleItems\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Item offering details.\"},\"description\":\"This field groups offerings (services) related to the item and displays their ID and quantity. A gift package is an example of an offering.\"},\"params\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Param name.\"},\"description\":\"Information about params.\"},\"offerings\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Name of the service related to the item. For example, guarantee or installation.\"},\"description\":\"Item's offerings, which are services related to the item. For example, guarantee or installation.\"},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"type\":\"object\",\"description\":\"Attachment details.\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Schema of the content declared in the field `attachmentOfferings`.\"}}}},\"sellerSku\":{\"type\":\"string\",\"description\":\"SKU ID from the seller perspective.\"},\"priceValidUntil\":{\"type\":[\"string\",\"null\"],\"description\":\"Date until when the price is going to be valid if there is a promotion.\"},\"commission\":{\"type\":\"integer\",\"description\":\"Commission value registered for the seller.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Item's tax.\"},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Item's pre sale date.\"},\"additionalInfo\":{\"title\":\"AdditionalInfo\",\"description\":\"Additional information about the item.\",\"required\":[\"brandName\",\"brandId\",\"categoriesIds\",\"productClusterId\",\"commercialConditionId\",\"dimension\",\"offeringInfo\",\"offeringType\",\"offeringTypeId\"],\"type\":\"object\",\"properties\":{\"brandName\":{\"type\":\"string\",\"description\":\"Item's brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Item's brand ID.\"},\"categoriesIds\":{\"type\":\"string\",\"description\":\"Item's category ID.\"},\"productClusterId\":{\"type\":\"string\",\"description\":\"All product clusters related to the item.\"},\"commercialConditionId\":{\"type\":\"string\",\"description\":\"Commercial conditions ID.\"},\"dimension\":{\"type\":\"object\",\"description\":\"Item dimensions.\",\"required\":[\"cubicweight\",\"height\",\"length\",\"weight\",\"width\"],\"properties\":{\"cubicweight\":{\"type\":\"number\",\"description\":\"Item cubic weight.\"},\"height\":{\"type\":\"number\",\"description\":\"Item height.\"},\"length\":{\"type\":\"number\",\"description\":\"Item length.\"},\"weight\":{\"type\":\"number\",\"description\":\"Item weight.\"},\"width\":{\"type\":\"number\",\"description\":\"Item width.\"}}},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about services related to the item. For example: guarantee or installation.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Item's measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Item's unit multiplier.\"},\"sellingPrice\":{\"type\":\"integer\",\"description\":\"Item's selling price.\"},\"isGift\":{\"type\":\"boolean\",\"description\":\"This field is `true` when the item is a gift in order context and `false` when it is not.\"},\"shippingPrice\":{\"type\":[\"string\",\"null\"],\"description\":\"Item's shipping price.\"},\"rewardValue\":{\"type\":\"integer\",\"description\":\"Item's reward value.\"},\"freightCommission\":{\"type\":\"integer\",\"description\":\"Value of the freight commission.\"},\"priceDefinitions\":{\"type\":\"object\",\"description\":\"Item's price information.\",\"required\":[\"sellingPrices\",\"calculatedSellingPrice\",\"total\"],\"properties\":{\"sellingPrices\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"description\":\"Item value and quantity.\",\"required\":[\"value\",\"quantity\"],\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Total value of items in cents.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity of items.\"}}},\"description\":\"Details on item's selling price.\"},\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value of all item's units in cents.\"}}},\"taxCode\":{\"type\":[\"string\",\"null\"],\"description\":\" Item's tax code.\"},\"parentItemIndex\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"callCenterOperator\":{\"type\":[\"string\",\"null\"],\"description\":\"Call center operator responsible for the order.\"},\"serialNumbers\":{\"type\":[\"string\",\"null\"],\"description\":\"This field identifies the order in the `handling` status in the workflow, and it was used for VTEX internal control.\"},\"assemblies\":{\"type\":[\"array\",\"null\"],\"description\":\"Retrieves information about orders item's customizations.\",\"items\":{\"type\":\"string\",\"description\":\"Customization information.\"}},\"costPrice\":{\"type\":\"integer\",\"description\":\"Item's cost price.\"}}},\"description\":\"Information about order's items.\"},\"marketplaceItems\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Marketplace details object.\"},\"clientProfileData\":{\"title\":\"ClientProfileData\",\"description\":\"Object with information on the client's profile.\",\"required\":[\"id\",\"email\",\"firstName\",\"lastName\",\"documentType\",\"document\",\"phone\",\"corporateName\",\"tradeName\",\"corporateDocument\",\"stateInscription\",\"corporatePhone\",\"isCorporate\",\"userProfileId\",\"customerClass\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID, the expected value is `clientProfileData`.\"},\"email\":{\"type\":\"string\",\"description\":\"Customer's email.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Customer's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Customer's last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document identification code informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Customers's phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, here goes the corporate name.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, here goes the trade name.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, here goes the corporate document.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, here goes the state inscription.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"If the customer is a legal entity, here goes the corpany's phone number.\"},\"isCorporate\":{\"type\":\"boolean\",\"description\":\"The value is `true` when the customer is a legal entity and `false` when not.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Customer user profile ID.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Identification of the class the customer belongs to.\"}}},\"giftRegistryData\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about gift list, when it applies.\"},\"marketingData\":{\"type\":\"object\",\"description\":\"Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs.\",\"required\":[\"id\",\"utmSource\",\"utmPartner\",\"utmMedium\",\"utmCampaign\",\"coupon\",\"utmiCampaign\",\"utmipage\",\"utmiPart\",\"marketingTags\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID which expected value is `marketingData`.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"Value of the `utm_source` parameter of the URL that led to the request.\"},\"utmPartner\":{\"type\":\"string\",\"description\":\"UTM Source Parameters.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"Value of the `utm_medium` parameter of the URL that led to the request.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"Value of the `utm_campaign` parameter of the URL that led to the request.\"},\"coupon\":{\"type\":\"string\",\"description\":\"Coupon's code information.\"},\"utmiCampaign\":{\"type\":\"string\",\"description\":\"Internal UTM value `utmi_cp`.\"},\"utmipage\":{\"type\":\"string\",\"description\":\"Internal UTM value `utmi_p`.\"},\"utmiPart\":{\"type\":\"string\",\"description\":\"Internal UTM value `utmi_pc`.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions.\",\"items\":{\"type\":\"string\"}}}},\"ratesAndBenefitsData\":{\"title\":\"RatesAndBenefitsData\",\"description\":\"Information on promotions and taxes that apply to the order.\",\"required\":[\"id\",\"rateAndBenefitsIdentifiers\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the rate or benefit.\"},\"rateAndBenefitsIdentifiers\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Information about order's promotions and taxes identifiers.\"}}},\"shippingData\":{\"title\":\"ShippingData\",\"description\":\"Object containing shipping data.\",\"required\":[\"id\",\"address\",\"logisticsInfo\",\"trackingHints\",\"selectedAddresses\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID, the expected value is `shippingData`.\"},\"address\":{\"title\":\"Address\",\"description\":\"Shipping address details.\",\"required\":[\"addressType\",\"receiverName\",\"addressId\",\"versionId\",\"entityId\",\"postalCode\",\"city\",\"state\",\"country\",\"street\",\"number\",\"neighborhood\",\"complement\",\"reference\",\"geoCoordinates\"],\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`, among others.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":\"string\",\"description\":\"Shipping address ID.\"},\"versionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address version ID.\"},\"entityId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address entity ID.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code of the shipping address.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3).\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement to the shipping address when it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to help locate the shipping address, in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"items\":{\"type\":\"number\"},\"description\":\"Array with two numbers with geocoordinates, first longitude then latitude.\"}}},\"logisticsInfo\":{\"type\":\"array\",\"items\":{\"title\":\"LogisticsInfo\",\"required\":[\"itemIndex\",\"selectedSla\",\"lockTTL\",\"price\",\"listPrice\",\"sellingPrice\",\"deliveryWindow\",\"deliveryCompany\",\"shippingEstimate\",\"shippingEstimateDate\",\"slas\",\"shipsTo\",\"deliveryIds\",\"deliveryChannels\",\"deliveryChannel\",\"pickupStoreInfo\",\"addressId\",\"versionId\",\"entityId\",\"polygonName\",\"pickupPointId\",\"transitTime\"],\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index of the item starting from 0.\"},\"selectedSla\":{\"type\":\"string\",\"description\":\"Selected shipping option.\"},\"lockTTL\":{\"type\":\"string\",\"description\":\"Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time.\"},\"price\":{\"type\":\"integer\",\"description\":\"Shipping price for the item in cents. Does not account for the whole order's shipping price.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"SKU's optional price for a specific trade policy.\"},\"sellingPrice\":{\"type\":\"integer\",\"description\":\"Item's selling price.\"},\"deliveryWindow\":{\"type\":[\"string\",\"null\"],\"description\":\"[Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, if it applies to the item.\"},\"deliveryCompany\":{\"type\":\"string\",\"description\":\"[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.\"},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Total shipping estimate time in days. For instance, three business days is represented `3bd`.\"},\"shippingEstimateDate\":{\"type\":\"string\",\"description\":\"Shipping estimate date. It is defined only after the confirmation of the order.\"},\"slas\":{\"type\":\"array\",\"items\":{\"title\":\"Sla\",\"required\":[\"id\",\"name\",\"shippingEstimate\",\"deliveryWindow\",\"price\",\"deliveryChannel\",\"pickupStoreInfo\",\"polygonName\",\"lockTTL\",\"pickupPointId\",\"transitTime\",\"pickupDistance\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the shipping policy.\"},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Total shipping estimate time in days. For instance, three business days is represented `3bd`.\"},\"deliveryWindow\":{\"type\":[\"string\",\"null\"],\"description\":\"[Scheduled delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, if it applies to the item.\"},\"price\":{\"type\":\"integer\",\"description\":\"Shipping price for the item in cents. Does not account for the whole order's shipping price.\"},\"deliveryChannel\":{\"type\":\"string\",\"description\":\"If the delivery channel is `delivery` or `pickup-in-point`.\"},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfo\",\"description\":\"Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\",\"required\":[\"additionalInfo\",\"address\",\"dockId\",\"friendlyName\",\"isPickupStore\"],\"type\":\"object\",\"properties\":{\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the pickup point.\"},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point's address.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the pickup point displayed at checkout.\"},\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"If this field is set `true`, it means the type of shipping is pickup, and if set as `false`, it is not.\"}}},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\"},\"lockTTL\":{\"type\":\"string\",\"description\":\"Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA.\"},\"pickupPointId\":{\"type\":\"string\",\"description\":\"[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA.\"},\"transitTime\":{\"type\":\"string\",\"description\":\"Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`.\"},\"pickupDistance\":{\"type\":\"number\",\"description\":\"Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.\"}}},\"description\":\"Information on Service Level Agreement (SLA), corresponding to [shipping policies](https://help.vtex.com/tutorial/shipping-policy--tutorials_140).\"},\"shipsTo\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3).\"},\"deliveryIds\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryId\",\"description\":\"Information about delivery IDs.\",\"required\":[\"courierId\",\"courierName\",\"dockId\",\"quantity\",\"warehouseId\",\"accountCarrierName\",\"kitItemDetails\"],\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)'s ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Carrier's name.\"},\"dockId\":{\"type\":\"string\",\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity of items.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\"},\"accountCarrierName\":{\"type\":\"string\",\"description\":\"Name of the account's [carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE).\"},\"kitItemDetails\":{\"type\":[\"array\",\"null\"],\"description\":\"Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any.\",\"items\":{\"type\":\"string\"}}}},\"description\":\"Information about delivery IDs.\"},\"deliveryChannels\":{\"type\":\"array\",\"description\":\"List of delivery channels associated with the trade policy.\",\"items\":{\"type\":\"object\",\"required\":[\"id\",\"stockBalance\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel's shipping type, which can be `delivery` or `pickup-in-point`.\"},\"stockBalance\":{\"type\":\"integer\",\"description\":\"Stock check for an SKU availability.\"}}}},\"deliveryChannel\":{\"type\":\"string\",\"description\":\"If the delivery channel is `delivery` or `pickup-in-point`.\"},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfo\",\"description\":\"Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\",\"required\":[\"additionalInfo\",\"address\",\"dockId\",\"friendlyName\",\"isPickupStore\"],\"type\":\"object\",\"properties\":{\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the pickup point.\"},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point's address.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the pickup point displayed at checkout.\"},\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"If this field is set `true`, it means the type of shipping is pickup, and if set as `false`, it is not.\"}}},\"addressId\":{\"type\":\"string\",\"description\":\"Address ID.\"},\"versionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address version ID.\"},\"entityId\":{\"type\":\"string\",\"description\":\"Shipping address entity ID.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\"},\"pickupPointId\":{\"type\":\"string\",\"description\":\"[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)'s ID.\"},\"transitTime\":{\"type\":\"string\",\"description\":\"Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`.\"}}},\"description\":\"Array of objects containing item's logistics information.\"},\"trackingHints\":{\"type\":[\"string\",\"null\"]},\"selectedAddresses\":{\"type\":\"array\",\"items\":{\"title\":\"SelectedAddress\",\"required\":[\"addressId\",\"versionId\",\"entityId\",\"addressType\",\"receiverName\",\"street\",\"number\",\"complement\",\"neighborhood\",\"postalCode\",\"city\",\"state\",\"country\",\"reference\",\"geoCoordinates\"],\"type\":\"object\",\"properties\":{\"addressId\":{\"type\":\"string\",\"description\":\"Selected address ID.\"},\"versionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address version ID of the selected address.\"},\"entityId\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping address entity ID of the selected address.\"},\"addressType\":{\"type\":\"string\",\"description\":\"Selected adress's shipping type, which can be `pickup`, `residential`, `invoice`, `search`, `inStore`, `commercial` or `giftRegistry`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order in the selected address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the selected address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment of the selected address.\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement to the selected address if it applies.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the selected address.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code of the selected address.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the selected address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the selected address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letters ISO code of the country of the selected address (ISO 3166 ALPHA-3).\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to help locate the selected address.\"},\"geoCoordinates\":{\"type\":\"array\",\"items\":{\"type\":\"number\"},\"description\":\"Array with two numbers with the selected address's geocoordinates, first longitude then latitude.\"}}},\"description\":\"Information about selected adresses.\"}}},\"paymentData\":{\"title\":\"PaymentData\",\"description\":\"Object with information about the payment.\",\"required\":[\"transactions\"],\"type\":\"object\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Array with information about Gift Cards.\",\"items\":{\"type\":\"string\"}},\"transactions\":{\"type\":\"array\",\"items\":{\"title\":\"Transaction\",\"description\":\"Financial transaction details.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"type\":\"object\",\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"When this field is set as `true`, the payment is active, and when it is `false`, the payment is inactive.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"ID of the transaction.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Name of the merchant that will receive the payment.\"},\"payments\":{\"type\":\"array\",\"items\":{\"title\":\"Payment\",\"description\":\"Payment details.\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\",\"giftCardProvider\",\"giftCardAsDiscount\",\"koinUrl\",\"accountId\",\"parentAccountId\",\"bankIssuedInvoiceIdentificationNumber\",\"bankIssuedInvoiceIdentificationNumberFormatted\",\"bankIssuedInvoiceBarCodeNumber\",\"bankIssuedInvoiceBarCodeType\",\"billingAddress\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"VTEX payment ID that can be used as unique identifier.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system's ID.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system's name.\"},\"value\":{\"type\":\"integer\",\"description\":\"Payment's final amount in cents.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Payment's reference value in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the person who owns the card.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Numeric sequence of the card used in the transaction.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Fist digits of the card used in the transaction.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Last digits of the card used in the transaction.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Expire month of the card used in the transaction (2-digits).\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Expire year of the card used in the transaction (4-digits).\"},\"url\":{\"type\":\"string\",\"description\":\"Payment's URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift Card's ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift Card's name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift Card's caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Code for the customer to use the Gift Card.\"},\"group\":{\"type\":\"string\",\"description\":\"Name of the collection the Gift Card belongs to.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Provider's unique identifier for the transaction.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Payment due date, with the format `yyyy-mm-dd`.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Information about the connector responses.\",\"required\":[\"Tid\",\"ReturnCode\",\"Message\",\"authId\"],\"properties\":{\"Tid\":{\"type\":\"string\",\"description\":\"Provider's unique identifier for the transaction.\"},\"ReturnCode\":{\"type\":\"string\",\"description\":\"Provider's operation/error code to be logged.\"},\"Message\":{\"type\":\"string\",\"description\":\"Provider's operation/error message to be logged.\"},\"authId\":{\"type\":\"string\",\"description\":\"Connector's authorization ID.\"}}},\"giftCardProvider\":{\"type\":\"string\",\"description\":\"Gift Card provider's ID.\"},\"giftCardAsDiscount\":{\"type\":\"boolean\",\"description\":\"When this field is set as `true`, the Gift Card is a discount over the price, and when set as `false`, it is not a discount.\"},\"koinUrl\":{\"type\":\"string\",\"description\":\"Payment's account ID.\"},\"accountId\":{\"type\":\"string\",\"description\":\"Payment's account ID.\"},\"parentAccountId\":{\"type\":\"string\",\"description\":\"This field retrieves the main account if the payment was made in a subaccount.\"},\"bankIssuedInvoiceIdentificationNumber\":{\"type\":\"string\",\"description\":\"Numeric sequence that identifies the bank issued invoice.\"},\"bankIssuedInvoiceIdentificationNumberFormatted\":{\"type\":\"string\",\"description\":\"Bank issued invoice ID formatted.\"},\"bankIssuedInvoiceBarCodeNumber\":{\"type\":\"string\",\"description\":\"Number of the bank issued invoice bar code.\"},\"bankIssuedInvoiceBarCodeType\":{\"type\":\"string\",\"description\":\"Type of the bank issued invoice bar code.\"},\"billingAddress\":{\"type\":\"object\",\"description\":\"Billing address information.\"}}},\"description\":\"Detailed information about payment.\"}}},\"description\":\"Information about financial transactions.\"}}},\"packageAttachment\":{\"title\":\"PackageAttachment\",\"description\":\"Package object populated after order invoiced.\",\"required\":[\"packages\"],\"type\":\"object\",\"properties\":{\"packages\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Packages details.\"}}},\"sellers\":{\"type\":\"array\",\"items\":{\"title\":\"Seller\",\"description\":\"Information about the seller associated with the order.\",\"required\":[\"id\",\"name\",\"logo\",\"fulfillmentEndpoint\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID that identifies the seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller's name.\"},\"logo\":{\"type\":\"string\",\"description\":\"URL of the seller's logo.\"},\"fulfillmentEndpoint\":{\"type\":\"string\",\"description\":\"URL of the endpoint for fulfillment of seller's orders.\"}}},\"description\":\"List of all sellers associated with the order.\"},\"callCenterOperatorData\":{\"type\":[\"string\",\"null\"],\"description\":\"Call center operator responsible for the order.\"},\"followUpEmail\":{\"type\":\"string\",\"description\":\"Email of the store's employee responsible for managing the order.\"},\"lastMessage\":{\"type\":[\"string\",\"null\"],\"description\":\"Last sent transactional message.\"},\"hostname\":{\"type\":\"string\",\"description\":\"Account Hostname registered in License Manager.\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information pertinent to the order's invoice.\"},\"changesAttachment\":{\"title\":\"ChangesAttachment\",\"description\":\"Information about changes in the order.\",\"required\":[\"id\",\"changesData\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Object ID, the expect value is `changeAttachment`.\"},\"changesData\":{\"type\":\"array\",\"items\":{\"title\":\"ChangesDatum\",\"required\":[\"reason\",\"discountValue\",\"incrementValue\",\"itemsAdded\",\"itemsRemoved\",\"receipt\"],\"type\":\"object\",\"properties\":{\"reason\":{\"type\":\"string\",\"description\":\"Text explaining why there was a change in the order. This information may be shown to the customer in the UI or transactional emails.\"},\"discountValue\":{\"type\":\"integer\",\"description\":\"Order change discount value.\"},\"incrementValue\":{\"type\":\"integer\",\"description\":\"Order change increment value.\"},\"itemsAdded\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"List of items added to the order.\"},\"itemsRemoved\":{\"type\":\"array\",\"items\":{\"title\":\"ItemsRemoved\",\"required\":[\"id\",\"name\",\"quantity\",\"price\",\"unitMultiplier\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID of the item removed from the order.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the item removed from the order.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity of items removed from the order.\"},\"price\":{\"type\":\"integer\",\"description\":\"Total amount of items removed from the order.\"},\"unitMultiplier\":{\"type\":[\"string\",\"null\"],\"description\":\"Unit multiplier of the item removed from the order.\"}}},\"description\":\"List of items removed from the order.\"},\"receipt\":{\"title\":\"Receipt\",\"description\":\"Information about the receipt for changed orders.\",\"required\":[\"date\",\"orderId\",\"receipt\"],\"type\":\"object\",\"properties\":{\"date\":{\"type\":\"string\",\"description\":\"Date when the receipt was created.\"},\"orderId\":{\"type\":\"string\",\"description\":\"ID of the order.\"},\"receipt\":{\"type\":\"string\",\"description\":\"Receipt's unique identifier code.\"}}}}},\"description\":\"Order change details.\"}}},\"openTextField\":{\"type\":[\"string\",\"null\"],\"description\":\"Optional field with order's additional information. This field must be filled in using the following format: \\n\\r```\\n\\r{\\r\\n \\\"fieldExample\\\": \\\"ValueExample\\\"\\r\\n }\\n\\r```\\n\\r.\"},\"roundingError\":{\"type\":\"integer\",\"description\":\"Rounding error total amount, if it applies. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount amount, which is informed in this field.\"},\"orderFormId\":{\"type\":\"string\",\"description\":\"[Order form](https://developers.vtex.com/docs/guides/orderform-fields) ID.\"},\"commercialConditionData\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about commercial conditions.\"},\"isCompleted\":{\"type\":\"boolean\",\"description\":\"When set as `true`, the order's payment has been settled, and when set as `false`, it has not been settled yet.\"},\"customData\":{\"type\":[\"string\",\"null\"],\"description\":\"Custom information in the order. This field is useful for storing data not included in other fields, for example, a message for a gift or a name to be printed in a shirt.\"},\"storePreferencesData\":{\"title\":\"StorePreferencesData\",\"description\":\"Object with data from the store's configuration - stored in VTEX's License Manager.\",\"required\":[\"countryCode\",\"currencyCode\",\"currencyFormatInfo\",\"currencyLocale\",\"currencySymbol\",\"timeZone\"],\"type\":\"object\",\"properties\":{\"countryCode\":{\"type\":\"string\",\"description\":\"Three letters ISO code of the country (ISO 3166 ALPHA-3).\"},\"currencyCode\":{\"type\":\"string\",\"description\":\"Currency code in ISO 4217. For example, `BRL`.\"},\"currencyFormatInfo\":{\"title\":\"CurrencyFormatInfo\",\"description\":\"Object with currency format details.\",\"required\":[\"CurrencyDecimalDigits\",\"CurrencyDecimalSeparator\",\"CurrencyGroupSeparator\",\"CurrencyGroupSize\",\"StartsWithCurrencySymbol\"],\"type\":\"object\",\"properties\":{\"CurrencyDecimalDigits\":{\"type\":\"integer\",\"description\":\"Quantity of currency decimal digits.\"},\"CurrencyDecimalSeparator\":{\"type\":\"string\",\"description\":\"Defines what currency decimal separator will be applied.\"},\"CurrencyGroupSeparator\":{\"type\":\"string\",\"description\":\"Defines what currency group separator will be applied.\"},\"CurrencyGroupSize\":{\"type\":\"integer\",\"description\":\"Defines how many characters will be grouped.\"},\"StartsWithCurrencySymbol\":{\"type\":\"boolean\",\"description\":\"Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`).\"}}},\"currencyLocale\":{\"type\":\"integer\",\"description\":\"Currency Locale Code in LCID in decimal.\"},\"currencySymbol\":{\"type\":\"string\",\"description\":\"Currency symbol.\"},\"timeZone\":{\"type\":\"string\",\"description\":\"Time zone from where the order was made.\"}}},\"allowCancellation\":{\"type\":\"boolean\",\"description\":\"When set as `true`, the order can be canceled, and when set as `false`, it is no longer possible to cancel the order.\"},\"allowEdition\":{\"type\":\"boolean\",\"description\":\"When set as `true`, the order can be edited, and when set as `false`, it is no longer possible to edit the order.\"},\"isCheckedIn\":{\"type\":\"boolean\",\"description\":\"This field is set `true` when the order was made via inStore and `false` when it was not.\"},\"marketplace\":{\"title\":\"Marketplace\",\"description\":\"Details about the marketplace related to the order.\",\"required\":[\"baseURL\",\"isCertified\",\"name\"],\"type\":\"object\",\"properties\":{\"baseURL\":{\"type\":\"string\",\"description\":\"Marketplace base URL.\"},\"isCertified\":{\"type\":[\"string\",\"null\"],\"description\":\"If is a certified marketplace.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the marketplace.\"}}},\"authorizedDate\":{\"type\":\"string\",\"description\":\"Authorized order date.\"},\"invoicedDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Order's invoice date.\"},\"cancelReason\":{\"type\":[\"string\",\"null\"],\"description\":\"Reason for order cancellation.\"},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Metadata information about the order's items.\",\"required\":[\"Items\"],\"properties\":{\"Items\":{\"type\":\"array\",\"description\":\"Metadata items.\",\"items\":{\"type\":\"object\",\"required\":[\"Id\",\"Seller\",\"Name\",\"SkuName\",\"ProductId\",\"RefId\",\"Ean\",\"ImageUrl\",\"DetailUrl\",\"AssemblyOptions\"],\"properties\":{\"Id\":{\"type\":\"string\",\"description\":\"Item's SKU ID, which is a unique numerical identifier.\"},\"Seller\":{\"type\":\"string\",\"description\":\"Seller ID that identifies the seller the item belongs to.\"},\"Name\":{\"type\":\"string\",\"description\":\"Name of the item as displayed to customers in the storefront.\"},\"SkuName\":{\"type\":\"string\",\"description\":\"Name of the SKU corresponding to the item.\"},\"ProductId\":{\"type\":\"string\",\"description\":\"ID of the Product associated with the item.\"},\"RefId\":{\"type\":\"string\",\"description\":\"Item's reference ID.\"},\"Ean\":{\"type\":\"string\",\"description\":\"EAN of the item.\"},\"ImageUrl\":{\"type\":\"string\",\"description\":\"Item's SKU image URL.\"},\"DetailUrl\":{\"type\":\"string\",\"description\":\"URL slug of the item.\"},\"AssemblyOptions\":{\"type\":\"array\",\"description\":\"Displays information about [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) related to the item, if there are any.\",\"items\":{\"required\":[\"Id\",\"Name\",\"Required\",\"InputValues\",\"Composition\"],\"type\":\"object\",\"properties\":{\"Id\":{\"type\":\"string\",\"description\":\"ID of the attachment related to the order.\"},\"Name\":{\"type\":\"string\",\"description\":\"Name of the attachment related to the order.\"},\"Required\":{\"type\":\"boolean\",\"description\":\"If this field is set as `true`, when the customer purchases the item sending the attachment is required, and when set as `false`, sending the attachment is optional.\"},\"InputValues\":{\"type\":[\"object\",\"null\"],\"description\":\"Displays the attachment's content.\"},\"Composition\":{\"type\":[\"object\",\"null\"],\"description\":\"Displays the attachment's composition.\"}}}}}}}}},\"subscriptionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about [subscriptions](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453).\",\"required\":[\"SubscriptionGroupId\",\"Subscriptions\"],\"properties\":{\"SubscriptionGroupId\":{\"type\":\"string\",\"description\":\"ID of the subscription's group. If this field returns `null` and the `executionCount` is `0`, the order is the first one with subscriptions.\"},\"Subscriptions\":{\"type\":[\"array\",\"null\"],\"description\":\"List with subscriptions and their details.\",\"items\":{\"type\":\"object\",\"required\":[\"ExecutionCount\",\"PriceAtSubscriptionDate\",\"ItemIndex\",\"Plan\"],\"properties\":{\"ExecutionCount\":{\"type\":\"integer\",\"description\":\"Position of the order in the subscription cycle. The first order will have the value `0`, the second will have the value `1`, and so on.\"},\"PriceAtSubscriptionDate\":{\"type\":\"number\",\"description\":\"Price of the order when the customer signed up for subscriptions. Subscriptions created from Admin UI or APIs do not have an original order, so the field returns `0.0`. This field was valid only for Subscriptions v2 and is deprecated in Subscriptions v3.\"},\"ItemIndex\":{\"type\":\"integer\",\"description\":\"Each item in the subscriptions' order is identified by an index. The position starts in`0`, followed by `1`, `2`, and so on.\"},\"Plan\":{\"type\":\"object\",\"description\":\"Information about the subscription's validility and frequency.\",\"required\":[\"type\",\"frequency\",\"validity\"],\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Type of plan.\"},\"frequency\":{\"type\":\"object\",\"description\":\"Information about subscriptions' recurrence.\",\"required\":[\"periodicity\",\"interval\"],\"properties\":{\"periodicity\":{\"type\":\"string\",\"description\":\"Defines the subscriptions recurrence period. The possible values are `DAILY`,`WEEKLY`, `MONTHLY` and `YEARLY`.\"},\"interval\":{\"type\":\"integer\",\"description\":\"Number of the time interval configured between subscription orders, which depends on the periodicity. For a `DAILY` periodicity, the field's value will correspond to days, for `MONTHLY` to months, and so on.\"}}},\"validity\":{\"type\":\"object\",\"description\":\"Information about the period during which the subscription will be valid.\",\"required\":[\"begin\",\"end\"],\"properties\":{\"begin\":{\"type\":\"string\",\"description\":\"Subscriptions' beginning date with the format `yyyy-mm-ddThh:mm:ss`.\"},\"end\":{\"type\":\"string\",\"description\":\"Subscriptions' ending date with the format `yyyy-mm-ddThh:mm:ss`.\"}}}}}}}}}},\"taxData\":{\"type\":\"object\",\"description\":\"Order's tax information.\",\"required\":[\"areTaxesDesignatedByMarketplace\",\"taxInfoCollection\"],\"properties\":{\"areTaxesDesignatedByMarketplace\":{\"type\":\"boolean\",\"description\":\"If the taxes were designated by the marketplace (`true`) or not (`false`).\"},\"taxInfoCollection\":{\"type\":\"array\",\"description\":\"Array with taxes' details.\",\"items\":{\"type\":\"object\",\"required\":[\"itemIndex\",\"sku\",\"priceTags\"],\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Item's indexing number.\"},\"sku\":{\"type\":\"string\",\"description\":\"Alphanumeric sequence that identifies an SKU.\"},\"priceTags\":{\"type\":\"array\",\"description\":\"Price tag information.\",\"items\":{\"type\":\"object\",\"required\":[\"isPercentual\",\"name\",\"rawValue\"],\"properties\":{\"isPercentual\":{\"type\":\"boolean\",\"description\":\"If the tax is a percentage (`true`) or note (`false`).\"},\"name\":{\"type\":\"string\",\"description\":\"Name that identifies the tax.\"},\"rawValue\":{\"type\":\"string\",\"description\":\"The amount that corresponds to the tax.\"}}}}}}}}},\"checkedInPickupPointId\":{\"type\":\"string\",\"description\":\"If the field `isCheckedIn` is set as `true`, the `checkedInPickupPointId` will retrieve the ID of the physical store where the order was made.\"},\"cancellationData\":{\"type\":\"object\",\"description\":\"Information about order cancellation, when it applies.\",\"required\":[\"RequestedByUser\",\"RequestedBySystem\",\"RequestedBySellerNotification\",\"RequestedByPaymentNotification\",\"Reason\",\"CancellationDate\"],\"properties\":{\"RequestedByUser\":{\"type\":\"boolean\",\"description\":\"If the order cancellation was requested by the costumer (`true`) or not (`false`).\"},\"RequestedBySystem\":{\"type\":\"boolean\",\"description\":\"If the order cancellation was made by the system (`true`) or not (`false`). This type of order cancellation happens in [incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294), for example.\"},\"RequestedBySellerNotification\":{\"type\":\"boolean\",\"description\":\"If the order cancellation was requested by the seller (`true`) or not (`false`).\"},\"RequestedByPaymentNotification\":{\"type\":\"boolean\",\"description\":\"If the order cancellation was requested by the payment gateway (`true`) or not (`false`).\"},\"Reason\":{\"type\":\"string\",\"description\":\"The reason why the order was cancelled.\"},\"CancellationDate\":{\"type\":\"string\",\"description\":\"The date when the order was cancelled.\"}}},\"clientPreferencesData\":{\"type\":\"object\",\"description\":\"Information about customer's preferences.\",\"required\":[\"locale\",\"optinNewsLetter\"],\"properties\":{\"locale\":{\"type\":\"string\",\"description\":\"Customer's prefered language while accessing the store.\"},\"optinNewsLetter\":{\"type\":\"boolean\",\"description\":\"When set as `true`, this field indicates customers opted to receive the newsletters, and when set as `false`, it means they did not.\"}}}},\"example\":{\"orderId\":\"v502556llux-01\",\"sequence\":\"502556\",\"marketplaceOrderId\":\"\",\"marketplaceServicesEndpoint\":\"http://oms.vtexinternal.com.br/api/oms?an=luxstore\",\"sellerOrderId\":\"00-v502556llux-01\",\"origin\":\"Marketplace\",\"affiliateId\":\"\",\"salesChannel\":\"1\",\"merchantName\":\"luxstore\",\"status\":\"handling\",\"statusDescription\":\"Preparando Entrega\",\"value\":1160,\"creationDate\":\"2019-01-28T20:09:43.899958+00:00\",\"lastChange\":\"2019-02-06T20:46:11.7010747+00:00\",\"orderGroup\":\"v502556lspt\",\"totals\":[{\"id\":\"Items\",\"name\":\"Total dos Itens\",\"value\":3290},{\"id\":\"Discounts\",\"name\":\"Total dos Descontos\",\"value\":0},{\"id\":\"Shipping\",\"name\":\"Total do Frete\",\"value\":1160},{\"id\":\"Tax\",\"name\":\"Total da Taxa\",\"value\":0},{\"id\":\"Change\",\"name\":\"Total das mudanças\",\"value\":-3290}],\"items\":[{\"uniqueId\":\"87F0945396994B349158C7D9C9941442\",\"id\":\"1234568358\",\"productId\":\"9429485\",\"ean\":null,\"lockId\":\"00-v502556llux-01\",\"itemAttachment\":{\"content\":{},\"name\":null},\"attachments\":[],\"quantity\":1,\"seller\":\"1\",\"name\":\"Bay Max L\",\"refId\":\"BIGHEROBML\",\"price\":3290,\"listPrice\":3290,\"manualPrice\":null,\"priceTags\":[],\"imageUrl\":\"http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000\",\"detailUrl\":\"/bay-max-9429485/p\",\"components\":[],\"bundleItems\":[],\"params\":[],\"offerings\":[],\"attachmentOfferings\":[{\"name\":\"vtex.subscription.weekly\",\"required\":false,\"schema\":{\"vtex.subscription.key.frequency\":{\"MaximumNumberOfCharacters\":7,\"Domain\":[\" 1 week\",\" 2 week\",\" 3 week\",\" 4 week\"]}}}],\"sellerSku\":\"1234568358\",\"priceValidUntil\":null,\"commission\":0,\"tax\":0,\"preSaleDate\":null,\"additionalInfo\":{\"brandName\":\"VTEX\",\"brandId\":\"2000023\",\"categoriesIds\":\"/1/\",\"productClusterId\":\"135,142\",\"commercialConditionId\":\"5\",\"dimension\":{\"cubicweight\":0.7031,\"height\":15,\"length\":15,\"weight\":15,\"width\":15},\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null},\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"sellingPrice\":3290,\"isGift\":false,\"shippingPrice\":null,\"rewardValue\":0,\"freightCommission\":0,\"priceDefinitions\":{\"sellingPrices\":[{\"value\":99,\"quantity\":1}],\"calculatedSellingPrice\":99,\"total\":99},\"taxCode\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"callCenterOperator\":\"callCenterOp5473869\",\"serialNumbers\":\"3\",\"assemblies\":[],\"costPrice\":52}],\"marketplaceItems\":[],\"clientProfileData\":{\"id\":\"clientProfileData\",\"email\":\"rodrigo.cunha@vtex.com.br\",\"firstName\":\"Rodrigo\",\"lastName\":\"Cunha\",\"documentType\":\"cpf\",\"document\":\"11047867702\",\"phone\":\"+5521972321094\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":null,\"corporatePhone\":null,\"isCorporate\":false,\"userProfileId\":\"5a3692de-358a-4bea-8885-044bce33bb93\",\"customerClass\":null},\"giftRegistryData\":null,\"marketingData\":{\"id\":\"marketingData\",\"utmSource\":\"fb\",\"utmPartner\":\"utm partner\",\"utmMedium\":\"utm medium\",\"utmCampaign\":\"christmas\",\"coupon\":\"sale\",\"utmiCampaign\":\" \",\"utmipage\":\" \",\"utmiPart\":\" \",\"marketingTags\":[\"vtex-subscription\"]},\"ratesAndBenefitsData\":{\"id\":\"ratesAndBenefitsData\",\"rateAndBenefitsIdentifiers\":[]},\"shippingData\":{\"id\":\"shippingData\",\"address\":{\"addressType\":\"residential\",\"receiverName\":\"Rodrigo Cunha\",\"addressId\":\"-1425945657910\",\"versionId\":\"e9c3bec2-125d-4b96-a021-316c3aa9f14f\",\"entityId\":\"eabfb564-99d6-40d8-bd6c-bddbd4990aad\",\"postalCode\":\"22250-040\",\"city\":\"Rio de Janeiro\",\"state\":\"RJ\",\"country\":\"BRA\",\"street\":\"Praia de Botafogo\",\"number\":\"518\",\"neighborhood\":\"Botafogo\",\"complement\":\"10\",\"reference\":null,\"geoCoordinates\":[]},\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Normal\",\"lockTTL\":\"10d\",\"price\":1160,\"listPrice\":1160,\"sellingPrice\":1160,\"deliveryWindow\":null,\"deliveryCompany\":\"Todos os CEPS\",\"shippingEstimate\":\"5bd\",\"shippingEstimateDate\":\"2019-02-04T20:33:46.4595004+00:00\",\"slas\":[{\"id\":\"Normal\",\"name\":\"Normal\",\"shippingEstimate\":\"5bd\",\"deliveryWindow\":null,\"price\":1160,\"deliveryChannel\":\"delivery\",\"pickupStoreInfo\":{\"additionalInfo\":null,\"address\":null,\"dockId\":null,\"friendlyName\":null,\"isPickupStore\":false},\"polygonName\":\"region13\",\"lockTTL\":\"12d\",\"pickupPointId\":\"1_VTEX-RJ\",\"transitTime\":\"0d\",\"pickupDistance\":29.861602783203125},{\"id\":\"Expressa\",\"name\":\"Expressa\",\"shippingEstimate\":\"5bd\",\"deliveryWindow\":null,\"price\":1160,\"deliveryChannel\":\"delivery\",\"pickupStoreInfo\":{\"additionalInfo\":null,\"address\":null,\"dockId\":null,\"friendlyName\":null,\"isPickupStore\":false},\"polygonName\":\"region13\",\"lockTTL\":\"12d\",\"pickupPointId\":\"1_VTEX-RJ\",\"transitTime\":\"0d\",\"pickupDistance\":29.861602783203125},{\"id\":\"Quebra Kit\",\"name\":\"Quebra Kit\",\"shippingEstimate\":\"2bd\",\"deliveryWindow\":null,\"price\":1392,\"deliveryChannel\":\"delivery\",\"pickupStoreInfo\":{\"additionalInfo\":null,\"address\":null,\"dockId\":null,\"friendlyName\":null,\"isPickupStore\":false},\"polygonName\":\"region13\",\"lockTTL\":\"12d\",\"pickupPointId\":\"1_VTEX-RJ\",\"transitTime\":\"0d\",\"pickupDistance\":29.861602783203125},{\"id\":\"Sob Encomenda\",\"name\":\"Sob Encomenda\",\"shippingEstimate\":\"32bd\",\"deliveryWindow\":null,\"price\":1392,\"deliveryChannel\":\"delivery\",\"pickupStoreInfo\":{\"additionalInfo\":null,\"address\":null,\"dockId\":null,\"friendlyName\":null,\"isPickupStore\":false},\"polygonName\":\"region13\",\"lockTTL\":\"12d\",\"pickupPointId\":\"1_VTEX-RJ\",\"transitTime\":\"0d\",\"pickupDistance\":29.861602783203125}],\"shipsTo\":[\"BRA\"],\"deliveryIds\":[{\"courierId\":\"197a56f\",\"courierName\":\"Todos os CEPS\",\"dockId\":\"1\",\"quantity\":1,\"warehouseId\":\"1_1\",\"accountCarrierName\":\"recorrenciaqa\",\"kitItemDetails\":[]}],\"deliveryChannels\":[{\"id\":\"delivery\",\"stockBalance\":0}],\"deliveryChannel\":\"delivery\",\"pickupStoreInfo\":{\"additionalInfo\":null,\"address\":null,\"dockId\":null,\"friendlyName\":null,\"isPickupStore\":false},\"addressId\":\"-1425945657910\",\"versionId\":\"e9c3bec2-125d-4b96-a021-316c3aa9f14f\",\"entityId\":\"eabfb564-99d6-40d8-bd6c-bddbd4990aad\",\"polygonName\":\"region56\",\"pickupPointId\":\"1_VTEX-RJ\",\"transitTime\":\"3d\"}],\"trackingHints\":null,\"selectedAddresses\":[{\"addressId\":\"-1425945657910\",\"versionId\":\"e9c3bec2-125d-4b96-a021-316c3aa9f14f\",\"entityId\":\"eabfb564-99d6-40d8-bd6c-bddbd4990aad\",\"addressType\":\"residential\",\"receiverName\":\"Rodrigo Cunha\",\"street\":\"Praia de Botafogo\",\"number\":\"518\",\"complement\":\"10\",\"neighborhood\":\"Botafogo\",\"postalCode\":\"22250-040\",\"city\":\"Rio de Janeiro\",\"state\":\"RJ\",\"country\":\"BRA\",\"reference\":null,\"geoCoordinates\":[]}]},\"paymentData\":{\"transactions\":[{\"isActive\":true,\"transactionId\":\"418213DE29634837A63DD693A937A696\",\"merchantName\":\"luxstore\",\"payments\":[{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{\"Tid\":\"94857956\",\"ReturnCode\":\"200\",\"Message\":\"logMessage\",\"authId\":\"857956\"},\"giftCardProvider\":\"presentCard\",\"giftCardAsDiscount\":false,\"koinUrl\":\"koinURL\",\"accountId\":\"5BC5C6B417FE432AB971B1D399F190C9\",\"parentAccountId\":\"5BC5C6B417FE432AB971B1D399F190C9\",\"bankIssuedInvoiceIdentificationNumber\":\"23797770100000019003099260100022107500729050\",\"bankIssuedInvoiceIdentificationNumberFormatted\":\"32534.95739 75945.24534 54395.734214 5\",\"bankIssuedInvoiceBarCodeNumber\":\"325349573975945245345439573421443986734065\",\"bankIssuedInvoiceBarCodeType\":\"i25\",\"billingAddress\":{}}]}]},\"packageAttachment\":{\"packages\":[]},\"sellers\":[{\"id\":\"1\",\"name\":\"Lux Store\",\"logo\":\"https://sellersLogo/images.png\",\"fulfillmentEndpoint\":\"http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName\"}],\"callCenterOperatorData\":null,\"followUpEmail\":\"7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br\",\"lastMessage\":null,\"hostname\":\"luxstore\",\"invoiceData\":null,\"changesAttachment\":{\"id\":\"changeAttachment\",\"changesData\":[{\"reason\":\"Blah\",\"discountValue\":3290,\"incrementValue\":0,\"itemsAdded\":[],\"itemsRemoved\":[{\"id\":\"1234568358\",\"name\":\"Bay Max L\",\"quantity\":1,\"price\":3290,\"unitMultiplier\":null}],\"receipt\":{\"date\":\"2019-02-06T20:46:04.4003606+00:00\",\"orderId\":\"v502556llux-01\",\"receipt\":\"029f9ab8-751a-4b1e-bf81-7dd25d14b49b\"}}]},\"openTextField\":null,\"roundingError\":0,\"orderFormId\":\"caae7471333e403f959fa5fd66951340\",\"commercialConditionData\":null,\"isCompleted\":true,\"customData\":null,\"storePreferencesData\":{\"countryCode\":\"BRA\",\"currencyCode\":\"BRL\",\"currencyFormatInfo\":{\"CurrencyDecimalDigits\":2,\"CurrencyDecimalSeparator\":\",\",\"CurrencyGroupSeparator\":\".\",\"CurrencyGroupSize\":3,\"StartsWithCurrencySymbol\":true},\"currencyLocale\":1046,\"currencySymbol\":\"R$\",\"timeZone\":\"E. South America Standard Time\"},\"allowCancellation\":true,\"allowEdition\":false,\"isCheckedIn\":false,\"marketplace\":{\"baseURL\":\"http://oms.vtexinternal.com.br/api/oms?an=luxstore\",\"isCertified\":null,\"name\":\"luxstore\"},\"authorizedDate\":\"2019-01-28T20:33:04+00:00\",\"invoicedDate\":null,\"cancelReason\":\"The size was too big.\",\"itemMetadata\":{\"Items\":[{\"Id\":\"18\",\"Seller\":\"1\",\"Name\":\"Cat food\",\"SkuName\":\"Cat food\",\"ProductId\":\"6\",\"RefId\":\"105\",\"Ean\":\"43673557\",\"ImageUrl\":\"http://store.vteximg.com.br/ids/155392-55-55/AlconKOI.jpg?v=635918402228600000\",\"DetailUrl\":\"/catfood/p\",\"AssemblyOptions\":[{\"Id\":\"vtex.subscription.plan-ana\",\"Name\":\"vtex.subscription.plan-ana\",\"Required\":false,\"InputValues\":{\"vtex.subscription.key.frequency\":{\"MaximumNumberOfCharacters\":8,\"Domain\":[\"4 month\",\"1 month\"]}},\"Composition\":{}}]}]},\"subscriptionData\":{\"SubscriptionGroupId\":\"A64AC73C0FB8693A7ADB4AC69CA4FD5F\",\"Subscriptions\":[{\"ExecutionCount\":724,\"PriceAtSubscriptionDate\":100,\"ItemIndex\":0,\"Plan\":{\"type\":\"RECURRING_PAYMENT\",\"frequency\":{\"periodicity\":\"DAILY\",\"interval\":1},\"validity\":{\"begin\":\"2022-01-10T00:00:00.0000000+00:00\",\"end\":\"2024-02-03T00:00:00.0000000+00:00\"}}}]},\"taxData\":{\"areTaxesDesignatedByMarketplace\":true,\"taxInfoCollection\":[{\"itemIndex\":0,\"sku\":\"COLOCAR_O_SKUID\",\"priceTags\":[{\"isPercentual\":false,\"name\":\"Taxes (Magazine Luisa)\",\"rawValue\":\"COLOCAR_O_VALOR_SEM_DECIMAL\"}]}]},\"checkedInPickupPointId\":\"storeNameExample_901\",\"cancellationData\":{\"RequestedByUser\":true,\"RequestedBySystem\":false,\"RequestedBySellerNotification\":false,\"RequestedByPaymentNotification\":false,\"Reason\":\"Item was too big in the client.\",\"CancellationDate\":\"2022-10--05T15:40:33\"},\"clientPreferencesData\":{\"locale\":\"en-US\",\"optinNewsLetter\":false}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/oms/user/orders/:orderId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -7089,7 +7240,7 @@ "event": [] }, { - "id": "b54ed402-ad98-40a8-9f8a-43f2bc5d4c32", + "id": "953e8a18-00f0-4afa-8de3-c841656c0f17", "name": "Change seller", "description": { "content": "", @@ -7097,7 +7248,7 @@ }, "item": [ { - "id": "6b12eee0-062e-4f81-b2e3-985ad3b5bd8c", + "id": "41655a2d-f4bc-47a1-bde1-27ca0f9871f7", "name": "Get window to change seller", "request": { "name": "Get window to change seller", @@ -7151,7 +7302,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e47f3cd4-41bc-4c05-b44d-2dcecc1cfbaf", + "id": "40b4d2ed-a325-44fe-9bdb-28f58a059497", "name": "OK", "originalRequest": { "url": { @@ -7219,7 +7370,7 @@ { "listen": "test", "script": { - "id": "2c7d823d-dfe3-4968-9d83-ad40809ebb24", + "id": "49d335ca-a9cd-4456-8683-9419c60d0f36", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pvt/configuration/window-to-change-seller - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -7235,7 +7386,7 @@ } }, { - "id": "b0c416e8-5213-4e12-9e7d-a51692ad90c0", + "id": "c5959fbc-ebad-4a2e-b8ec-c8422cf43194", "name": "Update window to change seller", "request": { "name": "Update window to change seller", @@ -7298,7 +7449,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "ce4341ba-34a9-4070-814d-e595464ab66e", + "id": "befbf854-fd6f-4e2e-b4d6-48a593b13703", "name": "Created", "originalRequest": { "url": { @@ -7369,7 +7520,7 @@ { "listen": "test", "script": { - "id": "8bf012b4-0c46-44b0-8883-f58f9d75ed9c", + "id": "3490ea20-e072-444e-ac37-f2be0a445fc2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pvt/configuration/window-to-change-seller - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -7424,7 +7575,7 @@ } ], "info": { - "_postman_id": "67a458d0-21f2-4ec7-ad24-fe8b34c93b0c", + "_postman_id": "d1dacbca-07cc-40c6-a2e2-fe5c621e48d0", "name": "Orders API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/VTEX - Orders API.json b/VTEX - Orders API.json index f32fcfc55..29200cd0c 100644 --- a/VTEX - Orders API.json +++ b/VTEX - Orders API.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "Orders API", - "description": "Each purchase a customer makes in your store generates an [order](https:\/\/help.vtex.com\/en\/tutorial\/order-flow-and-status--tutorials_196) on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also [change orders](https:\/\/help.vtex.com\/en\/tutorial\/changing-items-from-a-complete-order--tutorials_190) and make configurations to allow or forbid marketplaces and sellers to change or cancel orders.\r\n\r\n### Order integration\n\r\nTo automate actions related to order processing, you can [integrate orders](https:\/\/developers.vtex.com\/docs\/guides\/erp-integration-guide) with systems like ERP (Enterprise Resource Planning) and WMS (Warehouse Management System) using [Feed and Hook](https:\/\/developers.vtex.com\/docs\/guides\/orders-feed).\r\n\r\n## Orders API Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-)\r\n- `GET` [List orders](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders)\r\n- `POST` [Start handling order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/start-handling)\r\n- `POST` [Cancel order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/cancel)\r\n- `POST` [Register change on order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/changes)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/invoice)\r\n- `PATCH` [Update order's partial invoice (send tracking number)](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#patch-\/api\/oms\/pvt\/orders\/-orderId-\/invoice\/-invoiceNumber-)\r\n\r\n### Tracking\r\n\r\n- `PUT` [Update order tracking status](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#put-\/api\/oms\/pvt\/orders\/-orderId-\/invoice\/-invoiceNumber-\/tracking)\r\n\r\n### Conversation\r\n\r\n- `GET` [Retrieve order conversation](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-\/conversation-message)\r\n\r\n### Payment\r\n\r\n- `GET` [Retrieve payment transaction](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-\/payment-transaction)\r\n- `POST` [Send payment notification](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/payments\/-paymentId-\/payment-notification)\r\n\r\n### Feed v2 (deprecated)\r\n\r\n- `GET` [Get feed order status](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/feed\/orders\/status)\r\n\r\n### Feed v3\r\n\r\n- `GET` [Get feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/feed\/config)\r\n- `POST` [Create or update feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/feed\/config)\r\n- `DELETE` [Delete feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#delete-\/api\/orders\/feed\/config)\r\n- `GET` [Retrieve feed items](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/feed)\r\n- `POST` [Commit feed items](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/feed)\r\n- `POST` [Test JSONata expression](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/expressions\/jsonata)\r\n\r\n### Order hook\r\n\r\n- `GET` [Get hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/hook\/config)\r\n- `POST` [Create or update hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/hook\/config)\r\n- `DELETE` [Delete hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#delete-\/api\/orders\/hook\/config)\r\n\r\n### User orders\r\n\r\n- `GET` [Retrieve user's orders](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/user\/orders)\r\n- `GET` [Retrieve user order details](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/user\/orders\/-orderId-)\r\n\r\n### Change seller\r\n\r\n- `GET` [Get window to change seller](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/checkout\/pvt\/configuration\/window-to-change-seller)\r\n- `POST` [Update window to change seller](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/checkout\/pvt\/configuration\/window-to-change-seller) \r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| :---: | :--- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |", + "description": "Each purchase a customer makes in your store generates an [order](https:\/\/help.vtex.com\/en\/tutorial\/order-flow-and-status--tutorials_196) on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also [change orders](https:\/\/help.vtex.com\/en\/tutorial\/changing-items-from-a-complete-order--tutorials_190) and make configurations to allow or forbid marketplaces and sellers to change or cancel orders.\r\n\r\n### Order integration\n\r\nTo automate actions related to order processing, you can [integrate orders](https:\/\/developers.vtex.com\/docs\/guides\/erp-integration-guide) with systems like ERP (Enterprise Resource Planning) and WMS (Warehouse Management System) using [Feed and Hook](https:\/\/developers.vtex.com\/docs\/guides\/orders-feed).\r\n\r\n## Orders API Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-)\r\n- `GET` [Get orders by order group ID](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/order-group\/-orderGroup-)\r\n- `GET` [List orders](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders)\r\n- `POST` [Start handling order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/start-handling)\r\n- `POST` [Cancel order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/cancel)\r\n- `POST` [Register change on order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/changes)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/invoice)\r\n- `PATCH` [Update order's partial invoice (send tracking number)](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#patch-\/api\/oms\/pvt\/orders\/-orderId-\/invoice\/-invoiceNumber-)\r\n\r\n### Tracking\r\n\r\n- `PUT` [Update order tracking status](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#put-\/api\/oms\/pvt\/orders\/-orderId-\/invoice\/-invoiceNumber-\/tracking)\r\n\r\n### Conversation\r\n\r\n- `GET` [Retrieve order conversation](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-\/conversation-message)\r\n\r\n### Payment\r\n\r\n- `GET` [Retrieve payment transaction](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-\/payment-transaction)\r\n- `POST` [Send payment notification](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/payments\/-paymentId-\/payment-notification)\r\n\r\n### Feed v2 (deprecated)\r\n\r\n- `GET` [Get feed order status](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/feed\/orders\/status)\r\n\r\n### Feed v3\r\n\r\n- `GET` [Get feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/feed\/config)\r\n- `POST` [Create or update feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/feed\/config)\r\n- `DELETE` [Delete feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#delete-\/api\/orders\/feed\/config)\r\n- `GET` [Retrieve feed items](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/feed)\r\n- `POST` [Commit feed items](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/feed)\r\n- `POST` [Test JSONata expression](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/expressions\/jsonata)\r\n\r\n### Order hook\r\n\r\n- `GET` [Get hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/hook\/config)\r\n- `POST` [Create or update hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/hook\/config)\r\n- `DELETE` [Delete hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#delete-\/api\/orders\/hook\/config)\r\n\r\n### User orders\r\n\r\n- `GET` [Retrieve user's orders](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/user\/orders)\r\n- `GET` [Retrieve user order details](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/user\/orders\/-orderId-)\r\n\r\n### Change seller\r\n\r\n- `GET` [Get window to change seller](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/checkout\/pvt\/configuration\/window-to-change-seller)\r\n- `POST` [Update window to change seller](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/checkout\/pvt\/configuration\/window-to-change-seller) \r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| :---: | :--- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |", "contact": {}, "version": "1.0" }, @@ -3147,22 +3147,23 @@ } } }, - "/api/oms/pvt/orders": { + "/api/oms/pvt/orders/order-group/{orderGroup}": { "get": { - "tags": ["Orders"], - "summary": "List orders", - "description": "Retrieves a list of orders according to the filters described below. \r\n\r\nThe limit of information retrieval is 30 pages, the default number of orders per page is 15 and it is possible to configure it up to 100 using the `per_page` parameter. \r\n\r\nBe aware that since October 3rd, 2018, this endpoint does not return the `items` property. \r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). \r\n\r\n> This endpoint should **not** be used for integrations. Use the [orders Feed or hook](https://developers.vtex.com/docs/guides/orders-feed) for this purpose. \r\n\r\nThis endpoint returns only orders that already have been indexed, which takes approximately four minutes. Because of this, the data retrieved may present inconsistencies. To get live up-to-date information and [build order integrations](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration) use the [orders Feed or hook](https://developers.vtex.com/docs/guides/orders-feed).\r\n\r\n> **Onboarding guide** \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **List Orders** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | List Orders |\r\n| Checkout Admin | List Orders |\r\n| IntegrationProfile - Fulfillment Oms | List Orders |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", - "operationId": "ListOrders", + "tags": [ + "Orders" + ], + "summary": "Get orders by order group ID", + "description": "Retrieves details about all orders related to the same purchase by searching by order group ID.\r\n\r\n>⚠️ Throttling: Each VTEX account can make up to 6000 requests per minute.\r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | View order |\r\n| Checkout Admin | View order |\r\n| IntegrationProfile - Fulfillment Oms | View order |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "Accept", "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", - "default": "application/json" + "example": "application/json" } }, { @@ -3173,259 +3174,18 @@ "style": "simple", "schema": { "type": "string", - "default": "application/json" - } - }, - { - "name": "orderBy", - "in": "query", - "description": "You can retrieve orders lists filtering by an `OrderField` combined with an `OrderType`. To do so, you have to concatenate them: `orderBy={{OrderField}},{{OrderType}}`. \r\n- `OrderField` values accepted: `creationDate`, `orderId`, `items`, `totalValue` and `origin`. \r\n- `OrderType` values accepted: `asc` and `desc`.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "v502556llux-01,asc" - } - }, - { - "name": "page", - "in": "query", - "description": "Define the number of pages you wish to retrieve, restricted to the limit of 30 pages.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "example": 10 - } - }, - { - "name": "per_page", - "in": "query", - "description": "Quantity of orders for each page, the default value is 15 and it goes up to 100 orders per page. Be aware that the limit of retrieval ofthis endpoint is 30 pages.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "example": 15 - } - }, - { - "name": "f_hasInputInvoice", - "in": "query", - "description": "Filters list to return only orders with non `null` values for the `invoiceInput` field.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "boolean", - "example": false - } - }, - { - "name": "q", - "in": "query", - "description": "This parameter filters using Fulltext and accepts the values below. Be aware that the `+` caracter is not allowed in Fulltext Search. \r\n- Order Id \r\n- Client email \r\n- Client document \r\n- Client name", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "- OrderID: v212333lux-02 \r\n- Client email: taylor@email.com \r\n- Client document: 21133355524 \r\n- Client name: Taylor" - } - }, - { - "name": "f_shippingEstimate", - "in": "query", - "description": "You can filter orders by shipping estimate time in days by concatenating the desired number of days with the sufix `.days`. For example: \r\n- Next 7 days: `7.days` \r\n- Tomorrow: `1.days` \r\n- Today: `0.days` \r\n- Late: `-1.days`", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "0.days" - } - }, - { - "name": "f_invoicedDate", - "in": "query", - "description": "You can filter orders by invoiced date by concatenating the sufix `invoicedDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]" - } - }, - { - "name": "f_creationDate", - "in": "query", - "description": "You can filter orders by creation date by concatenating the sufix `creationDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]" - } - }, - { - "name": "f_authorizedDate", - "in": "query", - "description": "You can filter orders by creation date by concatenating the sufix `authorizedDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]" - } - }, - { - "name": "f_UtmSource", - "in": "query", - "description": "You can filter orders by Urchin Tracking Module (UTM) source.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "christmas_campaign" - } - }, - { - "name": "f_sellerNames", - "in": "query", - "description": "You can filter orders by using a seller's name.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "SellerName" - } - }, - { - "name": "f_callCenterOperatorName", - "in": "query", - "description": "You can filter orders by using a Call Center Operator's identification.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "Operator%20Name" - } - }, - { - "name": "f_salesChannel", - "in": "query", - "description": "You can filter orders by sales channel's ([or trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) name.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "Main" - } - }, - { - "name": "salesChannelId", - "in": "query", - "description": "You can filter orders by sales channel's ([or trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "1" - } - }, - { - "name": "f_affiliateId", - "in": "query", - "description": "You can filter orders by affiliate ID.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "WLM" - } - }, - { - "name": "f_status", - "in": "query", - "description": "You can filter orders by the following [order status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196): \r\n- `waiting-for-sellers-confirmation` \r\n- `payment-pending` \r\n- `payment-approved` \r\n- `ready-for-handling` \r\n- `handling` \r\n- `invoiced` \r\n- `canceled`", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "ready-for-handling" - } - }, - { - "name": "incompleteOrders", - "in": "query", - "description": "When set as `true`, you retrieve [incomplete orders](https://help.vtex.com/en/tutorial/understanding-incomplete-orders), when set as `false`, you retrieve orders that are not incomplete.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "boolean", - "example": true - } - }, - { - "name": "f_paymentNames", - "in": "query", - "description": "You can filter orders by payment type.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "Visa" - } - }, - { - "name": "f_RnB", - "in": "query", - "description": "You can filter orders by rates and benefits (promotions).", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "Free+Shipping" + "example": "application/json" } }, { - "name": "searchField", - "in": "query", - "description": "You can search orders by using one of the following criterias: \r\n- SKU ID - `sku_Ids&sku_Ids` \r\n- Gift List ID - `listId&listId` \r\n- Transaction ID (TID) - `tid&tid` \r\n- PCI Connector's Transaction ID (TID) - `pci_tid&pci_tid` \r\n- Payment ID (PID) - `paymentId&paymentId` \r\n- Connector's NSU - `nsu&nsu`", - "required": false, - "style": "form", - "explode": true, + "name": "orderGroup", + "in": "path", + "description": "Order group ID is a part of the order ID that groups all orders related to the same purchase. For example, when an order is fullfilled by multiple sellers, each seller has its own order ID (`v71021570str-01` and `v71021570str-02`), but they share the same order group ID (`v71021570str`).", + "required": true, + "style": "simple", "schema": { "type": "string", - "example": "- SKU ID: `25` \r\n- Gift List ID: `11223` \r\n- Transaction ID (TID): `54546300238810034995829230012` \r\n- PCI Connector's Transaction ID (TID): `7032909234899834298423209` \r\n- Payment ID (PID): `2` \r\n- Connector's NSU: `2437281`" - } - }, - { - "name": "f_isInstore", - "in": "query", - "description": "When set as `true`, this parameter filters orders made via [inStore](https://help.vtex.com/en/tracks/what-is-instore--zav76TFEZlAjnyBVL5tRc), and when set as `false`, it filters orders that were not made via inStore.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "boolean", - "example": true + "example": "71021570" } } ], @@ -3433,555 +3193,1418 @@ "200": { "description": "OK", "content": { - "application/json; charset=utf-8": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ListOrders" + "type": "array", + "description": "List of orders grouped by the order group ID.", + "items": { + "type": "object", + "description": "Information about an order related to the order group ID.", + "properties": { + "orderId": { + "type": "string", + "description": "Order ID." + }, + "sequence": { + "type": "string", + "description": "Sequence number part of the order ID. For example, in order `v70530116str-01`, the sequence is `70530116`." + }, + "marketplaceOrderId": { + "type": "string", + "description": "Order ID in the marketplace.", + "nullable": true + }, + "marketplaceServicesEndpoint": { + "type": "string", + "description": "Marketplace endpoint for post purchase communication.", + "nullable": true + }, + "sellerOrderId": { + "type": "string", + "description": "Seller order ID." + }, + "origin": { + "type": "string", + "description": "Order's [origin in the order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).", + "enum": [ + "Marketplace", + "Fulfillment", + "Chain" + ] + }, + "affiliateId": { + "type": "string", + "description": "Three-letter [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) code configured by the seller to identify a marketplace.", + "nullable": true + }, + "salesChannel": { + "type": "string", + "description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order." + }, + "merchantName": { + "type": "string", + "description": "For a VTEX store, the merchant's name will be the same as the account name. An external seller can have a `merchantName`, but it will not be an account name.", + "nullable": true + }, + "status": { + "type": "string", + "description": "[Order status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) in the workflow." + }, + "statusDescription": { + "type": "string", + "description": "Status description displayed on the VTEX Admin. This field is obsolete and may not return any value.", + "nullable": true, + "deprecated": true + }, + "value": { + "type": "integer", + "description": "Order total value in cents." + }, + "creationDate": { + "type": "string", + "description": "Order creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "lastChange": { + "type": "string", + "description": "Order last change date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "orderGroup": { + "type": "string", + "description": "Order's group ID, a code part of the order ID that groupes all orders related to the same purchase. For example, in order ID `v71021570str-02`), the order group ID is `v71021570str`." + }, + "totals": { + "$ref": "#/components/schemas/TotalsUpdated" + }, + "items": { + "$ref": "#/components/schemas/ItemsUpdated" + }, + "marketplaceItems": { + "type": "array", + "description": "Array with marketplace items information.", + "items": { + "type": "string", + "description": "Marketplace items." + } + }, + "clientProfileData": { + "$ref": "#/components/schemas/ClientProfileDataUpdated" + }, + "giftRegistryData": { + "$ref": "#/components/schemas/GiftRegistryDataUpdated" + }, + "marketingData": { + "$ref": "#/components/schemas/MarketingDataUpdated" + }, + "ratesAndBenefitsData": { + "$ref": "#/components/schemas/RatesAndBenefitsDataUpdated" + }, + "shippingData": { + "$ref": "#/components/schemas/ShippingDataUpdated" + }, + "paymentData": { + "$ref": "#/components/schemas/PaymentDataUpdated" + }, + "packageAttachment": { + "$ref": "#/components/schemas/PackageAttachmentUpdated" + }, + "sellers": { + "$ref": "#/components/schemas/SellersUpdated" + }, + "callCenterOperatorData": { + "type": "object", + "description": "Information about the call center operator responsible for the order.", + "nullable": true, + "properties": { + "id": { + "type": "string", + "description": "Call center operator identification code." + }, + "email": { + "type": "string", + "description": "Call center operator email." + }, + "userName": { + "type": "string", + "description": "Call center operator user name." + } + } + }, + "followUpEmail": { + "type": "string", + "description": "Email of the store employee responsible for managing the order." + }, + "lastMessage": { + "type": "string", + "description": "Last transactional message sent to the customer.", + "nullable": true + }, + "hostname": { + "type": "string", + "description": "Main [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC)." + }, + "invoiceData": { + "$ref": "#/components/schemas/InvoiceDataUpdated" + }, + "changesAttachment": { + "$ref": "#/components/schemas/ChangesAttachmentUpdated" + }, + "openTextField": { + "type": "object", + "description": "Optional field for additional information.", + "nullable": true, + "additionalProperties": { + "type": "string", + "description": "Additional information." + } + }, + "roundingError": { + "type": "integer", + "description": "Rounding error total value in cents, when applicable. For example, in orders with a discount over non-integer multiplier items, the rounding price is applied per item, not after the sum of all items, what can cause a difference in the total discount value." + }, + "orderFormId": { + "type": "string", + "description": "ID of the [orderForm](https://developers.vtex.com/docs/guides/orderform-fields), the main object processed by the VTEX Checkout." + }, + "commercialConditionData": { + "type": "string", + "description": "Commercial condition information.", + "nullable": true + }, + "isCompleted": { + "type": "boolean", + "description": "Defines if the order payment has been settled (`true`) or not (`false`)." + }, + "customData": { + "type": "object", + "description": "Customizable fields created by the store for the shopping cart. This field is useful for storing data not included in other fields. For example, a message for a gift or a name to be printed in a shirt.", + "nullable": true, + "properties": { + "customApps": { + "type": "array", + "description": "Customizable apps created by the store.", + "nullable": true, + "items": { + "type": "string", + "description": "Customizable apps details.", + "nullable": true + } + } + } + }, + "storePreferencesData": { + "$ref": "#/components/schemas/StorePreferencesDataUpdated" + }, + "allowCancellation": { + "type": "boolean", + "description": "Defines if order cancellation is allowed (`true`) or not anymore (`false`)." + }, + "allowEdition": { + "type": "boolean", + "description": "Defines if the order can be edited (`true`) or not anymore (`false`)." + }, + "isCheckedIn": { + "type": "boolean", + "description": "Defines if the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) (`true`) or not (`false`)." + }, + "marketplace": { + "$ref": "#/components/schemas/MarketplaceUpdated" + }, + "authorizedDate": { + "type": "string", + "description": "Order authorization date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "nullable": true + }, + "invoicedDate": { + "type": "string", + "description": "Order invoice date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "nullable": true + }, + "cancelReason": { + "type": "string", + "description": "Order cancellation reason.", + "nullable": true + }, + "itemMetadata": { + "$ref": "#/components/schemas/ItemMetadataUpdated" + }, + "subscriptionData": { + "$ref": "#/components/schemas/SubscriptionDataUpdated" + }, + "taxData": { + "$ref": "#/components/schemas/TaxDataUpdated" + }, + "checkedInPickupPointId": { + "type": "string", + "description": "When the order is created at a physical store which is configured as a pickup point, this field retrieves the pickup point ID.", + "nullable": true + }, + "cancellationData": { + "$ref": "#/components/schemas/CancellationDataUpdated" + }, + "cancellationRequests": { + "$ref": "#/components/schemas/CancellationRequestsUpdated" + }, + "clientPreferencesData": { + "$ref": "#/components/schemas/ClientPreferencesDataUpdated" + } + } + } }, - "example": { - "list": [ - { - "orderId": "1306331686122-01", - "creationDate": "2019-02-04T10:29:11+00:00", - "clientName": "J C", - "items": null, - "totalValue": 7453, - "paymentNames": "Boleto Bancário", - "status": "invoiced", - "statusDescription": "Faturado", - "marketPlaceOrderId": null, - "sequence": "502559", - "salesChannel": "1", - "affiliateId": "", - "origin": "Marketplace", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci", - "ShippingEstimatedDate": null, - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2019-02-07T21:29:54+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" + "example": [ + { + "orderId": "v71425090str-01", + "sequence": "71425090", + "marketplaceOrderId": "", + "marketplaceServicesEndpoint": "http://oms.vtexinternal.com.br/api/oms?an=str", + "sellerOrderId": "00-v71425090str-01", + "origin": "Marketplace", + "affiliateId": "", + "salesChannel": "1", + "merchantName": null, + "status": "", + "statusDescription": null, + "value": 5458, + "creationDate": "2024-10-09T19:25:26.5838646+00:00", + "lastChange": "2024-10-09T19:26:29.6119318+00:00", + "orderGroup": "v71425090str", + "totals": [ + { + "id": "Items", + "name": "Total Items", + "value": 6999 + }, + { + "id": "Discounts", + "name": "Total Discounts", + "value": -1750 + }, + { + "id": "Shipping", + "name": "Total Freight", + "value": 209, + "alternativeTotals": [ + { + "id": "AlternativeShippingTotal", + "name": "Alternative Shipping Total", + "value": 2435 + }, + { + "id": "AlternativeShippingDiscount", + "name": "Alternative Shipping Discount", + "value": -2226 + } + ] + }, + { + "id": "Tax", + "name": "Total Tax", + "value": 0 + } + ], + "items": [ + { + "uniqueId": "E1CA66F73B8746B19AE2A9CFB2D2D260", + "id": "5830010", + "productId": "4301268", + "ean": null, + "lockId": "00-v71425090str-01", + "itemAttachment": { + "content": {}, + "name": null + }, + "attachments": [], + "quantity": 1, + "seller": "1", + "name": "white cotton shirt M", + "refId": "11167127", + "price": 6999, + "listPrice": 6999, + "manualPrice": null, + "manualPriceAppliedBy": null, + "priceTags": [ + { + "name": "DISCOUNT@MARKETPLACE", + "value": -1750, + "isPercentual": false, + "identifier": "026be20b-9839-486e-9e6e-8987a93eb92a", + "rawValue": -17.50, + "rate": null, + "jurisCode": null, + "jurisType": null, + "jurisName": null + } + ], + "imageUrl": "https://str.vteximg.com.br/files/ids/56901106-200-240/white-cotton-shirt.jpg?v=638108542148100000", + "detailUrl": "/white-cotton-shirt/p", + "components": [], + "bundleItems": [], + "params": [], + "offerings": [], + "attachmentOfferings": [], + "sellerSku": "5830010", + "priceValidUntil": null, + "commission": 0, + "tax": 0, + "preSaleDate": null, + "additionalInfo": { + "brandName": "STR", + "brandId": "1", + "categoriesIds": "/1000083/1004135/1004138/", + "categories": [ + { + "id": 1004138, + "name": "Shirts" + }, + { + "id": 1004135, + "name": "Clothes" + }, + { + "id": 1000083, + "name": "Male fashion" + } + ], + "productClusterId": "8896,9708,9922,10068,11240,13213,15891,16552,17287,17349,17415,17436,17465,17630,17775,17785,17822,17836,17992,18126,18187,18224,18231,18234,18265,18269,18292,18335,18348,18363,18379,18398,18410,18419,18422,18442,18472,18509,18519,18658,18674,18681,18695,18701,18715,18847,18855,18896,18912,18916,18927,18959,18969,18971,18999,19016,19023,19035,19072,19107,19147,19151,19206,19230,19242,19387,19422,19454,19481,19482,19588,19597,19603,19640,19660,19671,19681,19699,19721,19738,19739", + "commercialConditionId": "1", + "dimension": { + "cubicweight": 0.5208, + "height": 10.0, + "length": 25.0, + "weight": 210.0, + "width": 10.0 + }, + "offeringInfo": null, + "offeringType": null, + "offeringTypeId": null + }, + "measurementUnit": "un", + "unitMultiplier": 1.0, + "sellingPrice": 5249, + "isGift": false, + "shippingPrice": null, + "rewardValue": 0, + "freightCommission": 0, + "priceDefinition": { + "sellingPrices": [ + { + "value": 5249, + "quantity": 1 + } + ], + "calculatedSellingPrice": 5249, + "total": 5249, + "reason": null + }, + "taxCode": null, + "parentItemIndex": null, + "parentAssemblyBinding": null, + "callCenterOperator": null, + "serialNumbers": null, + "assemblies": [], + "costPrice": 6998 + } + ], + "marketplaceItems": [], + "clientProfileData": { + "id": "clientProfileData", + "email": "cmlsmith@email.com", + "firstName": "Camila", + "lastName": "Smith", + "documentType": "cpf", + "document": "15586841755", + "phone": "+5521975366533", + "corporateName": null, + "tradeName": null, + "corporateDocument": null, + "stateInscription": null, + "corporatePhone": null, + "isCorporate": false, + "userProfileId": "e366889f-9d07-4076-a78d-72af8fdfd7e7", + "userProfileVersion": null, + "customerClass": null, + "customerCode": null }, - { - "orderId": "v502556llux-01", - "creationDate": "2019-01-28T20:09:43+00:00", - "clientName": "Rodrigo VTEX", - "items": null, - "totalValue": 1160, - "paymentNames": "Boleto Bancário", - "status": "handling", - "statusDescription": "Preparando Entrega", - "marketPlaceOrderId": null, - "sequence": "502556", - "salesChannel": "1", - "affiliateId": "", - "origin": "Marketplace", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": " Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ", - "ShippingEstimatedDate": "2019-02-04T20:33:46+00:00", - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2019-01-28T20:33:04+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" + "giftRegistryData": null, + "marketingData": { + "id": "marketingData", + "utmSource": "delorean", + "utmPartner": null, + "utmMedium": "mystr", + "utmCampaign": "johnvasconcelosg", + "coupon": "", + "utmiCampaign": "", + "utmipage": "", + "utmiPart": "", + "marketingTags": [ + "mstr_servicos", + "mstr_delorean", + "mstr_johnvasconcelosg", + "mstr_mystr", + "mobile", + "Delivery", + "STR" + ] }, - { - "orderId": "v502553llux-01", - "creationDate": "2019-01-24T12:35:19+00:00", - "clientName": "test test", - "items": null, - "totalValue": 10150, - "paymentNames": "Mastercard", - "status": "ready-for-handling", - "statusDescription": "Pronto para o manuseio", - "marketPlaceOrderId": null, - "sequence": "502554", - "salesChannel": "1", - "affiliateId": "", - "origin": "Marketplace", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502553llux-01 Olá, test. Estamos empacotando seu produto para provide", - "ShippingEstimatedDate": "2019-01-31T12:36:30+00:00", - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2019-01-24T12:36:01+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" + "ratesAndBenefitsData": { + "id": "ratesAndBenefitsData", + "rateAndBenefitsIdentifiers": [ + { + "description": "ID\t518\nValis purchases\tMy STR;CRM;POM;\nWeek\t202441\nDate_begin\t07/10/2024 14:00\nDate_end\t22/10/2024\nName_promotion\t25%_3PC_W41_07-10-2024\n\nValid_for\tColection\t19738\nChannel\tApp;Site;\nName_requester\tJohn Carlos\nEmail_requester\tjohn.c@str.com\nAuthor\tGuilherme Verner", + "featured": false, + "id": "026be20b-9839-486e-9e6e-8987a93eb92a", + "name": "25%_3PC_W41_07-10-2024", + "matchedParameters": { + "Seller@CatalogSystem": "1|inclusive" + }, + "additionalInfo": null + } + ] }, - { - "orderId": "v502550llux-01", - "creationDate": "2019-01-23T16:39:45+00:00", - "clientName": "test test", - "items": null, - "totalValue": 10150, - "paymentNames": "Mastercard", - "status": "ready-for-handling", - "statusDescription": "Pronto para o manuseio", - "marketPlaceOrderId": null, - "sequence": "502551", - "salesChannel": "1", - "affiliateId": "", - "origin": "Marketplace", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502550llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc", - "ShippingEstimatedDate": "2019-01-30T16:40:55+00:00", - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2019-01-23T16:40:27+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" + "shippingData": { + "id": "shippingData", + "address": { + "addressType": "residential", + "receiverName": "Camila Smith", + "addressId": "968d3b10816145878aa09b320f7e688a", + "versionId": null, + "entityId": null, + "postalCode": "21020-402", + "city": "Rio de Janeiro", + "state": "RJ", + "country": "BRA", + "street": "Couto", + "number": "29", + "neighborhood": "Penha", + "complement": "Bloco 5 apt 321", + "reference": "Next to the Shopping", + "geoCoordinates": [ + -43.273593902587891, + -22.835159301757813 + ] + }, + "logisticsInfo": [ + { + "itemIndex": 0, + "itemId": "5830010", + "selectedDeliveryChannel": "delivery", + "selectedSla": "Normal", + "lockTTL": "12d", + "price": 209, + "listPrice": 2435, + "sellingPrice": 209, + "deliveryWindow": null, + "deliveryCompany": "ASAPLAG_CR", + "shippingEstimate": "2bd", + "shippingEstimateDate": "2024-10-11T18:00:00.0000000+00:00", + "slas": [ + { + "id": "Normal", + "name": "Normal", + "shippingEstimate": "2bd", + "shippingEstimateDate": "2024-10-11T18:00:00.0000000+00:00", + "deliveryWindow": null, + "availableDeliveryWindows": [], + "deliveryIds": [ + { + "courierId": "ASAPLAG_CR", + "courierName": "ASAPLAG_CR", + "dockId": "6", + "quantity": 1, + "warehouseId": "1_1", + "accountCarrierName": "str", + "kitItemDetails": [] + } + ], + "listPrice": 2435, + "price": 209, + "deliveryChannel": "delivery", + "pickupStoreInfo": { + "additionalInfo": null, + "address": null, + "dockId": null, + "friendlyName": null, + "isPickupStore": false + }, + "polygonName": "", + "lockTTL": "12d", + "pickupPointId": null, + "transitTime": "1bd", + "pickupDistance": 0.0 + }, + { + "id": "Gift", + "name": "Gift", + "shippingEstimate": "2bd", + "shippingEstimateDate": null, + "deliveryWindow": null, + "availableDeliveryWindows": [], + "deliveryIds": [ + { + "courierId": "ASAPLAG_CR_GIFT", + "courierName": "ASAPLAG_CR_GIFT", + "dockId": "1317c52", + "quantity": 1, + "warehouseId": "1_1", + "accountCarrierName": "str", + "kitItemDetails": [] + } + ], + "listPrice": 4435, + "price": 1399, + "deliveryChannel": "delivery", + "pickupStoreInfo": { + "additionalInfo": null, + "address": null, + "dockId": null, + "friendlyName": null, + "isPickupStore": false + }, + "polygonName": "", + "lockTTL": "12d", + "pickupPointId": null, + "transitTime": "1bd", + "pickupDistance": 0.0 + }, + { + "id": "Pickup at store (CAR)", + "name": "Pickup at store (CAR)", + "shippingEstimate": "1bd", + "shippingEstimateDate": null, + "deliveryWindow": null, + "availableDeliveryWindows": [], + "deliveryIds": [ + { + "courierId": "1", + "courierName": "Flexible shipping", + "dockId": "1", + "quantity": 1, + "warehouseId": "1_2", + "accountCarrierName": "strcar", + "kitItemDetails": [] + } + ], + "listPrice": 0, + "price": 0, + "deliveryChannel": "pickup-in-point", + "pickupStoreInfo": { + "additionalInfo": "{\"phoneNumber\":\"(21) 3317-6791 \",\"pickupInstructions\":\"Present document with photo\"}", + "address": { + "addressType": "pickup", + "receiverName": null, + "addressId": "CAR", + "versionId": null, + "entityId": null, + "postalCode": "21210000", + "city": "Rio De Janeiro", + "state": "RJ", + "country": "BRA", + "street": "Avenida Vicente De Carvalho", + "number": "909", + "neighborhood": "Vicente De Carvalho", + "complement": "Store STR Store 101", + "reference": null, + "geoCoordinates": [ + -43.31001, + -22.84991 + ] + }, + "dockId": null, + "friendlyName": "STR Carioca Shopping - Pickup at store", + "isPickupStore": true + }, + "polygonName": "", + "lockTTL": "12d", + "pickupPointId": "strcar_CAR", + "transitTime": "1bd", + "pickupDistance": 4.0762801170349121 + } + ], + "shipsTo": [ + "BRA" + ], + "deliveryIds": [ + { + "courierId": "ASAPLAG_CR", + "courierName": "ASAPLAG_CR", + "dockId": "6", + "quantity": 1, + "warehouseId": "1_1", + "accountCarrierName": "str", + "kitItemDetails": [] + } + ], + "deliveryChannels": [ + { + "id": "delivery", + "stockBalance": 0 + }, + { + "id": "pickup-in-point", + "stockBalance": 0 + } + ], + "deliveryChannel": "delivery", + "pickupStoreInfo": { + "additionalInfo": null, + "address": null, + "dockId": null, + "friendlyName": null, + "isPickupStore": false + }, + "addressId": "968d3b10816145878aa09b320f7e688a", + "versionId": null, + "entityId": null, + "polygonName": "", + "pickupPointId": null, + "transitTime": "1bd" + } + ], + "trackingHints": null, + "selectedAddresses": [ + { + "addressId": "968d3b10816145878aa09b320f7e688a", + "versionId": null, + "entityId": null, + "addressType": "residential", + "receiverName": "Camila Smith", + "street": "Couto", + "number": "29", + "complement": "Building 3 apt 321", + "neighborhood": "Penha", + "postalCode": "21020-402", + "city": "Rio de Janeiro", + "state": "RJ", + "country": "BRA", + "reference": "Next to the Shopping", + "geoCoordinates": [ + -43.273593902587891, + -22.835159301757813 + ] + } + ], + "availableAddresses": [ + { + "addressId": "968d3b10816145878aa09b320f7e688a", + "versionId": null, + "entityId": null, + "addressType": "residential", + "receiverName": "Camila Smith", + "street": "Couto", + "number": "29", + "complement": "Building 3 apt 321", + "neighborhood": "Penha", + "postalCode": "21020-402", + "city": "Rio de Janeiro", + "state": "RJ", + "country": "BRA", + "reference": "Next to the Shopping", + "geoCoordinates": [ + -43.273593902587891, + -22.835159301757813 + ] + } + ], + "contactInformation": [] }, - { - "orderId": "v502547llux-01", - "creationDate": "2019-01-23T16:34:20+00:00", - "clientName": "test test", - "items": null, - "totalValue": 10150, - "paymentNames": "Mastercard", - "status": "ready-for-handling", - "statusDescription": "Pronto para o manuseio", - "marketPlaceOrderId": null, - "sequence": "502548", - "salesChannel": "1", - "affiliateId": "", - "origin": "Marketplace", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502547llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc", - "ShippingEstimatedDate": "2019-01-30T16:35:30+00:00", - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2019-01-23T16:35:04+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" + "paymentData": { + "giftCards": [], + "transactions": [ + { + "isActive": true, + "transactionId": "A599C01B84114016884B143BED05A3GG", + "merchantName": "STR", + "payments": [ + { + "id": "B004B117C52F405FB2AE82835373186D", + "paymentSystem": "125", + "paymentSystemName": "Pix", + "value": 22745, + "installments": 1, + "referenceValue": 22745, + "cardHolder": null, + "cardNumber": null, + "firstDigits": null, + "lastDigits": null, + "cvv2": null, + "expireMonth": null, + "expireYear": null, + "url": null, + "giftCardId": null, + "giftCardName": null, + "giftCardCaption": null, + "redemptionCode": null, + "group": "instantPayment", + "tid": "89781829739", + "dueDate": null, + "connectorResponses": { + "Tid": "89781829739", + "ReturnCode": null, + "Message": null, + "authId": "89781829739", + "nsu": "89781829739", + "acquirer": "paymarket" + }, + "giftCardProvider": null, + "giftCardAsDiscount": null, + "koinUrl": null, + "accountId": null, + "parentAccountId": null, + "bankIssuedInvoiceIdentificationNumber": null, + "bankIssuedInvoiceIdentificationNumberFormatted": null, + "bankIssuedInvoiceBarCodeNumber": null, + "bankIssuedInvoiceBarCodeType": null, + "billingAddress": null, + "paymentOrigin": null + } + ] + } + ] }, - { - "orderId": "v502544llux-01", - "creationDate": "2018-12-28T18:15:28+00:00", - "clientName": "test test", - "items": null, - "totalValue": 8990, - "paymentNames": "Boleto Bancário", - "status": "canceled", - "statusDescription": "Cancelado", - "marketPlaceOrderId": null, - "sequence": "502544", - "salesChannel": "1", - "affiliateId": "", - "origin": "Marketplace", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": " Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502544llux-01 Resumo Itens R$ 89,90 Total R$ 89,90 Produto Alavanca De M", - "ShippingEstimatedDate": null, - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": null, - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" + "packageAttachment": { + "packages": [] }, - { - "orderId": "v502541llux-01", - "creationDate": "2018-12-18T18:48:17+00:00", - "clientName": "Douglas Rodrigues", - "items": null, - "totalValue": 3290, - "paymentNames": "Boleto Bancário", - "status": "canceled", - "statusDescription": "Cancelado", - "marketPlaceOrderId": null, - "sequence": "502541", - "salesChannel": "1", - "affiliateId": "", - "origin": "Marketplace", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": " Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502541llux-01 Resumo Itens R$ 32,90 Total R$ 32,90 Produto Bay Max L 1 u", - "ShippingEstimatedDate": null, - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": null, - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" + "sellers": [ + { + "id": "1", + "name": "STR", + "logo": "", + "fulfillmentEndpoint": "http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=str" + } + ], + "callCenterOperatorData": null, + "followUpEmail": "90ea3ef8b6a64b2588f4bc6cb8617acd@ct.vtex.com", + "lastMessage": null, + "hostname": "str", + "invoiceData": null, + "changesAttachment": null, + "openTextField": null, + "roundingError": 0, + "orderFormId": "066ab2f7f65043a3aa396c749e202fd3", + "commercialConditionData": null, + "isCompleted": true, + "customData": null, + "storePreferencesData": { + "countryCode": "BRA", + "currencyCode": "BRL", + "currencyFormatInfo": { + "CurrencyDecimalDigits": 2, + "CurrencyDecimalSeparator": ",", + "CurrencyGroupSeparator": ".", + "CurrencyGroupSize": 3, + "StartsWithCurrencySymbol": true + }, + "currencyLocale": 1046, + "currencySymbol": "R$", + "timeZone": "E. South America Standard Time" }, - { - "orderId": "v502538llux-01", - "creationDate": "2018-12-12T18:21:47+00:00", - "clientName": "test test", - "items": null, - "totalValue": 8990, - "paymentNames": "Mastercard", - "status": "ready-for-handling", - "statusDescription": "Pronto para o manuseio", - "marketPlaceOrderId": null, - "sequence": "502538", - "salesChannel": "1", - "affiliateId": "", - "origin": "Marketplace", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502538llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc", - "ShippingEstimatedDate": "2018-12-19T18:22:26+00:00", - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2018-12-12T18:22:22+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" + "allowCancellation": true, + "allowEdition": false, + "isCheckedIn": false, + "marketplace": { + "baseURL": "http://oms.vtexinternal.com.br/api/oms?an=str", + "isCertified": null, + "name": "str" }, - { - "orderId": "SCP-880102018018-01", - "creationDate": "2018-11-30T17:34:01+00:00", - "clientName": "roberta grecco", - "items": null, - "totalValue": 1250, - "paymentNames": "", - "status": "canceled", - "statusDescription": "Cancelado", - "marketPlaceOrderId": "880102018018-01", - "sequence": "502537", - "salesChannel": "1", - "affiliateId": "SCP", - "origin": "Fulfillment", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": "cancelamento teste shp ", - "ShippingEstimatedDate": null, - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2018-11-30T17:34:42+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" + "authorizedDate": null, + "invoicedDate": null, + "cancelReason": null, + "itemMetadata": { + "Items": [ + { + "Id": "6193892", + "Seller": "1", + "Name": "oversized tshirt brown", + "SkuName": "G", + "ProductId": "4451807", + "RefId": "11493357", + "Ean": null, + "ImageUrl": "https://str.vteximg.com.br/files/ids/58461640-200-240/photo-1.jpg?v=638446429959270000", + "DetailUrl": "/oversized-tshirt-brown_e2/p", + "AssemblyOptions": [] + }, + { + "Id": "5830010", + "Seller": "1", + "Name": "oversized tshirt blue", + "SkuName": "GG", + "ProductId": "4301268", + "RefId": "11167127", + "Ean": null, + "ImageUrl": "https://str.vteximg.com.br/files/ids/56901106-200-240/1045935-blue.jpg?v=638108542148100000", + "DetailUrl": "/oversized-tshirt-blue-1045935-branco/p", + "AssemblyOptions": [] + } + ] }, - { - "orderId": "SCP-880091692043-01", - "creationDate": "2018-11-30T17:28:35+00:00", - "clientName": "roberta grecco", - "items": null, - "totalValue": 1250, - "paymentNames": "", - "status": "invoiced", - "statusDescription": "Faturado", - "marketPlaceOrderId": "880091692043-01", - "sequence": "502536", - "salesChannel": "1", - "affiliateId": "SCP", - "origin": "Fulfillment", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": null, - "ShippingEstimatedDate": null, - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2018-11-30T17:29:22+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" - }, - { - "orderId": "SCP-880091058221-01", - "creationDate": "2018-11-30T17:18:00+00:00", - "clientName": "roberta grecco", - "items": null, - "totalValue": 1250, - "paymentNames": "", - "status": "canceled", - "statusDescription": "Cancelado", - "marketPlaceOrderId": "880091058221-01", - "sequence": "502535", - "salesChannel": "1", - "affiliateId": "SCP", - "origin": "Fulfillment", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": "Teste de cancelamento do ShopFácil ", - "ShippingEstimatedDate": null, - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2018-11-30T17:18:44+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" - }, - { - "orderId": "SCP-880090643370-01", - "creationDate": "2018-11-30T17:10:59+00:00", - "clientName": "roberta grecco", - "items": null, - "totalValue": 1250, - "paymentNames": "", - "status": "ready-for-handling", - "statusDescription": "Pronto para o manuseio", - "marketPlaceOrderId": "880090643370-01", - "sequence": "502534", - "salesChannel": "1", - "affiliateId": "SCP", - "origin": "Fulfillment", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": null, - "ShippingEstimatedDate": "2018-12-07T17:11:39+00:00", - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2018-11-30T17:11:42+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" - }, - { - "orderId": "SCP-880090622238-01", - "creationDate": "2018-11-30T17:10:45+00:00", - "clientName": "roberta grecco", - "items": null, - "totalValue": 1250, - "paymentNames": "", - "status": "canceled", - "statusDescription": "Cancelado", - "marketPlaceOrderId": "880090622238-01", - "sequence": "502533", - "salesChannel": "1", - "affiliateId": "SCP", - "origin": "Fulfillment", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": null, - "ShippingEstimatedDate": null, - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": null, - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" - }, - { - "orderId": "MNC-877730530419-01", - "creationDate": "2018-11-20T21:09:01+00:00", - "clientName": "Carlos VTEX", - "items": null, - "totalValue": 11150, - "paymentNames": "", - "status": "canceled", - "statusDescription": "Cancelado", - "marketPlaceOrderId": "877730530419-01", - "sequence": "502532", - "salesChannel": "1", - "affiliateId": "MNC", - "origin": "Fulfillment", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": null, - "ShippingEstimatedDate": null, - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2018-11-20T21:13:06+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" - }, - { - "orderId": "SCP-876733475998-01", - "creationDate": "2018-11-16T16:58:18+00:00", - "clientName": "roberta grecco", - "items": null, - "totalValue": 1250, - "paymentNames": "", - "status": "ready-for-handling", - "statusDescription": "Pronto para o manuseio", - "marketPlaceOrderId": "876733475998-01", - "sequence": "502531", - "salesChannel": "1", - "affiliateId": "SCP", - "origin": "Fulfillment", - "workflowInErrorState": false, - "workflowInRetry": false, - "lastMessageUnread": null, - "ShippingEstimatedDate": "2018-11-23T16:58:48+00:00", - "ShippingEstimatedDateMax": null, - "ShippingEstimatedDateMin": null, - "orderIsComplete": true, - "listId": null, - "listType": null, - "authorizedDate": "2018-11-16T16:58:53+00:00", - "callCenterOperatorName": null, - "totalItems": 1, - "currencyCode": "BRL" + "subscriptionData": null, + "taxData": null, + "checkedInPickupPointId": null, + "cancellationData": null, + "cancellationRequests": null, + "clientPreferencesData": { + "locale": "pt-BR", + "optinNewsLetter": true } - ], - "facets": [], - "paging": { - "total": 84, - "pages": 6, - "currentPage": 1, - "perPage": 15 }, - "stats": { - "stats": { - "totalValue": { - "Count": 84, - "Max": 21526180, - "Mean": 262672.75, - "Min": 1160, - "Missing": 0, - "StdDev": 2348087.3869179883, - "Sum": 22064511, - "SumOfSquares": 463417439039853, - "Facets": { - "origin": { - "Fulfillment": { - "Count": 68, - "Max": 11150, - "Mean": 1395.5882352941176, - "Min": 1250, - "Missing": 0, - "StdDev": 1200.5513439298484, - "Sum": 94900, - "SumOfSquares": 229010000, - "Facets": null - }, - "Marketplace": { - "Count": 16, - "Max": 21526180, - "Mean": 1373100.6875, - "Min": 1160, - "Missing": 0, - "StdDev": 5374326.141087491, - "Sum": 21969611, - "SumOfSquares": 463417210029853, - "Facets": null - } + { + "orderId": "v71425090str-02", + "sequence": "71425091", + "marketplaceOrderId": "", + "marketplaceServicesEndpoint": null, + "sellerOrderId": "SLR-v71425090str-02", + "origin": "Marketplace", + "affiliateId": "", + "salesChannel": "1", + "merchantName": null, + "status": "", + "statusDescription": null, + "value": 6208, + "creationDate": "2024-10-09T19:25:26.5841061+00:00", + "lastChange": "2024-10-09T19:26:29.6129583+00:00", + "orderGroup": "v71425090str", + "totals": [ + { + "id": "Items", + "name": "Total Items", + "value": 7999 + }, + { + "id": "Discounts", + "name": "Total Discounts", + "value": -2000 + }, + { + "id": "Shipping", + "name": "Total Freight", + "value": 209, + "alternativeTotals": [ + { + "id": "AlternativeShippingTotal", + "name": "Alternative Shipping Total", + "value": 2455 }, - "currencyCode": { - "BRL": { - "Count": 84, - "Max": 21526180, - "Mean": 262672.75, - "Min": 1160, - "Missing": 0, - "StdDev": 2348087.3869179883, - "Sum": 22064511, - "SumOfSquares": 463417439039853, - "Facets": null - } + { + "id": "AlternativeShippingDiscount", + "name": "Alternative Shipping Discount", + "value": -2246 } - } + ] }, - "totalItems": { - "Count": 84, - "Max": 89, - "Mean": 2.2261904761904763, - "Min": 1, - "Missing": 0, - "StdDev": 9.660940100525016, - "Sum": 187, - "SumOfSquares": 8163, - "Facets": { - "origin": { - "Fulfillment": { - "Count": 68, - "Max": 1, - "Mean": 1, - "Min": 1, - "Missing": 0, - "StdDev": 0, - "Sum": 68, - "SumOfSquares": 68, - "Facets": null + { + "id": "Tax", + "name": "Total Tax", + "value": 0 + } + ], + "items": [ + { + "uniqueId": "54638748C4D54F6CBAA738737E65D594", + "id": "6229640", + "productId": "4460339", + "ean": null, + "lockId": null, + "itemAttachment": { + "content": {}, + "name": null + }, + "attachments": [], + "quantity": 1, + "seller": "strbar", + "name": "cropped brown G", + "refId": "11455795", + "price": 7999, + "listPrice": 7999, + "manualPrice": null, + "manualPriceAppliedBy": null, + "priceTags": [ + { + "name": "discount@price-026be20b-9839-486e-9e6e-8987a93eb92a#5420fe70-7470-4b79-9741-80d951e451b2", + "value": -2000, + "isPercentual": false, + "identifier": "026be20b-9839-486e-9e6e-8987a93eb92a", + "rawValue": -20.0, + "rate": null, + "jurisCode": null, + "jurisType": null, + "jurisName": null + } + ], + "imageUrl": "https://str.vteximg.com.br/files/ids/58845769-200-240/photo-0.jpg?v=638569102126000000", + "detailUrl": "/cropped-brown-1065805_e2/p", + "components": [], + "bundleItems": [], + "params": [], + "offerings": [], + "attachmentOfferings": [], + "sellerSku": "6229640", + "priceValidUntil": "2044-05-29T14:00:00.0000000+00:00", + "commission": 0, + "tax": 0, + "preSaleDate": null, + "additionalInfo": { + "brandName": "C&A", + "brandId": "1", + "categoriesIds": "/1000003/1004161/1004162/", + "categories": [ + { + "id": 1004162, + "name": "Tops" }, - "Marketplace": { - "Count": 16, - "Max": 89, - "Mean": 7.4375, - "Min": 1, - "Missing": 0, - "StdDev": 21.92401651157926, - "Sum": 119, - "SumOfSquares": 8095, - "Facets": null + { + "id": 1004161, + "name": "Clothes" + }, + { + "id": 1000003, + "name": "Women Fashion" } + ], + "productClusterId": "8896,9708,9922,10068,11240,11577,13213,14487,15891,18170,18224,19010,19107,19122,19132,19482,19500,19519,19588,19597,19720,19736,19738,19742", + "commercialConditionId": "1", + "dimension": { + "cubicweight": 1.0, + "height": 100.0, + "length": 100.0, + "weight": 200.0, + "width": 100.0 }, - "currencyCode": { - "BRL": { - "Count": 84, - "Max": 89, - "Mean": 2.2261904761904763, - "Min": 1, - "Missing": 0, - "StdDev": 9.660940100525016, - "Sum": 187, - "SumOfSquares": 8163, - "Facets": null + "offeringInfo": null, + "offeringType": null, + "offeringTypeId": null + }, + "measurementUnit": "un", + "unitMultiplier": 1.0, + "sellingPrice": 5999, + "isGift": false, + "shippingPrice": null, + "rewardValue": 0, + "freightCommission": 0, + "priceDefinition": { + "sellingPrices": [ + { + "value": 5999, + "quantity": 1 } - } + ], + "calculatedSellingPrice": 5999, + "total": 5999, + "reason": null + }, + "taxCode": null, + "parentItemIndex": null, + "parentAssemblyBinding": null, + "callCenterOperator": null, + "serialNumbers": null, + "assemblies": [], + "costPrice": null + } + ], + "marketplaceItems": [], + "clientProfileData": { + "id": "clientProfileData", + "email": "cmlsmith@email.com", + "firstName": "Camila", + "lastName": "Smith", + "documentType": "cpf", + "document": "15586841755", + "phone": "+5521975366533", + "corporateName": null, + "tradeName": null, + "corporateDocument": null, + "stateInscription": null, + "corporatePhone": null, + "isCorporate": false, + "userProfileId": "e366889f-9d07-4076-a78d-72af8fdfd7e7", + "userProfileVersion": null, + "customerClass": null, + "customerCode": null + }, + "giftRegistryData": null, + "marketingData": { + "id": "marketingData", + "utmSource": "delorean", + "utmPartner": null, + "utmMedium": "mystr", + "utmCampaign": "johnvasconcelosg", + "coupon": "", + "utmiCampaign": "", + "utmipage": "", + "utmiPart": "", + "marketingTags": [ + "mstr_servicos", + "mstr_delorean", + "mstr_johnvasconcelosg", + "mstr_mystr", + "mobile", + "Delivery", + "STR" + ] + }, + "ratesAndBenefitsData": { + "id": "ratesAndBenefitsData", + "rateAndBenefitsIdentifiers": [ + { + "description": "ID\t518\nValid purchases in\tMy STR;CRM;POM;\nWeek\t202441\nDate_begin\t07/10/2024 14:00\nDate_end\t22/10/2024 12:00\nName_promotion\t25%_3PC_W41_07-10-2024\nMecanic\t25% off\nSeller\tSTR\nValid_for\tColection\t19738\nChannel\tApp;Site;\nName_requester\tJohn Carlos\nEmail_requester\tjose.c@str.com\nAuthor\tGuilherme Verner", + "featured": false, + "id": "026be20b-9839-486e-9e6e-8987a93eb92a", + "name": "25%_3PC_W41_07-10-2024", + "matchedParameters": { + "Seller@CatalogSystem": "1|inclusive" + }, + "additionalInfo": null + } + ] + }, + "shippingData": { + "id": "shippingData", + "address": { + "addressType": "residential", + "receiverName": "Camila Smith", + "addressId": "968d3b10816145878aa09b320f7e688a", + "versionId": null, + "entityId": null, + "postalCode": "21020-402", + "city": "Rio de Janeiro", + "state": "RJ", + "country": "BRA", + "street": "Couto", + "number": "29", + "neighborhood": "Penha", + "complement": "Building 3 apt 321", + "reference": "Next to the Shopping", + "geoCoordinates": [ + -43.273593902587891, + -22.835159301757813 + ] + }, + "logisticsInfo": [ + { + "itemIndex": 0, + "itemId": "6229640", + "selectedDeliveryChannel": "delivery", + "selectedSla": "Normal", + "lockTTL": "12d", + "price": 209, + "listPrice": 2455, + "sellingPrice": 209, + "deliveryWindow": null, + "deliveryCompany": "ASAPLAG_NORMAL", + "shippingEstimate": "2bd", + "shippingEstimateDate": "2024-10-11T20:00:00.0000000+00:00", + "slas": [ + { + "id": "Pickup at store (BAR)", + "name": "Pickup at store (BAR)", + "shippingEstimate": "1bd", + "shippingEstimateDate": null, + "deliveryWindow": null, + "availableDeliveryWindows": [], + "deliveryIds": [ + { + "courierId": "1", + "courierName": "Flexible shipping", + "dockId": "1", + "quantity": 1, + "warehouseId": "1_2", + "accountCarrierName": "strbar", + "kitItemDetails": [] + } + ], + "listPrice": 0, + "price": 0, + "deliveryChannel": "pickup-in-point", + "pickupStoreInfo": { + "additionalInfo": "{\"phoneNumber\":\"(21) 2107-0063\",\"pickupInstructions\":\"Present document with photo\"}", + "address": { + "addressType": "pickup", + "receiverName": null, + "addressId": "BAR", + "versionId": null, + "entityId": null, + "postalCode": "22631004", + "city": "Rio De Janeiro", + "state": "RJ", + "country": "BRA", + "street": "Av. Das Americas", + "number": "4666", + "neighborhood": "Barra Da Tijuca", + "complement": "Store STR Store A - BAR 530", + "reference": null, + "geoCoordinates": [ + -43.35817, + -22.9973 + ] + }, + "dockId": null, + "friendlyName": "STR Barra Shopping - Pickup at store", + "isPickupStore": true + }, + "polygonName": "", + "lockTTL": "12d", + "pickupPointId": "strbar_BAR", + "transitTime": "1bd", + "pickupDistance": 20.0021915435791 + }, + { + "id": "Normal", + "name": "Normal", + "shippingEstimate": "2bd", + "shippingEstimateDate": "2024-10-11T20:00:00.0000000+00:00", + "deliveryWindow": null, + "availableDeliveryWindows": [], + "deliveryIds": [ + { + "courierId": "ASAPLAG_NORMAL", + "courierName": "ASAPLAG_NORMAL", + "dockId": "SFS_BAR", + "quantity": 1, + "warehouseId": "1_2", + "accountCarrierName": "strbar", + "kitItemDetails": [] + } + ], + "listPrice": 2455, + "price": 209, + "deliveryChannel": "delivery", + "pickupStoreInfo": { + "additionalInfo": null, + "address": null, + "dockId": null, + "friendlyName": null, + "isPickupStore": false + }, + "polygonName": "", + "lockTTL": "12d", + "pickupPointId": null, + "transitTime": "1bd", + "pickupDistance": null + } + ], + "shipsTo": [ + "BRA" + ], + "deliveryIds": [ + { + "courierId": "ASAPLAG_NORMAL", + "courierName": "ASAPLAG_NORMAL", + "dockId": "SFS_BAR", + "quantity": 1, + "warehouseId": "1_2", + "accountCarrierName": "strbar", + "kitItemDetails": [] + } + ], + "deliveryChannels": [ + { + "id": "delivery", + "stockBalance": 0 + }, + { + "id": "pickup-in-point", + "stockBalance": 0 + } + ], + "deliveryChannel": "delivery", + "pickupStoreInfo": { + "additionalInfo": null, + "address": null, + "dockId": null, + "friendlyName": null, + "isPickupStore": false + }, + "addressId": "968d3b10816145878aa09b320f7e688a", + "versionId": null, + "entityId": null, + "polygonName": "", + "pickupPointId": null, + "transitTime": "1bd" + } + ], + "trackingHints": null, + "selectedAddresses": [ + { + "addressId": "968d3b10816145878aa09b320f7e688a", + "versionId": null, + "entityId": null, + "addressType": "residential", + "receiverName": "Camila Smith", + "street": "Couto", + "number": "29", + "complement": "Building 3 apt 321", + "neighborhood": "Penha", + "postalCode": "21020-402", + "city": "Rio de Janeiro", + "state": "RJ", + "country": "BRA", + "reference": "Next to the Shopping", + "geoCoordinates": [ + -43.273593902587891, + -22.835159301757813 + ] } + ], + "availableAddresses": [ + { + "addressId": "968d3b10816145878aa09b320f7e688a", + "versionId": null, + "entityId": null, + "addressType": "residential", + "receiverName": "Camila Smith", + "street": "Couto", + "number": "29", + "complement": "Building 3 apt 321", + "neighborhood": "Penha", + "postalCode": "21020-402", + "city": "Rio de Janeiro", + "state": "RJ", + "country": "BRA", + "reference": "Next to the Shopping", + "geoCoordinates": [ + -43.273593902587891, + -22.835159301757813 + ] + } + ], + "contactInformation": [] + }, + "paymentData": { + "giftCards": [], + "transactions": [ + { + "isActive": true, + "transactionId": "A599C01B84114016884B143BED05A3GG", + "merchantName": "STR", + "payments": [ + { + "id": "B004B117C52F405FB2AE82835373186D", + "paymentSystem": "125", + "paymentSystemName": "Pix", + "value": 22745, + "installments": 1, + "referenceValue": 22745, + "cardHolder": null, + "cardNumber": null, + "firstDigits": null, + "lastDigits": null, + "cvv2": null, + "expireMonth": null, + "expireYear": null, + "url": null, + "giftCardId": null, + "giftCardName": null, + "giftCardCaption": null, + "redemptionCode": null, + "group": "instantPayment", + "tid": "89781829739", + "dueDate": null, + "connectorResponses": { + "Tid": "89781829739", + "ReturnCode": null, + "Message": null, + "authId": "89781829739", + "nsu": "89781829739", + "acquirer": "paymarket" + }, + "giftCardProvider": null, + "giftCardAsDiscount": null, + "koinUrl": null, + "accountId": null, + "parentAccountId": null, + "bankIssuedInvoiceIdentificationNumber": null, + "bankIssuedInvoiceIdentificationNumberFormatted": null, + "bankIssuedInvoiceBarCodeNumber": null, + "bankIssuedInvoiceBarCodeType": null, + "billingAddress": null, + "paymentOrigin": null + } + ] + } + ] + }, + "packageAttachment": { + "packages": [] + }, + "sellers": [ + { + "id": "strbar", + "name": "STR Barra Shopping", + "logo": "", + "fulfillmentEndpoint": "http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=strbar&affiliateId=SLR&sc=1" } + ], + "callCenterOperatorData": null, + "followUpEmail": "c76fef8c4de34725aae5ebb429af3768@ct.vtex.com", + "lastMessage": null, + "hostname": "str", + "invoiceData": null, + "changesAttachment": null, + "openTextField": null, + "roundingError": 0, + "orderFormId": "066ab2f7f65043a3aa396c749e202fd3", + "commercialConditionData": null, + "isCompleted": true, + "customData": null, + "storePreferencesData": { + "countryCode": "BRA", + "currencyCode": "BRL", + "currencyFormatInfo": { + "CurrencyDecimalDigits": 2, + "CurrencyDecimalSeparator": ",", + "CurrencyGroupSeparator": ".", + "CurrencyGroupSize": 3, + "StartsWithCurrencySymbol": true + }, + "currencyLocale": 1046, + "currencySymbol": "R$", + "timeZone": "E. South America Standard Time" + }, + "allowCancellation": true, + "allowEdition": false, + "isCheckedIn": false, + "marketplace": null, + "authorizedDate": null, + "invoicedDate": null, + "cancelReason": null, + "itemMetadata": { + "Items": [ + + { + "Id": "6229640", + "Seller": "1", + "Name": "cropped brown G", + "SkuName": "GG", + "ProductId": "4460339", + "RefId": "11455795", + "Ean": null, + "ImageUrl": "https://str.vteximg.com.br/files/ids/58845769-200-240/photo-0.jpg?v=638569102126000000", + "DetailUrl": "/cropped-brown-1065805_e2/p", + "AssemblyOptions": [] + } + ] + }, + "subscriptionData": null, + "taxData": null, + "checkedInPickupPointId": null, + "cancellationData": null, + "cancellationRequests": null, + "clientPreferencesData": { + "locale": "pt-BR", + "optinNewsLetter": true } } - } + ] } } } } } }, - "/api/oms/pvt/orders/{orderId}/start-handling": { - "post": { + "/api/oms/pvt/orders": { + "get": { "tags": ["Orders"], - "summary": "Start handling order", - "description": "Changes the status of an order to indicate that it is in `handling`.\n\r\n\r> Expect a `status 204` response with no content in case of a successful request. The store must validate this response to retry the call if the response differs from the `204` code, making this flow the store's responsibility. This endpoint can also respond with `status 500`. \n\r\n\r> The `Change order workflow status` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#).", - "operationId": "StartHandling", + "summary": "List orders", + "description": "Retrieves a list of orders according to the filters described below. \r\n\r\nThe limit of information retrieval is 30 pages, the default number of orders per page is 15 and it is possible to configure it up to 100 using the `per_page` parameter. \r\n\r\nBe aware that since October 3rd, 2018, this endpoint does not return the `items` property. \r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). \r\n\r\n> This endpoint should **not** be used for integrations. Use the [orders Feed or hook](https://developers.vtex.com/docs/guides/orders-feed) for this purpose. \r\n\r\nThis endpoint returns only orders that already have been indexed, which takes approximately four minutes. Because of this, the data retrieved may present inconsistencies. To get live up-to-date information and [build order integrations](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration) use the [orders Feed or hook](https://developers.vtex.com/docs/guides/orders-feed).\r\n\r\n> **Onboarding guide** \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **List Orders** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | List Orders |\r\n| Checkout Admin | List Orders |\r\n| IntegrationProfile - Fulfillment Oms | List Orders |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", + "operationId": "ListOrders", "parameters": [ { "name": "Accept", @@ -4006,1222 +4629,2051 @@ } }, { - "name": "orderId", - "in": "path", - "description": "Order ID is a unique code that identifies an order.", - "required": true, - "style": "simple", + "name": "orderBy", + "in": "query", + "description": "You can retrieve orders lists filtering by an `OrderField` combined with an `OrderType`. To do so, you have to concatenate them: `orderBy={{OrderField}},{{OrderType}}`. \r\n- `OrderField` values accepted: `creationDate`, `orderId`, `items`, `totalValue` and `origin`. \r\n- `OrderType` values accepted: `asc` and `desc`.", + "required": false, + "style": "form", + "explode": true, "schema": { "type": "string", - "example": "1172452900788-01" - } - } - ], - "responses": { - "204": { - "description": "[No content](https://httpstatuses.com/204)" - }, - "401": { - "description": "[Unauthorized](https://httpstatuses.com/401)", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Root object", - "properties": { - "error": { - "description": "Object containing the error information.", - "type": "object", - "properties": { - "code": { - "description": "Error code in the Order Management System (OMS).", - "type": "string" - }, - "message": { - "description": "Error message.", - "type": "string" - }, - "exception": { - "description": "Exception information.", - "type": "string", - "nullable": true - } - } - } - } - }, - "example": { - "error": { - "code": "1", - "message": "Unauthorized access", - "exception": null - } - } - } - } - }, - "403": { - "description": "[Forbidden](https://httpstatuses.com/403)" - }, - "404": { - "description": "[Not found](https://httpstatuses.com/404)" - }, - "409": { - "description": "[Conflict](https://httpstatuses.com/409)", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Root object", - "properties": { - "error": { - "description": "Object containing the error information.", - "type": "object", - "properties": { - "code": { - "description": "Error code in the Order Management System (OMS).", - "type": "string" - }, - "message": { - "description": "Error message.", - "type": "string" - }, - "exception": { - "description": "Exception information.", - "type": "string", - "nullable": true - } - } - } - } - }, - "example": { - "error": { - "code": "OMS003", - "message": "Order status should be ready-for-handling to perform this action", - "exception": null - } - } - } + "example": "v502556llux-01,asc" } }, - "429": { - "description": "[Too many requests](https://httpstatuses.com/429)" - } - } - } - }, - "/api/oms/pvt/orders/{orderId}/cancel": { - "post": { - "tags": ["Orders"], - "summary": "Cancel order", - "description": "Cancels an order using its identification code (`orderId`). A common scenario is when the seller has a problem fulfilling the order and requests the marketplace to cancel it. \r\n\r\n## Orders that cannot be canceled \r\n\r\nThe following situations do not allow order cancellation: \r\n\r\n- **Partial invoices:** [Partially invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) orders cannot be canceled. However, the customer can [change the order](https://developers.vtex.com/docs/guides/change-order) to replace or remove items from it. \r\n\r\n- **Invoiced status:** Orders with `invoiced` [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) cannot be canceled. If the order has already been invoiced, you can use the [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice) endpoint to generate a return invoice. \r\n\r\n- **Incomplete orders:** [Incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294) cannot be canceled. \r\n\r\n## Declining order cancelation \r\n\r\nThe order flow has a cancellation window (grace period) in which the customer can automatically cancel the order. Except for that period, the seller can [decline an order cancellation request](https://help.vtex.com/en/tutorial/declining-order-cancelation--F2n0h1TeQ5td540Gjyff4), regardless of whether the customer or the marketplace initiated it. \r\n\r\nFor more information, see [Order canceling improvements](https://developers.vtex.com/docs/guides/order-canceling-improvements). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **Cancel order** | \r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | Cancel order |\r\n| IntegrationProfile - Fulfillment Oms | Cancel order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", - "operationId": "CancelOrder", - "parameters": [ { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", + "name": "page", + "in": "query", + "description": "Define the number of pages you wish to retrieve, restricted to the limit of 30 pages.", + "required": false, + "style": "form", + "explode": true, "schema": { - "type": "string", - "default": "application/json" + "type": "integer", + "example": 10 } }, { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent.", - "required": true, - "style": "simple", + "name": "per_page", + "in": "query", + "description": "Quantity of orders for each page, the default value is 15 and it goes up to 100 orders per page. Be aware that the limit of retrieval ofthis endpoint is 30 pages.", + "required": false, + "style": "form", + "explode": true, "schema": { - "type": "string", - "default": "application/json" + "type": "integer", + "example": 15 } - }, + }, { - "name": "orderId", - "in": "path", - "description": "ID that identifies the order in the seller.", - "example": "1172452900788-01", - "required": true, - "style": "simple", + "name": "f_hasInputInvoice", + "in": "query", + "description": "Filters list to return only orders with non `null` values for the `invoiceInput` field.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "example": false + } + }, + { + "name": "q", + "in": "query", + "description": "This parameter filters using Fulltext and accepts the values below. Be aware that the `+` caracter is not allowed in Fulltext Search. \r\n- Order Id \r\n- Client email \r\n- Client document \r\n- Client name", + "required": false, + "style": "form", + "explode": true, "schema": { "type": "string", - "example": "1172452900788-01" + "example": "- OrderID: v212333lux-02 \r\n- Client email: taylor@email.com \r\n- Client document: 21133355524 \r\n- Client name: Taylor" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "Reason for cancelling the order.", - "example": "Unexpected stock shortage" - } - } - } + }, + { + "name": "f_shippingEstimate", + "in": "query", + "description": "You can filter orders by shipping estimate time in days by concatenating the desired number of days with the sufix `.days`. For example: \r\n- Next 7 days: `7.days` \r\n- Tomorrow: `1.days` \r\n- Today: `0.days` \r\n- Late: `-1.days`", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "0.days" } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "Date and time when the notification was received." - }, - "orderId": { - "type": "string", - "description": "Identification of the order in the seller." - }, - "receipt": { - "type": "string", - "description": "Protocol code generated by the update. It may be `null`." - } - } - }, - "example": { - "date": "2024-02-07T15:22:56.7612218-02:00", - "orderId": "123543123", - "receipt": "38e0e47da2934847b489216d208cfd91" - } - } + }, + { + "name": "f_invoicedDate", + "in": "query", + "description": "You can filter orders by invoiced date by concatenating the sufix `invoicedDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]" } }, - "429": { - "description": "Too many requests." + { + "name": "f_creationDate", + "in": "query", + "description": "You can filter orders by creation date by concatenating the sufix `creationDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]" + } }, - "403": { - "description": "The credentials are not enabled to access the service." + { + "name": "f_authorizedDate", + "in": "query", + "description": "You can filter orders by creation date by concatenating the sufix `authorizedDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]" + } }, - "404": { - "description": "Value not found." - } - } - } - }, - "/api/oms/pvt/orders/{orderId}/changes": { - "post": { - "tags": ["Orders"], - "summary": "Register change on order", - "description": "This request allows [changing an order](https://help.vtex.com/en/tutorial/changing-items-from-a-completed-order--tutorials_190) by:\r\n\r\n- Adding items to an order.\r\n\r\n- Removing items from an order.\r\n\r\n- Applying discounts to the total value of the order.\r\n\r\n- Incrementing the total value of the order. \r\n\r\n> **Timeout settings:** This is a synchronous API, which means the application requests data and waits until a value is returned. This behavior can cause timeout errors. To avoid them, we recommend setting the timeout in 20 seconds.\r\n\r\nIn change order scenarios, it is possible to insert a [Partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe). The total value of the order will be updated after the insertion of the invoice, even when there is a partial invoice scenario. The updated value is settled by the VTEX Payment Gateway, and the customer reimbursement is automatic. \r\n\r\nThis action can only be done for orders in the following status:\r\n\r\n- `handling`\r\n\r\n- `waiting-for-fulfillment` \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", - "operationId": "RegisterChange", - "parameters": [ { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", + "name": "f_UtmSource", + "in": "query", + "description": "You can filter orders by Urchin Tracking Module (UTM) source.", + "required": false, + "style": "form", + "explode": true, "schema": { "type": "string", - "default": "application/json" + "example": "christmas_campaign" } }, { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", + "name": "f_sellerNames", + "in": "query", + "description": "You can filter orders by using a seller's name.", + "required": false, + "style": "form", + "explode": true, "schema": { "type": "string", - "default": "application/json" + "example": "SellerName" } }, { - "name": "orderId", - "in": "path", - "description": "ID that identifies the order in the seller.", - "required": true, - "style": "simple", + "name": "f_callCenterOperatorName", + "in": "query", + "description": "You can filter orders by using a Call Center Operator's identification.", + "required": false, + "style": "form", + "explode": true, "schema": { "type": "string", - "example": "1172452900788-01" + "example": "Operator%20Name" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "requestId", - "reason", - "discountValue", - "incrementValue" - ], - "properties": { - "requestId": { - "type": "string", - "description": "Request identification of the change. Only the first change made with each `requestId` will be effective on a given order. Use different IDs for different changes to the same order.", - "example": "change-request-0123" - }, - "reason": { - "type": "string", - "description": "Reason for order change. This may be shown to the shopper in the UI or transactional emails.", - "example": "Stock shortage" - }, - "discountValue": { - "type": "integer", - "description": "This field can be used to apply a discount to the total value of the order. Value in cents.", - "example": 100 - }, - "incrementValue": { - "type": "integer", - "description": "This field can be used to increment the total value of the order. Value in cents.", - "example": 100 - }, - "itemsRemoved": { - "type": "array", - "description": "List of items that should be removed from the order.", - "items": { - "type": "object", - "description": "Removed items' details.", - "required": [ - "id", - "price", - "quantity" - ], - "properties": { - "id": { - "type": "string", - "description": "Product ID of the item.", - "example": "0" - }, - "price": { - "type": "integer", - "description": "Price of the item in cents.", - "example": 2499 - }, - "quantity": { - "type": "integer", - "description": "Amount of items to be removed.", - "example": 1 - } - } - } - }, - "itemsAdded": { - "type": "array", - "description": "List of items that should be added to the order.", - "items": { - "type": "object", - "description": "Added items' details.", - "required": [ - "id", - "price", - "quantity" - ], - "properties": { - "id": { - "type": "string", - "description": "Product ID of the item.", - "example": "0" - }, - "price": { - "type": "integer", - "description": "Price of the item in cents.", - "example": 2499 - }, - "quantity": { - "type": "integer", - "description": "Amount of items to be added.", - "example": 1 - } - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "Date of order change." - }, - "orderId": { - "type": "string", - "description": "ID of the order." - }, - "receipt": { - "type": "string", - "description": "Receipt identification." - } - } - }, - "example": { - "date": "2024-02-08T13:54:33.6868469+00:00", - "orderId": "v502538llux-01", - "receipt": "535d4581-a2a2-4fd2-a206-1c61eae91b1e" - } - } + }, + { + "name": "f_salesChannel", + "in": "query", + "description": "You can filter orders by sales channel's ([or trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) name.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "Main" } - } - } - } - }, - "/api/oms/pvt/orders/{orderId}/interactions": { - "post": { - "tags": ["Orders"], - "summary": "Add log in orders", - "description": "Add a Log in Interactions Order Array.", - "operationId": "AddLog", - "parameters": [ + }, { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", + "name": "salesChannelId", + "in": "query", + "description": "You can filter orders by sales channel's ([or trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID.", + "required": false, + "style": "form", + "explode": true, "schema": { "type": "string", - "default": "application/json" + "example": "1" } }, { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", + "name": "f_affiliateId", + "in": "query", + "description": "You can filter orders by affiliate ID.", + "required": false, + "style": "form", + "explode": true, "schema": { "type": "string", - "default": "application/json" + "example": "WLM" } }, { - "name": "orderId", - "in": "path", - "description": "Unique code that identifies an order.", - "required": true, - "style": "simple", + "name": "f_status", + "in": "query", + "description": "You can filter orders by the following [order status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196): \r\n- `waiting-for-sellers-confirmation` \r\n- `payment-pending` \r\n- `payment-approved` \r\n- `ready-for-handling` \r\n- `handling` \r\n- `invoiced` \r\n- `canceled`", + "required": false, + "style": "form", + "explode": true, "schema": { "type": "string", - "example": "1172452900788-01" - + "example": "ready-for-handling" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "source", - "message" - ], - "properties": { - "source": { - "type": "string", - "description": "Source information.", - "example": "Postman" - }, - "message": { - "type": "string", - "description": "Interactions message.", - "example": "Add interactions" - } - } - } + }, + { + "name": "incompleteOrders", + "in": "query", + "description": "When set as `true`, you retrieve [incomplete orders](https://help.vtex.com/en/tutorial/understanding-incomplete-orders), when set as `false`, you retrieve orders that are not incomplete.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "example": true } - } - }, - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/oms/pvt/orders/{orderId}/invoice": { - "post": { - "tags": ["Invoice"], - "summary": "Order invoice notification", - "description": "This request is used for [invoicing an order](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT). Entering the order's invoice means it was successfully completed, and the order status can be changed to the `invoiced` in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). Once an order is `invoiced`, its status cannot be changed. \r\n\r\nAfter the insertion of the invoice, the order's total value will be updated, even in [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios. \r\n\r\n>❗ To avoid rounding errors, we recommend always sending the object of items being invoiced. \r\n\r\n## Partial invoices \r\n\r\nAfter adding a [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe), the order's value will be updated, corresponding to a partial settled value in the VTEX payment gateway. \r\n\r\nPartially invoiced orders cannot be canceled, and cancellation attempts will result in a `400` status code error. If the customer wants to replace or remove items, it is possible to [change the order](https://developers.vtex.com/docs/guides/change-order). \r\n\r\n> The partial invoices feature is available for all VTEX stores. The partial settlement in the gateway is in Beta, and requires a connector with the Payment Provider Protocol. \r\n\r\n## Returning items \r\n\r\nBesides using this endpoint for generating invoices for sold items, you can use it for generating invoices for returned items. You determine this in the request body `type` field by choosing one of the following values: \r\n\r\n- `output`: selling order invoice. \r\n\r\n- `input`: returning items invoice. \r\n\r\nBe aware of generating return invoices only after the full order amount was invoiced, otherwise, no refund will occur. \r\n\r\n## Changing the receipt code \r\n\r\nEvery time this endpoint is called using the same `invoiceNumber`, a new `receipt` code is generated, and it overrides the previous one. By doing this, you cannot change other information, only the `receipt` code.\r\n\r\n## Integration with marketplaces \r\n\r\nThe invoice should be pushed to the fulfillment account, not to the marketplace account. Once the order is invoiced, the seller should use this request to send the invoice information to the marketplace. \r\n\r\nThis endpoint is also used by the seller to send the order tracking information. However, this only should be done after the seller has the tracking information. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **Notify invoice** |\r\n| OMS | OMS access | **Notify refund** | \r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | Cancel order |\r\n| IntegrationProfile - Fulfillment Oms | Cancel order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", - "operationId": "InvoiceNotification", - "parameters": [ + }, { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", + "name": "f_paymentNames", + "in": "query", + "description": "You can filter orders by payment type.", + "required": false, + "style": "form", + "explode": true, "schema": { "type": "string", - "default": "application/json" + "example": "Visa" } }, { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent.", - "required": true, - "style": "simple", + "name": "f_RnB", + "in": "query", + "description": "You can filter orders by rates and benefits (promotions).", + "required": false, + "style": "form", + "explode": true, "schema": { "type": "string", - "default": "application/json" + "example": "Free+Shipping" } }, { - "name": "orderId", - "in": "path", - "description": "Unique code that identifies the order whose invoice is being sent.", - "required": true, - "style": "simple", + "name": "searchField", + "in": "query", + "description": "You can search orders by using one of the following criterias: \r\n- SKU ID - `sku_Ids&sku_Ids` \r\n- Gift List ID - `listId&listId` \r\n- Transaction ID (TID) - `tid&tid` \r\n- PCI Connector's Transaction ID (TID) - `pci_tid&pci_tid` \r\n- Payment ID (PID) - `paymentId&paymentId` \r\n- Connector's NSU - `nsu&nsu`", + "required": false, + "style": "form", + "explode": true, "schema": { "type": "string", - "example": "1172452900788-01" + "example": "- SKU ID: `25` \r\n- Gift List ID: `11223` \r\n- Transaction ID (TID): `54546300238810034995829230012` \r\n- PCI Connector's Transaction ID (TID): `7032909234899834298423209` \r\n- Payment ID (PID): `2` \r\n- Connector's NSU: `2437281`" + } + }, + { + "name": "f_isInstore", + "in": "query", + "description": "When set as `true`, this parameter filters orders made via [inStore](https://help.vtex.com/en/tracks/what-is-instore--zav76TFEZlAjnyBVL5tRc), and when set as `false`, it filters orders that were not made via inStore.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "example": true } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "type", - "issuanceDate", - "invoiceNumber", - "invoiceValue", - "items" - ], - "properties": { - "type": { - "type": "string", - "description": "The type of invoice. There are two possible values: **Output** and **Input**. The Output type should be used when the invoice you are sending is a selling invoice. The Input type should be used when you send a return invoice.", - "example": "Output" - }, - "issuanceDate": { - "type": "string", - "description": "The invoice date is when the order was [invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT) in the VTEX platform, and the `IssuanceDate` is the date when the merchant registers the order's invoice in the store's system. The `IssuanceDate` can be different from the invoice date, because the merchant can register the invoice days or even months after order invoicing. You must add date and time in this field.", - "example": "2024-01-31T18:25:43-05:00" - }, - "invoiceNumber": { - "type": "string", - "description": "Unique code that identifies the invoice. When you call this endpoint using the same invoice number, you generate a new `receipt` code.", - "example": "DFG-v7731485plzv-01", - "nullable": true - }, - "invoiceValue": { - "type": "string", - "description": "Total amount being invoiced in cents. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`.", - "example": "2499" - }, - "invoiceKey": { - "type": "string", - "nullable": true, - "description": "Information about invoice key.", - "example": "CFe35201100063960001504590006629690333214542150" - }, - "invoiceUrl": { - "type": "string", - "description": "URL of the invoice. Can be used to send the URL of an XML file, for example, which is useful for some integrations.", - "nullable": true, - "example": "https://luxstore.com/invoices/24382.pdf" - }, - "embeddedInvoice": { - "type": "string", - "nullable": true, - "description": "XML text of the invoice, not the URL. This field is very important for external marketplace integrations such as Mercado Libre.", - "example": "\r\n\r\n\r\n37\r\n000005177\r\nVenda a vista\r\n0\r\n55\r\n1\r\n1\r\n2018-07-06\r\n2018-07-06\r\n0\r\n79950308\r\n1\r\n1\r\n3\r\n2\r\n1\r\n0\r\nNF-eletronica.com\r\n\r\n\r\n99999090998760\r\nNF-e Associacao NF-e\r\nNF-e\r\n\r\nRua Central\r\n100\r\nFundos\r\nDistrito Industrial\r\n0000000\r\nMunicípio\r\nSP\r\n0000000\r\n1058\r\nBrasil\r\n1733021717\r\n\r\n123456789012\r\n\r\n\r\n00000000000000\r\nDISTRIBUIDORA DE AGUAS MINERAIS\r\n\r\nAV DAS FONTES\r\n1777\r\n1001 ANDAR\r\nPARQUE\r\n0000000\r\nSao Paulo\r\nSP\r\n00000000\r\n1058\r\nBRASIL\r\n3900000000\r\n\r\n \r\n\r\n\r\n000000000004\r\nAV PAULISTA\r\n12345\r\nTERREO\r\nCERQUEIRA CESAR\r\n0000000\r\nSAO PAULO\r\nSP\r\n\r\n\r\n00000000299000194\r\nAV FARIA LIMA\r\n154400\r\n156 ANDAR\r\nPINHEIROS\r\n0000308\r\nSAO PAULO\r\nSP\r\n\r\n\r\n\r\n00001\r\n\r\nAgua Mineral\r\n5101\r\ndz\r\n1000000.0000\r\n1\r\n10000000.00\r\n\r\nund\r\n12000000.0000\r\n1\r\n\r\n\r\n\r\n\r\n0\r\n00\r\n0\r\n10000000.00\r\n18.00\r\n1800000.00\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n0.65\r\n65000\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n2.00\r\n200000.00\r\n\r\n\r\n\r\n\r\n\r\n\r\n00002\r\n\r\nAgua Mineral\r\n5101\r\npack\r\n5000000.0000\r\n2\r\n10000000.00\r\n\r\nund\r\n3000000.0000\r\n0.3333\r\n\r\n\r\n\r\n\r\n0\r\n00\r\n0\r\n10000000.00\r\n18.00\r\n1800000.00\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n0.65\r\n65000\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n2.00\r\n200000.00\r\n\r\n\r\n\r\n\r\n\r\n\r\n20000000.00\r\n18.00\r\n0\r\n0\r\n20000000.00\r\n0\r\n0\r\n0\r\n0\r\n0\r\n130000.00\r\n400000.00\r\n0\r\n20000000.00\r\n\r\n\r\n\r\n0\r\n\r\n00000000000000\r\nDistribuidora de Bebidas Fazenda de SP Ltda.\r\n00000000999119\r\nRua Central 100 - Fundos - Distrito Industrial\r\nSAO PAULO\r\nSP\r\n\r\n\r\nBXI1717\r\nSP\r\n123456789\r\n\r\n\r\nUUU0000\r\nSP\r\n123456789\r\n\r\n\r\n10000\r\nCAIXA\r\nLINDOYA\r\n500\r\n1000000000.000\r\n1200000000.000\r\n\r\nXYZ10231486\r\n\r\n\r\n\r\n\r\nNota Fiscal de exemplo NF-eletronica.com\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nxFzhgdgnhjSD1e9uqe04lnoHT4ZzLSY=\r\n\r\n\r\n\r\nIz5Z3PLQbzZt9jnBtr6xsmHZMOu/3plXG9xxfFjRCQYGnD1rjlhzBGrqt026Ca2VHHM/bHNepi6FuFkAi595GScKVuHREUotzifE2OIjgavvTOrMwbXG7+0LYgkwPFiPCao2S33UpZe7MneaxcmKQGKQZw1fP8fsWmaQ4cczZT8=\r\n\r\n\r\n\r\n\r\nMIIEuzCCA6OgAwIBAgIDMTMxMA0GasfFSDAGQUAMIGSMQswCQYDVQQGEwJCUjELMAkGA1UECBMCUlMxFTATBgNVBAcTDFBvcnRvIEFsZWdyZTEdMBsGA1UEChMUVGVzdGUgUHJvamV0byBORmUgUlMxHTAbBgNVBAsTFFRlc3RlIFByb2pldG8gTkZlIFJTMSEwHwYDVQQDExhORmUgLSBBQyBJbnRlcm1lZGlhcmlhIDEwHhcNMDgwNDI4MDkwMTAyWhcNMDkwNDMwMjM1OTU5WjCBnjELMAkGA1UECBMCUlMxHTAfvw4567DRhg76FByb2pldG8gTkZlIFJTMR0wGwYDVQQKExRUZXN0ZSBQcm9qZXRvIE5GZSBSUzEVMBMGA1UEBxMMUE9SVE8gQUxFR1JFMQswCQYDVQQGEwJCUjEtMCsGA1UEAxMkTkZlIC0gQXNzb2NpYWNhbyBORi1lOjk5OTk5MDkwOTEwMjcwMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDh6RRv0bj4RYX+tDQrZRb5opa77LBVVs+6LphIfSF3TSWPfnKh0+xLlBFdmnB5YGgbbW9Uon6pZQTfaC8jZhRhI5eFRRofY/Ugoeo0NGt6PcIQNZQd6lLQ/ASd1qWwjqJoEa7udriKjy3h351Mf1bng1VxS1urqC3Dn39ZWIEwQIDAQABo4IBjjCCAYowIgYDVR0jAQEABBgwFoAUPT5TqhNWAm+ZpcVsvB7malDBjEQwDwYDVR0TAQH/BAUwAwEBADAPBgNVHQ8BAf8EBQMDAOAAMAwGA1UdIAEBAAQCMAAwgbwGA1UdEQEBAASBsTCBrqA4BgVgTAEDBKAvBC0wNzA4MTk1MTE1MTk0NTMxMDg3MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDCgHQYFYEwBAwKgFAQSRmVybmFuZG8gQ2FudG8gQWx0oBkGBWBMAQMDoBAEDjk5OTk5MDkwOTEwMjcwoBcGBWBMAQMHoA4EDDAwMDAwMDAwMDAwMIEfZmVybmFuZG8tYWx0QHByb2NlcmdzLnJzLmdvdi5icjAgBgNVHSUBAf8EFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwUwYDVR0fAQEABEkwRzBFoEOgQYY/aHR0cDovL25mZWNlcnRpZmljYWRvLnNlZmF6LnJzLmdvdi5ici9MQ1IvQUNJbnRlcm1lZGlhcmlhMzguY3JsMA0GCSqGSIb3DQEBBQUAA4IBAQCNPpaZ3Byu3/70nObXE8NiM53j1ddIFXsb+v2ghCVd4ffExv3hYc+/a3lfgV8H/WfQsdSCTzS2cHrd4Aasr/eXfclVDmf2hcWz+R7iysOHuT6B6r+DvV3JcMdJJCDdynR5REa+zViMnVZo1G3KuceQ7/y5X3WFNVq4kwHvonJ9oExsWyw8rTwUK5bsjz0A2yEwXkmkJIngnF41sP31+9jCImiqkXcmsesFhxzX7iurAQAQCZOm7iwMWxQKcAjXCZrgSZWRQy6mU224sX3HTArHahmLJ9Iw+WYAua5qBJsiN6PC7v5tfhdsgGD46DHMnOecxvkkPolDUyBa7d7xwgm\r\n\r\n\r\n\r\n\r\n" - }, - "courier": { - "type": "string", - "nullable": true, - "description": "The name of the carrier responsible for delivering the order. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)*.", - "example": "carrierOne" - }, - "trackingNumber": { - "type": "string", - "nullable": true, - "description": "The number code that identifies the order tracking. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)*.", - "example": "87658" - }, - "trackingUrl": { - "type": "string", - "nullable": true, - "description": "The URL used to track the order. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)*.", - "example": "https://www.tracking.com/url" - }, - "dispatchedDate": { - "type": "string", - "nullable": true, - "description": "Order dispatch date. May be `null`.", - "example": "2019-02-08T13:16:13.4617653+00:00" - }, - "items": { - "type": "array", - "description": "Array containing the SKUs that are being invoiced.", - "items": { - "type": "object", - "description": "Information about a SKU being invoiced.", - "required": [ - "id", - "price", - "quantity" - ], - "properties": { - "id": { - "type": "string", - "description": "ID of the SKU being invoiced.", - "example": "123" - }, - "price": { - "type": "integer", - "description": "Price in cents of the SKU being invoiced. Do not use a decimal separator, for example, the price $24.99 corresponds to `2499`. You must insert the SKU unitary price because the VTEX system will multiply the price over the quantity.", - "example": 2499 - }, - "description": { - "type": "string", - "description": "You can use this field for additional information about the SKU being invoiced.", - "example": "335" - }, - "quantity": { - "type": "integer", - "description": "Quantity currently in inventory of the SKU being invoiced.", - "example": 2 - } - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "Date and time when the notification was received." - }, - "orderId": { - "type": "string", - "description": "Identification of the order in the seller." - }, - "receipt": { - "type": "string", - "description": "Protocol code generated by the update that identifies the receipt. Every time this endpoint is called using the same `invoiceNumber`, a new `receipt` code is generated, and it overrides the previous one." - } - } - }, - "example": { - "date": "2024-02-07T15:22:56.7612218-02:00", - "orderId": "123543123", - "receipt": "38e0e47da2934847b489216d208cfd91" - } - } - } - } - } - } - }, - "/api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}": { - "patch": { - "tags": ["Invoice"], - "summary": "Update order's partial invoice (send tracking number)", - "description": "Update a given order, adding its tracking number to its [Partial invoice](https://help.vtex.com/en/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe).\n\r\n\rAfter using this call to add a tracking number to an order, you can use the [Update order tracking status](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking) API request to add tracking events.\n\r\n\r> The `Notify invoice` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).", - "operationId": "Updatepartialinvoice.SendTrackingNumber", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderId", - "in": "path", - "description": "Unique code that identifies the order whose invoice is being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "1172452900788-01" - } - }, - { - "name": "invoiceNumber", - "in": "path", - "description": "Number that identifies the invoice.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "000030711" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Updatepartialinvoice.SendTrackingNumber.Request" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Updatepartialinvoice.SendTrackingNumber" - }, - "example": { - "date": "2019-02-08T13:16:13.4617653+00:00", - "orderId": "00-v5195004lux-01", - "receipt": "527b1ae251264ef1b7a9b597cd8f16b9" - } - } - } - } - } - } - }, - "/api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}/tracking": { - "put": { - "tags": ["Tracking"], - "summary": "Update order tracking status", - "description": "This endpoint sends a tracking event to an order that already has a tracking number registered to its invoice.\r\n\r\nThis request is not meant to send a tracking number and URL to the invoice. If you wish to send a tracking number and URL to an order, use the [Update order's partial invoice](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-) endpoint. For more information, see [Partial invoice](https://help.vtex.com/en/tracks/partial-invoices--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios.\r\n\r\nThis endpoint applies to orders with any shipping type, whether delivery or [pickup](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\r\n\r\n> The `Notify invoice` License Manager resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about [License Manager Roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).", - "operationId": "UpdateTrackingStatus", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderId", - "in": "path", - "description": "Order ID is a unique code that identifies an order.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "1172452900788-01" - } - }, - { - "name": "invoiceNumber", - "in": "path", - "description": "Number that identifies the invoice.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "000030711" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateTrackingStatusRequest" - } - } - } - }, "responses": { "200": { "description": "OK", "content": { "application/json; charset=utf-8": { "schema": { - "$ref": "#/components/schemas/UpdateTrackingStatus" + "$ref": "#/components/schemas/ListOrders" }, "example": { - "date": "2017-03-29T18:04:31.0521233+00:00", - "orderId": "v501245lspt-01", - "receipt": "f67d33a8029c42ce9a8f07fc17f54449" - } - } - } - } - } - } - }, - "/api/oms/pvt/orders/{orderId}/conversation-message": { - "get": { - "tags": ["Conversation"], - "summary": "Retrieve order conversation", - "description": "List all order conversations of an order by its order ID.", - "operationId": "GetConversation", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderId", - "in": "path", - "description": "Order ID is a unique code that identifies an order.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "1172452900788-01" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json; charset=utf-8": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetConversation" - } - }, - "example": [ - { - "id": "2023-01-23t09-23-08_619a80a05aa34efb982b309c7a1910e3", - "from": { - "conversationRelatedTo": "1305371685465-01", - "conversationSubject": "oms", - "emailAlias": "noreply@vtexcommerce.com.br-9814872b.ct.store.com.br", - "aliasMaskType": 0, - "email": "noreply@store.com.br", - "name": "no reply", - "role": "null" + "list": [ + { + "orderId": "1306331686122-01", + "creationDate": "2019-02-04T10:29:11+00:00", + "clientName": "J C", + "items": null, + "totalValue": 7453, + "paymentNames": "Boleto Bancário", + "status": "invoiced", + "statusDescription": "Faturado", + "marketPlaceOrderId": null, + "sequence": "502559", + "salesChannel": "1", + "affiliateId": "", + "origin": "Marketplace", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci", + "ShippingEstimatedDate": null, + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2019-02-07T21:29:54+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" }, - "to": [ - { - "conversationRelatedTo": "1305371685465-01", - "conversationSubject": "oms", - "emailAlias": "64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br", - "aliasMaskType": 0, - "email": "customer.name@email.com", - "name": "Mary John", - "role": "Customer" - } - ], - "subject": "Your payment has been aproved.", - "firstWords": "Your payment has been aproved and we are waiting for...", - "body": " recorrenciaqa

Seu pagamento foi aprovado.

Referente ao Pedido #1305371685465-01

Olá, jose. Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto.

Pagamento

Visa final 1111
R$ 3,99 à vista

Atenciosamente,
Equipe recorrenciaqa

", - "hasAttachment": false, - "attachmentNames": [ - "attachments439505" - ], - "date": "2023-01-23T09:23:31.0000000+00:00" - } - ] - } - } - } - } - } - }, - "/api/oms/pvt/orders/{orderId}/payment-transaction": { - "get": { - "tags": ["Payment"], - "summary": "Retrieve payment transaction", - "description": "Retrieves transaction details by order ID. All events in the transaction will be registered in this call's response body. \n\nIn scenarios of [order changes](https://developers.vtex.com/vtex-rest-api/reference/registerchange), it is possible to insert a [Partial invoice](https://help.vtex.com/en/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe). The total value of the order will be updated after the insertion of the invoice, even when there is a [Partial invoice](https://help.vtex.com/en/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenario. The updated value is settled by VTEX's Payment Gateway. The reimbursement for the shopper is automatic.", - "operationId": "GetPaymenttransaction", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderId", - "in": "path", - "description": "Order ID is a unique code that identifies an order.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "1172452900788-01" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetPaymenttransaction" - }, - "example": { - "status": "Finished", - "isActive": true, - "transactionId": "CB452D77E7D04099A4DB0479087B1D2C", - "merchantName": "LUXSTORE", - "payments": [ { - "id": "721CBE1090324D12ABE301FE33DE775A", - "paymentSystem": "4", - "paymentSystemName": "Mastercard", - "value": 10150, - "installments": 1, - "referenceValue": 10150, - "cardHolder": null, - "cardNumber": null, - "firstDigits": "412341", - "lastDigits": "4123", - "url": null, - "giftCardId": null, - "giftCardName": null, - "cvv2": null, - "expireMonth": null, - "expireYear": null, - "giftCardCaption": null, - "redemptionCode": null, - "group": "creditCard", - "tid": "101770752", - "dueDate": null, - "connectorResponses": { - "Tid": "101770752", - "ReturnCode": "200", - "Message": "logMessage", - "authId": "170852" - } - } - ] - } - } - } - } - } - } - }, - "/api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification": { - "post": { - "tags": ["Payment"], - "summary": "Send payment notification", - "description": "Send a payment notification of a given order, by order ID.\n\r\n\r> The `Notify payment` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#).", - "operationId": "SendPaymentNotification", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderId", - "in": "path", - "description": "Order ID is a unique code that identifies an order.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "1172452900788-01" - } - }, - { - "name": "paymentId", - "in": "path", - "description": "VTEX payment identifier.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "F5C1A4E20D3B4E07B7E871F5B5BC9F91" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "400": { - "description": "Bad request." - }, - "403": { - "description": "The credentials are not enabled to access the service." - }, - "404": { - "description": "Value not found." - }, - "429": { - "description": "Too many requests." - } - } - } - }, - "/api/oms/pvt/feed/orders/status": { - "get": { - "tags": ["Feed v2 (deprecated)"], - "summary": "Get feed order status", - "description": "Get feed order status (deprecated)", - "operationId": "Getfeedorderstatus", - "parameters": [ - { - "name": "maxLot", - "in": "query", - "description": "Maximum lot.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "{{maxLot}}" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/orders/feed/config": { - "get": { - "tags": ["Feed v3"], - "summary": "Get feed configuration", - "description": "The Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our [Feed v3 guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed) and our [order integration guide](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration).\n\r\n> 📘 Onboarding guide \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.\r\n\r\n", - "operationId": "GetFeedConfiguration", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "filter": { - "type": "object", - "description": "Information on how orders are filtered to show on the feed.", - "properties": { - "type": { - "type": "string", - "description": "Determines what orders appear in the feed and how they are filtered. If a feed has the `FromWorkflow` type configuration, it will receive order updates only when order's statuses change and orders can be filtered by status, using the `status` field. A feed with the `FromOrders` type configuration gets updates whenever any change is made to an order. in this case, orders can be filtered by any property, according to JSONata expressions set in the `expression` field." - }, - "status": { - "type": "array", - "description": "List of order statuses that should be included in the feed. This should only be used in case `type` is `FromWorkflow`.", - "items": { - "type": "string", - "description": "Order status to be filtered in the feed." - } - }, - "expression": { - "type": "string", - "description": "JSONata query expression that defines what conditions must be met for an order to be included in the feed. This should only be used in case `type` is `FromOrders`." - }, - "disableSingleFire": { - "type": "boolean", - "description": "Sets a limit to how many times a specific order shows on the feed, after it first meets filtering conditions. Using the `FromOrders` type configuration with JSONata filtering expressions might cause orders to appear more than once on a feed, whenever changes are made to that order. If this field is `false` orders will appear in the feed only once." - } - } + "orderId": "v502556llux-01", + "creationDate": "2019-01-28T20:09:43+00:00", + "clientName": "Rodrigo VTEX", + "items": null, + "totalValue": 1160, + "paymentNames": "Boleto Bancário", + "status": "handling", + "statusDescription": "Preparando Entrega", + "marketPlaceOrderId": null, + "sequence": "502556", + "salesChannel": "1", + "affiliateId": "", + "origin": "Marketplace", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": " Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ", + "ShippingEstimatedDate": "2019-02-04T20:33:46+00:00", + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2019-01-28T20:33:04+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" }, - "queue": { - "type": "object", - "description": "Information that define the functioning of the queue.", - "properties": { - "visibilityTimeoutInSeconds": { - "type": "integer", - "description": "Period of time for which an item is not visible in the feed after it has been retrieved with the Get feed items request. Measured in seconds." - }, - "MessageRetentionPeriodInSeconds": { - "type": "integer", - "description": "Maximum life span of an order update after it gets to the feed. When a feed item is on the feed for this period of time, it is removed from the feed. Measured in seconds." - } - } + { + "orderId": "v502553llux-01", + "creationDate": "2019-01-24T12:35:19+00:00", + "clientName": "test test", + "items": null, + "totalValue": 10150, + "paymentNames": "Mastercard", + "status": "ready-for-handling", + "statusDescription": "Pronto para o manuseio", + "marketPlaceOrderId": null, + "sequence": "502554", + "salesChannel": "1", + "affiliateId": "", + "origin": "Marketplace", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502553llux-01 Olá, test. Estamos empacotando seu produto para provide", + "ShippingEstimatedDate": "2019-01-31T12:36:30+00:00", + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2019-01-24T12:36:01+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" }, - "quantity": { - "type": "integer", - "description": "Current number of messages in the feed, including messages that may not be visible due to time out after retrieval." + { + "orderId": "v502550llux-01", + "creationDate": "2019-01-23T16:39:45+00:00", + "clientName": "test test", + "items": null, + "totalValue": 10150, + "paymentNames": "Mastercard", + "status": "ready-for-handling", + "statusDescription": "Pronto para o manuseio", + "marketPlaceOrderId": null, + "sequence": "502551", + "salesChannel": "1", + "affiliateId": "", + "origin": "Marketplace", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502550llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc", + "ShippingEstimatedDate": "2019-01-30T16:40:55+00:00", + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2019-01-23T16:40:27+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" }, - "approximateAgeOfOldestMessageInSeconds": { - "type": "number", - "description": "Aproximate age of the oldest message in the feed, measured in seconds." - } - } - }, - "example": { - "filter": { - "type": "FromOrders", - "expression": "status = \"payment-pending\"", - "disableSingleFire": false - }, - "queue": { - "visibilityTimeoutInSeconds": 240, - "messageRetentionPeriodInSeconds": 345600 - }, - "quantity": 127, - "approximateAgeOfOldestMessageInSeconds": 78.91597222222222 - } - } - } - } - } - }, - "post": { - "tags": ["Feed v3"], - "summary": "Create or update feed configuration", - "description": "The Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our [Feed v3 guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed) and our [order integration guide](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration)\n\r\n\rThere are two types of filtering that can be used. The `FromWorkflow` type filters orders by status, whereas the `FromOrders` type uses JSONata expressions to filter orders according to any property in the orders JSON document. This enables stores to filter delivered orders and orders in which products have been added or removed, for example. To learn more, access the [JSONata documentation](https://docs.jsonata.org/overview.html) and test filtering JSONata expressions with our [Test JSONata expression](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/expressions/jsonata) endpoint.", - "operationId": "FeedConfiguration", - "parameters": [ - { + { + "orderId": "v502547llux-01", + "creationDate": "2019-01-23T16:34:20+00:00", + "clientName": "test test", + "items": null, + "totalValue": 10150, + "paymentNames": "Mastercard", + "status": "ready-for-handling", + "statusDescription": "Pronto para o manuseio", + "marketPlaceOrderId": null, + "sequence": "502548", + "salesChannel": "1", + "affiliateId": "", + "origin": "Marketplace", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502547llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc", + "ShippingEstimatedDate": "2019-01-30T16:35:30+00:00", + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2019-01-23T16:35:04+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" + }, + { + "orderId": "v502544llux-01", + "creationDate": "2018-12-28T18:15:28+00:00", + "clientName": "test test", + "items": null, + "totalValue": 8990, + "paymentNames": "Boleto Bancário", + "status": "canceled", + "statusDescription": "Cancelado", + "marketPlaceOrderId": null, + "sequence": "502544", + "salesChannel": "1", + "affiliateId": "", + "origin": "Marketplace", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": " Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502544llux-01 Resumo Itens R$ 89,90 Total R$ 89,90 Produto Alavanca De M", + "ShippingEstimatedDate": null, + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": null, + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" + }, + { + "orderId": "v502541llux-01", + "creationDate": "2018-12-18T18:48:17+00:00", + "clientName": "Douglas Rodrigues", + "items": null, + "totalValue": 3290, + "paymentNames": "Boleto Bancário", + "status": "canceled", + "statusDescription": "Cancelado", + "marketPlaceOrderId": null, + "sequence": "502541", + "salesChannel": "1", + "affiliateId": "", + "origin": "Marketplace", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": " Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502541llux-01 Resumo Itens R$ 32,90 Total R$ 32,90 Produto Bay Max L 1 u", + "ShippingEstimatedDate": null, + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": null, + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" + }, + { + "orderId": "v502538llux-01", + "creationDate": "2018-12-12T18:21:47+00:00", + "clientName": "test test", + "items": null, + "totalValue": 8990, + "paymentNames": "Mastercard", + "status": "ready-for-handling", + "statusDescription": "Pronto para o manuseio", + "marketPlaceOrderId": null, + "sequence": "502538", + "salesChannel": "1", + "affiliateId": "", + "origin": "Marketplace", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502538llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc", + "ShippingEstimatedDate": "2018-12-19T18:22:26+00:00", + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2018-12-12T18:22:22+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" + }, + { + "orderId": "SCP-880102018018-01", + "creationDate": "2018-11-30T17:34:01+00:00", + "clientName": "roberta grecco", + "items": null, + "totalValue": 1250, + "paymentNames": "", + "status": "canceled", + "statusDescription": "Cancelado", + "marketPlaceOrderId": "880102018018-01", + "sequence": "502537", + "salesChannel": "1", + "affiliateId": "SCP", + "origin": "Fulfillment", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": "cancelamento teste shp ", + "ShippingEstimatedDate": null, + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2018-11-30T17:34:42+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" + }, + { + "orderId": "SCP-880091692043-01", + "creationDate": "2018-11-30T17:28:35+00:00", + "clientName": "roberta grecco", + "items": null, + "totalValue": 1250, + "paymentNames": "", + "status": "invoiced", + "statusDescription": "Faturado", + "marketPlaceOrderId": "880091692043-01", + "sequence": "502536", + "salesChannel": "1", + "affiliateId": "SCP", + "origin": "Fulfillment", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": null, + "ShippingEstimatedDate": null, + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2018-11-30T17:29:22+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" + }, + { + "orderId": "SCP-880091058221-01", + "creationDate": "2018-11-30T17:18:00+00:00", + "clientName": "roberta grecco", + "items": null, + "totalValue": 1250, + "paymentNames": "", + "status": "canceled", + "statusDescription": "Cancelado", + "marketPlaceOrderId": "880091058221-01", + "sequence": "502535", + "salesChannel": "1", + "affiliateId": "SCP", + "origin": "Fulfillment", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": "Teste de cancelamento do ShopFácil ", + "ShippingEstimatedDate": null, + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2018-11-30T17:18:44+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" + }, + { + "orderId": "SCP-880090643370-01", + "creationDate": "2018-11-30T17:10:59+00:00", + "clientName": "roberta grecco", + "items": null, + "totalValue": 1250, + "paymentNames": "", + "status": "ready-for-handling", + "statusDescription": "Pronto para o manuseio", + "marketPlaceOrderId": "880090643370-01", + "sequence": "502534", + "salesChannel": "1", + "affiliateId": "SCP", + "origin": "Fulfillment", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": null, + "ShippingEstimatedDate": "2018-12-07T17:11:39+00:00", + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2018-11-30T17:11:42+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" + }, + { + "orderId": "SCP-880090622238-01", + "creationDate": "2018-11-30T17:10:45+00:00", + "clientName": "roberta grecco", + "items": null, + "totalValue": 1250, + "paymentNames": "", + "status": "canceled", + "statusDescription": "Cancelado", + "marketPlaceOrderId": "880090622238-01", + "sequence": "502533", + "salesChannel": "1", + "affiliateId": "SCP", + "origin": "Fulfillment", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": null, + "ShippingEstimatedDate": null, + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": null, + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" + }, + { + "orderId": "MNC-877730530419-01", + "creationDate": "2018-11-20T21:09:01+00:00", + "clientName": "Carlos VTEX", + "items": null, + "totalValue": 11150, + "paymentNames": "", + "status": "canceled", + "statusDescription": "Cancelado", + "marketPlaceOrderId": "877730530419-01", + "sequence": "502532", + "salesChannel": "1", + "affiliateId": "MNC", + "origin": "Fulfillment", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": null, + "ShippingEstimatedDate": null, + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2018-11-20T21:13:06+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" + }, + { + "orderId": "SCP-876733475998-01", + "creationDate": "2018-11-16T16:58:18+00:00", + "clientName": "roberta grecco", + "items": null, + "totalValue": 1250, + "paymentNames": "", + "status": "ready-for-handling", + "statusDescription": "Pronto para o manuseio", + "marketPlaceOrderId": "876733475998-01", + "sequence": "502531", + "salesChannel": "1", + "affiliateId": "SCP", + "origin": "Fulfillment", + "workflowInErrorState": false, + "workflowInRetry": false, + "lastMessageUnread": null, + "ShippingEstimatedDate": "2018-11-23T16:58:48+00:00", + "ShippingEstimatedDateMax": null, + "ShippingEstimatedDateMin": null, + "orderIsComplete": true, + "listId": null, + "listType": null, + "authorizedDate": "2018-11-16T16:58:53+00:00", + "callCenterOperatorName": null, + "totalItems": 1, + "currencyCode": "BRL" + } + ], + "facets": [], + "paging": { + "total": 84, + "pages": 6, + "currentPage": 1, + "perPage": 15 + }, + "stats": { + "stats": { + "totalValue": { + "Count": 84, + "Max": 21526180, + "Mean": 262672.75, + "Min": 1160, + "Missing": 0, + "StdDev": 2348087.3869179883, + "Sum": 22064511, + "SumOfSquares": 463417439039853, + "Facets": { + "origin": { + "Fulfillment": { + "Count": 68, + "Max": 11150, + "Mean": 1395.5882352941176, + "Min": 1250, + "Missing": 0, + "StdDev": 1200.5513439298484, + "Sum": 94900, + "SumOfSquares": 229010000, + "Facets": null + }, + "Marketplace": { + "Count": 16, + "Max": 21526180, + "Mean": 1373100.6875, + "Min": 1160, + "Missing": 0, + "StdDev": 5374326.141087491, + "Sum": 21969611, + "SumOfSquares": 463417210029853, + "Facets": null + } + }, + "currencyCode": { + "BRL": { + "Count": 84, + "Max": 21526180, + "Mean": 262672.75, + "Min": 1160, + "Missing": 0, + "StdDev": 2348087.3869179883, + "Sum": 22064511, + "SumOfSquares": 463417439039853, + "Facets": null + } + } + } + }, + "totalItems": { + "Count": 84, + "Max": 89, + "Mean": 2.2261904761904763, + "Min": 1, + "Missing": 0, + "StdDev": 9.660940100525016, + "Sum": 187, + "SumOfSquares": 8163, + "Facets": { + "origin": { + "Fulfillment": { + "Count": 68, + "Max": 1, + "Mean": 1, + "Min": 1, + "Missing": 0, + "StdDev": 0, + "Sum": 68, + "SumOfSquares": 68, + "Facets": null + }, + "Marketplace": { + "Count": 16, + "Max": 89, + "Mean": 7.4375, + "Min": 1, + "Missing": 0, + "StdDev": 21.92401651157926, + "Sum": 119, + "SumOfSquares": 8095, + "Facets": null + } + }, + "currencyCode": { + "BRL": { + "Count": 84, + "Max": 89, + "Mean": 2.2261904761904763, + "Min": 1, + "Missing": 0, + "StdDev": 9.660940100525016, + "Sum": 187, + "SumOfSquares": 8163, + "Facets": null + } + } + } + } + } + } + } + } + } + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/start-handling": { + "post": { + "tags": ["Orders"], + "summary": "Start handling order", + "description": "Changes the status of an order to indicate that it is in `handling`.\n\r\n\r> Expect a `status 204` response with no content in case of a successful request. The store must validate this response to retry the call if the response differs from the `204` code, making this flow the store's responsibility. This endpoint can also respond with `status 500`. \n\r\n\r> The `Change order workflow status` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#).", + "operationId": "StartHandling", + "parameters": [ + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "orderId", + "in": "path", + "description": "Order ID is a unique code that identifies an order.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + } + ], + "responses": { + "204": { + "description": "[No content](https://httpstatuses.com/204)" + }, + "401": { + "description": "[Unauthorized](https://httpstatuses.com/401)", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Root object", + "properties": { + "error": { + "description": "Object containing the error information.", + "type": "object", + "properties": { + "code": { + "description": "Error code in the Order Management System (OMS).", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "exception": { + "description": "Exception information.", + "type": "string", + "nullable": true + } + } + } + } + }, + "example": { + "error": { + "code": "1", + "message": "Unauthorized access", + "exception": null + } + } + } + } + }, + "403": { + "description": "[Forbidden](https://httpstatuses.com/403)" + }, + "404": { + "description": "[Not found](https://httpstatuses.com/404)" + }, + "409": { + "description": "[Conflict](https://httpstatuses.com/409)", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Root object", + "properties": { + "error": { + "description": "Object containing the error information.", + "type": "object", + "properties": { + "code": { + "description": "Error code in the Order Management System (OMS).", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "exception": { + "description": "Exception information.", + "type": "string", + "nullable": true + } + } + } + } + }, + "example": { + "error": { + "code": "OMS003", + "message": "Order status should be ready-for-handling to perform this action", + "exception": null + } + } + } + } + }, + "429": { + "description": "[Too many requests](https://httpstatuses.com/429)" + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/cancel": { + "post": { + "tags": ["Orders"], + "summary": "Cancel order", + "description": "Cancels an order using its identification code (`orderId`). A common scenario is when the seller has a problem fulfilling the order and requests the marketplace to cancel it. \r\n\r\n## Orders that cannot be canceled \r\n\r\nThe following situations do not allow order cancellation: \r\n\r\n- **Partial invoices:** [Partially invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) orders cannot be canceled. However, the customer can [change the order](https://developers.vtex.com/docs/guides/change-order) to replace or remove items from it. \r\n\r\n- **Invoiced status:** Orders with `invoiced` [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) cannot be canceled. If the order has already been invoiced, you can use the [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice) endpoint to generate a return invoice. \r\n\r\n- **Incomplete orders:** [Incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294) cannot be canceled. \r\n\r\n## Declining order cancelation \r\n\r\nThe order flow has a cancellation window (grace period) in which the customer can automatically cancel the order. Except for that period, the seller can [decline an order cancellation request](https://help.vtex.com/en/tutorial/declining-order-cancelation--F2n0h1TeQ5td540Gjyff4), regardless of whether the customer or the marketplace initiated it. \r\n\r\nFor more information, see [Order canceling improvements](https://developers.vtex.com/docs/guides/order-canceling-improvements). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **Cancel order** | \r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | Cancel order |\r\n| IntegrationProfile - Fulfillment Oms | Cancel order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", + "operationId": "CancelOrder", + "parameters": [ + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Describes the type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "orderId", + "in": "path", + "description": "ID that identifies the order in the seller.", + "example": "1172452900788-01", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "Reason for cancelling the order.", + "example": "Unexpected stock shortage" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date and time when the notification was received." + }, + "orderId": { + "type": "string", + "description": "Identification of the order in the seller." + }, + "receipt": { + "type": "string", + "description": "Protocol code generated by the update. It may be `null`." + } + } + }, + "example": { + "date": "2024-02-07T15:22:56.7612218-02:00", + "orderId": "123543123", + "receipt": "38e0e47da2934847b489216d208cfd91" + } + } + } + }, + "429": { + "description": "Too many requests." + }, + "403": { + "description": "The credentials are not enabled to access the service." + }, + "404": { + "description": "Value not found." + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/changes": { + "post": { + "tags": ["Orders"], + "summary": "Register change on order", + "description": "This request allows [changing an order](https://help.vtex.com/en/tutorial/changing-items-from-a-completed-order--tutorials_190) by:\r\n\r\n- Adding items to an order.\r\n\r\n- Removing items from an order.\r\n\r\n- Applying discounts to the total value of the order.\r\n\r\n- Incrementing the total value of the order. \r\n\r\n> **Timeout settings:** This is a synchronous API, which means the application requests data and waits until a value is returned. This behavior can cause timeout errors. To avoid them, we recommend setting the timeout in 20 seconds.\r\n\r\nIn change order scenarios, it is possible to insert a [Partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe). The total value of the order will be updated after the insertion of the invoice, even when there is a partial invoice scenario. The updated value is settled by the VTEX Payment Gateway, and the customer reimbursement is automatic. \r\n\r\nThis action can only be done for orders in the following status:\r\n\r\n- `handling`\r\n\r\n- `waiting-for-fulfillment` \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", + "operationId": "RegisterChange", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "orderId", + "in": "path", + "description": "ID that identifies the order in the seller.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "requestId", + "reason", + "discountValue", + "incrementValue" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Request identification of the change. Only the first change made with each `requestId` will be effective on a given order. Use different IDs for different changes to the same order.", + "example": "change-request-0123" + }, + "reason": { + "type": "string", + "description": "Reason for order change. This may be shown to the shopper in the UI or transactional emails.", + "example": "Stock shortage" + }, + "discountValue": { + "type": "integer", + "description": "This field can be used to apply a discount to the total value of the order. Value in cents.", + "example": 100 + }, + "incrementValue": { + "type": "integer", + "description": "This field can be used to increment the total value of the order. Value in cents.", + "example": 100 + }, + "itemsRemoved": { + "type": "array", + "description": "List of items that should be removed from the order.", + "items": { + "type": "object", + "description": "Removed items' details.", + "required": [ + "id", + "price", + "quantity" + ], + "properties": { + "id": { + "type": "string", + "description": "Product ID of the item.", + "example": "0" + }, + "price": { + "type": "integer", + "description": "Price of the item in cents.", + "example": 2499 + }, + "quantity": { + "type": "integer", + "description": "Amount of items to be removed.", + "example": 1 + } + } + } + }, + "itemsAdded": { + "type": "array", + "description": "List of items that should be added to the order.", + "items": { + "type": "object", + "description": "Added items' details.", + "required": [ + "id", + "price", + "quantity" + ], + "properties": { + "id": { + "type": "string", + "description": "Product ID of the item.", + "example": "0" + }, + "price": { + "type": "integer", + "description": "Price of the item in cents.", + "example": 2499 + }, + "quantity": { + "type": "integer", + "description": "Amount of items to be added.", + "example": 1 + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of order change." + }, + "orderId": { + "type": "string", + "description": "ID of the order." + }, + "receipt": { + "type": "string", + "description": "Receipt identification." + } + } + }, + "example": { + "date": "2024-02-08T13:54:33.6868469+00:00", + "orderId": "v502538llux-01", + "receipt": "535d4581-a2a2-4fd2-a206-1c61eae91b1e" + } + } + } + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/interactions": { + "post": { + "tags": ["Orders"], + "summary": "Add log in orders", + "description": "Add a Log in Interactions Order Array.", + "operationId": "AddLog", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "orderId", + "in": "path", + "description": "Unique code that identifies an order.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "source", + "message" + ], + "properties": { + "source": { + "type": "string", + "description": "Source information.", + "example": "Postman" + }, + "message": { + "type": "string", + "description": "Interactions message.", + "example": "Add interactions" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/invoice": { + "post": { + "tags": ["Invoice"], + "summary": "Order invoice notification", + "description": "This request is used for [invoicing an order](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT). Entering the order's invoice means it was successfully completed, and the order status can be changed to the `invoiced` in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). Once an order is `invoiced`, its status cannot be changed. \r\n\r\nAfter the insertion of the invoice, the order's total value will be updated, even in [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios. \r\n\r\n>❗ To avoid rounding errors, we recommend always sending the object of items being invoiced. \r\n\r\n## Partial invoices \r\n\r\nAfter adding a [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe), the order's value will be updated, corresponding to a partial settled value in the VTEX payment gateway. \r\n\r\nPartially invoiced orders cannot be canceled, and cancellation attempts will result in a `400` status code error. If the customer wants to replace or remove items, it is possible to [change the order](https://developers.vtex.com/docs/guides/change-order). \r\n\r\n> The partial invoices feature is available for all VTEX stores. The partial settlement in the gateway is in Beta, and requires a connector with the Payment Provider Protocol. \r\n\r\n## Returning items \r\n\r\nBesides using this endpoint for generating invoices for sold items, you can use it for generating invoices for returned items. You determine this in the request body `type` field by choosing one of the following values: \r\n\r\n- `output`: selling order invoice. \r\n\r\n- `input`: returning items invoice. \r\n\r\nBe aware of generating return invoices only after the full order amount was invoiced, otherwise, no refund will occur. \r\n\r\n## Changing the receipt code \r\n\r\nEvery time this endpoint is called using the same `invoiceNumber`, a new `receipt` code is generated, and it overrides the previous one. By doing this, you cannot change other information, only the `receipt` code.\r\n\r\n## Integration with marketplaces \r\n\r\nThe invoice should be pushed to the fulfillment account, not to the marketplace account. Once the order is invoiced, the seller should use this request to send the invoice information to the marketplace. \r\n\r\nThis endpoint is also used by the seller to send the order tracking information. However, this only should be done after the seller has the tracking information. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **Notify invoice** |\r\n| OMS | OMS access | **Notify refund** | \r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | Cancel order |\r\n| IntegrationProfile - Fulfillment Oms | Cancel order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", + "operationId": "InvoiceNotification", + "parameters": [ + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Describes the type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "orderId", + "in": "path", + "description": "Unique code that identifies the order whose invoice is being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "type", + "issuanceDate", + "invoiceNumber", + "invoiceValue", + "items" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of invoice. There are two possible values: **Output** and **Input**. The Output type should be used when the invoice you are sending is a selling invoice. The Input type should be used when you send a return invoice.", + "example": "Output" + }, + "issuanceDate": { + "type": "string", + "description": "The invoice date is when the order was [invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT) in the VTEX platform, and the `IssuanceDate` is the date when the merchant registers the order's invoice in the store's system. The `IssuanceDate` can be different from the invoice date, because the merchant can register the invoice days or even months after order invoicing. You must add date and time in this field.", + "example": "2024-01-31T18:25:43-05:00" + }, + "invoiceNumber": { + "type": "string", + "description": "Unique code that identifies the invoice. When you call this endpoint using the same invoice number, you generate a new `receipt` code.", + "example": "DFG-v7731485plzv-01", + "nullable": true + }, + "invoiceValue": { + "type": "string", + "description": "Total amount being invoiced in cents. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`.", + "example": "2499" + }, + "invoiceKey": { + "type": "string", + "nullable": true, + "description": "Information about invoice key.", + "example": "CFe35201100063960001504590006629690333214542150" + }, + "invoiceUrl": { + "type": "string", + "description": "URL of the invoice. Can be used to send the URL of an XML file, for example, which is useful for some integrations.", + "nullable": true, + "example": "https://luxstore.com/invoices/24382.pdf" + }, + "embeddedInvoice": { + "type": "string", + "nullable": true, + "description": "XML text of the invoice, not the URL. This field is very important for external marketplace integrations such as Mercado Libre.", + "example": "\r\n\r\n\r\n37\r\n000005177\r\nVenda a vista\r\n0\r\n55\r\n1\r\n1\r\n2018-07-06\r\n2018-07-06\r\n0\r\n79950308\r\n1\r\n1\r\n3\r\n2\r\n1\r\n0\r\nNF-eletronica.com\r\n\r\n\r\n99999090998760\r\nNF-e Associacao NF-e\r\nNF-e\r\n\r\nRua Central\r\n100\r\nFundos\r\nDistrito Industrial\r\n0000000\r\nMunicípio\r\nSP\r\n0000000\r\n1058\r\nBrasil\r\n1733021717\r\n\r\n123456789012\r\n\r\n\r\n00000000000000\r\nDISTRIBUIDORA DE AGUAS MINERAIS\r\n\r\nAV DAS FONTES\r\n1777\r\n1001 ANDAR\r\nPARQUE\r\n0000000\r\nSao Paulo\r\nSP\r\n00000000\r\n1058\r\nBRASIL\r\n3900000000\r\n\r\n \r\n\r\n\r\n000000000004\r\nAV PAULISTA\r\n12345\r\nTERREO\r\nCERQUEIRA CESAR\r\n0000000\r\nSAO PAULO\r\nSP\r\n\r\n\r\n00000000299000194\r\nAV FARIA LIMA\r\n154400\r\n156 ANDAR\r\nPINHEIROS\r\n0000308\r\nSAO PAULO\r\nSP\r\n\r\n\r\n\r\n00001\r\n\r\nAgua Mineral\r\n5101\r\ndz\r\n1000000.0000\r\n1\r\n10000000.00\r\n\r\nund\r\n12000000.0000\r\n1\r\n\r\n\r\n\r\n\r\n0\r\n00\r\n0\r\n10000000.00\r\n18.00\r\n1800000.00\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n0.65\r\n65000\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n2.00\r\n200000.00\r\n\r\n\r\n\r\n\r\n\r\n\r\n00002\r\n\r\nAgua Mineral\r\n5101\r\npack\r\n5000000.0000\r\n2\r\n10000000.00\r\n\r\nund\r\n3000000.0000\r\n0.3333\r\n\r\n\r\n\r\n\r\n0\r\n00\r\n0\r\n10000000.00\r\n18.00\r\n1800000.00\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n0.65\r\n65000\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n2.00\r\n200000.00\r\n\r\n\r\n\r\n\r\n\r\n\r\n20000000.00\r\n18.00\r\n0\r\n0\r\n20000000.00\r\n0\r\n0\r\n0\r\n0\r\n0\r\n130000.00\r\n400000.00\r\n0\r\n20000000.00\r\n\r\n\r\n\r\n0\r\n\r\n00000000000000\r\nDistribuidora de Bebidas Fazenda de SP Ltda.\r\n00000000999119\r\nRua Central 100 - Fundos - Distrito Industrial\r\nSAO PAULO\r\nSP\r\n\r\n\r\nBXI1717\r\nSP\r\n123456789\r\n\r\n\r\nUUU0000\r\nSP\r\n123456789\r\n\r\n\r\n10000\r\nCAIXA\r\nLINDOYA\r\n500\r\n1000000000.000\r\n1200000000.000\r\n\r\nXYZ10231486\r\n\r\n\r\n\r\n\r\nNota Fiscal de exemplo NF-eletronica.com\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nxFzhgdgnhjSD1e9uqe04lnoHT4ZzLSY=\r\n\r\n\r\n\r\nIz5Z3PLQbzZt9jnBtr6xsmHZMOu/3plXG9xxfFjRCQYGnD1rjlhzBGrqt026Ca2VHHM/bHNepi6FuFkAi595GScKVuHREUotzifE2OIjgavvTOrMwbXG7+0LYgkwPFiPCao2S33UpZe7MneaxcmKQGKQZw1fP8fsWmaQ4cczZT8=\r\n\r\n\r\n\r\n\r\nMIIEuzCCA6OgAwIBAgIDMTMxMA0GasfFSDAGQUAMIGSMQswCQYDVQQGEwJCUjELMAkGA1UECBMCUlMxFTATBgNVBAcTDFBvcnRvIEFsZWdyZTEdMBsGA1UEChMUVGVzdGUgUHJvamV0byBORmUgUlMxHTAbBgNVBAsTFFRlc3RlIFByb2pldG8gTkZlIFJTMSEwHwYDVQQDExhORmUgLSBBQyBJbnRlcm1lZGlhcmlhIDEwHhcNMDgwNDI4MDkwMTAyWhcNMDkwNDMwMjM1OTU5WjCBnjELMAkGA1UECBMCUlMxHTAfvw4567DRhg76FByb2pldG8gTkZlIFJTMR0wGwYDVQQKExRUZXN0ZSBQcm9qZXRvIE5GZSBSUzEVMBMGA1UEBxMMUE9SVE8gQUxFR1JFMQswCQYDVQQGEwJCUjEtMCsGA1UEAxMkTkZlIC0gQXNzb2NpYWNhbyBORi1lOjk5OTk5MDkwOTEwMjcwMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDh6RRv0bj4RYX+tDQrZRb5opa77LBVVs+6LphIfSF3TSWPfnKh0+xLlBFdmnB5YGgbbW9Uon6pZQTfaC8jZhRhI5eFRRofY/Ugoeo0NGt6PcIQNZQd6lLQ/ASd1qWwjqJoEa7udriKjy3h351Mf1bng1VxS1urqC3Dn39ZWIEwQIDAQABo4IBjjCCAYowIgYDVR0jAQEABBgwFoAUPT5TqhNWAm+ZpcVsvB7malDBjEQwDwYDVR0TAQH/BAUwAwEBADAPBgNVHQ8BAf8EBQMDAOAAMAwGA1UdIAEBAAQCMAAwgbwGA1UdEQEBAASBsTCBrqA4BgVgTAEDBKAvBC0wNzA4MTk1MTE1MTk0NTMxMDg3MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDCgHQYFYEwBAwKgFAQSRmVybmFuZG8gQ2FudG8gQWx0oBkGBWBMAQMDoBAEDjk5OTk5MDkwOTEwMjcwoBcGBWBMAQMHoA4EDDAwMDAwMDAwMDAwMIEfZmVybmFuZG8tYWx0QHByb2NlcmdzLnJzLmdvdi5icjAgBgNVHSUBAf8EFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwUwYDVR0fAQEABEkwRzBFoEOgQYY/aHR0cDovL25mZWNlcnRpZmljYWRvLnNlZmF6LnJzLmdvdi5ici9MQ1IvQUNJbnRlcm1lZGlhcmlhMzguY3JsMA0GCSqGSIb3DQEBBQUAA4IBAQCNPpaZ3Byu3/70nObXE8NiM53j1ddIFXsb+v2ghCVd4ffExv3hYc+/a3lfgV8H/WfQsdSCTzS2cHrd4Aasr/eXfclVDmf2hcWz+R7iysOHuT6B6r+DvV3JcMdJJCDdynR5REa+zViMnVZo1G3KuceQ7/y5X3WFNVq4kwHvonJ9oExsWyw8rTwUK5bsjz0A2yEwXkmkJIngnF41sP31+9jCImiqkXcmsesFhxzX7iurAQAQCZOm7iwMWxQKcAjXCZrgSZWRQy6mU224sX3HTArHahmLJ9Iw+WYAua5qBJsiN6PC7v5tfhdsgGD46DHMnOecxvkkPolDUyBa7d7xwgm\r\n\r\n\r\n\r\n\r\n" + }, + "courier": { + "type": "string", + "nullable": true, + "description": "The name of the carrier responsible for delivering the order. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)*.", + "example": "carrierOne" + }, + "trackingNumber": { + "type": "string", + "nullable": true, + "description": "The number code that identifies the order tracking. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)*.", + "example": "87658" + }, + "trackingUrl": { + "type": "string", + "nullable": true, + "description": "The URL used to track the order. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)*.", + "example": "https://www.tracking.com/url" + }, + "dispatchedDate": { + "type": "string", + "nullable": true, + "description": "Order dispatch date. May be `null`.", + "example": "2019-02-08T13:16:13.4617653+00:00" + }, + "items": { + "type": "array", + "description": "Array containing the SKUs that are being invoiced.", + "items": { + "type": "object", + "description": "Information about a SKU being invoiced.", + "required": [ + "id", + "price", + "quantity" + ], + "properties": { + "id": { + "type": "string", + "description": "ID of the SKU being invoiced.", + "example": "123" + }, + "price": { + "type": "integer", + "description": "Price in cents of the SKU being invoiced. Do not use a decimal separator, for example, the price $24.99 corresponds to `2499`. You must insert the SKU unitary price because the VTEX system will multiply the price over the quantity.", + "example": 2499 + }, + "description": { + "type": "string", + "description": "You can use this field for additional information about the SKU being invoiced.", + "example": "335" + }, + "quantity": { + "type": "integer", + "description": "Quantity currently in inventory of the SKU being invoiced.", + "example": 2 + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date and time when the notification was received." + }, + "orderId": { + "type": "string", + "description": "Identification of the order in the seller." + }, + "receipt": { + "type": "string", + "description": "Protocol code generated by the update that identifies the receipt. Every time this endpoint is called using the same `invoiceNumber`, a new `receipt` code is generated, and it overrides the previous one." + } + } + }, + "example": { + "date": "2024-02-07T15:22:56.7612218-02:00", + "orderId": "123543123", + "receipt": "38e0e47da2934847b489216d208cfd91" + } + } + } + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}": { + "patch": { + "tags": ["Invoice"], + "summary": "Update order's partial invoice (send tracking number)", + "description": "Update a given order, adding its tracking number to its [Partial invoice](https://help.vtex.com/en/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe).\n\r\n\rAfter using this call to add a tracking number to an order, you can use the [Update order tracking status](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking) API request to add tracking events.\n\r\n\r> The `Notify invoice` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).", + "operationId": "Updatepartialinvoice.SendTrackingNumber", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "orderId", + "in": "path", + "description": "Unique code that identifies the order whose invoice is being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + }, + { + "name": "invoiceNumber", + "in": "path", + "description": "Number that identifies the invoice.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "000030711" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Updatepartialinvoice.SendTrackingNumber.Request" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Updatepartialinvoice.SendTrackingNumber" + }, + "example": { + "date": "2019-02-08T13:16:13.4617653+00:00", + "orderId": "00-v5195004lux-01", + "receipt": "527b1ae251264ef1b7a9b597cd8f16b9" + } + } + } + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}/tracking": { + "put": { + "tags": ["Tracking"], + "summary": "Update order tracking status", + "description": "This endpoint sends a tracking event to an order that already has a tracking number registered to its invoice.\r\n\r\nThis request is not meant to send a tracking number and URL to the invoice. If you wish to send a tracking number and URL to an order, use the [Update order's partial invoice](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-) endpoint. For more information, see [Partial invoice](https://help.vtex.com/en/tracks/partial-invoices--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios.\r\n\r\nThis endpoint applies to orders with any shipping type, whether delivery or [pickup](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\r\n\r\n> The `Notify invoice` License Manager resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about [License Manager Roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).", + "operationId": "UpdateTrackingStatus", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "orderId", + "in": "path", + "description": "Order ID is a unique code that identifies an order.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + }, + { + "name": "invoiceNumber", + "in": "path", + "description": "Number that identifies the invoice.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "000030711" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTrackingStatusRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/UpdateTrackingStatus" + }, + "example": { + "date": "2017-03-29T18:04:31.0521233+00:00", + "orderId": "v501245lspt-01", + "receipt": "f67d33a8029c42ce9a8f07fc17f54449" + } + } + } + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/conversation-message": { + "get": { + "tags": ["Conversation"], + "summary": "Retrieve order conversation", + "description": "List all order conversations of an order by its order ID.", + "operationId": "GetConversation", + "parameters": [ + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "orderId", + "in": "path", + "description": "Order ID is a unique code that identifies an order.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json; charset=utf-8": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetConversation" + } + }, + "example": [ + { + "id": "2023-01-23t09-23-08_619a80a05aa34efb982b309c7a1910e3", + "from": { + "conversationRelatedTo": "1305371685465-01", + "conversationSubject": "oms", + "emailAlias": "noreply@vtexcommerce.com.br-9814872b.ct.store.com.br", + "aliasMaskType": 0, + "email": "noreply@store.com.br", + "name": "no reply", + "role": "null" + }, + "to": [ + { + "conversationRelatedTo": "1305371685465-01", + "conversationSubject": "oms", + "emailAlias": "64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br", + "aliasMaskType": 0, + "email": "customer.name@email.com", + "name": "Mary John", + "role": "Customer" + } + ], + "subject": "Your payment has been aproved.", + "firstWords": "Your payment has been aproved and we are waiting for...", + "body": " recorrenciaqa

Seu pagamento foi aprovado.

Referente ao Pedido #1305371685465-01

Olá, jose. Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto.

Pagamento

Visa final 1111
R$ 3,99 à vista

Atenciosamente,
Equipe recorrenciaqa

", + "hasAttachment": false, + "attachmentNames": [ + "attachments439505" + ], + "date": "2023-01-23T09:23:31.0000000+00:00" + } + ] + } + } + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/payment-transaction": { + "get": { + "tags": ["Payment"], + "summary": "Retrieve payment transaction", + "description": "Retrieves transaction details by order ID. All events in the transaction will be registered in this call's response body. \n\nIn scenarios of [order changes](https://developers.vtex.com/vtex-rest-api/reference/registerchange), it is possible to insert a [Partial invoice](https://help.vtex.com/en/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe). The total value of the order will be updated after the insertion of the invoice, even when there is a [Partial invoice](https://help.vtex.com/en/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenario. The updated value is settled by VTEX's Payment Gateway. The reimbursement for the shopper is automatic.", + "operationId": "GetPaymenttransaction", + "parameters": [ + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "orderId", + "in": "path", + "description": "Order ID is a unique code that identifies an order.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPaymenttransaction" + }, + "example": { + "status": "Finished", + "isActive": true, + "transactionId": "CB452D77E7D04099A4DB0479087B1D2C", + "merchantName": "LUXSTORE", + "payments": [ + { + "id": "721CBE1090324D12ABE301FE33DE775A", + "paymentSystem": "4", + "paymentSystemName": "Mastercard", + "value": 10150, + "installments": 1, + "referenceValue": 10150, + "cardHolder": null, + "cardNumber": null, + "firstDigits": "412341", + "lastDigits": "4123", + "url": null, + "giftCardId": null, + "giftCardName": null, + "cvv2": null, + "expireMonth": null, + "expireYear": null, + "giftCardCaption": null, + "redemptionCode": null, + "group": "creditCard", + "tid": "101770752", + "dueDate": null, + "connectorResponses": { + "Tid": "101770752", + "ReturnCode": "200", + "Message": "logMessage", + "authId": "170852" + } + } + ] + } + } + } + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification": { + "post": { + "tags": ["Payment"], + "summary": "Send payment notification", + "description": "Send a payment notification of a given order, by order ID.\n\r\n\r> The `Notify payment` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#).", + "operationId": "SendPaymentNotification", + "parameters": [ + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "orderId", + "in": "path", + "description": "Order ID is a unique code that identifies an order.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + }, + { + "name": "paymentId", + "in": "path", + "description": "VTEX payment identifier.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "F5C1A4E20D3B4E07B7E871F5B5BC9F91" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad request." + }, + "403": { + "description": "The credentials are not enabled to access the service." + }, + "404": { + "description": "Value not found." + }, + "429": { + "description": "Too many requests." + } + } + } + }, + "/api/oms/pvt/feed/orders/status": { + "get": { + "tags": ["Feed v2 (deprecated)"], + "summary": "Get feed order status", + "description": "Get feed order status (deprecated)", + "operationId": "Getfeedorderstatus", + "parameters": [ + { + "name": "maxLot", + "in": "query", + "description": "Maximum lot.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "{{maxLot}}" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/orders/feed/config": { + "get": { + "tags": ["Feed v3"], + "summary": "Get feed configuration", + "description": "The Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our [Feed v3 guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed) and our [order integration guide](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration).\n\r\n> 📘 Onboarding guide \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.\r\n\r\n", + "operationId": "GetFeedConfiguration", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "filter": { + "type": "object", + "description": "Information on how orders are filtered to show on the feed.", + "properties": { + "type": { + "type": "string", + "description": "Determines what orders appear in the feed and how they are filtered. If a feed has the `FromWorkflow` type configuration, it will receive order updates only when order's statuses change and orders can be filtered by status, using the `status` field. A feed with the `FromOrders` type configuration gets updates whenever any change is made to an order. in this case, orders can be filtered by any property, according to JSONata expressions set in the `expression` field." + }, + "status": { + "type": "array", + "description": "List of order statuses that should be included in the feed. This should only be used in case `type` is `FromWorkflow`.", + "items": { + "type": "string", + "description": "Order status to be filtered in the feed." + } + }, + "expression": { + "type": "string", + "description": "JSONata query expression that defines what conditions must be met for an order to be included in the feed. This should only be used in case `type` is `FromOrders`." + }, + "disableSingleFire": { + "type": "boolean", + "description": "Sets a limit to how many times a specific order shows on the feed, after it first meets filtering conditions. Using the `FromOrders` type configuration with JSONata filtering expressions might cause orders to appear more than once on a feed, whenever changes are made to that order. If this field is `false` orders will appear in the feed only once." + } + } + }, + "queue": { + "type": "object", + "description": "Information that define the functioning of the queue.", + "properties": { + "visibilityTimeoutInSeconds": { + "type": "integer", + "description": "Period of time for which an item is not visible in the feed after it has been retrieved with the Get feed items request. Measured in seconds." + }, + "MessageRetentionPeriodInSeconds": { + "type": "integer", + "description": "Maximum life span of an order update after it gets to the feed. When a feed item is on the feed for this period of time, it is removed from the feed. Measured in seconds." + } + } + }, + "quantity": { + "type": "integer", + "description": "Current number of messages in the feed, including messages that may not be visible due to time out after retrieval." + }, + "approximateAgeOfOldestMessageInSeconds": { + "type": "number", + "description": "Aproximate age of the oldest message in the feed, measured in seconds." + } + } + }, + "example": { + "filter": { + "type": "FromOrders", + "expression": "status = \"payment-pending\"", + "disableSingleFire": false + }, + "queue": { + "visibilityTimeoutInSeconds": 240, + "messageRetentionPeriodInSeconds": 345600 + }, + "quantity": 127, + "approximateAgeOfOldestMessageInSeconds": 78.91597222222222 + } + } + } + } + } + }, + "post": { + "tags": ["Feed v3"], + "summary": "Create or update feed configuration", + "description": "The Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our [Feed v3 guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed) and our [order integration guide](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration)\n\r\n\rThere are two types of filtering that can be used. The `FromWorkflow` type filters orders by status, whereas the `FromOrders` type uses JSONata expressions to filter orders according to any property in the orders JSON document. This enables stores to filter delivered orders and orders in which products have been added or removed, for example. To learn more, access the [JSONata documentation](https://docs.jsonata.org/overview.html) and test filtering JSONata expressions with our [Test JSONata expression](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/expressions/jsonata) endpoint.", + "operationId": "FeedConfiguration", + "parameters": [ + { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", @@ -6729,305 +8181,1190 @@ } ] }, - "openTextField": null, - "roundingError": 0, - "orderFormId": "caae7471333e403f959fa5fd66951340", - "commercialConditionData": null, - "isCompleted": true, - "customData": null, - "storePreferencesData": { - "countryCode": "BRA", - "currencyCode": "BRL", - "currencyFormatInfo": { - "CurrencyDecimalDigits": 2, - "CurrencyDecimalSeparator": ",", - "CurrencyGroupSeparator": ".", - "CurrencyGroupSize": 3, - "StartsWithCurrencySymbol": true + "openTextField": null, + "roundingError": 0, + "orderFormId": "caae7471333e403f959fa5fd66951340", + "commercialConditionData": null, + "isCompleted": true, + "customData": null, + "storePreferencesData": { + "countryCode": "BRA", + "currencyCode": "BRL", + "currencyFormatInfo": { + "CurrencyDecimalDigits": 2, + "CurrencyDecimalSeparator": ",", + "CurrencyGroupSeparator": ".", + "CurrencyGroupSize": 3, + "StartsWithCurrencySymbol": true + }, + "currencyLocale": 1046, + "currencySymbol": "R$", + "timeZone": "E. South America Standard Time" + }, + "allowCancellation": true, + "allowEdition": false, + "isCheckedIn": false, + "marketplace": { + "baseURL": "http://oms.vtexinternal.com.br/api/oms?an=luxstore", + "isCertified": null, + "name": "luxstore" + }, + "authorizedDate": "2019-01-28T20:33:04+00:00", + "invoicedDate": null, + "cancelReason": "The size was too big.", + "itemMetadata": { + "Items": [ + { + "Id": "18", + "Seller": "1", + "Name": "Cat food", + "SkuName": "Cat food", + "ProductId": "6", + "RefId": "105", + "Ean": "43673557", + "ImageUrl": "http://store.vteximg.com.br/ids/155392-55-55/AlconKOI.jpg?v=635918402228600000", + "DetailUrl": "/catfood/p", + "AssemblyOptions": [ + { + "Id": "vtex.subscription.plan-ana", + "Name": "vtex.subscription.plan-ana", + "Required": false, + "InputValues": { + "vtex.subscription.key.frequency": { + "MaximumNumberOfCharacters": 8, + "Domain": [ + "4 month", + "1 month" + ] + } + }, + "Composition": {} + } + ] + } + ] + }, + "subscriptionData": { + "SubscriptionGroupId": "A64AC73C0FB8693A7ADB4AC69CA4FD5F", + "Subscriptions": [ + { + "ExecutionCount": 724, + "PriceAtSubscriptionDate": 100.0, + "ItemIndex": 0, + "Plan": { + "type": "RECURRING_PAYMENT", + "frequency": { + "periodicity": "DAILY", + "interval": 1 + }, + "validity": { + "begin": "2022-01-10T00:00:00.0000000+00:00", + "end": "2024-02-03T00:00:00.0000000+00:00" + } + } + } + ] + }, + "taxData": { + "areTaxesDesignatedByMarketplace": true, + "taxInfoCollection": [ + { + "itemIndex": 0, + "sku": "COLOCAR_O_SKUID", + "priceTags": [ + { + "isPercentual": false, + "name": "Taxes (Magazine Luisa)", + "rawValue": "COLOCAR_O_VALOR_SEM_DECIMAL" + } + ] + } + ] + }, + "checkedInPickupPointId": "storeNameExample_901", + "cancellationData": { + "RequestedByUser": true, + "RequestedBySystem": false, + "RequestedBySellerNotification": false, + "RequestedByPaymentNotification": false, + "Reason": "Item was too big in the client.", + "CancellationDate": "2022-10--05T15:40:33" + }, + "clientPreferencesData": { + "locale": "en-US", + "optinNewsLetter": false + } + } + } + } + } + } + } + }, + "/api/orders/expressions/jsonata": { + "post": { + "tags": ["Feed v3"], + "summary": "Test JSONata expression", + "description": "This endpoint allows you to test a JSON document with a JSONata expression, returning `true` if the document meets the criteria posed in the expression, or `false` if it does not.\n\r\n\rSince JSONata expressions can be used to filter order updates in the [Orders API feed and hook](https://developers.vtex.com/docs/guides/orders-feed), this endpoint can be used to test an expression's results before configuring the [feed or hook](https://developers.vtex.com/docs/guides/orders-feed).\n\r\n\rLearn more about how to use JSONata expressions, in the [JSONata documentation](https://docs.jsonata.org/overview.html).", + "operationId": "TestJSONataExpression", + "parameters": [ + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "Expression", + "Document" + ], + "properties": { + "Expression": { + "type": "string", + "description": "JSONata expression to be tested.", + "example": "status = \\\"canceled\\\"" + }, + "Document": { + "type": "string", + "description": "JSON document to be evaluated by the expression.", + "example": "{\\\"status\\\":\\\"canceled\\\"}" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "boolean", + "description": "Successful requests return the message `true`." + }, + "example": true + } + } + } + } + } + }, + "/api/checkout/pvt/configuration/window-to-change-seller": { + "get": { + "tags": ["Change seller"], + "summary": "Get window to change seller", + "description": "Retrieves a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rThe default period for this window is of 2 days, but it can be configured by the request Update window to change seller.", + "operationId": "GetWindowToChangeSeller", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "integer", + "description": "Successful requests return the window to change seller value measured in days." + }, + "example": 2 + } + } + } + } + }, + "post": { + "tags": ["Change seller"], + "summary": "Update window to change seller", + "description": "Updates a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rIt is possible to check the current window using the request Get window to change seller.", + "operationId": "UpdateWindowToChangeSeller", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "waitingTime" + ], + "properties": { + "waitingTime": { + "type": "integer", + "description": "Number of days after order cancelation by a seller, during which another seller may be assigned to fulfill the order.", + "example": 4 + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Created" + } + } + } + }, + "/api/order-system/orders/{changeOrderId}/changes": { + "patch": { + "tags": [ + "Change order (beta)" + ], + "summary": "Create order change", + "operationId": "Createchange", + "description": "[Change order](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) feature allows you to modify an order, whether the change is motivated by customer mistakes, product unavailability, or others. Both sellers and marketplaces can use this endpoint and change orders in multiple scenarios, and it is possible to make a single change or combine multiple ones in the same request. \r\nThe possible change order operations you can perform are the following:\r\n- **Add:** Adding items, quantity, or product weight.\r\n- **Remove:** Removing a part of items or the total quantity.\r\n- **Replace:** Changing items' quantity, weight, or price. You can also replace one or more items with different ones, including weighable products.\r\n\r\n>❗ When removing or adding items to an order, your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) is not automatically updated. You can use the [Update inventory by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#put-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-) endpoint.\r\n\r\nThe next sections are listed below:\r\n- Number of changes per order \r\n- Acceptable order status for changes \r\n- Order change and price \r\n- Combining multiples operations \r\n\r\n## Number of changes per order\r\nBesides being able to combine multiple change operations - add, remove, and replace - in a single request, you can make different change requests, and there is no limit to how many times an order can be changed.\r\n\r\nEach order has its change history, you can retrieve it using the [Get order change history](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n## Acceptable order status for changes\r\nYou can only change an order when it is one of the following [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) status:\r\n- `handling`\r\n- `waiting-for-fulfillment` \r\n- `ready for invoicing` \r\n\r\nIt is not possible to change an order when the payment transaction is complete.\r\n\r\n## Order change and price\r\nWhen you add, remove or replace items using this endpoint, the order and payment transaction values are automatically updated. Change order calculates the update of the following values:\r\n- Item value\r\n- Total value \r\n\r\n**Example:** If you send the request body for replacing items without the unit multiplier (`unitMultiplier`) or measurement (`measurementUnit`), Change order will get this information on your store's Catalog, Pricing and Payment systems. \r\n>⚠️ Increasing the price of an order is allowed only when the order was paid by credit card, [payable notes](https:/help.vtex.com/en/tutorial/setting-up-payments-with-promissory--5pW7avTwtyQcMu4uiW8quQ), cash, or [credit control](https:/help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0). In addition, the [acquirer](https:/help.vtex.com/en/tutorial/what-is-an-acquirer--7N1oRTG8dGmOiIugC0cs4E) must allow transactions without the CVV code and two charging transactions in the same order. \r\n\r\nFor order changes with discounts, Order Management System (OMS) considers that you still can change the order's transactional value, as long as its status in Transaction Details is not `Finished`. \r\n\r\n## Order change and payment transaction flow \r\n\r\nAn order's [transaction flow](https://help.vtex.com/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/1xjzgJZvqwaI1rfxLMCC3Y) goes through various payment statuses before its conclusion. Within certain conditions, it is possible to change settled orders. The requirements are the following:\r\n\r\n- The order's [payment method](https://help.vtex.com/en/tutorial/difference-between-payment-methods-and-payment-conditions--3azJenhGFyUy2gsocms42Q) is a credit card.\r\n- The settlement occurs before the order is invoiced.\r\n- The payment connector is configured to allow partial refunds.\r\n\r\n> Currently, [Adyen](https://help.vtex.com/en/tutorial/configuring-payment-with-adyenv3--7xAz67E2Eg63LWCQNjVdwv) is the only payment connector that supports that operation.\r\n\r\nIf the order change increases or decreases the cost for the customer, the platform has the following behavior:\r\n\r\n- **Smaller price after order change:** An automatic notification is sent to the payment [gateway](https://help.vtex.com/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/kdPbEIWf8Xq8tESQvViMB#gateway) to reimburse the customer for the difference.\r\n- **Higher price after order change:** An automatic notification is sent to the payment gateway to require the customer to pay for the additional cost.\r\n\r\n## Combining multiples operations\r\nYou can use this endpoint to make a single change operation or combine them in the same request. See some examples below.\r\n\r\n### Add request body example:\r\n\r\n```json\r\n{\r\n \"add\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n### Remove request body example:\r\n\r\n```json\r\n{\r\n \"reason\": \"The client wants to remove a product.\",\r\n \"remove\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 2,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n### Replace request body example:\r\n```json\r\n{\r\n \"reason\": \"The client wants to increase the product weight.\",\r\n \"replace\": [\r\n {\r\n \"from\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1\r\n }\r\n ]\r\n },\r\n \"to\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"kg\",\r\n \"unitMultiplier\": 1.0\r\n }\r\n ],\r\n \"shippingData\": {\r\n \"logisticsInfo\": [\r\n {\r\n \"itemIndex\": 0,\r\n \"slaId\": \"Normal\",\r\n \"deliveryChannel\": \"delivery\",\r\n \"addressId\": \"12334048475146857\",\r\n \"price\": 1000\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n ]\r\n}\r\n```\r\n\r\n\r\n### Add, remove and replace request body example:\r\n\r\n\r\n```json\r\n{\r\n \"reason\": \"The client wants to add, remove and replace a weighable product.\",\r\n \"manualDiscountValue\": 0,\r\n \"add\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n },\r\n \"remove\": {\r\n \"items\": [\r\n {\r\n \"id\": \"31\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n },\r\n \"replace\": [\r\n {\r\n \"from\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1\r\n }\r\n ]\r\n },\r\n \"to\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"kg\",\r\n \"unitMultiplier\": 1.0\r\n }\r\n ],\r\n \"shippingData\": {\r\n \"logisticsInfo\": [\r\n {\r\n \"itemIndex\": 0,\r\n \"slaId\": \"Normal\",\r\n \"deliveryChannel\": \"delivery\",\r\n \"addressId\": \"12334048475146857\",\r\n \"price\": 1000\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n ]\r\n}\r\n```\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", + "parameters": [ + { + "name": "an", + "in": "query", + "description": "Name of the VTEX account that created the order.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "storeName" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "changeOrderId", + "in": "path", + "description": "Order ID of the order you wish to change.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "v12772213qst-02" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Createchange" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/response202" + }, + "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 }, - "currencyLocale": 1046, - "currencySymbol": "R$", - "timeZone": "E. South America Standard Time" - }, - "allowCancellation": true, - "allowEdition": false, - "isCheckedIn": false, - "marketplace": { - "baseURL": "http://oms.vtexinternal.com.br/api/oms?an=luxstore", - "isCertified": null, - "name": "luxstore" - }, - "authorizedDate": "2019-01-28T20:33:04+00:00", - "invoicedDate": null, - "cancelReason": "The size was too big.", - "itemMetadata": { - "Items": [ - { - "Id": "18", - "Seller": "1", - "Name": "Cat food", - "SkuName": "Cat food", - "ProductId": "6", - "RefId": "105", - "Ean": "43673557", - "ImageUrl": "http://store.vteximg.com.br/ids/155392-55-55/AlconKOI.jpg?v=635918402228600000", - "DetailUrl": "/catfood/p", - "AssemblyOptions": [ - { - "Id": "vtex.subscription.plan-ana", - "Name": "vtex.subscription.plan-ana", - "Required": false, - "InputValues": { - "vtex.subscription.key.frequency": { - "MaximumNumberOfCharacters": 8, - "Domain": [ - "4 month", - "1 month" - ] - } - }, - "Composition": {} - } - ] - } - ] - }, - "subscriptionData": { - "SubscriptionGroupId": "A64AC73C0FB8693A7ADB4AC69CA4FD5F", - "Subscriptions": [ - { - "ExecutionCount": 724, - "PriceAtSubscriptionDate": 100.0, - "ItemIndex": 0, - "Plan": { - "type": "RECURRING_PAYMENT", - "frequency": { - "periodicity": "DAILY", - "interval": 1 - }, - "validity": { - "begin": "2022-01-10T00:00:00.0000000+00:00", - "end": "2024-02-03T00:00:00.0000000+00:00" - } - } - } - ] - }, - "taxData": { - "areTaxesDesignatedByMarketplace": true, - "taxInfoCollection": [ - { - "itemIndex": 0, - "sku": "COLOCAR_O_SKUID", - "priceTags": [ - { - "isPercentual": false, - "name": "Taxes (Magazine Luisa)", - "rawValue": "COLOCAR_O_VALOR_SEM_DECIMAL" - } - ] - } - ] - }, - "checkedInPickupPointId": "storeNameExample_901", - "cancellationData": { - "RequestedByUser": true, - "RequestedBySystem": false, - "RequestedBySellerNotification": false, - "RequestedByPaymentNotification": false, - "Reason": "Item was too big in the client.", - "CancellationDate": "2022-10--05T15:40:33" + "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 }, - "clientPreferencesData": { - "locale": "en-US", - "optinNewsLetter": false - } - } + "pickupDistance": null + } + ] + } } + } + ], + "date": "2023-07-27T17:52:18.6483116Z", + "origin": { + "account": "qastore", + "orderId": "v12772213qst-02", + "component": "MarketplaceComponent" + }, + "settings": { + "customPaymentSystemsAllowed": [ + "201" + ] } + } } + } } - } - }, - "/api/orders/expressions/jsonata": { - "post": { - "tags": ["Feed v3"], - "summary": "Test JSONata expression", - "description": "This endpoint allows you to test a JSON document with a JSONata expression, returning `true` if the document meets the criteria posed in the expression, or `false` if it does not.\n\r\n\rSince JSONata expressions can be used to filter order updates in the [Orders API feed and hook](https://developers.vtex.com/docs/guides/orders-feed), this endpoint can be used to test an expression's results before configuring the [feed or hook](https://developers.vtex.com/docs/guides/orders-feed).\n\r\n\rLearn more about how to use JSONata expressions, in the [JSONata documentation](https://docs.jsonata.org/overview.html).", - "operationId": "TestJSONataExpression", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", + } + }, + "get": { + "tags": [ + "Change order (beta)" + ], + "summary": "Get order change history", + "operationId": "GetChangeHistory", + "description": "This endpoint retrieves a history of every successful [Change order request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) made to an order and provides detailed information about each request.\r\n\r\nYou can access an order's history using the `changeOrderId`, which corresponds to its `orderId`.\r\n\r\n> If you want detailed information about a single change request, you can use the endpoint [Get order change details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:/developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", + "parameters": [ + { + "name": "an", + "in": "query", + "description": "Name of the VTEX account that created the order.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "storeName" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "changeOrderId", + "in": "path", + "description": "Order ID of the order you wish to get the change history.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "v12772213qst-02" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "requests", + "actions" + ], + "properties": { + "requests": { + "type": "array", + "description": "Array with change order requests details.", + "items": { "required": [ - "Expression", - "Document" + "requestId", + "workflowId", + "reason", + "manualDiscountValue", + "manualIncrementValue", + "totalChangeValue", + "totals", + "add", + "remove", + "replace", + "date", + "origin", + "settings" ], + "type": "object", + "description": "Information about each change order request.", "properties": { - "Expression": { - "type": "string", - "description": "JSONata expression to be tested.", - "example": "status = \\\"canceled\\\"" - }, - "Document": { - "type": "string", - "description": "JSON document to be evaluated by the expression.", - "example": "{\\\"status\\\":\\\"canceled\\\"}" + "requestId": { + "type": "string", + "description": "Unique code that identifies an order change." + }, + "workflowId": { + "type": "string", + "description": "Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." + }, + "reason": { + "type": "string", + "description": "Reason that motivated the order change." + }, + "manualDiscountValue": { + "type": "integer", + "description": "This field shows if it was applied a manual price for the total order amount. The value is in cents." + }, + "manualIncrementValue": { + "type": "integer", + "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." + }, + "totalChangeValue": { + "type": "integer", + "description": "This field shows how much the order total price is, considering that price changes might have been made. The value is in cents." + }, + "totals": { + "type": "array", + "description": "Array containing total costs information.", + "items": { + "type": "object", + "description": "Total changing price details for a given type of cost.", + "properties": { + "id": { + "type": "string", + "description": "Changing price type, for example the item price or shipping costs." + }, + "name": { + "type": "string", + "description": "Changing price name." + }, + "value": { + "type": "number", + "description": "Changing price value in cents." + } + } } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean", - "description": "Successful requests return the message `true`." - }, - "example": true + }, + "add": { + "type": "object", + "nullable": true, + "description": "Information about an `add` operation, when there was one. It will have the same schema of `request.replace.to`." + }, + "remove": { + "type": "object", + "nullable": true, + "description": "Information about a `remove` operation, when there was one. It will have the same schema of `request.replace.from`." + }, + "replace": { + "type": "array", + "description": "Array with information about the replacement operation performed.", + "items": { + "type": "object", + "description": "Replacing operation object.", + "required": [ + "from", + "to" + ], + "properties": { + "from": { + "$ref": "#/components/schemas/From2" + }, + "to": { + "$ref": "#/components/schemas/To2" + } + } + } + }, + "date": { + "type": "string", + "description": "Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`." + }, + "origin": { + "$ref": "#/components/schemas/OriginV2" + }, + "settings": { + "$ref": "#/components/schemas/Settings" + } + } + } + }, + "actions": { + "type": "array", + "description": "Array containing previous changing order actions history.", + "items": { + "type": "object", + "description": "Changing order action details, with a schema like the `requests` property.", + "nullable": true } + } } - } - } - } - }, - "/api/checkout/pvt/configuration/window-to-change-seller": { - "get": { - "tags": ["Change seller"], - "summary": "Get window to change seller", - "description": "Retrieves a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rThe default period for this window is of 2 days, but it can be configured by the request Update window to change seller.", - "operationId": "GetWindowToChangeSeller", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "integer", - "description": "Successful requests return the window to change seller value measured in days." + }, + "example": { + "requests": [ + { + "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": [ + { + "id": "ManualValues", + "name": "Manual Values Total", + "value": -1000 + } + ], + "add": null, + "remove": null, + "replace": [ + { + "from": { + "paymentData": { + "transactions": [] + }, + "items": [ + { + "id": "31", + "quantity": 1, + "price": 5000, + "measurementUnit": "un", + "unitMultiplier": 1, + "sellingPrice": 5000, + "name": "Small toy", + "detailUrl": "/small-toy-24/p", + "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" + } + ], + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "DeliverClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 180, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Pickup", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "31", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 180, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 180, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } }, - "example": 2 - } - } - } - } - }, - "post": { - "tags": ["Change seller"], - "summary": "Update window to change seller", - "description": "Updates a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rIt is possible to check the current window using the request Get window to change seller.", - "operationId": "UpdateWindowToChangeSeller", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "waitingTime" - ], - "properties": { - "waitingTime": { - "type": "integer", - "description": "Number of days after order cancelation by a seller, during which another seller may be assigned to fulfill the order.", - "example": 4 + "to": { + "items": [ + { + "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", + "id": "1", + "productId": "1", + "productRefId": "", + "refId": "codrefxicaraazul", + "ean": "8745121641", + "name": "Blue cup", + "skuName": "cup", + "modalType": null, + "parentItemIndex": null, + "parentAssemblyBinding": null, + "assemblies": [], + "priceValidUntil": null, + "tax": 0, + "price": 5000, + "listPrice": null, + "manualPrice": null, + "manualPriceAppliedBy": null, + "sellingPrice": 5000, + "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": "/1/", + "productCategories": { + "1": "Category" + }, + "quantity": 1, + "seller": "1", + "sellerChain": [ + "1" + ], + "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", + "detailUrl": "/xicara/p", + "components": [], + "bundleItems": [], + "attachments": [], + "attachmentOfferings": [], + "offerings": [], + "priceTags": [], + "availability": null, + "measurementUnit": "un", + "unitMultiplier": 1, + "manufacturerCode": null, + "priceDefinition": { + "calculatedSellingPrice": 5000, + "total": 5000, + "sellingPrices": [ + { + "value": 5000, + "quantity": 1 + } + ] + } } + ], + "paymentData": { + "transactions": [] + }, + "receiptData": null, + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 600, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Pickup", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "1", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 600, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 600, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } } + } + ], + "date": "2024-07-27T17:52:18.6483116Z", + "origin": { + "account": "qastore", + "orderId": "v12772213qst-02", + "component": "MarketplaceComponent" + }, + "settings": { + "customPaymentSystemsAllowed": [ + "201" + ] } - } - } - }, - "responses": { - "201": { - "description": "Created" + } + ], + "actions": [] + } } + } } + } } - }, - "/api/order-system/orders/{changeOrderId}/changes": { - "patch": { + }, + "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}": { + "get": { "tags": [ "Change order (beta)" ], - "summary": "Create order change", - "operationId": "Createchange", - "description": "[Change order](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) feature allows you to modify an order, whether the change is motivated by customer mistakes, product unavailability, or others. Both sellers and marketplaces can use this endpoint and change orders in multiple scenarios, and it is possible to make a single change or combine multiple ones in the same request. \r\nThe possible change order operations you can perform are the following:\r\n- **Add:** Adding items, quantity, or product weight.\r\n- **Remove:** Removing a part of items or the total quantity.\r\n- **Replace:** Changing items' quantity, weight, or price. You can also replace one or more items with different ones, including weighable products.\r\n\r\n>❗ When removing or adding items to an order, your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) is not automatically updated. You can use the [Update inventory by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#put-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-) endpoint.\r\n\r\nThe next sections are listed below:\r\n- Number of changes per order \r\n- Acceptable order status for changes \r\n- Order change and price \r\n- Combining multiples operations \r\n\r\n## Number of changes per order\r\nBesides being able to combine multiple change operations - add, remove, and replace - in a single request, you can make different change requests, and there is no limit to how many times an order can be changed.\r\n\r\nEach order has its change history, you can retrieve it using the [Get order change history](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n## Acceptable order status for changes\r\nYou can only change an order when it is one of the following [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) status:\r\n- `handling`\r\n- `waiting-for-fulfillment` \r\n- `ready for invoicing` \r\n\r\nIt is not possible to change an order when the payment transaction is complete.\r\n\r\n## Order change and price\r\nWhen you add, remove or replace items using this endpoint, the order and payment transaction values are automatically updated. Change order calculates the update of the following values:\r\n- Item value\r\n- Total value \r\n\r\n**Example:** If you send the request body for replacing items without the unit multiplier (`unitMultiplier`) or measurement (`measurementUnit`), Change order will get this information on your store's Catalog, Pricing and Payment systems. \r\n>⚠️ Increasing the price of an order is allowed only when the order was paid by credit card, [payable notes](https:/help.vtex.com/en/tutorial/setting-up-payments-with-promissory--5pW7avTwtyQcMu4uiW8quQ), cash, or [credit control](https:/help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0). In addition, the [acquirer](https:/help.vtex.com/en/tutorial/what-is-an-acquirer--7N1oRTG8dGmOiIugC0cs4E) must allow transactions without the CVV code and two charging transactions in the same order. \r\n\r\nFor order changes with discounts, Order Management System (OMS) considers that you still can change the order's transactional value, as long as its status in Transaction Details is not `Finished`. \r\n\r\n## Order change and payment transaction flow \r\n\r\nAn order's [transaction flow](https://help.vtex.com/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/1xjzgJZvqwaI1rfxLMCC3Y) goes through various payment statuses before its conclusion. Within certain conditions, it is possible to change settled orders. The requirements are the following:\r\n\r\n- The order's [payment method](https://help.vtex.com/en/tutorial/difference-between-payment-methods-and-payment-conditions--3azJenhGFyUy2gsocms42Q) is a credit card.\r\n- The settlement occurs before the order is invoiced.\r\n- The payment connector is configured to allow partial refunds.\r\n\r\n> Currently, [Adyen](https://help.vtex.com/en/tutorial/configuring-payment-with-adyenv3--7xAz67E2Eg63LWCQNjVdwv) is the only payment connector that supports that operation.\r\n\r\nIf the order change increases or decreases the cost for the customer, the platform has the following behavior:\r\n\r\n- **Smaller price after order change:** An automatic notification is sent to the payment [gateway](https://help.vtex.com/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/kdPbEIWf8Xq8tESQvViMB#gateway) to reimburse the customer for the difference.\r\n- **Higher price after order change:** An automatic notification is sent to the payment gateway to require the customer to pay for the additional cost.\r\n\r\n## Combining multiples operations\r\nYou can use this endpoint to make a single change operation or combine them in the same request. See some examples below.\r\n\r\n### Add request body example:\r\n\r\n```json\r\n{\r\n \"add\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n### Remove request body example:\r\n\r\n```json\r\n{\r\n \"reason\": \"The client wants to remove a product.\",\r\n \"remove\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 2,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n### Replace request body example:\r\n```json\r\n{\r\n \"reason\": \"The client wants to increase the product weight.\",\r\n \"replace\": [\r\n {\r\n \"from\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1\r\n }\r\n ]\r\n },\r\n \"to\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"kg\",\r\n \"unitMultiplier\": 1.0\r\n }\r\n ],\r\n \"shippingData\": {\r\n \"logisticsInfo\": [\r\n {\r\n \"itemIndex\": 0,\r\n \"slaId\": \"Normal\",\r\n \"deliveryChannel\": \"delivery\",\r\n \"addressId\": \"12334048475146857\",\r\n \"price\": 1000\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n ]\r\n}\r\n```\r\n\r\n\r\n### Add, remove and replace request body example:\r\n\r\n\r\n```json\r\n{\r\n \"reason\": \"The client wants to add, remove and replace a weighable product.\",\r\n \"manualDiscountValue\": 0,\r\n \"add\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n },\r\n \"remove\": {\r\n \"items\": [\r\n {\r\n \"id\": \"31\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n },\r\n \"replace\": [\r\n {\r\n \"from\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1\r\n }\r\n ]\r\n },\r\n \"to\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"kg\",\r\n \"unitMultiplier\": 1.0\r\n }\r\n ],\r\n \"shippingData\": {\r\n \"logisticsInfo\": [\r\n {\r\n \"itemIndex\": 0,\r\n \"slaId\": \"Normal\",\r\n \"deliveryChannel\": \"delivery\",\r\n \"addressId\": \"12334048475146857\",\r\n \"price\": 1000\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n ]\r\n}\r\n```\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", + "summary": "Get order change details", + "description": "This endpoint retrieves detailed information about a specific order change. So after creating multiple changes, you can get information on each one of them by its `changeRequestId`, the unique identification code generated by the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\nThe successful status code is `200 OK`, and its response body schema is very similar to the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint, with some additional fields:\r\n\r\n- `status`: The change request status in the workflow, which progresses in the following order:\r\n - `waiting-acknowledgement`\r\n - `waiting-confirmation`\r\n - `done`\r\n - `canceled`\r\n\r\n- `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.\r\n\r\n- `logs`: Lists the workflow processing logs.\r\n\r\n> If you want information about all the changes made to an order, use the [Get order change history](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", + "operationId": "GetChangeDetail", "parameters": [ { "name": "an", @@ -7066,215 +9403,596 @@ { "name": "changeOrderId", "in": "path", - "description": "Order ID of the order you wish to change.", + "description": "Order ID of the order you wish to get the change detail.", "required": true, "style": "simple", "schema": { "type": "string", "example": "v12772213qst-02" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Createchange" - } + }, + { + "name": "changeRequestId", + "in": "path", + "description": "Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code. There are no limits to changes you can perform using the same `changeRequestId`, and we recommend keeping all changes of a given order grouped by the same `changeRequestId`, so you will have a unified change history.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" } } - }, + ], "responses": { - "202": { - "description": "Accepted", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/response202" - }, - "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 + "required": [ + "requestId", + "workflowId", + "status", + "inProgress", + "reason", + "manualDiscountValue", + "manualIncrementValue", + "totalChangeValue", + "totals", + "add", + "remove", + "replace", + "date", + "origin", + "settings" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "Unique code that identifies a change order request." + }, + "workflowId": { + "type": "string", + "description": "Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." + }, + "status": { + "type": "string", + "description": "Order status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." + }, + "inProgress": { + "type": "boolean", + "description": "When set as `true`, the order is still progressing in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196), when set as `false`, it is complete, whether by cancellation or because the customer received it." + }, + "reason": { + "type": "string", + "description": "Reason that motivated the order change." + }, + "manualDiscountValue": { + "type": "integer", + "description": "This field shows if a manual price was applied to the total order amount. The value is in cents." + }, + "manualIncrementValue": { + "type": "integer", + "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." + }, + "totalChangeValue": { + "type": "integer", + "description": "This field shows how much is the order total price considering that price changes might have been made. The value is in cents." + }, + "totals": { + "type": "array", + "description": "Array containing total costs information.", + "items": { + "type": "object", + "description": "Total changing price details for a given type of cost.", + "properties": { + "id": { + "type": "string", + "description": "Changing price type, for example the item price or shipping costs." + }, + "name": { + "type": "string", + "description": "Changing price name." + }, + "value": { + "type": "number", + "description": "Changing price value in cents." + } } - ], - "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 + } + }, + "add": { + "type": "array", + "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", + "nullable": true, + "items": { + "type": "string", + "description": "Adding operation information, when applicable." + } + }, + "remove": { + "type": "array", + "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", + "nullable": true, + "items": { + "type": "string", + "description": "Removing operation information, when applicable." + } + }, + "replace": { + "type": "array", + "description": "Array with information about the `replace` operation, when applicable.", + "items": { + "$ref": "#/components/schemas/Replace1" + } + }, + "date": { + "type": "string", + "description": "Date and time of the request in UTC ISO 8601 format, as in `yyyy-mm-ddThh:mm:ss.sssZ`." + }, + "origin": { + "$ref": "#/components/schemas/OriginV2" + }, + "settings": { + "$ref": "#/components/schemas/Settings" + } + } + }, + "example": { + "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", + "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", + "status": "done", + "inProgress": false, + "reason": "The client did not like the size.", + "manualDiscountValue": 0, + "manualIncrementValue": 0, + "totalChangeValue": 0, + "totals": [ + { + "id": "ManualValues", + "name": "Manual Values Total", + "value": -1000 + } + ], + "add": null, + "remove": null, + "replace": [ + { + "from": { + "paymentData": { + "transactions": [] }, - "preSaleDate": null, - "productCategoryIds": null, - "productCategories": {}, - "quantity": 1, - "seller": null, - "sellerChain": [ - null + "items": [ + { + "id": "31", + "quantity": 1, + "price": 5000, + "measurementUnit": "un", + "unitMultiplier": 1, + "sellingPrice": 5000, + "name": "Small toy", + "detailUrl": "/small-toy-24/p", + "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" + } + ], + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "DeliverClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 180, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Pickup", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "31", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 180, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 180, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + }, + "to": { + "items": [ + { + "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", + "id": "1", + "productId": "1", + "productRefId": "", + "refId": "codrefxicaraazul", + "ean": "8745121641", + "name": "Blue cup", + "skuName": "cup", + "modalType": null, + "parentItemIndex": null, + "parentAssemblyBinding": null, + "assemblies": [], + "priceValidUntil": null, + "tax": 0, + "price": 5000, + "listPrice": null, + "manualPrice": null, + "manualPriceAppliedBy": null, + "sellingPrice": 5000, + "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": "/1/", + "productCategories": { + "1": "Category" + }, + "quantity": 1, + "seller": "1", + "sellerChain": [ + "1" + ], + "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", + "detailUrl": "/xicara/p", + "components": [], + "bundleItems": [], + "attachments": [], + "attachmentOfferings": [], + "offerings": [], + "priceTags": [], + "availability": null, + "measurementUnit": "un", + "unitMultiplier": 1, + "manufacturerCode": null, + "priceDefinition": { + "calculatedSellingPrice": 5000, + "total": 5000, + "sellingPrices": [ + { + "value": 5000, + "quantity": 1 + } + ] + } + } ], - "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": [ + "paymentData": { + "transactions": [] + }, + "receiptData": null, + "shippingData": { + "logisticsInfo": [ { - "id": "Lenta", - "deliveryChannel": "delivery", - "name": "Lenta", - "deliveryIds": [], - "shippingEstimate": null, - "shippingEstimateDate": null, - "lockTTL": null, - "availableDeliveryWindows": [], - "deliveryWindow": null, + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 600, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Pickup", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "1", + "deliveryChannels": [ + { + "id": "delivery" + } + ], "price": 600, - "listPrice": 600, - "tax": 0, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 600, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, "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": [ - "201" - ] + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + } + } + ], + "date": "2024-07-27T17:52:18.6483116Z", + "origin": { + "account": "qastore", + "orderId": "v12772213qst-02", + "component": "MarketplaceComponent" + }, + "settings": { + "customPaymentSystemsAllowed": [ + "201" + ] + } } - } } } } } - }, - "get": { + } + }, + "/api/order-system/orders/{changeOrderId}/changes/preview": { + "post": { "tags": [ "Change order (beta)" ], - "summary": "Get order change history", - "operationId": "GetChangeHistory", - "description": "This endpoint retrieves a history of every successful [Change order request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) made to an order and provides detailed information about each request.\r\n\r\nYou can access an order's history using the `changeOrderId`, which corresponds to its `orderId`.\r\n\r\n> If you want detailed information about a single change request, you can use the endpoint [Get order change details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:/developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", + "summary": "Preview order change", + "operationId": "PreviewChange", + "description": "This endpoint allows you to simulate an order change and preview what the real change will look like if you use the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint. A preview is especially useful for more complex scenarios, such as orders with multiple items and combinations of change operations — add, remove, and replace. Ensuring you get the desired results before making the actual change helps prevent mistakes.\r\n\r\nThe request body is the same one to be used in the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint, and the response body of a successful request provides a preview of the change order effect.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", "parameters": [ { "name": "an", @@ -7313,7 +10031,7 @@ { "name": "changeOrderId", "in": "path", - "description": "Order ID of the order you wish to get the change history.", + "description": "Order ID of the order you wish to preview change.", "required": true, "style": "simple", "schema": { @@ -7322,6 +10040,34 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "required": [ + "reason", + "replace" + ], + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "Reason why you wish to change order. Since you can make several changes to an order, filling this field with a clear explanation helps organize the change order history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).", + "example": "The client wants to change a weighable product." + + }, + "replace": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Replace" + }, + "description": "Name of the change operation you are performing, which can be `replace`, `add` or `remove`. If you want, you can combine all change operations in a single request." + } + } + } + } + } + }, "responses": { "200": { "description": "OK", @@ -7330,315 +10076,246 @@ "schema": { "type": "object", "required": [ - "requests", - "actions" + "reason", + "manualDiscountValue", + "manualIncrementValue", + "totalChangeValue", + "totals", + "add", + "remove", + "replace", + "date", + "origin", + "settings" ], "properties": { - "requests": { + "reason": { + "type": "string", + "description": "Reason why you wish to change order. Since you can make several changes to an order, filling this field with a clear explanation helps organize the change order history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh)." + }, + "manualDiscountValue": { + "type": "integer", + "description": "This field shows if a manual price was applied to the total order amount. The value is in cents." + }, + "manualIncrementValue": { + "type": "integer", + "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." + }, + "totalChangeValue": { + "type": "integer", + "description": "This field shows how much is the order total price considering that price changes might have been made. The value is in cents." + }, + "totals": { "type": "array", - "description": "Array with change order requests details.", + "description": "Array containing total costs information.", "items": { - "required": [ - "requestId", - "workflowId", - "reason", - "manualDiscountValue", - "manualIncrementValue", - "totalChangeValue", - "totals", - "add", - "remove", - "replace", - "date", - "origin", - "settings" - ], "type": "object", - "description": "Information about each change order request.", + "description": "Total changing price details for a given type of cost.", "properties": { - "requestId": { - "type": "string", - "description": "Unique code that identifies an order change." - }, - "workflowId": { - "type": "string", - "description": "Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." - }, - "reason": { - "type": "string", - "description": "Reason that motivated the order change." - }, - "manualDiscountValue": { - "type": "integer", - "description": "This field shows if it was applied a manual price for the total order amount. The value is in cents." - }, - "manualIncrementValue": { - "type": "integer", - "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." - }, - "totalChangeValue": { - "type": "integer", - "description": "This field shows how much the order total price is, considering that price changes might have been made. The value is in cents." - }, - "totals": { - "type": "array", - "description": "Array containing total costs information.", - "items": { - "type": "object", - "description": "Total changing price details for a given type of cost.", - "properties": { - "id": { - "type": "string", - "description": "Changing price type, for example the item price or shipping costs." - }, - "name": { - "type": "string", - "description": "Changing price name." - }, - "value": { - "type": "number", - "description": "Changing price value in cents." - } - } + "id": { + "type": "string", + "description": "Changing price type, for example the item price or shipping costs." + }, + "name": { + "type": "string", + "description": "Changing price name." + }, + "value": { + "type": "number", + "description": "Changing price value in cents." } - }, - "add": { - "type": "object", - "nullable": true, - "description": "Information about an `add` operation, when there was one. It will have the same schema of `request.replace.to`." - }, - "remove": { - "type": "object", - "nullable": true, - "description": "Information about a `remove` operation, when there was one. It will have the same schema of `request.replace.from`." - }, - "replace": { - "type": "array", - "description": "Array with information about the replacement operation performed.", - "items": { - "type": "object", - "description": "Replacing operation object.", - "required": [ - "from", - "to" - ], - "properties": { - "from": { - "$ref": "#/components/schemas/From2" - }, - "to": { - "$ref": "#/components/schemas/To2" - } - } - } - }, - "date": { - "type": "string", - "description": "Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`." - }, - "origin": { - "$ref": "#/components/schemas/OriginV2" - }, - "settings": { - "$ref": "#/components/schemas/Settings" - } } - } + } }, - "actions": { + "add": { "type": "array", - "description": "Array containing previous changing order actions history.", + "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", + "nullable": true, "items": { - "type": "object", - "description": "Changing order action details, with a schema like the `requests` property.", - "nullable": true + "type": "string", + "description": "Adding operation information, when applicable." } + }, + "remove": { + "type": "array", + "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", + "nullable": true, + "items": { + "type": "string", + "description": "Removing operation information, when applicable." + } + }, + "replace": { + "type": "array", + "description": "Array with information about the `replace` operation, when applicable.", + "items": { + "type": "object", + "description": "Replacing operation object.", + "required": [ + "from", + "to" + ], + "properties": { + "from": { + "$ref": "#/components/schemas/From2" + }, + "to": { + "$ref": "#/components/schemas/To2" + } + } + } + }, + "date": { + "type": "string", + "description": "Date and time of the request in UTC ISO 8601 format, as in `yyyy-mm-ddThh:mm:ss.sssZ`." + }, + "origin": { + "$ref": "#/components/schemas/OriginV2" + }, + "settings": { + "$ref": "#/components/schemas/Settings" } } }, "example": { - "requests": [ + "reason": "I would like to receive a preview.", + "manualDiscountValue": 0, + "manualIncrementValue": 0, + "totalChangeValue": 420, + "totals": [ { - "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": [ + "id": "ManualValues", + "name": "Manual Values Total", + "value": 0 + }, + { + "id": "Shipping", + "name": "Shipping Total", + "value": 420 + } + ], + "add": null, + "remove": null, + "replace": [ + { + "from": { + "paymentData": { + "transactions": [] + }, + "items": [ { - "id": "ManualValues", - "name": "Manual Values Total", - "value": -1000 + "id": "31", + "quantity": 1, + "price": 5000, + "measurementUnit": "un", + "unitMultiplier": 1, + "sellingPrice": 5000, + "name": "Small toy", + "detailUrl": "/small-toy-24/p", + "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" } - ], - "add": null, - "remove": null, - "replace": [ - { - "from": { - "paymentData": { - "transactions": [] - }, - "items": [ - { - "id": "31", - "quantity": 1, - "price": 5000, - "measurementUnit": "un", - "unitMultiplier": 1, - "sellingPrice": 5000, - "name": "Small toy", - "detailUrl": "/small-toy-24/p", - "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" - } - ], - "shippingData": { - "logisticsInfo": [ + ], + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ { - "itemIndex": 0, - "selectedSla": "Economic", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ - { - "id": "Economic", - "deliveryChannel": "delivery", - "name": "Economic", - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "DeliverClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 180, - "listPrice": 180, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - }, - { - "id": "Normal", - "deliveryChannel": "delivery", - "name": "Normal", - "deliveryIds": [ - { - "courierId": "1", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "CourierClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "3bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 500, - "listPrice": 500, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "3bd" - }, + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ { - "id": "Pickup", - "deliveryChannel": "delivery", - "name": "Pickup", - "deliveryIds": [ - { - "courierId": "ech018654", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Pickup", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 700, - "listPrice": 700, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "DeliverClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null } ], - "shipsTo": [ - "BRA" - ], - "itemId": "31", - "deliveryChannels": [ + "shippingEstimate": "25bd", + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 180, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ { - "id": "delivery" + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null } ], - "price": 180, - "listPrice": 180, - "shippingEstimate": "25bd", - "dockEstimate": null, - "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "shippingEstimate": "3bd", + "shippingEstimateDate": null, "lockTTL": "12d", - "deliveryCompany": null, + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, "polygonName": "", - "transitTime": "25bd", - "sellingPrice": 180, + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", "deliveryIds": [ { - "courierId": "1c083bf", + "courierId": "ech018654", "warehouseId": "1_1", "dockId": "1", - "courierName": "CourierClass", + "courierName": "Pickup", "quantity": 1, - "kitItemDetails": null, - "accountCarrierName": "qastoreecho" + "kitItemDetails": [], + "accountCarrierName": null } ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], "deliveryWindow": null, - "pickupPointId": null, + "price": 700, + "listPrice": 700, + "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, @@ -7646,230 +10323,230 @@ "additionalInfo": null, "dockId": null }, - "pickupDistance": null + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" } - ] - } - }, - "to": { - "items": [ - { - "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", - "id": "1", - "productId": "1", - "productRefId": "", - "refId": "codrefxicaraazul", - "ean": "8745121641", - "name": "Blue cup", - "skuName": "cup", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": null, - "tax": 0, - "price": 5000, - "listPrice": null, - "manualPrice": null, - "manualPriceAppliedBy": null, - "sellingPrice": 5000, - "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": "/1/", - "productCategories": { - "1": "Category" - }, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", - "detailUrl": "/xicara/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": null, - "measurementUnit": "un", - "unitMultiplier": 1, - "manufacturerCode": null, - "priceDefinition": { - "calculatedSellingPrice": 5000, - "total": 5000, - "sellingPrices": [ - { - "value": 5000, - "quantity": 1 - } - ] + ], + "shipsTo": [ + "BRA" + ], + "itemId": "31", + "deliveryChannels": [ + { + "id": "delivery" } - } - ], - "paymentData": { - "transactions": [] - }, - "receiptData": null, - "shippingData": { - "logisticsInfo": [ + ], + "price": 180, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 180, + "deliveryIds": [ { - "itemIndex": 0, - "selectedSla": "Economic", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ - { - "id": "Economic", - "deliveryChannel": "delivery", - "name": "Economic", - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "CourierClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 600, - "listPrice": 180, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - }, - { - "id": "Normal", - "deliveryChannel": "delivery", - "name": "Normal", - "deliveryIds": [ - { - "courierId": "1", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "CourierClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "3bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 500, - "listPrice": 500, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "3bd" - }, - { - "id": "Pickup", - "deliveryChannel": "delivery", - "name": "Pickup", - "deliveryIds": [ - { - "courierId": "ech018654", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Pickup", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 700, - "listPrice": 700, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - } - ], - "shipsTo": [ - "BRA" - ], - "itemId": "1", - "deliveryChannels": [ + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + }, + "to": { + "items": [ + { + "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", + "id": "1", + "productId": "1", + "productRefId": "", + "refId": "codrefxicaraazul", + "ean": "8745121641", + "name": "Blue cup", + "skuName": "cup", + "modalType": null, + "parentItemIndex": null, + "parentAssemblyBinding": null, + "assemblies": [], + "priceValidUntil": null, + "tax": 0, + "price": 5000, + "listPrice": null, + "manualPrice": null, + "manualPriceAppliedBy": null, + "sellingPrice": 5000, + "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": "/1/", + "productCategories": { + "1": "Category" + }, + "quantity": 1, + "seller": "1", + "sellerChain": [ + "1" + ], + "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", + "detailUrl": "/xicara/p", + "components": [], + "bundleItems": [], + "attachments": [], + "attachmentOfferings": [], + "offerings": [], + "priceTags": [], + "availability": null, + "measurementUnit": "un", + "unitMultiplier": 1, + "manufacturerCode": null, + "priceDefinition": { + "calculatedSellingPrice": 5000, + "total": 5000, + "sellingPrices": [ + { + "value": 5000, + "quantity": 1 + } + ] + } + } + ], + "paymentData": { + "transactions": [] + }, + "receiptData": null, + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ { - "id": "delivery" + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null } ], - "price": 600, - "listPrice": 180, "shippingEstimate": "25bd", - "dockEstimate": null, "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", "lockTTL": "12d", - "deliveryCompany": null, + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 600, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, "polygonName": "", - "transitTime": "25bd", - "sellingPrice": 600, + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", "deliveryIds": [ { - "courierId": "1c083bf", + "courierId": "1", "warehouseId": "1_1", "dockId": "1", - "courierName": "Donkey", + "courierName": "CourierClass", "quantity": 1, - "kitItemDetails": null, - "accountCarrierName": "qastoreecho" + "kitItemDetails": [], + "accountCarrierName": null } ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Pickup", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, "pickupStoreInfo": { "isPickupStore": false, "friendlyName": null, @@ -7877,27 +10554,69 @@ "additionalInfo": null, "dockId": null }, - "pickupDistance": null + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" } - ] + ], + "shipsTo": [ + "BRA" + ], + "itemId": "1", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 600, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 600, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null } - } + ] } - ], - "date": "2024-07-27T17:52:18.6483116Z", - "origin": { - "account": "qastore", - "orderId": "v12772213qst-02", - "component": "MarketplaceComponent" - }, - "settings": { - "customPaymentSystemsAllowed": [ - "201" - ] } } ], - "actions": [] + "date": "2024-07-27T17:52:18.6483116Z", + "origin": { + "account": "qastore", + "orderId": "v12772213qst-02", + "component": "MarketplaceComponent" + }, + "settings": { + "customPaymentSystemsAllowed": [ + "201" + ] + } } } } @@ -7905,15 +10624,37 @@ } } }, - "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}": { - "get": { + "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry": { + "post": { "tags": [ "Change order (beta)" ], - "summary": "Get order change details", - "description": "This endpoint retrieves detailed information about a specific order change. So after creating multiple changes, you can get information on each one of them by its `changeRequestId`, the unique identification code generated by the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\nThe successful status code is `200 OK`, and its response body schema is very similar to the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint, with some additional fields:\r\n\r\n- `status`: The change request status in the workflow, which progresses in the following order:\r\n - `waiting-acknowledgement`\r\n - `waiting-confirmation`\r\n - `done`\r\n - `canceled`\r\n\r\n- `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.\r\n\r\n- `logs`: Lists the workflow processing logs.\r\n\r\n> If you want information about all the changes made to an order, use the [Get order change history](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", - "operationId": "GetChangeDetail", + "summary": "Retry order change", + "operationId": "RetryChange", + "description": "This endpoint makes a new attempt to perform an order change previously made using the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint that, for some reason, was not completely processed.\r\n\r\nTo make this request, you need the `changeRequestId`, a unique change identification code that you get when you make a [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) request. When you retry to change an order using the `changeRequestId`, instead of creating a new change, you avoid duplications.\r\n\r\nThis endpoint's successful response status code is `204 No Content`, therefore with no response body.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, { "name": "an", "in": "query", @@ -7926,6 +10667,54 @@ "example": "storeName" } }, + { + "name": "changeOrderId", + "in": "path", + "description": "Order ID of the order you wish to retry change.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "v12772213qst-02" + } + }, + { + "name": "changeRequestId", + "in": "path", + "description": "Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code.\r\n\r\nThere are no limits to changes you can perform using the same `changeRequestId`, and we recommend keeping all changes of a given order grouped by the same `changeRequestId`, so you will have a unified change history.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Createchange" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel": { + "post": { + "tags": [ + "Change order (beta)" + ], + "summary": "Cancel order change", + "operationId": "CancelChangeStoppedonError", + "description": "This endpoint cancels an [order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes). It is meant for when, due to an error, a change was not completely processed, and you do not wish to [retry](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/retry) it. For this request, you need the order's `changeRequestId`, the unique identification code generated by the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n>⚠️ Once an order change has been successfully processed, canceling it is no longer possible. If you wish to revert the changes made to an order, you will have to [create a new order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", + "parameters": [ { "name": "Content-Type", "in": "header", @@ -7948,10 +10737,22 @@ "default": "application/json" } }, + { + "name": "an", + "in": "query", + "description": "Name of the VTEX account that created the order.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "storeName" + } + }, { "name": "changeOrderId", "in": "path", - "description": "Order ID of the order you wish to get the change detail.", + "description": "Order ID of the order with the changes you wish to cancel.", "required": true, "style": "simple", "schema": { @@ -7962,7 +10763,7 @@ { "name": "changeRequestId", "in": "path", - "description": "Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code. There are no limits to changes you can perform using the same `changeRequestId`, and we recommend keeping all changes of a given order grouped by the same `changeRequestId`, so you will have a unified change history.", + "description": "Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code. After cancelling an order change, the `changeRequestId` will no longer be valid.", "required": true, "style": "simple", "schema": { @@ -7971,1678 +10772,3093 @@ } } ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "required": [ - "requestId", - "workflowId", - "status", - "inProgress", - "reason", - "manualDiscountValue", - "manualIncrementValue", - "totalChangeValue", - "totals", - "add", - "remove", - "replace", - "date", - "origin", - "settings" - ], - "type": "object", - "properties": { - "requestId": { - "type": "string", - "description": "Unique code that identifies a change order request." - }, - "workflowId": { - "type": "string", - "description": "Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." - }, - "status": { - "type": "string", - "description": "Order status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." - }, - "inProgress": { - "type": "boolean", - "description": "When set as `true`, the order is still progressing in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196), when set as `false`, it is complete, whether by cancellation or because the customer received it." - }, - "reason": { - "type": "string", - "description": "Reason that motivated the order change." - }, - "manualDiscountValue": { - "type": "integer", - "description": "This field shows if a manual price was applied to the total order amount. The value is in cents." - }, - "manualIncrementValue": { - "type": "integer", - "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." - }, - "totalChangeValue": { - "type": "integer", - "description": "This field shows how much is the order total price considering that price changes might have been made. The value is in cents." - }, - "totals": { - "type": "array", - "description": "Array containing total costs information.", - "items": { + "requestBody": { + "content": { + "application/json": { + "schema": { "type": "object", - "description": "Total changing price details for a given type of cost.", + "required": [ + "reason" + ], "properties": { - "id": { - "type": "string", - "description": "Changing price type, for example the item price or shipping costs." - }, - "name": { + "reason": { "type": "string", - "description": "Changing price name." - }, - "value": { - "type": "number", - "description": "Changing price value in cents." + "description": "Reason why you wish to cancel the order change. The customer will not view the value inserted in this field.", + "example": "I want to cancel this change order request because it's stopped on a blocking error." } } } - }, - "add": { - "type": "array", - "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", - "nullable": true, - "items": { - "type": "string", - "description": "Adding operation information, when applicable." - } - }, - "remove": { - "type": "array", - "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", - "nullable": true, - "items": { - "type": "string", - "description": "Removing operation information, when applicable." - } - }, - "replace": { - "type": "array", - "description": "Array with information about the `replace` operation, when applicable.", - "items": { - "$ref": "#/components/schemas/Replace1" + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/order-system/orders/changes/settings": { + "put": { + "tags": [ + "Change order (beta)" + ], + "summary": "Update Change order settings", + "description": "Updates the [Change order](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) settings from a store.\r\n\r\n>ℹ️ To know more about **Change order**, see [How Change order works (Beta)](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", + "parameters": [ + { + "name": "an", + "in": "query", + "description": "VTEX [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC).", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "storename" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "application/json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "paymentConfiguration": { + "type": "object", + "description": "[Change order](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) payment configurations.", + "properties": { + "customPaymentSystemsAllowed": { + "type": "array", + "description": "List of custom payment system IDs configured for the VTEX account.", + "items": { + "type": "string", + "description": "Payment system ID.", + "example": "201" + } } - }, - "date": { - "type": "string", - "description": "Date and time of the request in UTC ISO 8601 format, as in `yyyy-mm-ddThh:mm:ss.sssZ`." - }, - "origin": { - "$ref": "#/components/schemas/OriginV2" - }, - "settings": { - "$ref": "#/components/schemas/Settings" } - } - }, - "example": { - "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", - "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", - "status": "done", - "inProgress": false, - "reason": "The client did not like the size.", - "manualDiscountValue": 0, - "manualIncrementValue": 0, - "totalChangeValue": 0, - "totals": [ - { - "id": "ManualValues", - "name": "Manual Values Total", - "value": -1000 + }, + "rolloutConfiguration": { + "type": "object", + "description": "**Change order** settings regarding VTEX Admin, [Orders API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes?endpoint=patch-/api/order-system/orders/-changeOrderId-/changes) and **My Account** feature.", + "properties": { + "enableApi": { + "type": "boolean", + "description": "Defines if the account enabled the [Change order API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) (`true`) or not (`false`). The account can only use the [Change order via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw) or [via API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) if this field is set to `true`.", + "default": false, + "example": true + }, + "enableAdminOrders": { + "type": "object", + "description": "Object about enabling the [Change order feature via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw).", + "properties": { + "enabledWorkspaces": { + "type": "array", + "description": "List with the workspaces' names that have the **Change order** feature enabled via VTEX Admin.", + "items": { + "type": "string", + "description": "Name of the workspace with **Change order** enabled via VTEX Admin. The asterisk `*` value includes all of the account's workspaces.", + "example": "*" + } } - ], - "add": null, - "remove": null, - "replace": [ - { - "from": { - "paymentData": { - "transactions": [] - }, - "items": [ - { - "id": "31", - "quantity": 1, - "price": 5000, - "measurementUnit": "un", - "unitMultiplier": 1, - "sellingPrice": 5000, - "name": "Small toy", - "detailUrl": "/small-toy-24/p", - "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" - } - ], - "shippingData": { - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Economic", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ - { - "id": "Economic", - "deliveryChannel": "delivery", - "name": "Economic", - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "DeliverClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 180, - "listPrice": 180, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - }, - { - "id": "Normal", - "deliveryChannel": "delivery", - "name": "Normal", - "deliveryIds": [ - { - "courierId": "1", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "CourierClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "3bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 500, - "listPrice": 500, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "3bd" - }, - { - "id": "Pickup", - "deliveryChannel": "delivery", - "name": "Pickup", - "deliveryIds": [ - { - "courierId": "ech018654", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Pickup", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 700, - "listPrice": 700, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - } - ], - "shipsTo": [ - "BRA" - ], - "itemId": "31", - "deliveryChannels": [ - { - "id": "delivery" - } - ], - "price": 180, - "listPrice": 180, - "shippingEstimate": "25bd", - "dockEstimate": null, - "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "deliveryCompany": null, - "polygonName": "", - "transitTime": "25bd", - "sellingPrice": 180, - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "CourierClass", - "quantity": 1, - "kitItemDetails": null, - "accountCarrierName": "qastoreecho" - } - ], - "deliveryWindow": null, - "pickupPointId": null, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupDistance": null - } - ] + } + }, + "enableMyOrders": { + "type": "object", + "description": "Object about enabling the **Change order** feature via [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).", + "properties": { + "enabledWorkspaces": { + "type": "array", + "description": "List with the workspaces' names that have the **Change order** feature enabled via **My Account**.", + "items": { + "type": "string", + "description": "Name of the workspace with **Change order** enabled via **My Account**. The asterisk `*` value includes all of the account's workspaces.", + "example": "storename" } - }, - "to": { - "items": [ - { - "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", - "id": "1", - "productId": "1", - "productRefId": "", - "refId": "codrefxicaraazul", - "ean": "8745121641", - "name": "Blue cup", - "skuName": "cup", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": null, - "tax": 0, - "price": 5000, - "listPrice": null, - "manualPrice": null, - "manualPriceAppliedBy": null, - "sellingPrice": 5000, - "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": "/1/", - "productCategories": { - "1": "Category" - }, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", - "detailUrl": "/xicara/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": null, - "measurementUnit": "un", - "unitMultiplier": 1, - "manufacturerCode": null, - "priceDefinition": { - "calculatedSellingPrice": 5000, - "total": 5000, - "sellingPrices": [ - { - "value": 5000, - "quantity": 1 - } - ] - } + } + } + } + } + }, + "pipelineConfiguration": { + "type": "object", + "description": "**Change order** settings related to taxes and shipping calculation.", + "properties": { + "enableTaxHubRecalculation": { + "type": "boolean", + "description": "Defines if the tax calculation is enabled for **Change order** (`true`) or not (`false`).", + "default": false, + "example": false + }, + "compensateShippingChanges": { + "type": "boolean", + "description": "Defines if the orders changed will have zero shipping cost (`true`) or not (`false`). Merchants can enable this configuration to change only items and prices, without impacting the orders' original freight costs.", + "default": true, + "example": true + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChangeOrderSettingsResponse" + }, + "example": { + "paymentConfiguration": { + "customPaymentSystemsAllowed": [ + "201", + "125" + ] + }, + "rolloutConfiguration": { + "usingDefaultBehavior": false, + "enableApi": true, + "enableAdminOrders": { + "enabledWorkspaces": [ + "*" + ] + }, + "enableMyOrders": { + "enabledWorkspaces": [ + "*" + ] + } + }, + "pipelineConfiguration": { + "enableTaxHubRecalculation": false, + "compensateShippingChanges": true + } + } + } + } + } + } + }, + "get": { + "tags": [ + "Change order (beta)" + ], + "summary": "Get Change order settings", + "description": "Retrieves the [Change order settings](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/order-system/orders/changes/settings) from a store.\r\n\r\n>ℹ️ To know more about **Change order**, see [How Change order works (Beta)](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | View order |\r\n| Checkout Admin | View order |\r\n| IntegrationProfile - Fulfillment Oms | View order |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", + "parameters": [ + { + "name": "an", + "in": "query", + "description": "VTEX [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC).", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "mystore" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "application/json" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChangeOrderSettingsResponse" + }, + "example": { + "paymentConfiguration": { + "customPaymentSystemsAllowed": [ + "201", + "125" + ] + }, + "rolloutConfiguration": { + "usingDefaultBehavior": false, + "enableApi": true, + "enableAdminOrders": { + "enabledWorkspaces": [ + "*" + ] + }, + "enableMyOrders": { + "enabledWorkspaces": [ + "*" + ] + } + }, + "pipelineConfiguration": { + "enableTaxHubRecalculation": false, + "compensateShippingChanges": true + } + } + } + } + } + } + } + } + }, + "security": [ + { + "appKey": [], + "appToken": [] + }, + { + "VtexIdclientAutCookie": [] + } + ], + "components": { + "parameters": { + "UNUSED_incompleteOrders": + { + "name": "incompleteOrders", + "in": "query", + "description": "You can use this parameter to filter [incomplete orders](https://help.vtex.com/en/tutorial/understanding-incomplete-orders) by their situations, whether permanent (`perm`) or temporary (`temp`). When the situation is temporary, the order is still opened and has not being cancelled. To filter the total number of incomplete orders, use the value `all`.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "all" + } + } + }, + "securitySchemes": { + "appKey": { + "type": "apiKey", + "in": "header", + "name": "X-VTEX-API-AppKey", + "description": "Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." + }, + "appToken": { + "type": "apiKey", + "in": "header", + "name": "X-VTEX-API-AppToken", + "description": "Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." + }, + "VtexIdclientAutCookie": { + "type": "apiKey", + "in": "header", + "name": "VtexIdclientAutCookie", + "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours." + } + }, + "schemas": { + "TotalsUpdated": { + "type": "array", + "description": "Information about the order totals.", + "items": { + "type": "object", + "description": "Details about the order totals.", + "properties": { + "id": { + "type": "string", + "description": "Total ID, which defines what the total is about.", + "enum": [ + "Items", + "Discounts", + "Shipping", + "Tax" + ] + }, + "name": { + "type": "string", + "description": "Total name." + }, + "value": { + "type": "integer", + "description": "Total value in cents." + }, + "alternativeTotals": { + "type": "array", + "description": "Information about the order alternative totals, when applicable. For example, when there is a discount for items in the marketplace that results in a difference in the `Items` total value, the `alternativeTotals` can retrieve details about it.", + "nullable": true, + "items": { + "type": "object", + "description": "Details about the order alternative totals.", + "properties": { + "id": { + "type": "string", + "description": "Alternative total ID, which can be related to items, discounts, shipping or taxes." + }, + "name": { + "type": "string", + "description": "Alternative total name." + }, + "value": { + "type": "integer", + "description": "Alternative total value in cents." } - ], - "paymentData": { - "transactions": [] - }, - "receiptData": null, - "shippingData": { - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Economic", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ - { - "id": "Economic", - "deliveryChannel": "delivery", - "name": "Economic", - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "CourierClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 600, - "listPrice": 180, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - }, - { - "id": "Normal", - "deliveryChannel": "delivery", - "name": "Normal", - "deliveryIds": [ - { - "courierId": "1", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "CourierClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "3bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 500, - "listPrice": 500, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null + } + } + } + } + } + }, + "ItemsUpdated": { + "type": "array", + "description": "Information on order items.", + "items": { + "type": "object", + "description": "Information on each order item.", + "properties": { + "uniqueId": { + "type": "string", + "description": "Order item unique ID." + }, + "id": { + "type": "string", + "description": "Item ID." + }, + "productId": { + "type": "string", + "description": "Product ID." + }, + "ean": { + "type": "string", + "description": "European Article Number (EAN) of the item.", + "nullable": true + }, + "lockId": { + "type": "string", + "description": "[Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) ID.", + "nullable": true + }, + "attachments": { + "type": "array", + "description": "Information about [attachments](https://help.vtex.com/en/tutorial/what-is-an-attachment--aGICk0RVbqKg6GYmQcWUm).", + "nullable": true, + "items": { + "type": "object", + "description": "Information about a given attachment.", + "properties": { + "name": { + "type": "string", + "description": "Attachment name.", + "nullable": true + }, + "content": { + "type": "object", + "description": "Custom field for attachment content.", + "nullable": true, + "additionalProperties": { + "type": "string", + "description": "Attachment custom field content.", + "nullable": true + } + } + } + } + }, + "quantity": { + "type": "integer", + "description": "Item quantity." + }, + "seller": { + "type": "string", + "description": "Seller name. When the store acts both as marketplace and seller, this field corresponds to `1`, because every VTEX store is its own seller 1." + }, + "name": { + "type": "string", + "description": "SKU name." + }, + "refId": { + "type": "string", + "description": "Ref ID." + }, + "price": { + "type": "integer", + "description": "Item price in cents." + }, + "listPrice": { + "type": "integer", + "description": "List price in cents." + }, + "manualPrice": { + "type": "integer", + "description": "[Manual price](https://help.vtex.com/en/tutorial/change-the-price-of-an-item-in-the-shopping-cart--7Cd37aCAmtL1qmoZJJvjNf) in cents.", + "nullable": true + }, + "manualPriceAppliedBy": { + "type": "string", + "description": "ID of the user who applied the manual price.", + "nullable": true + }, + "priceTags": { + "type": "array", + "description": "Information about price tags. A price tag is a price modifier, like s discount or a promotion applicable to the item in the order context.", + "items": { + "type": "object", + "description": "Information about a given price tag.", + "properties": { + "name": { + "type": "string", + "description": "Price tag name." + }, + "value": { + "type": "number", + "description": "Price tag value in cents. Discounts correspond to negative numbers.", + "nullable": true + }, + "isPercentual": { + "type": "boolean", + "description": "Defines if the price tag value is applied through a percentage (`true`) or not (`false`)." + }, + "identifier": { + "type": "string", + "description": "Price tag identifier." + }, + "rawValue": { + "type": "number", + "description": "Price tag raw value." + }, + "rate": { + "type": "integer", + "description": "Price tag rate.", + "nullable": true + }, + "jurisCode": { + "type": "string", + "description": "Juris code.", + "nullable": true + }, + "jurisType": { + "type": "string", + "description": "Juris type.", + "nullable": true + }, + "jurisName": { + "type": "string", + "description": "Juris name.", + "nullable": true + } + } + } + }, + "imageUrl": { + "type": "string", + "description": "Image URL." + }, + "detailUrl": { + "type": "string", + "description": "Detail URL." + }, + "components": { + "type": "array", + "description": "Item components.", + "nullable": true, + "items": { + "type": "string", + "description": "Component name.", + "nullable": true + } + }, + "bundleItems": { + "type": "array", + "description": "Information about services sold with the item. For example, a gift package.", + "nullable": true, + "items": { + "type": "object", + "description": "Information about a given service.", + "properties": { + "type": { + "type": "string", + "description": "Service type." + }, + "id": { + "type": "integer", + "description": "Service ID." + }, + "name": { + "type": "string", + "description": "Service name." + }, + "price": { + "type": "integer", + "description": "Service price in cents." + } + } + } + }, + "params": { + "type": "array", + "description": "Array with information about params.", + "items": { + "type": "string", + "description": "Param name." + } + }, + "offerings": { + "type": "array", + "description": "Information about offerings, which are services related to the item. For example, a warranty or installation.", + "nullable": true, + "items": { + "type": "string", + "description": "Name of the service related to the item.", + "nullable": true + } + }, + "attachmentOfferings": { + "type": "array", + "description": "Array containing attachments information.", + "nullable": true, + "items": { + "type": "object", + "description": "Attachment details.", + "nullable": true, + "properties": { + "name": { + "type": "string", + "description": "Attachment name.", + "nullable": true + }, + "required": { + "type": "boolean", + "description": "Defines if the attachment is required (`true`) or not (`false`).", + "nullable": true + }, + "schema": { + "type": "object", + "description": "Schema of the content declared in the field `attachmentOfferings`.", + "nullable": true, + "additionalProperties": { + "type": "string", + "description": "Attachment schema content.", + "nullable": true + } + } + } + } + }, + "sellerSku": { + "type": "string", + "description": "Seller SKU ID." + }, + "priceValidUntil": { + "type": "string", + "description": "Item price expiration date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "nullable": true + }, + "commission": { + "type": "integer", + "description": "Commission value registered for the seller." + }, + "tax": { + "type": "integer", + "description": "Tax value in cents." + }, + "preSaleDate": { + "type": "string", + "description": "Presale date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "nullable": true + }, + "additionalInfo": { + "type": "object", + "description": "Item additional information.", + "properties": { + "brandName": { + "type": "string", + "description": "Item brand name." + }, + "brandId": { + "type": "string", + "description": "Item brand ID." + }, + "categoriesIds": { + "type": "string", + "description": "Categories IDs." + }, + "categories": { + "type": "array", + "description": "Item [categories](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2gkZDjXRqfsq62TlAkj4uf) information.", + "items": { + "type": "object", + "description": "Information about a given category.", + "properties": { + "id": { + "type": "integer", + "description": "Category ID." }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "3bd" - }, - { - "id": "Pickup", - "deliveryChannel": "delivery", - "name": "Pickup", - "deliveryIds": [ - { - "courierId": "ech018654", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Pickup", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 700, - "listPrice": 700, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null + "name": { + "type": "string", + "description": "Category name." + } + } + } + }, + "productClusterId": { + "type": "string", + "description": "All product clusters related to the item." + }, + "commercialConditionId": { + "type": "string", + "description": "Commercial condition ID." + }, + "dimension": { + "$ref": "#/components/schemas/Dimension" + }, + "offeringInfo": { + "type": "string", + "description": "Offering information.", + "nullable": true + }, + "offeringType": { + "type": "string", + "description": "Offering type.", + "nullable": true + }, + "offeringTypeId": { + "type": "string", + "description": "Offering type ID.", + "nullable": true + } + } + }, + "measurementUnit": { + "type": "string", + "description": "Item measurement unit." + }, + "unitMultiplier": { + "type": "number", + "description": "Item unit multiplier." + }, + "sellingPrice": { + "type": "integer", + "description": "Selling price in cents. This field can present rounding discrepancies, so we recommend retrieving pricing information from the `priceDefinition` field." + }, + "isGift": { + "type": "boolean", + "description": "Defines it the item is a gift (`true`) or not (`false`)." + }, + "shippingPrice": { + "type": "integer", + "description": "Item shipping price in cents. This value does not account for the order total shipping price.", + "nullable": true + }, + "rewardValue": { + "type": "integer", + "description": "Reward value in cents." + }, + "freightCommission": { + "type": "integer", + "description": "Freight commission value in cents." + }, + "priceDefinition": { + "type": "object", + "description": "Item price information.", + "properties": { + "sellingPrices": { + "type": "array", + "description": "Item selling prices.", + "items": { + "type": "object", + "description": "Price value per quantity.", + "properties": { + "value": { + "type": "integer", + "description": "Item selling price value in cents." }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - } - ], - "shipsTo": [ - "BRA" - ], - "itemId": "1", - "deliveryChannels": [ - { - "id": "delivery" - } - ], - "price": 600, - "listPrice": 180, - "shippingEstimate": "25bd", - "dockEstimate": null, - "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "deliveryCompany": null, - "polygonName": "", - "transitTime": "25bd", - "sellingPrice": 600, - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Donkey", - "quantity": 1, - "kitItemDetails": null, - "accountCarrierName": "qastoreecho" - } - ], - "deliveryWindow": null, - "pickupPointId": null, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupDistance": null - } - ] - } + "quantity": { + "type": "integer", + "description": "Item quantity." + } + } + } + }, + "calculatedSellingPrice": { + "type": "integer", + "description": "Item calculated selling price in cents." + }, + "total": { + "type": "integer", + "description": "Item total price in cents." + }, + "reason": { + "type": "string", + "description": "Item price definition reason.", + "nullable": true } - } - ], - "date": "2024-07-27T17:52:18.6483116Z", - "origin": { - "account": "qastore", - "orderId": "v12772213qst-02", - "component": "MarketplaceComponent" - }, - "settings": { - "customPaymentSystemsAllowed": [ - "201" - ] - } - } - } - } - } - } - } - }, - "/api/order-system/orders/{changeOrderId}/changes/preview": { - "post": { - "tags": [ - "Change order (beta)" - ], - "summary": "Preview order change", - "operationId": "PreviewChange", - "description": "This endpoint allows you to simulate an order change and preview what the real change will look like if you use the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint. A preview is especially useful for more complex scenarios, such as orders with multiple items and combinations of change operations — add, remove, and replace. Ensuring you get the desired results before making the actual change helps prevent mistakes.\r\n\r\nThe request body is the same one to be used in the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint, and the response body of a successful request provides a preview of the change order effect.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", - "parameters": [ - { - "name": "an", - "in": "query", - "description": "Name of the VTEX account that created the order.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "storeName" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "changeOrderId", - "in": "path", - "description": "Order ID of the order you wish to preview change.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "v12772213qst-02" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "required": [ - "reason", - "replace" - ], - "type": "object", - "properties": { - "reason": { + } + }, + "taxCode": { + "type": "string", + "description": " Item tax code.", + "nullable": true + }, + "parentItemIndex": { + "type": "integer", + "description": "Ranking number that shows how related items are indexed in between each other. It starts at `0` as the primary item reference and counts up to `1`, `2`, and so on. For example, a customer bought sunglasses and hired a warranty service. Since the sunglasses are index `0`, the warranty service (the [assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)) is index `1` and has the `parentItemIndex` value `0`. This response is `null` for items that are not assembly options.", + "nullable": true + }, + "parentAssemblyBinding": { + "type": "string", + "description": "When items are indexed in between each other, this field returns the assembly option ID. This response is `null` for items that are not [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH).", + "nullable": true + }, + "callCenterOperator": { "type": "string", - "description": "Reason why you wish to change order. Since you can make several changes to an order, filling this field with a clear explanation helps organize the change order history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).", - "example": "The client wants to change a weighable product." - - }, - "replace": { + "description": "Identification code of the call center operator that sold the item, when applicable.", + "nullable": true + }, + "serialNumbers": { + "type": "string", + "description": "This field identifies the order in the `handling` status in the workflow, and it was used for VTEX internal control.", + "deprecated": true, + "nullable": true + }, + "assemblies": { "type": "array", + "description": "Information about the item customization, when applicable.", + "nullable": true, "items": { - "$ref": "#/components/schemas/Replace" - }, - "description": "Name of the change operation you are performing, which can be `replace`, `add` or `remove`. If you want, you can combine all change operations in a single request." - } + "type": "string", + "description": "Customization information.", + "nullable": true + } + }, + "costPrice": { + "type": "integer", + "description": "Item cost price in cents.", + "nullable": true } - } - } + } } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "reason", - "manualDiscountValue", - "manualIncrementValue", - "totalChangeValue", - "totals", - "add", - "remove", - "replace", - "date", - "origin", - "settings" - ], - "properties": { - "reason": { + }, + "ClientProfileDataUpdated": { + "type": "object", + "description": "Information about the customer profile.", + "properties": { + "id": { + "type": "string", + "description": "Object ID, the expected value is `clientProfileData`." + }, + "email": { + "type": "string", + "description": "Customer email." + }, + "firstName": { + "type": "string", + "description": "Customer first name." + }, + "lastName": { + "type": "string", + "description": "Customer last name." + }, + "documentType": { + "type": "string", + "description": "Type of the document informed by the customer." + }, + "document": { + "type": "string", + "description": "Document identification code informed by the customer." + }, + "phone": { + "type": "string", + "description": "Customer phone number." + }, + "corporateName": { + "type": "string", + "nullable": true, + "description": "If the customer is a legal entity, this field includes the corporate name." + }, + "tradeName": { + "type": "string", + "nullable": true, + "description": "If the customer is a legal entity, this field includes the trade name." + }, + "corporateDocument": { + "type": "string", + "nullable": true, + "description": "If the customer is a legal entity, this field includes the corporate document." + }, + "stateInscription": { + "type": "string", + "nullable": true, + "description": "If the customer is a legal entity, this field includes the state inscription." + }, + "corporatePhone": { + "type": "string", + "nullable": true, + "description": "If the customer is a legal entity, this field includes the company's phone number." + }, + "isCorporate": { + "type": "boolean", + "description": "Defines if the customer is a legal entity (`true`) or not (`false`)." + }, + "userProfileId": { + "type": "string", + "description": "Customer user profile ID." + }, + "userProfileVersion": { + "type": "string", + "nullable": true, + "description": "Customer user profile version." + }, + "customerClass": { + "type": "string", + "nullable": true, + "description": "Customer class identification." + }, + "customerCode": { + "type": "string", + "nullable": true, + "description": "Customer code." + } + } + }, + "GiftRegistryDataUpdated": { + "type": "object", + "description": "[Gift list](https://developers.vtex.com/docs/guides/creating-gift-lists) information.", + "nullable": true, + "properties": { + "giftRegistryId": { + "type": "string", + "description": "Gift list ID." + }, + "giftRegistryType": { + "type": "string", + "description": "[Gift list type](https://help.vtex.com/en/tutorial/creating-a-type-of-list)." + }, + "giftRegistryTypeName": { + "type": "string", + "description": "Gift list type name." + }, + "addressId": { + "type": "string", + "description": "Gift list shipping address ID." + }, + "description": { + "type": "string", + "description": "Gift list description." + } + } + }, + "MarketingDataUpdated": { + "type": "object", + "description": "Information about marketing and promotions, such as coupon code and [Urchin Tracking Module (UTM)](https://help.vtex.com/en/tutorial/what-are-utm-source-utm-campaign-and-utm-medium--2wTz7QJ8KUG6skGAoAQuii).", + "nullable": true, + "properties": { + "id": { + "type": "string", + "description": "Object ID. The expected value is `marketingData`." + }, + "utmSource": { + "type": "string", + "description": "A UTM is an Urchin Tracking Module used to track traffic related to your store. This field is an UTM for tracking the traffic source, to know from which site, advertiser, or publication the customer came before reaching your site.", + "nullable": true + }, + "utmPartner": { + "type": "string", + "description": "UTM for tracking the partner.", + "nullable": true + }, + "utmMedium": { + "type": "string", + "description": "UTM for tracking the advertising or marketing media used to reach your site, such as banners and newsletters." + }, + "utmCampaign": { + "type": "string", + "description": "UTM for tracking the marketing campaign context.", + "nullable": true + }, + "coupon": { + "type": "string", + "description": "Coupon code used by the customer.", + "nullable": true + }, + "utmiCampaign": { + "type": "string", + "description": "Internal UTM for tracking the marketing campaign context.", + "nullable": true + }, + "utmipage": { + "type": "string", + "description": "A `utmi` is an internal Urchin Tracking Module (UTM) used to track traffic inside your site. This field is an internal UTM for tracking pages.", + "nullable": true + }, + "utmiPart": { + "type": "string", + "description": "Internal UTM for tracking the partner.", + "nullable": true + }, + "marketingTags": { + "type": "array", + "description": "List of marketing tags valid for the item.", + "items": { "type": "string", - "description": "Reason why you wish to change order. Since you can make several changes to an order, filling this field with a clear explanation helps organize the change order history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh)." - }, - "manualDiscountValue": { - "type": "integer", - "description": "This field shows if a manual price was applied to the total order amount. The value is in cents." - }, - "manualIncrementValue": { - "type": "integer", - "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." - }, - "totalChangeValue": { - "type": "integer", - "description": "This field shows how much is the order total price considering that price changes might have been made. The value is in cents." - }, - "totals": { - "type": "array", - "description": "Array containing total costs information.", - "items": { - "type": "object", - "description": "Total changing price details for a given type of cost.", - "properties": { - "id": { + "description": "Marketing tag name." + } + } + } + }, + "RatesAndBenefitsDataUpdated": { + "type": "object", + "description": "Information on promotions and taxes that apply to the order.", + "properties": { + "id": { + "type": "string", + "description": "Object ID. The expected value is `ratesAndBenefitsData`." + }, + "rateAndBenefitsIdentifiers": { + "type": "array", + "description": "Information about order's promotions and taxes identifiers.", + "items": { + "type": "object", + "description": "Information about a given promotion or tax.", + "properties": { + "description": { + "type": "string", + "description": "Promotion or tax description.", + "nullable": true + }, + "featured": { + "type": "boolean", + "description": "Defines if the [target audience](https://help.vtex.com/en/tutorial/creating-a-campaign-audience--6cnuDZJzIkIeocewAQQK4K) is featured (`true`) or not (`false`)." + }, + "id": { + "type": "string", + "description": "Promotion or tax ID." + }, + "name": { + "type": "string", + "description": "Promotion or tax name." + }, + "matchedParameters": { + "type": "object", + "description": "Informs the criteria and conditions fulfilled so the promotion became valid.", + "additionalProperties": { "type": "string", - "description": "Changing price type, for example the item price or shipping costs." - }, - "name": { + "description": "Promotion or tax criteria content." + } + }, + "additionalInfo": { + "type": "object", + "description": "Object containing the promotion or tax additional information.", + "nullable": true, + "additionalProperties": { "type": "string", - "description": "Changing price name." - }, - "value": { - "type": "number", - "description": "Changing price value in cents." + "description": "Additional information." } } } - }, - "add": { - "type": "array", - "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", - "nullable": true, - "items": { - "type": "string", - "description": "Adding operation information, when applicable." - } - }, - "remove": { - "type": "array", - "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", - "nullable": true, - "items": { - "type": "string", - "description": "Removing operation information, when applicable." - } - }, - "replace": { - "type": "array", - "description": "Array with information about the `replace` operation, when applicable.", - "items": { - "type": "object", - "description": "Replacing operation object.", - "required": [ - "from", - "to" - ], - "properties": { - "from": { - "$ref": "#/components/schemas/From2" - }, - "to": { - "$ref": "#/components/schemas/To2" - } - } - } - }, - "date": { - "type": "string", - "description": "Date and time of the request in UTC ISO 8601 format, as in `yyyy-mm-ddThh:mm:ss.sssZ`." - }, - "origin": { - "$ref": "#/components/schemas/OriginV2" - }, - "settings": { - "$ref": "#/components/schemas/Settings" - } + } + } + } + }, + "ShippingDataUpdated": { + "type": "object", + "description": "Order shipping information.", + "properties": { + "id": { + "type": "string", + "description": "Object ID. The expected value is `shippingData`." + }, + "address": { + "type": "object", + "description": "Shipping address details.", + "required": [ + "addressType", + "receiverName", + "addressId", + "postalCode", + "city", + "state", + "country", + "street", + "number", + "neighborhood", + "complement", + "reference", + "geoCoordinates" + ], + "properties": { + "addressType": { + "type": "string", + "description": "Shipping address type.", + "enum": [ + "residential", + "pickup" + ] + }, + "receiverName": { + "type": "string", + "description": "Full name of the order receiver." + }, + "addressId": { + "type": "string", + "description": "Shipping address ID." + }, + "versionId": { + "type": "string", + "description": "Shipping address version ID.", + "nullable": true + }, + "entityId": { + "type": "string", + "description": "Shipping address entity ID.", + "nullable": true + }, + "postalCode": { + "type": "string", + "description": "Shipping address postal code." + }, + "city": { + "type": "string", + "description": "Shipping address city." + }, + "state": { + "type": "string", + "description": "Shipping address state." + }, + "country": { + "type": "string", + "description": "Shipping address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." + }, + "street": { + "type": "string", + "description": "Shipping address street." + }, + "number": { + "type": "string", + "description": "Shipping address number." + }, + "neighborhood": { + "type": "string", + "description": "Shipping address neighborhood." + }, + "complement": { + "type": "string", + "description": "Shipping address complement.", + "nullable": true + }, + "reference": { + "type": "string", + "description": "Shipping address additional information.", + "nullable": true + }, + "geoCoordinates": { + "type": "array", + "description": "Shipping address pair of geolocation coordinates, first longitude then latitude.", + "items": { + "type": "number", + "description": "Longitude or latitude." + } + } } - }, - "example": { - "reason": "I would like to receive a preview.", - "manualDiscountValue": 0, - "manualIncrementValue": 0, - "totalChangeValue": 420, - "totals": [ - { - "id": "ManualValues", - "name": "Manual Values Total", - "value": 0 - }, - { - "id": "Shipping", - "name": "Shipping Total", - "value": 420 - } - ], - "add": null, - "remove": null, - "replace": [ - { - "from": { - "paymentData": { - "transactions": [] - }, - "items": [ - { - "id": "31", - "quantity": 1, - "price": 5000, - "measurementUnit": "un", - "unitMultiplier": 1, - "sellingPrice": 5000, - "name": "Small toy", - "detailUrl": "/small-toy-24/p", - "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" + }, + "logisticsInfo": { + "type": "array", + "description": "Logistics information regarding order items.", + "items": { + "type": "object", + "description": "Logistics information about an item.", + "properties": { + "itemIndex": { + "type": "integer", + "description": "Each item in the order is identified by an index. The position starts in `0`, followed by `1`, `2`, and so on." + }, + "itemId": { + "type": "string", + "description": "SKU ID." + }, + "selectedDeliveryChannel": { + "type": "string", + "description": "Delivery channel selected by the customer. This field is being deprecated and the information it retrieves can be found in the `deliveryChannel` field.", + "deprecated": true, + "enum": [ + "delivery", + "pickup-in-point" + ] + }, + "selectedSla": { + "type": "string", + "description": "Service Level Agreement (SLA), which corresponds to the shipping method selected by the customer, usually like normal or express." + }, + "lockTTL": { + "type": "string", + "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time." + }, + "price": { + "type": "integer", + "description": "Item shipping price in cents. This value does not correspond to the order total shipping price." + }, + "listPrice": { + "type": "integer", + "description": "Item [list price](https://help.vtex.com/en/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/3XcXp0r5WrJvogB8KIX4Kx#list-price) in cents." + }, + "sellingPrice": { + "type": "integer", + "description": "Item selling price in cents." + }, + "deliveryWindow": { + "type": "string", + "description": "[Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, when applicable.", + "nullable": true + }, + "deliveryCompany": { + "type": "string", + "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company name." + }, + "shippingEstimate": { + "type": "string", + "description": "Shipping estimate time in days. For instance, three business days is represented `3bd`." + }, + "shippingEstimateDate": { + "type": "string", + "description": "Shipping estimate date, defined after order confirmation, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "slas": { + "type": "array", + "description": "Service Level Agreements (SLA) corresponding to [shipping policies](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).", + "items": { + "type": "object", + "description": "Service Level Agreement (SLA) information.", + "properties": { + "id": { + "type": "string", + "description": "ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140)." + }, + "name": { + "type": "string", + "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name." + }, + "shippingEstimate": { + "type": "string", + "description": "Shipping estimate time in days. For instance, three business days is represented `3bd`." + }, + "shippingEstimateDate": { + "type": "string", + "description": "SLA shipping estimate date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "nullable": true + }, + "deliveryWindow": { + "type": "string", + "description": "[Delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.", + "nullable": true + }, + "availableDeliveryWindows": { + "type": "array", + "description": "Available delivery windows information, when applicable.", + "nullable": true, + "items": { + "type": "string", + "description": "Information about an available delivery window." + } + }, + "deliveryIds": { + "type": "array", + "description": "SLA delivery IDs information.", + "items": { + "type": "object", + "description": "Information about a delivery ID.", + "properties": { + "courierId": { + "type": "string", + "description": "Carrier ID." + }, + "courierName": { + "type": "string", + "description": "Carrier name." + }, + "dockId": { + "type": "string", + "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID." + }, + "quantity": { + "type": "integer", + "description": "Quantity of items being delivered." + }, + "warehouseId": { + "type": "string", + "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID." + }, + "accountCarrierName": { + "type": "string", + "description": "Account carrier name." + }, + "kitItemDetails": { + "type": "array", + "description": "Information about [kit](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.", + "nullable": true, + "items": { + "type": "string", + "description": "Kit item information." + } + } + } + } + }, + "listPrice": { + "type": "integer", + "description": "SLA shipping list price in cents." + }, + "price": { + "type": "integer", + "description": "SLA shipping price in cents. Does not account for the order total shipping price." + }, + "deliveryChannel": { + "type": "string", + "description": "Defines if the delivery channel is delivery or [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", + "enum": [ + "delivery", + "pickup-in-point" + ] + }, + "pickupStoreInfo": { + "$ref": "#/components/schemas/PickupStoreInfoUpdated" + }, + "polygonName": { + "type": "string", + "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.", + "nullable": true + }, + "lockTTL": { + "type": "string", + "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time related to the SLA." + }, + "pickupPointId": { + "type": "string", + "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA.", + "nullable": true + }, + "transitTime": { + "type": "string", + "description": "Number of days the carrier takes in transit to deliver the order. For instance, three business days is represented `3bd`." + }, + "pickupDistance": { + "type": "number", + "description": "Distance in kilometers between the pickup point and the customer address. The distance is measured as a straight line.", + "nullable": true + } + } + } + }, + "shipsTo": { + "type": "array", + "description": "List of shipping address countries.", + "items": { + "type": "string", + "description": "Shipping address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." + } + }, + "deliveryIds": { + "type": "array", + "description": "Order delivery IDs information.", + "items": { + "type": "object", + "description": "Information about a delivery ID.", + "properties": { + "courierId": { + "type": "string", + "description": "Carrier ID." + }, + "courierName": { + "type": "string", + "description": "Carrier name." + }, + "dockId": { + "type": "string", + "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID." + }, + "quantity": { + "type": "integer", + "description": "Quantity of items being delivered." + }, + "warehouseId": { + "type": "string", + "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID." + }, + "accountCarrierName": { + "type": "string", + "description": "Account carrier name." + }, + "kitItemDetails": { + "type": "array", + "description": "Information about [kit](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.", + "nullable": true, + "items": { + "type": "string", + "description": "Kit item information." + } + } + } + } + }, + "deliveryChannels": { + "type": "array", + "description": "Delivery channels associated with the sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)).", + "items": { + "type": "object", + "description": "Delivery channel information.", + "properties": { + "id": { + "type": "string", + "description": "Delivery channel shipping type.", + "enum": [ + "delivery", + "pickup-in-point" + ] + }, + "stockBalance": { + "type": "integer", + "description": "Stock check for SKU availability." + } + } + } + }, + "deliveryChannel": { + "type": "string", + "description": "Defines if the delivery channel is delivery or pickup. This field is deprecated and was replaced by the `deliveryChannels` field.", + "deprecated": true, + "enum": [ + "delivery", + "pickup-in-point" + ] + }, + "pickupStoreInfo": { + "$ref": "#/components/schemas/PickupStoreInfoUpdated" + }, + "addressId": { + "type": "string", + "description": "Shipping address ID.", + "nullable": true + }, + "versionId": { + "type": "string", + "description": "Shipping address version ID.", + "nullable": true + }, + "entityId": { + "type": "string", + "description": "Shipping address entity ID.", + "nullable": true + }, + "polygonName": { + "type": "string", + "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).", + "nullable": true + }, + "pickupPointId": { + "type": "string", + "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID, when applicable.", + "nullable": true + }, + "transitTime": { + "type": "string", + "description": "Number of days the carrier takes in transit to deliver the order. For instance, three business days is represented `3bd`." } - ], - "shippingData": { - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Economic", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ - { - "id": "Economic", - "deliveryChannel": "delivery", - "name": "Economic", - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "DeliverClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 180, - "listPrice": 180, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - }, - { - "id": "Normal", - "deliveryChannel": "delivery", - "name": "Normal", - "deliveryIds": [ - { - "courierId": "1", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "CourierClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "3bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 500, - "listPrice": 500, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "3bd" - }, - { - "id": "Pickup", - "deliveryChannel": "delivery", - "name": "Pickup", - "deliveryIds": [ - { - "courierId": "ech018654", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Pickup", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 700, - "listPrice": 700, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - } - ], - "shipsTo": [ - "BRA" - ], - "itemId": "31", - "deliveryChannels": [ - { - "id": "delivery" - } - ], - "price": 180, - "listPrice": 180, - "shippingEstimate": "25bd", - "dockEstimate": null, - "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "deliveryCompany": null, - "polygonName": "", - "transitTime": "25bd", - "sellingPrice": 180, - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "CourierClass", - "quantity": 1, - "kitItemDetails": null, - "accountCarrierName": "qastoreecho" - } - ], - "deliveryWindow": null, - "pickupPointId": null, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupDistance": null - } - ] - } - }, - "to": { - "items": [ - { - "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", - "id": "1", - "productId": "1", - "productRefId": "", - "refId": "codrefxicaraazul", - "ean": "8745121641", - "name": "Blue cup", - "skuName": "cup", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": null, - "tax": 0, - "price": 5000, - "listPrice": null, - "manualPrice": null, - "manualPriceAppliedBy": null, - "sellingPrice": 5000, - "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": "/1/", - "productCategories": { - "1": "Category" - }, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", - "detailUrl": "/xicara/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": null, - "measurementUnit": "un", - "unitMultiplier": 1, - "manufacturerCode": null, - "priceDefinition": { - "calculatedSellingPrice": 5000, - "total": 5000, - "sellingPrices": [ - { - "value": 5000, - "quantity": 1 - } + } + } + }, + "trackingHints": { + "type": "array", + "description": "Order shipping label information.", + "nullable": true, + "items": { + "type": "object", + "description": "Shipping label details.", + "properties": { + "trackingId": { + "type": "string", + "description": "Order tracking ID." + }, + "courierName": { + "type": "string", + "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) name." + }, + "trackingUrl": { + "type": "string", + "description": "Order tracking URL." + }, + "trackingLabel": { + "type": "string", + "description": "Order tracking label." + } + } + } + }, + "selectedAddresses": { + "type": "array", + "description": "Selected adresses information.", + "items": { + "type": "object", + "description": "Details about a selected adress.", + "properties": { + "addressId": { + "type": "string", + "description": "Selected address ID." + }, + "versionId": { + "type": "string", + "description": "Selected address version ID.", + "nullable": true + }, + "entityId": { + "type": "string", + "description": "Selected address entity ID.", + "nullable": true + }, + "addressType": { + "type": "string", + "description": "Selected adress shipping type.", + "enum": [ + "residential", + "pickup" ] - } + }, + "receiverName": { + "type": "string", + "description": "Full name of the order receiver." + }, + "street": { + "type": "string", + "description": "Selected address street." + }, + "number": { + "type": "string", + "description": "Selected address number." + }, + "complement": { + "type": "string", + "description": "Selected address complement.", + "nullable": true + }, + "neighborhood": { + "type": "string", + "description": "Selected address neighborhood." + }, + "postalCode": { + "type": "string", + "description": "Selected address postal code." + }, + "city": { + "type": "string", + "description": "Selected address city." + }, + "state": { + "type": "string", + "description": "Selected address state." + }, + "country": { + "type": "string", + "description": "Selected address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." + }, + "reference": { + "type": "string", + "nullable": true, + "description": "Selected address additional information." + }, + "geoCoordinates": { + "type": "array", + "description": "Selected address pair of geolocation coordinates, first longitude then latitude.", + "items": { + "type": "number", + "description": "Longitude or latitude." + } + } + } + } + }, + "availableAddresses": { + "type": "array", + "description": "Available adresses information.", + "items": { + "type": "object", + "description": "Details about an available adress.", + "properties": { + "addressId": { + "type": "string", + "description": "Available address ID." + }, + "versionId": { + "type": "string", + "description": "Available address version ID.", + "nullable": true + }, + "entityId": { + "type": "string", + "description": "Available address entity ID.", + "nullable": true + }, + "addressType": { + "type": "string", + "description": "Available adress shipping type.", + "enum": [ + "residential", + "pickup" + ] + }, + "receiverName": { + "type": "string", + "description": "Full name of the order receiver." + }, + "street": { + "type": "string", + "description": "Available address street." + }, + "number": { + "type": "string", + "description": "Available address number." + }, + "complement": { + "type": "string", + "description": "Available address complement.", + "nullable": true + }, + "neighborhood": { + "type": "string", + "description": "Available address neighborhood." + }, + "postalCode": { + "type": "string", + "description": "Available address postal code." + }, + "city": { + "type": "string", + "description": "Available address city." + }, + "state": { + "type": "string", + "description": "Available address state." + }, + "country": { + "type": "string", + "description": "Available address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." + }, + "reference": { + "type": "string", + "nullable": true, + "description": "Available address additional information." + }, + "geoCoordinates": { + "type": "array", + "description": "Available address pair of geolocation coordinates, first longitude then latitude.", + "items": { + "type": "number", + "description": "Longitude or latitude." + } + } + } + } + }, + "contactInformation": { + "type": "array", + "description": "Order contact information.", + "nullable": true, + "items": { + "type": "object", + "description": "Order contact details.", + "properties": { + "id": { + "type": "string", + "description": "Contact ID." + }, + "email": { + "type": "string", + "description": "Contact email." + }, + "firstName": { + "type": "string", + "description": "Contact first name." + }, + "lastName": { + "type": "string", + "description": "Contact last name." + }, + "document": { + "type": "string", + "description": "Contact document number." + }, + "phone": { + "type": "string", + "description": "Contact phone number." + }, + "documentType": { + "type": "string", + "description": "Contact document type." + } + } + } + } + } + }, + "PickupStoreInfoUpdated": { + "type": "object", + "description": "Information about a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", + "required": [ + "additionalInfo", + "address", + "dockId", + "friendlyName", + "isPickupStore" + ], + "properties": { + "isPickupStore": { + "type": "boolean", + "description": "Defines if the shipping type was pickup (`true`) or not (`false`)." + }, + "friendlyName": { + "type": "string", + "description": "Name of the pickup point displayed at checkout.", + "nullable": true + }, + "address": { + "type": "object", + "description": "Pickup point address information.", + "nullable": true, + "properties": { + "postalCode": { + "type": "string", + "description": "Pickup point address postal code." + }, + "country": { + "type": "string", + "description": "Three-digit country code of the pickup point address in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." + }, + "city": { + "type": "string", + "description": "Pickup point address city." + }, + "state": { + "type": "string", + "description": "Pickup point address state." + }, + "neighborhood": { + "type": "string", + "description": "Pickup point address neighborhood." + }, + "street": { + "type": "string", + "description": "Pickup point address street." + }, + "number": { + "type": "string", + "description": "Pickup point address number." + }, + "complement": { + "type": "string", + "description": "Pickup point address complement." + }, + "reference": { + "type": "string", + "description": "Pickup point address reference.", + "nullable": true + }, + "location": { + "type": "object", + "description": "Pickup point geolocation coordinates.", + "properties": { + "latitude": { + "type": "number", + "description": "Latitude coordinate." + }, + "longitude": { + "type": "number", + "description": "Longitude coordinate." + } + } + } + } + }, + "additionalInfo": { + "type": "string", + "description": "Additional information.", + "nullable": true + }, + "dockId": { + "type": "string", + "description": "ID of the loading dock related to the pickup point.", + "nullable": true + } + } + }, + "PaymentDataUpdated": { + "type": "object", + "description": "Payments information.", + "properties": { + "giftCards": { + "type": "array", + "description": "[Gift cards](https://developers.vtex.com/docs/guides/gift-card-integration-guide) information, when applicable.", + "nullable": true, + "items": { + "type": "object", + "description": "Gift card details.", + "properties": { + "id": { + "type": "string", + "description": "Gift card identification." + }, + "redemptionCode": { + "type": "string", + "description": "Gift card code used by the customer at checkout." + }, + "name": { + "type": "string", + "description": "Gift card name.", + "nullable": true + }, + "caption": { + "type": "string", + "description": "Gift card loyalty program, when applicable.", + "nullable": true + }, + "value": { + "type": "integer", + "description": "Gift card value in cents." + }, + "balance": { + "type": "number", + "description": "Gift card current balance. For newly created gift cards, the balance will be `0.0`." + }, + "provider": { + "type": "string", + "description": "Gift card provider name." + }, + "groupName": { + "type": "string", + "description": "Gift card group name.", + "nullable": true + }, + "inUse": { + "type": "boolean", + "description": "Defines if the gift card is in use (`true`) or not (`false`)." + }, + "isSpecialCard": { + "type": "boolean", + "description": "Defines if the gift card is a special card (`true`) or not (`false`)." + } + } + } + }, + "transactions": { + "type": "array", + "description": "Information about the order financial transactions.", + "items": { + "type": "object", + "description": "Information about a given transaction.", + "properties": { + "isActive": { + "type": "boolean", + "description": "Defines of the transaction is active (`true`) or inactive (`false`)." + }, + "transactionId": { + "type": "string", + "description": "Transaction ID." + }, + "merchantName": { + "type": "string", + "description": "Merchant name." + }, + "payments": { + "type": "array", + "description": "Payments information.", + "items": { + "type": "object", + "description": "Payment details.", + "properties": { + "id": { + "type": "string", + "description": "Payment unique identifier." + }, + "paymentSystem": { + "type": "string", + "description": "Payment system ID." + }, + "paymentSystemName": { + "type": "string", + "description": "Payment system name." + }, + "value": { + "type": "integer", + "description": "Order total payment value in cents." + }, + "installments": { + "type": "integer", + "description": "Number of payment installments." + }, + "referenceValue": { + "type": "integer", + "description": "Total payment reference value in cents." + }, + "cardHolder": { + "type": "string", + "nullable": true, + "description": "Name of the card owner." + }, + "cardNumber": { + "type": "string", + "nullable": true, + "description": "Card number." + }, + "firstDigits": { + "type": "string", + "nullable": true, + "description": "Card first four digits." + }, + "lastDigits": { + "type": "string", + "nullable": true, + "description": "Card last four digits." + }, + "cvv2": { + "type": "string", + "nullable": true, + "description": "Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions." + }, + "expireMonth": { + "type": "string", + "nullable": true, + "description": "Card expiration month in 2-digit format." + }, + "expireYear": { + "type": "string", + "description": "Card expiration year in 4-digit format.", + "nullable": true + }, + "url": { + "type": "string", + "description": "Payment URL.", + "nullable": true + }, + "giftCardId": { + "type": "string", + "description": "Gift card ID.", + "nullable": true + }, + "giftCardName": { + "type": "string", + "description": "Gift card name.", + "nullable": true + }, + "giftCardCaption": { + "type": "string", + "description": "Gift card caption.", + "nullable": true + }, + "redemptionCode": { + "type": "string", + "description": "Gift card code used by the customer at checkout.", + "nullable": true + }, + "group": { + "type": "string", + "description": "Transaction payment method, which can be credit card, debid card, bank invoice, promissory, gift card or pix (`instantPayment`).", + "enum": [ + "creditCard", + "debitCard", + "bankInvoice", + "promissory", + "giftCard", + "instantPayment" + ] + }, + "tid": { + "type": "string", + "description": "Provider unique identifier for the transaction." + }, + "dueDate": { + "type": "string", + "description": "Payment due date in `MM/YY` format.", + "nullable": true + }, + "connectorResponses": { + "type": "object", + "description": "Payment provider (connector) responses. The fields within this object can vary according to the order payment provider.", + "properties": { + "Message": { + "type": "string", + "description": "Provider operational message or error to be logged.", + "nullable": true + }, + "tid": { + "type": "string", + "description": "Provider unique identifier for the transaction." + }, + "authorizationId": { + "type": "string", + "description": "Provider authorization ID." + }, + "status": { + "type": "string", + "description": "Order payment status in the [transaction flow](https://help.vtex.com/en/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/1xjzgJZvqwaI1rfxLMCC3Y)." + }, + "delayToAutoSettle": { + "type": "integer", + "description": "Total time (in seconds) before the auto settle, when the platform makes an automatic call to `/settlements`, regardless if the payment was approved by the merchant's anti-fraud provider. The maximum value allowed is `604800` seconds (7 days)." + }, + "ReturnCode": { + "type": "string", + "description": "Provider operational return code or error to be logged.", + "nullable": true + }, + "nsu": { + "type": "string", + "description": "Provider unique sequential number for the transaction." + }, + "code": { + "type": "string", + "description": "Provider operational code or error to be logged." + }, + "message": { + "type": "string", + "description": "Provider operational message or error to be logged." + }, + "Tid": { + "type": "string", + "description": "Provider unique identifier for the transaction." + }, + "acquirer": { + "type": "string", + "description": "[Acquirer](https://help.vtex.com/en/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/kdPbEIWf8Xq8tESQvViMB#acquirer) name (mostly used for card payments)." + }, + "authId": { + "type": "string", + "description": "Authorization identification." + }, + "paymentId": { + "type": "string", + "description": "Payment ID." + }, + "delayToAutoSettleAfterAntifraud": { + "type": "string", + "description": "Total time (in seconds) before the auto settle, when the platform makes an automatic call to `/settlements`. This happens only after the payment was approved by the merchant's anti-fraud provider." + } + } + }, + "giftCardProvider": { + "type": "string", + "description": "Gift card provider ID.", + "nullable": true + }, + "giftCardAsDiscount": { + "type": "boolean", + "description": "Defines if the payment has a gift card discount (`true`) or not (`false`).", + "nullable": true + }, + "koinUrl": { + "type": "string", + "description": "Koin connector URL.", + "nullable": true + }, + "accountId": { + "type": "string", + "description": "Identification code of the account where the payment was made.", + "nullable": true + }, + "parentAccountId": { + "type": "string", + "description": "When the payment was made in a subaccount, this field retrieves the main account ID.", + "nullable": true + }, + "bankIssuedInvoiceIdentificationNumber": { + "type": "string", + "description": "Bank issued invoice numeric sequence.", + "nullable": true + }, + "bankIssuedInvoiceIdentificationNumberFormatted": { + "type": "string", + "description": "Bank issued invoice numeric sequence formatted as customers see.", + "nullable": true + }, + "bankIssuedInvoiceBarCodeNumber": { + "type": "string", + "description": "Bank issued invoice bar code number.", + "nullable": true + }, + "bankIssuedInvoiceBarCodeType": { + "type": "string", + "description": "Bank issued invoice bar code type.", + "nullable": true + }, + "billingAddress": { + "type": "object", + "description": "Billing address information.", + "nullable": true, + "properties": { + "postalCode": { + "type": "string", + "description": "Billing address postal code." + }, + "city": { + "type": "string", + "description": "Billing address city." + }, + "state": { + "type": "string", + "description": "Billing address state." + }, + "country": { + "type": "string", + "description": "Billing address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." + }, + "street": { + "type": "string", + "description": "Billing address street." + }, + "number": { + "type": "string", + "description": "Billing address number." + }, + "neighborhood": { + "type": "string", + "description": "Billing address neighborhood." + }, + "complement": { + "type": "string", + "description": "Billing address complement.", + "nullable": true + }, + "reference": { + "type": "string", + "description": "Billing address additional information.", + "nullable": true + }, + "geoCoordinates": { + "type": "array", + "description": "Billing address pair of geolocation coordinates, first longitude then latitude.", + "items": { + "type": "number", + "description": "Longitude or latitude." + } + } + } + }, + "paymentOrigin": { + "type": "string", + "description": "Type of [wallet](https://help.vtex.com/en/tutorial/what-is-an-e-wallet--4v5wcOe4A0SiaimWM2cU60) used in the payment.", + "nullable": true + } + } + } } - ], - "paymentData": { - "transactions": [] - }, - "receiptData": null, - "shippingData": { - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Economic", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ - { - "id": "Economic", - "deliveryChannel": "delivery", - "name": "Economic", - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "CourierClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 600, - "listPrice": 180, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - }, - { - "id": "Normal", - "deliveryChannel": "delivery", - "name": "Normal", - "deliveryIds": [ - { - "courierId": "1", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "CourierClass", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "3bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 500, - "listPrice": 500, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "3bd" - }, - { - "id": "Pickup", - "deliveryChannel": "delivery", - "name": "Pickup", - "deliveryIds": [ - { - "courierId": "ech018654", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Pickup", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 700, - "listPrice": 700, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null + } + } + } + } + }, + "PackageAttachmentUpdated": { + "type": "object", + "description": "Information about shipping packages, which are created after order invoicing.", + "nullable": true, + "properties": { + "packages": { + "type": "array", + "description": "List with packages' information.", + "nullable": true, + "items": { + "type": "object", + "description": "Package details.", + "properties": { + "courier": { + "type": "string", + "description": "Name of the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) responsible for the package shipping." + }, + "description": { + "type": "string", + "description": "Package description.", + "nullable": true + }, + "invoiceNumber": { + "type": "string", + "description": "Unique identification code of the package invoice." + }, + "invoiceValue": { + "type": "integer", + "description": "Package invoice value in cents." + }, + "invoiceUrl": { + "type": "string", + "description": "Package invoice URL." + }, + "issuanceDate": { + "type": "string", + "description": "Package invoice issuance date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "trackingNumber": { + "type": "string", + "description": "Package [tracking number](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-)." + }, + "invoiceKey": { + "type": "string", + "description": "Package invoice key." + }, + "trackingUrl": { + "type": "string", + "description": "Package tracking URL." + }, + "embeddedInvoice": { + "type": "string", + "description": "Package invoice text in [xml format](https://help.vtex.com/en/tutorial/configuring-xml--tutorials_242). This field is important for stores integrated with [external marketplaces](https://developers.vtex.com/docs/guides/external-marketplace-integration-guide)." + }, + "type": { + "type": "string", + "description": "Package invoice type, which can be:\r\n- `Output`: Selling order invoice.\r\n- `Input`: Returning items invoice.", + "enum": [ + "Output", + "Input" + ] + }, + "items": { + "type": "array", + "description": "Information on each item in the package.", + "items": { + "type": "object", + "description": "Package item details.", + "properties": { + "itemIndex": { + "type": "integer", + "description": "Item index of the item position whithin the `items` array. The count starts at `0`." + }, + "id": { + "type": "string", + "description": "SKU ID." + }, + "quantity": { + "type": "integer", + "description": "Package item quantity." + }, + "price": { + "type": "integer", + "description": "Package item price in cents." + }, + "description": { + "type": "string", + "description": "Package item description." + }, + "unitMultiplier": { + "type": "number", + "description": "Package item unit multiplier." + } + } + } + }, + "courierStatus": { + "type": "object", + "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) shipping information.", + "nullable": true, + "properties": { + "deliveredDate": { + "type": "string", + "description": "Package delivery date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - } - ], - "shipsTo": [ - "BRA" - ], - "itemId": "1", - "deliveryChannels": [ - { - "id": "delivery" - } - ], - "price": 600, - "listPrice": 180, - "shippingEstimate": "25bd", - "dockEstimate": null, - "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "deliveryCompany": null, - "polygonName": "", - "transitTime": "25bd", - "sellingPrice": 600, - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Donkey", - "quantity": 1, - "kitItemDetails": null, - "accountCarrierName": "qastoreecho" - } + "status": { + "type": "string", + "description": "Defines if a carrier was assigned for order shipping (`ok`) or not (`null`).", + "nullable": true + }, + "finished": { + "type": "boolean", + "description": "Defines if the carrier has already delivered the package (`true`) or not (`false`)." + }, + "data": { + "type": "array", + "description": "Package tracking information.", + "items": { + "type": "object", + "description": "Package tracking details.", + "properties": { + "lastChange": { + "type": "string", + "description": "Date since package tracking last change in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "city": { + "type": "string", + "description": "Package tracking city." + }, + "state": { + "type": "string", + "description": "Package tracking state in two-digit code format." + }, + "description": { + "type": "string", + "description": "Package tracking description." + }, + "createDate": { + "type": "string", + "description": "Package tracking creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + } + } + } + } + } + }, + "cfop": { + "type": "string", + "description": "[CFOP](https://www.gov.br/receitafederal/pt-br/acesso-a-informacao/acoes-e-programas/facilitacao/anexo-ecf-cfop) (_Código Fiscal de Operação e Prestação_) is a Brazilian fiscal code of operations and services that classifies business transaction types.", + "nullable": true + }, + "lastChange": { + "type": "string", + "description": "Date since package tracking last change in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "restitutions": { + "type": "object", + "description": "Information about a value being returned to the customer. This field applies only to invoices with the `Input` type because it relates to returning items.", + "nullable": true, + "properties": { + "refund": { + "type": "object", + "description": "Customer refund details.", + "properties": { + "value": { + "type": "integer", + "description": "Refund value in cents." + }, + "giftCardData": { + "type": "string", + "description": "Refund involving a [gift card](https://developers.vtex.com/docs/guides/gift-card-integration-guide).", + "nullable": true + }, + "items": { + "type": "array", + "description": "Information about the items being returned.", + "nullable": true, + "items": { + "type": "object", + "description": "Returned item details.", + "properties": { + "useFreight": { + "type": "boolean", + "description": "Defines if the refund includes freight values (`true`) or not (`false`).", + "nullable": true + }, + "isCompensation": { + "type": "boolean", + "description": "Defines if there are compensated unit tags in the package (`true`) or not (`false`)." + }, + "compensationValue": { + "type": "integer", + "description": "Compensational refund value in cents." + }, + "id": { + "type": "string", + "description": "SKU ID of the returned item." + }, + "quantity": { + "type": "integer", + "description": "Number of items being returned." + }, + "price": { + "type": "integer", + "description": "Returned item price in cents." + }, + "description": { + "type": "string", + "description": "Customer reason for returning the item." + } + } + } + } + } + } + } + }, + "volumes": { + "type": "integer", + "description": "Indicates the number of boxes (volumes) needed to contain the package items. For example, two refrigerators do not fit in a single volume, so this field would have value `2`.", + "nullable": true + } + } + } + } + } + }, + "SellersUpdated": { + "type": "array", + "description": "Information about the sellers associated with the order.", + "items": { + "type": "object", + "description": "Information about a given seller.", + "properties": { + "id": { + "type": "string", + "description": "Seller identifier." + }, + "name": { + "type": "string", + "description": "Seller name." + }, + "logo": { + "type": "string", + "description": "Seller logo URL.", + "nullable": true + }, + "fulfillmentEndpoint": { + "type": "string", + "description": "URL of the endpoint for fulfillment of seller's orders, which the marketplace use to communicate with the seller." + } + } + } + }, + "InvoiceDataUpdated": { + "type": "object", + "description": "Order invoices information.", + "nullable": true, + "properties": { + "address": { + "type": "object", + "description": "Invoice address information.", + "nullable": true, + "properties": { + "addressType": { + "type": "string", + "description": "Invoice address type, which can be `residential`, when the customer gives an address for delivery, or `pickup`, when the customer picks the order at a pickup point.", + "nullable": true, + "enum": [ + "residential", + "pickup" + ] + }, + "receiverName": { + "type": "string", + "description": "Full name of the order receiver.", + "nullable": true + }, + "addressId": { + "type": "string", + "description": "Invoice address ID.", + "nullable": true + }, + "versionId": { + "type": "string", + "description": "Invoice address version ID.", + "nullable": true + }, + "entityId": { + "type": "string", + "description": "Invoice address entity ID.", + "nullable": true + }, + "postalCode": { + "type": "string", + "description": "Invoice address postal code." + }, + "city": { + "type": "string", + "description": "Invoice address city." + }, + "state": { + "type": "string", + "description": "Invoice address state." + }, + "country": { + "type": "string", + "description": "Invoice address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." + }, + "street": { + "type": "string", + "description": "Invoice address street." + }, + "number": { + "type": "string", + "description": "Invoice address number." + }, + "neighborhood": { + "type": "string", + "description": "Invoice address neighborhood." + }, + "complement": { + "type": "string", + "description": "Invoice address complement.", + "nullable": true + }, + "reference": { + "type": "string", + "description": "Invoice address additional information.", + "nullable": true + }, + "geoCoordinates": { + "type": "array", + "description": "Invoice address pair of geolocation coordinates, first longitude then latitude.", + "items": { + "type": "number", + "description": "Longitude or latitude." + } + }, + "contactId": { + "type": "string", + "description": "Contact unique identifier.", + "nullable": true + } + } + }, + "userPaymentInfo": { + "type": "object", + "description": "Invoice information regarding payment method.", + "nullable": true, + "properties": { + "paymentMethods": { + "type": "array", + "description": "List of the payment methods used by the customer in the purchase.", + "items": { + "type": "string", + "description": "Payment method name." + } + } + } + }, + "invoiceSubject": { + "type": "object", + "description": "Information about the invoice subject.", + "nullable": true, + "properties": { + "id": { + "type": "string", + "description": "Invoice subject ID." + }, + "email": { + "type": "string", + "description": "Invoice subject email address." + }, + "firstName": { + "type": "string", + "description": "Invoice subject first name." + }, + "lastName": { + "type": "string", + "description": "Invoice subject last name." + }, + "phone": { + "type": "string", + "description": "Invoice subject phone number." + } + } + } + } + }, + "ChangesAttachmentUpdated": { + "type": "object", + "description": "Information about changes in the order.", + "nullable": true, + "required": [ + "id", + "changesData" + ], + "properties": { + "id": { + "type": "string", + "description": "Order changes ID." + }, + "changesData": { + "type": "array", + "description": "Order changes details.", + "items": { + "required": [ + "reason", + "discountValue", + "incrementValue", + "itemsAdded", + "itemsRemoved", + "receipt" + ], + "type": "object", + "description": "Details about an order change.", + "properties": { + "reason": { + "type": "string", + "description": "Text explaining why the order was changed. This information may be shown to the customer in the storefront or transactional emails." + }, + "discountValue": { + "type": "integer", + "description": "Order change discount value in cents.", + "nullable": true + }, + "incrementValue": { + "type": "integer", + "description": "Order change increment value in cents.", + "nullable": true + }, + "itemsAdded": { + "type": "array", + "description": "Information about items added to the order, when applicable.", + "nullable": true, + "items": { + "type": "object", + "description": "Information about an item added to the order.", + "properties": { + "id": { + "type": "string", + "description": "Added item SKU ID." + }, + "name": { + "type": "string", + "description": "Added item SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of items added." + }, + "price": { + "type": "integer", + "description": "Added item price in cents." + }, + "unitMultiplier": { + "type": "string", + "description": "Added item unit multiplier.", + "nullable": true + } + } + } + }, + "itemsRemoved": { + "type": "array", + "description": "Information about items removed from the order, when applicable.", + "nullable": true, + "items": { + "type": "object", + "description": "Information about an item removed from the order.", + "required": [ + "id", + "name", + "quantity", + "price", + "unitMultiplier" + ], + "properties": { + "id": { + "type": "string", + "description": "Removed item SKU ID." + }, + "name": { + "type": "string", + "description": "Removed item name." + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "Quantity of removed items." + }, + "price": { + "type": "integer", + "format": "int32", + "description": "Removed item price in cents." + }, + "unitMultiplier": { + "type": "string", + "description": "Removed item unit multiplier.", + "nullable": true + } + } + } + }, + "receipt": { + "required": [ + "date", + "orderId", + "receipt" ], - "deliveryWindow": null, - "pickupPointId": null, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupDistance": null - } - ] - } + "type": "object", + "description": "Order changes receipt information.", + "properties": { + "date": { + "type": "string", + "description": "Receipt creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "orderId": { + "type": "string", + "description": "Order ID." + }, + "receipt": { + "type": "string", + "description": "Receipt unique identifier code." + } + } + } } - } - ], - "date": "2024-07-27T17:52:18.6483116Z", - "origin": { - "account": "qastore", - "orderId": "v12772213qst-02", - "component": "MarketplaceComponent" - }, - "settings": { - "customPaymentSystemsAllowed": [ - "201" - ] } - } - } - } - } - } - } - }, - "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry": { - "post": { - "tags": [ - "Change order (beta)" - ], - "summary": "Retry order change", - "operationId": "RetryChange", - "description": "This endpoint makes a new attempt to perform an order change previously made using the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint that, for some reason, was not completely processed.\r\n\r\nTo make this request, you need the `changeRequestId`, a unique change identification code that you get when you make a [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) request. When you retry to change an order using the `changeRequestId`, instead of creating a new change, you avoid duplications.\r\n\r\nThis endpoint's successful response status code is `204 No Content`, therefore with no response body.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "an", - "in": "query", - "description": "Name of the VTEX account that created the order.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "storeName" - } - }, - { - "name": "changeOrderId", - "in": "path", - "description": "Order ID of the order you wish to retry change.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "v12772213qst-02" - } - }, - { - "name": "changeRequestId", - "in": "path", - "description": "Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code.\r\n\r\nThere are no limits to changes you can perform using the same `changeRequestId`, and we recommend keeping all changes of a given order grouped by the same `changeRequestId`, so you will have a unified change history.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Createchange" } - } } - }, - "responses": { - "204": { - "description": "No Content" - } - } - } - }, - "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel": { - "post": { - "tags": [ - "Change order (beta)" - ], - "summary": "Cancel order change", - "operationId": "CancelChangeStoppedonError", - "description": "This endpoint cancels an [order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes). It is meant for when, due to an error, a change was not completely processed, and you do not wish to [retry](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/retry) it. For this request, you need the order's `changeRequestId`, the unique identification code generated by the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n>⚠️ Once an order change has been successfully processed, canceling it is no longer possible. If you wish to revert the changes made to an order, you will have to [create a new order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "an", - "in": "query", - "description": "Name of the VTEX account that created the order.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "storeName" - } - }, - { - "name": "changeOrderId", - "in": "path", - "description": "Order ID of the order with the changes you wish to cancel.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "v12772213qst-02" - } - }, - { - "name": "changeRequestId", - "in": "path", - "description": "Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code. After cancelling an order change, the `changeRequestId` will no longer be valid.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" - } + }, + "StorePreferencesDataUpdated": { + "type": "object", + "description": "Store preferences in the [Account settings](https://help.vtex.com/en/tutorial/account-details-page--2vhUVOKfCaswqLguT2F9xq) page.", + "properties": { + "countryCode": { + "type": "string", + "description": "Country code in three-digit [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." + }, + "currencyCode": { + "type": "string", + "description": "Currency code in [ISO 4217](https://www.iban.com/currency-codes) format." + }, + "currencyFormatInfo": { + "type": "object", + "description": "Currency format settings.", + "properties": { + "CurrencyDecimalDigits": { + "type": "integer", + "description": "Number of currency decimal digits." + }, + "CurrencyDecimalSeparator": { + "type": "string", + "description": "Character for currency decimal separation." + }, + "CurrencyGroupSeparator": { + "type": "string", + "description": "Character for currency group separation." + }, + "CurrencyGroupSize": { + "type": "integer", + "description": "Limit of characters that can be grouped for currency groups." + }, + "StartsWithCurrencySymbol": { + "type": "boolean", + "description": "Defines if the prices displayed for customers start with the currency symbol (`true`) or not (`false`)." + } + } + }, + "currencyLocale": { + "type": "integer", + "description": "Currency locale code in [LCID](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a) format." + }, + "currencySymbol": { + "type": "string", + "description": "Currency symbol characters." + }, + "timeZone": { + "type": "string", + "description": "Time zone considered for the store orders." + } } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "reason" - ], - "properties": { - "reason": { - "type": "string", - "description": "Reason why you wish to cancel the order change. The customer will not view the value inserted in this field.", - "example": "I want to cancel this change order request because it's stopped on a blocking error." + }, + "MarketplaceUpdated": { + "type": "object", + "description": "Information about the marketplace related to the order.", + "nullable": true, + "properties": { + "baseURL": { + "type": "string", + "description": "Marketplace base URL." + }, + "isCertified": { + "type": "boolean", + "nullable": true, + "description": "Defines if the marketplace is a [VTEX certified marketplace](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-certified-marketplaces) (`true`) or not (`false`)." + }, + "name": { + "type": "string", + "description": "Marketplace name." + } + } + }, + "ItemMetadataUpdated": { + "type": "object", + "description": "Metadata information about items.", + "properties": { + "Items": { + "type": "array", + "description": "Metadata details about items.", + "items": { + "type": "object", + "description": "Metadata details about a given item", + "properties": { + "Id": { + "type": "string", + "description": "SKU ID." + }, + "Seller": { + "type": "string", + "description": "Seller ID." + }, + "Name": { + "type": "string", + "description": "Item name as displayed to customers in the storefront." + }, + "SkuName": { + "type": "string", + "description": "SKU name." + }, + "ProductId": { + "type": "string", + "description": "Product ID." + }, + "RefId": { + "type": "string", + "description": "SKU reference ID." + }, + "Ean": { + "type": "string", + "description": "European Article Number (EAN) of the item.", + "nullable": true + }, + "ImageUrl": { + "type": "string", + "description": "SKU image URL." + }, + "DetailUrl": { + "type": "string", + "description": "SKU slug." + }, + "AssemblyOptions": { + "type": "array", + "description": "[Assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) information related to the item, when applicable.", + "nullable": true, + "items": { + "type": "object", + "description": "[Assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) details.", + "properties": { + "Id": { + "type": "string", + "description": "Assembly option ID." + }, + "Name": { + "type": "string", + "description": "Assembly option name." + }, + "Required": { + "type": "boolean", + "description": "Defines if sending the attachment for the item purchased is required(`true`) or optional (`false`)." + }, + "InputValues": { + "type": "object", + "description": "Assembly option content.", + "nullable": true, + "additionalProperties": { + "type": "string", + "description": "Assembly option value.", + "nullable": true + } + }, + "Composition": { + "type": "object", + "description": "Assembly option composition.", + "nullable": true, + "additionalProperties": { + "type": "string", + "description": "Assembly option composition value." + } + } + } } } } } } - }, - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/order-system/orders/changes/settings": { - "put": { - "tags": [ - "Change order (beta)" - ], - "summary": "Update Change order settings", - "description": "Updates the [Change order](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) settings from a store.\r\n\r\n>ℹ️ To know more about **Change order**, see [How Change order works (Beta)](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order<\/p>

Change order<\/p> |\r\n| inStore Sales Person |

Cancel order<\/p>

Change order<\/p> |\r\n\r\n>\u2757 Assigning a [predefined role](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).", - "parameters": [ - { - "name": "an", - "in": "query", - "description": "VTEX [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC).", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "storename" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "application/json" - } } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "paymentConfiguration": { - "type": "object", - "description": "[Change order](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) payment configurations.", - "properties": { - "customPaymentSystemsAllowed": { - "type": "array", - "description": "List of custom payment system IDs configured for the VTEX account.", - "items": { - "type": "string", - "description": "Payment system ID.", - "example": "201" - } - } - } - }, - "rolloutConfiguration": { - "type": "object", - "description": "**Change order** settings regarding VTEX Admin, [Orders API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes?endpoint=patch-/api/order-system/orders/-changeOrderId-/changes) and **My Account** feature.", - "properties": { - "enableApi": { - "type": "boolean", - "description": "Defines if the account enabled the [Change order API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) (`true`) or not (`false`). The account can only use the [Change order via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw) or [via API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) if this field is set to `true`.", - "default": false, - "example": true - }, - "enableAdminOrders": { - "type": "object", - "description": "Object about enabling the [Change order feature via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw).", - "properties": { - "enabledWorkspaces": { - "type": "array", - "description": "List with the workspaces' names that have the **Change order** feature enabled via VTEX Admin.", - "items": { - "type": "string", - "description": "Name of the workspace with **Change order** enabled via VTEX Admin. The asterisk `*` value includes all of the account's workspaces.", - "example": "*" - } + }, + "SubscriptionDataUpdated": { + "type": "object", + "description": "Information about [subscriptions](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453), when applicable.", + "nullable": true, + "properties": { + "subscriptionGroupId": { + "type": "string", + "description": "Subscription group ID. If this field returns `null` and the `executionCount` is `0`, the order is the first subscription order.", + "nullable": true + }, + "subscriptions": { + "type": "array", + "description": "List with subscriptions details.", + "nullable": true, + "items": { + "type": "object", + "description": "Subscription details.", + "properties": { + "executionCount": { + "type": "integer", + "description": "Position of the order in the subscription cycle. The first order will have the value `0`, the second will have the value `1`, and so on." + }, + "priceAtSubscriptionDate": { + "type": "number", + "description": "Value of the order when the customer subscribed. Subscriptions created via VTEX Admin or [Subscriptions API](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3) do not have an original order, so this field returns `0.0`.", + "nullable": true, + "deprecated": true + }, + "itemIndex": { + "type": "integer", + "description": "Each item in the subscription order is identified by an index. The position starts in `0`, followed by `1`, `2`, and so on." + }, + "plan": { + "type": "object", + "description": "Information about the [subscription plan](https://help.vtex.com/en/tutorial/subscription-plans-beta--5kczKRqHEsrs1tYtRcY8wR).", + "properties": { + "type": { + "type": "string", + "description": "Plan type." + }, + "frequency": { + "type": "object", + "description": "Information about subscriptions' recurrence.", + "properties": { + "periodicity": { + "type": "string", + "description": "Defines the subscription recurrence period.", + "enum": [ + "DAILY", + "WEEKLY", + "MONTHLY", + "YEARLY" + ] + }, + "interval": { + "type": "integer", + "description": "Time interval configured between subscription orders, which depends on the frequency. For a `DAY` frequency, the value will be days, for `MONTH` it will be months, and so on." + } + } + }, + "validity": { + "type": "object", + "description": "Information about the period during which the subscription will be valid.", + "properties": { + "begin": { + "type": "string", + "description": "Subscription plan beginning date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "end": { + "type": "string", + "description": "Subscription plan ending date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "nullable": true + } + } + } + } } - } - }, - "enableMyOrders": { - "type": "object", - "description": "Object about enabling the **Change order** feature via [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).", - "properties": { - "enabledWorkspaces": { - "type": "array", - "description": "List with the workspaces' names that have the **Change order** feature enabled via **My Account**.", - "items": { + } + } + } + } + }, + "TaxDataUpdated": { + "type": "object", + "description": "Order taxes information.", + "required": [ + "areTaxesDesignatedByMarketplace", + "taxInfoCollection" + ], + "nullable": true, + "properties": { + "areTaxesDesignatedByMarketplace": { + "type": "boolean", + "description": "Defines if the taxes were applied by the marketplace (`true`) or not (`false`)." + }, + "taxInfoCollection": { + "type": "array", + "description": "Order taxes details.", + "items": { + "type": "object", + "description": "Information about a given tax.", + "required": [ + "itemIndex", + "sku", + "priceTags" + ], + "properties": { + "itemIndex": { + "type": "integer", + "description": "Item indexing number." + }, + "sku": { "type": "string", - "description": "Name of the workspace with **Change order** enabled via **My Account**. The asterisk `*` value includes all of the account's workspaces.", - "example": "storename" - } + "description": "SKU ID." + }, + "priceTags": { + "type": "object", + "description": "Information about order taxes.", + "nullable": true, + "properties": { + "areTaxesDesignatedByMarketplace": { + "type": "boolean", + "description": "Defines if the taxes were designated by the marketplace (`true`) or not (`false`)." + }, + "taxInfoCollection": { + "type": "array", + "description": "Array with taxes' details.", + "items": { + "type": "object", + "description": "Details about a given tax.", + "properties": { + "itemIndex": { + "type": "integer", + "description": "Item index number." + }, + "sku": { + "type": "string", + "description": "Alphanumeric sequence that identifies a SKU." + }, + "priceTags": { + "type": "array", + "description": "Price tags information with the original taxes calculated at order placement.", + "items": { + "type": "object", + "description": "Information about a given price tag.", + "properties": { + "identifier": { + "type": "string", + "description": "Price tag identifier code." + }, + "isPercentual": { + "type": "boolean", + "description": "Indicates whether price tag value is applied through a percentage (`true`) or not (`false`)." + }, + "name": { + "type": "string", + "description": "Price tag name." + }, + "value": { + "type": "number", + "description": "Price tag value." + }, + "rawValue": { + "type": "number", + "description": "Price tag raw value that can contain up to five decimals, separated by a period." + } + } + } + } + } + } + } + } } - } - } - } - }, - "pipelineConfiguration": { - "type": "object", - "description": "**Change order** settings related to taxes and shipping calculation.", - "properties": { - "enableTaxHubRecalculation": { - "type": "boolean", - "description": "Defines if the tax calculation is enabled for **Change order** (`true`) or not (`false`).", - "default": false, - "example": false - }, - "compensateShippingChanges": { - "type": "boolean", - "description": "Defines if the orders changed will have zero shipping cost (`true`) or not (`false`). Merchants can enable this configuration to change only items and prices, without impacting the orders' original freight costs.", - "default": true, - "example": true } - } } - } } - } } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeOrderSettingsResponse" - }, - "example": { - "paymentConfiguration": { - "customPaymentSystemsAllowed": [ - "201", - "125" - ] - }, - "rolloutConfiguration": { - "usingDefaultBehavior": false, - "enableApi": true, - "enableAdminOrders": { - "enabledWorkspaces": [ - "*" - ] - }, - "enableMyOrders": { - "enabledWorkspaces": [ - "*" - ] - } - }, - "pipelineConfiguration": { - "enableTaxHubRecalculation": false, - "compensateShippingChanges": true - } - } + }, + "CancellationDataUpdated": { + "type": "object", + "description": "Information about [order cancellation](https://developers.vtex.com/docs/guides/order-canceling-improvements), when applicable.", + "nullable": true, + "properties": { + "requestedByUser": { + "type": "boolean", + "description": "Defines if the order cancellation was requested by the customer (`true`) or not (`false`)." + }, + "requestedBySystem": { + "type": "boolean", + "description": "Defines if the order cancellation was made by the system (`true`) or not (`false`). This type of order cancellation happens in [incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294), for example.", + "nullable": true + }, + "requestedBySellerNotification": { + "type": "boolean", + "description": "Defines if the order cancellation was requested by the seller (`true`) or not (`false`).", + "nullable": true + }, + "requestedByPaymentNotification": { + "type": "boolean", + "description": "Defines if the order cancellation was requested by the payment gateway (`true`) or not (`false`).", + "nullable": true + }, + "reason": { + "type": "string", + "description": "Reason why the order was canceled." + }, + "cancellationDate": { + "type": "string", + "description": "Order cancellation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "cancellationRequestId": { + "type": "string", + "description": "ID that identifies the cancellation operation." } - } } - } }, - "get": { - "tags": [ - "Change order (beta)" - ], - "summary": "Get Change order settings", - "description": "Retrieves the [Change order settings](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/order-system/orders/changes/settings) from a store.\r\n\r\n>ℹ️ To know more about **Change order**, see [How Change order works (Beta)](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | View order |\r\n| Checkout Admin | View order |\r\n| IntegrationProfile - Fulfillment Oms | View order |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", - "parameters": [ - { - "name": "an", - "in": "query", - "description": "VTEX [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC).", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "mystore" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeOrderSettingsResponse" - }, - "example": { - "paymentConfiguration": { - "customPaymentSystemsAllowed": [ - "201", - "125" - ] + "CancellationRequestsUpdated": { + "type": "array", + "description": "Information about the [seller order cancellation denials](https://developers.vtex.com/docs/guides/order-canceling-improvements), regardless if the cancellation request was made by the marketplace or the customer.", + "nullable": true, + "items": { + "type": "object", + "description": "Information about the seller denial to a given order cancellation request.", + "properties": { + "id": { + "type": "string", + "description": "ID that identifies the original cancellation operation made by the marketplaces or its customer care service using the [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/cancel) endpoint." }, - "rolloutConfiguration": { - "usingDefaultBehavior": false, - "enableApi": true, - "enableAdminOrders": { - "enabledWorkspaces": [ - "*" - ] - }, - "enableMyOrders": { - "enabledWorkspaces": [ - "*" - ] - } + "reason": { + "type": "string", + "description": "Reason why there was a request to cancel the order." }, - "pipelineConfiguration": { - "enableTaxHubRecalculation": false, - "compensateShippingChanges": true + "cancellationRequestDate": { + "type": "string", + "description": "Date of when the order cancellation request was processed by the platform. The date format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "requestedByUser": { + "type": "boolean", + "description": "Defines if the order cancellation was requested by the customer (`true`) or not (`false`)." + }, + "deniedBySeller": { + "type": "boolean", + "description": "Defines if the order cancellation request was [denied by the seller](https://developers.vtex.com/docs/guides/order-canceling-improvements) (`true`) or accepted by the seller (`false`)." + }, + "deniedBySellerReason": { + "type": "string", + "description": "Reason given by the seller for denying the order cancellation.", + "nullable": true + }, + "cancellationRequestDenyDate": { + "type": "string", + "description": "Date of when the platform processed the seller denial to an order cancellation request. The date format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "nullable": true } - } } - } - } - } - } - } - }, - "security": [ - { - "appKey": [], - "appToken": [] - }, - { - "VtexIdclientAutCookie": [] - } - ], - "components": { - "parameters": { - "UNUSED_incompleteOrders": - { - "name": "incompleteOrders", - "in": "query", - "description": "You can use this parameter to filter [incomplete orders](https://help.vtex.com/en/tutorial/understanding-incomplete-orders) by their situations, whether permanent (`perm`) or temporary (`temp`). When the situation is temporary, the order is still opened and has not being cancelled. To filter the total number of incomplete orders, use the value `all`.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "all" } - } - }, - "securitySchemes": { - "appKey": { - "type": "apiKey", - "in": "header", - "name": "X-VTEX-API-AppKey", - "description": "Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." }, - "appToken": { - "type": "apiKey", - "in": "header", - "name": "X-VTEX-API-AppToken", - "description": "Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." + "ClientPreferencesDataUpdated": { + "type": "object", + "description": "Information about the customer preferences.", + "properties": { + "locale": { + "type": "string", + "description": "Language code of the customer preferred language while accessing the store." + }, + "optinNewsLetter": { + "type": "boolean", + "description": "Defines if the customer receives the store's newsletter (`true`) or not (`false`)." + } + } }, - "VtexIdclientAutCookie": { - "type": "apiKey", - "in": "header", - "name": "VtexIdclientAutCookie", - "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours." - } - }, - "schemas": { "Total": { "required": ["id", "name", "value"], "type": "object", @@ -10075,7 +14291,8 @@ } }, "Dimension": { - "title": "Dimension", + "type": "object", + "description": "Item dimensions.", "required": [ "cubicweight", "height", @@ -10083,35 +14300,27 @@ "weight", "width" ], - "type": "object", "properties": { "cubicweight": { "type": "number", - "description": "Item's cubic weight." + "description": "Item cubic weight." }, "height": { - "type": "integer", - "description": "Item's height." + "type": "number", + "description": "Item height." }, "length": { - "type": "integer", - "description": "Item's length." + "type": "number", + "description": "Item length." }, "weight": { - "type": "integer", - "description": "Item's weight." + "type": "number", + "description": "Item weight." }, "width": { - "type": "integer", - "description": "Item's width." + "type": "number", + "description": "Item width." } - }, - "example": { - "cubicweight": 0.7031, - "height": 15, - "length": 15, - "weight": 15, - "width": 15 } }, "ClientProfileData": {