Vtex Pricechange Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "PriceChange",
"method": "PUT",
"path": "/api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/price",
"summary": "VTex Change price of an SKU in a cart",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"price": 10000
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"orderFormId": "ede846222cd44046ba6c638442c3505a",
"salesChannel": "1",
"loggedIn": true,
"isCheckedIn": false,
"storeId": "1",
"checkedInPickupPointId": "21",
"allowManualPrice": true,
"canEditData": true,
"userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
"userType": "User type",
"ignoreProfileData": false,
"value": 10000,
"messages": [],
"items": [
{
"uniqueId": "E0F2B7AF5CD74D668F1E27537206912C",
"id": "1",
"productId": "1",
"productRefId": "1",
"refId": "0001",
"ean": "123456789",
"name": "Ra\u00e7\u00e3o Royal Canin Feline Urinary 500g",
"skuName": "Ra\u00e7\u00e3o Royal Canin Feline Urinary 500g",
"modalType": null,
"parentItemIndex": null,
"parentAssemblyBinding": null,
"assemblies": [],
"priceValidUntil": "2021-02-27T14:59:00.8288784Z",
"tax": 0,
"taxCode": "54WC8ZN6K8",
"price": 15000,
"listPrice": 30000,
"manualPrice": 10000,
"sellingPrice": 10000,
"rewardValue": 0,
"isGift": false,
"additionalInfo": {
"brandName": "Royal Canin",
"brandId": "2000000",
"offeringInfo": null,
"offeringType": null,
"offeringTypeId": null
},
"preSaleDate": null,
"productCategoryIds": "/1/10/",
"productCategories": {
"1": "Alimenta\u00e7\u00e3o",
"10": "Ra\u00e7\u00e3o Seca"
},
"quantity": 1,
"seller": "1",
"sellerChain": [
"1"
],
"imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
"detailUrl": "/racao-royal-canin-feline-urinary/p",
"components": [],
"bundleItems": [],
"attachments": [],
"attachmentOfferings": [],
"offerings": [],
"priceTags": [
{
"name": "DISCOUNT@MANUALPRICE",
"value": -5000,
"rawValue": -50,
"isPercentual": false,
"identifier": null
}
],
"availability": "available",
"measurementUnit": "un",
"unitMultiplier": 1,
"manufacturerCode": null
}
],
"selectableGifts": [],
"totalizers": [
{
"id": "Items",
"name": "Total dos Itens",
"value": 15000
},
{
"id": "Discounts",
"name": "Total dos Descontos",
"value": -5000
}
],
"shippingData": {
"address": null,
"logisticsInfo": [
{
"itemIndex": 0,
"selectedSla": "Normal",
"selectedDeliveryChannel": "delivery",
"addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
"slas": [],
"shipsTo": [
"BRA"
],
"itemId": "1",
"deliveryChannels": [
{
"id": "pickup-in-point"
},
{
"id": "delivery"
}
]
}
],
"selectedAddresses": [],
"availableAddresses": [],
"pickupPoints": []
},
"clientProfileData": null,
"paymentData": {
"installmentOptions": [
{
"paymentSystem": 2,
"bin": null,
"paymentName": null,
"paymentGroupName": null,
"value": 10000,
"installments": [
{
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 10000,
"total": 10000,
"sellerMerchantInstallments": [
{
"id": "LOJADOBRENO",
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 10000,
"total": 10000
}
]
},
{
"count": 2,
"hasInterestRate": false,
"interestRate": 0,
"value": 5000,
"total": 10000,
"sellerMerchantInstallments": [
{
"id": "LOJADOBRENO",
"count": 2,
"hasInterestRate": false,
"interestRate": 0,
"value": 5000,
"total": 10000
}
]
}
]
}
],
"paymentSystems": [
{
"id": 2,
"name": "Visa",
"groupName": "creditCardPaymentGroup",
"validator": {
"regex": "^4[0-9]{15}$",
"mask": "9999 9999 9999 9999",
"cardCodeRegex": "^[0-9]{3}$",
"cardCodeMask": "999",
"weights": [
2,
1,
2,
1,
2
],
"useCvv": true,
"useExpirationDate": true,
"useCardHolderName": true,
"useBillingAddress": true
},
"stringId": "2",
"template": "creditCardPaymentGroup-template",
"requiresDocument": false,
"isCustom": false,
"description": "Payment description",
"requiresAuthentication": false,
"dueDate": "2020-03-05T16:42:31.7836281Z",
"availablePayments": null
}
],
"payments": [
{
"paymentSystem": 6,
"bin": null,
"accountId": "12",
"tokenId": null,
"value": 34390,
"referenceValue": 34390,
"giftCardRedemptionCode": null,
"giftCardProvider": null,
"giftCardId": null
}
],
"giftCards": [],
"giftCardMessages": [],
"availableAccounts": [],
"availableTokens": []
},
"marketingData": null,
"sellers": [
{
"id": "1",
"name": "lojadobreno",
"logo": "Logo"
}
],
"clientPreferencesData": {
"locale": "pt-BR",
"optinNewsLetter": null
},
"commercialConditionData": null,
"storePreferencesData": {
"countryCode": "BRA",
"saveUserData": true,
"timeZone": "E. South America Standard Time",
"currencyCode": "BRL",
"currencyLocale": 1046,
"currencySymbol": "R$",
"currencyFormatInfo": {
"currencyDecimalDigits": 2,
"currencyDecimalSeparator": ",",
"currencyGroupSeparator": ".",
"currencyGroupSize": 3,
"startsWithCurrencySymbol": true
}
},
"giftRegistryData": null,
"openTextField": null,
"invoiceData": null,
"customData": null,
"itemMetadata": {
"items": [
{
"id": "1",
"seller": "1",
"name": "Ra\u00e7\u00e3o Royal Canin Feline Urinary 500g",
"skuName": "Ra\u00e7\u00e3o Royal Canin Feline Urinary 500g",
"productId": "1",
"refId": "0001",
"ean": "123456789",
"imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
"detailUrl": "/racao-royal-canin-feline-urinary/p",
"assemblyOptions": []
}
]
},
"hooksData": null,
"ratesAndBenefitsData": {
"rateAndBenefitsIdentifiers": [],
"teaser": []
},
"subscriptionData": null,
"itemsOrdination": {
"criteria": "NAME",
"ascending": true
}
}
}
]
}