Get order

Retrieves order details by searching a specific order ID or sequence number.

The View order 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.

📘

Onboarding guide

Check the new Orders onboarding guide. 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.

Throttling

Throttling: Each account can make up to 5000 requests per minute.

Request body example

curl --location --request GET 'https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/v5195004lux-01' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \
--header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}'

Response body example

{
  "emailTracked": "[email protected]",
  "approvedBy": null,
  "cancelledBy": null,
  "cancelReason": null,
  "orderId": "v5195004lux-01",
  "sequence": "502556",
  "marketplaceOrderId": "",
  "marketplaceServicesEndpoint": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
  "sellerOrderId": "00-v5195004lux-01",
  "origin": "Marketplace",
  "affiliateId": "",
  "salesChannel": "1",
  "merchantName": null,
  "status": "handling",
  "statusDescription": "Preparando Entrega",
  "value": 1160,
  "creationDate": "2019-01-28T20:09:43.8999580+00:00",
  "lastChange": "2019-02-06T20:46:11.7010747+00:00",
  "orderGroup": null,
  "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-v5195004lux-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": [],
      "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,
      "priceDefinition": {
        "sellingPrice": [
          {
             "quantity": 1,
             "value": 3290,
          }
        ],
        "total": 3290     
      },
      "taxCode": null,
      "parentItemIndex": null,
      "parentAssemblyBinding": null
    }
  ],
  "marketplaceItems": [],
  "clientProfileData": {
    "id": "clientProfileData",
    "email": "[email protected]",
    "firstName": "Rodrigo",
    "lastName": "VTEX",
    "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": null,
  "ratesAndBenefitsData": {
    "id": "ratesAndBenefitsData",
    "rateAndBenefitsIdentifiers": []
  },
  "shippingData": {
    "id": "shippingData",
    "address": {
      "addressType": "residential",
      "receiverName": "Rodrigo Cunha",
      "addressId": "-1425945657910",
      "postalCode": "22250-040",
      "city": "Rio de Janeiro",
      "state": "RJ",
      "country": "BRA",
      "street": "Praia de Botafogo",
      "number": "300",
      "neighborhood": "Botafogo",
      "complement": "3",
      "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": null
          },
          {
            "id": "Expressa",
            "name": "Expressa",
            "shippingEstimate": "5bd",
            "deliveryWindow": null,
            "price": 1160,
            "deliveryChannel": "delivery",
            "pickupStoreInfo": {
              "additionalInfo": null,
              "address": null,
              "dockId": null,
              "friendlyName": null,
              "isPickupStore": false
            },
            "polygonName": null
          },
          {
            "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": null
          },
          {
            "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": null
          }
        ],
        "shipsTo": [
          "BRA"
        ],
        "deliveryIds": [
          {
            "courierId": "197a56f",
            "courierName": "Todos os CEPS",
            "dockId": "1",
            "quantity": 1,
            "warehouseId": "1_1"
          }
        ],
        "deliveryChannel": "delivery",
        "pickupStoreInfo": {
          "additionalInfo": null,
          "address": null,
          "dockId": null,
          "friendlyName": null,
          "isPickupStore": false
        },
        "addressId": "-1425945657910",
        "polygonName": null
      }
    ],
    "trackingHints": null,
    "selectedAddresses": [
      {
        "addressId": "-1425945657910",
        "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,
            "firstDigits": null,
            "lastDigits": 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": {},
            "billingAddress": {
                  "postalCode": "00000-000",
                  "city": "Rio de Janeiro",
                  "state": "RJ",
                  "country": "BRA",
                  "street": "Avenida Vice-Presidente José Alencar",
                  "number": "0000",
                  "neighborhood": "Jacarepaguá",
                  "complement": null,
                  "reference": null,
                  "geoCoordinates": [
                       -43.386474609375,
                       -22.965709686279297
                  ]
             }
          }
        ]
      }
    ]
  },
  "packageAttachment": {
    "packages": []
  },
  "sellers": [
    {
      "id": "1",
      "name": "Loja do Suporte",
      "logo": ""
    }
  ],
  "callCenterOperatorData": null,
  "followUpEmail": "[email protected]",
  "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": "v5195004lux-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": false,
  "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.0000000+00:00",
  "invoicedDate": null
}

Request object has the following properties:

AttributeTypeDescription
orderIdstringOrder Id

Response object has the following properties:

AttributeTypeDescription
affiliateIdstringSeller Name who was responsible for the order
allowCancellationbooleanIf Cancellation is allowed
allowEditionbooleanIf Order Edition is allowed
approvedBystringUser who approved the order
authorizedDatestringAuthorized Order Date
callCenterOperatorDatastringCall Center Operator responsible for the order
cancelReasonstringCancel Reason
cancelledBystringUser who Cancelled the order
changesAttachmentobjectChange details object
changesDataobjectArray with each change
discountValueintegerChange Discount Value
incrementValueintegerChange Increment Value
itemsAddedobjectAdded items details
itemsRemovedobjectRemoved items details
idintegerChanged SKU ID
namestringChanged SKU Name
priceintegerChanged SKU Price
quantityintegerChanged SKU Quantity
unitMultiplierintegerChanged SKU Unit Multiplier
reasonstringChange Reason
receiptobjectChange receipt details object
datestringChange receipt date
orderIdstringChange receipt order Id
receiptobjectChange receipt ID
idstringObject Id, expect value "changeAttachment"
clientProfileDataobjectObject with all Cliente Profile Data
corporateDocumentstringClient Corporate Document
corporateNamestringClient Corporate Name
corporatePhonestringCliente Corporate Telephone
customerClassstringCustomer class
documentstringClient Document
documentTypestringClient Document Type
emailstringClient e-mail
firstNamestringClient First Name
idstringObject ID, expected value "clientProfileData"
isCorporatestringIf the Client is a Corporate Client
lastNamestringClient Last Name
phonestringClient Telephone
stateInscriptionstringClient Corporate Inscription
tradeNamestringClient Corporate Trade Name
userProfileIdstringClient User Profile ID
commercialConditionDataobjectCommercial condition information, including "Id", "parentOrderId", and "reason"
creationDatestringOrder Creation Date
customDataobjectCustom Data Object
customAppsobjectCustom apps details object
fieldsobjectCustom app fields
idstringCustom App ID
majorintegerMajor
emailTrackedstringClient Conversation Tracker email
followUpEmailstringResponsible store e-mail
giftRegistryDataobjectGift registry list information, including "addressId" (object), "description" (string), and "giftRegistryId" (string)
hostnamestringAccount hostname registered in License Manager
invoiceDataobjectInformation pertinent to the order's invoice
invoicedDatestringInvoice Date
isCheckedInbooleanTrue if order is from inStore
isCompletedbooleanTrue if the order is completed
itemsobjectOrder items object
additionalInfostringOrder item additional info
brandIdstringBrand ID
brandNamestringBrand name
categoriesIdsstringItem category ID
commercialConditionIdstringInvoice date
dimensionobjectItem dimension object
cubicweightnumberItem cubic weight
heightnumberItem height
lengthnumberItem length
weightnumberItem weight
widthnumberItem width
offeringInfostringExtra information on offering
offeringTypestringOffering type
offeringTypeIdstringID of offering type
productClusterIdstringAll releated product clusters
attachmentsobjectAttachents Array
contentobjectAttachment Content Custom Field
namestringAttachment Name
bundleItemsobjectInvoice date
commissionstringComission value registered to Seller
componentsobjectIf item is a kit, contains components information
detailUrlstringProduct Slug URL
eanstringSKU EAN
freightCommissionintegerComission value registered to seller
idstringSKU Id
imageUrlstringSKU Image URL
isGiftstringIf this item is a gift in order context
itemAttachmentobjectAttachment Object
contentobjectAttachment Content Array
namestringAttachment Name
listPriceintegerItem List Price
lockIdstringReservation ID
manualPricestringManually inserted price, if there is one.
measurementUnitstringItem measurement unit
namestringItem name
offeringsobjectOfferings information
paramsobject"ContextParameter" hashset with "name" and "value"
preSaleDatestringItem pre sale date
priceintegerItem Price
items[].priceDefinitionObjectPrice information for all units of a specific item.
items[].priceDefinition.totalIntegerTotal value for all units of the item in cents.
items[].priceDefinition.calculatedSellingPriceIntegerItem's calculated unitary selling price in cents.
items[].priceDefinition.sellingPricesArrayArray of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
priceTagsobjectObject with all price modifiers
identifierstringPrice Tag ID
isPercentualbooleanIndicates whether the price tag is a percentual modifier
namestringPrice tag name
rawValuestringPrice tag raw value
valuestringPrice tag value
priceValidUntilstringPrice expiration date
productIdstringItem product ID
quantityintegerItem quantity
refIdstringItem reference ID
rewardValueintegerItem reward value
sellerstringItem seller
sellerSkustringInvoice Date
sellingPriceintegerItem selling price. For more accurate information, see the priceDefinition field
shippingPricestringItem Shipping Price
taxintegerItem Tax
taxCodestringItem Tax Code
uniqueIdstringItem Order Unique ID
unitMultiplierintegerItem Unit Multipler
lastChangestringOrder Last Change Date
lastMessagestringinitial excerpt from last message sent to the customer
marketingDatastringMarketing Data Object
couponstringOrder Disccount Coupon
idstringObject ID, expected value "marketingData"
marketingTagsobjectMarketing Tags Array
utmCampaignstringUTM Campaign Parameters
utmMediumstringUTM Medium Parameters
utmPartnerstringUTM Source Parameters
utmSourcestringUTM Source Parameters
utmiCampaignstringUTMI Campaign Internal Parameters
utmiPartstringUTMI Part Internal Parameters
utmipagestringUTMI Page Internal Parameters
marketplaceobjectMarketplace Details Object
baseURLstringMarketplace Base URL
isCertifiedstringIf is a Certified Marketplace
namestringMarketplace Name
marketplaceItemsobjectMarketplace Details Object
marketplaceOrderIdstringMarketplace Order Id
marketplaceServicesEndpointstringMarketplace Services Endpoint
merchantNamestringMerchant Name
openTextFieldobjectOpen Text Field Object
valuestringOpen Text Field Value
orderFormIdstringOrder Form Id
orderGroupstringOrder Group Id
orderIdstringOrder Id
originstringOrder Origin: "Marketplace", "Fulfillment", or "Chain" (for the third level in a Multilevel Omnichannel Inventory purchase).
packageAttachmentobjectPackage Object
packagesobjectPackages Details Object, populated after order invoiced
cfopstringFiscal code for operations and installments
courierstringPackage selected Courier
courierStatusstringPackage Tracking Status
dataobjectPackage Tracking Timeline
finishedstringIf the delivery are finished
statusstringCourier Status
embeddedInvoicestringXML of the invoice
invoiceKeystringInvoice Credencial Key
invoiceNumberstringPackage Invoice Number
invoiceUrlstringPackage Invoice URL
invoiceValuestringPackage Invoice Value
issuanceDatestringPackage Issuance Date
itemsstringItems Package Array
descriptionstringItem Desciprtion
itemIndexstringItem Index
pricestringItem Price
quantitystringItem Quantity
unitMultiplierstringUnit Multiplier
trackingNumberstringPackage Tracking Number
trackingUrlstringTracking Order URL
typestringInvoice Type, expected values "Output" and "Input"
paymentDataobjectPayment Object
transactionsobjectTransactions Object
isActivebooleanIf the payment is Active
merchantNamestringMerchant Name
paymentsobjectPayment Object
cardHolderstringPayment Card Holder
connectorResponsesobjectConnector Responses Object
billingAddressobjectBilling Address information
MessagestringConnector Responses Message
ReturnCodestringConnector Return Code
TidstringConnector Transaction ID
acquirerstringConnector acquirer
authIdstringConnector authorization ID
dueDatestringPayment due date
firstDigitsstringPayment card first digits
giftCardCaptionstringGift card caption
giftCardIdstringGift card ID
giftCardNamestringGift card name
groupstringPayment group
idstringPayment ID
installmentsstringPayment installments quantity
lastDigitsstringPayment card last digits
paymentSystemstringPayment system type ID
paymentSystemNamestringPayment system name
redemptionCodestringGift card redemption code
referenceValuestringPayment reference value
tidstringPayment transaction ID
urlstringPayment URL
valuestringPayment value with interest if it applies
transactionIdstringTransaction Id
ratesAndBenefitsDatastringRates and Benefits Data Object
idstringObject ID, expected value "ratesAndBenefitsData"
rateAndBenefitsIdentifiersobjectRates and Benefits Details Object
additionalInfostringRates and Benefits Additional Info
descriptionstringRates and Benefits Description
featuredstringIf is allowed to acumulate the Rates and Benefits
matchedParametersobjectMarch Parameters Array
namestringRates and Benefits Name
roundingErrorintegerRounding Error Total Amount
salesChannelstringOrder Sales Channel Id
sellerOrderIdstringOrder Seller Id
sellersobjectSellers Array
idstringSeller Id
logostringURL Seller Logo
namestringSeller Name
sequencestringOrder Sequence ID
shippingDataobjectShipping Data Object
addressobjectShipping Address
addressIdstringShipping Address Id
addressTypestringShipping Address Type
citystringShipping City
complementstringShipping Complement
countrystringShipping Country in ISO 3166 ALPHA-3 abbreviation
geoCoordinatesobjectShipping Geo Coordinates Array
neighborhoodstringShipping Neighborhood
numberstringShipping Number
postalCodestringShipping Postal Code
receiverNamestringShipping Receiver Name
referencestringShipping Reference
statestringShipping State
streetstringShipping Street
idstringObject ID, expected value "shippingData"
logisticsInfoobjectLogistics Info Object
addressIdstringAdress Id
deliveryChannelstringDelivery Channel, allowed values "delivery" or "pickup-in-point"
deliveryCompanystringCourier Company Name
deliveryIdsobjectDelivery Ids Object
courierIdstringCourier Id
courierNamestringCourier Name
dockIdstringReleated Dock Id
quantityintegerItems Quantity
warehouseIdstringReleated Warehouse Id
deliveryWindowobjectDelivery Window Object
endDateUtcstringDelivery Date End in UTC
pricestringDelivery Window Cost
startDateUtcstringDelivery Date Starts in UTC
itemIndexintegerLogistic Info Item Index
listPriceintegerLogistic Info Item List Price
lockTTLstringStock reservation waiting period
pickupStoreInfoobjectPickup Store Info Object
additionalInfostringPickup Store Additional Info
addressstringPickup Store Address
dockIdstringPickup Store Releated Dock Id
friendlyNamestringPickup Store Friendly Name
isPickupStorebooleanIf is a Pickup Store
polygonNamestringReleated Polygom Name
priceintegerLogistic Info Item Price
selectedSlastringSelected SLA
sellingPriceintegerLogistic Info Item Selling Price
shippingEstimatestringEstimate Shipping Duration
shippingEstimateDatestringEstimate Shipping Date
shipsToobjectShipping Country in ISO 3166 ALPHA-3 abbreviation
slasobjectSLAs Object
deliveryChannelstringDelivery Channel, allowed values "delivery" or "pickup-in-point"
deliveryWindowobjectDelivery Window Object
endDateUtcstringDelivery Date End in UTC
pricestringDelivery Window Cost
startDateUtcstringDelivery Date Starts in UTC
idstringSLA Id
pickupStoreInfoobjectPickup Store Details Object
additionalInfostringPickup Store Additional Info
addressstringPickup Store Address
dockIdstringPickup Store releated Dock Id
friendlyNamestringPickup Store Friendly Name
isPickupStorebooleanIf is a Pickup Store
polygonNamestringReleated Polygon Name
priceintegerSLA Price
shippingEstimatestringSLA Shipping Estimate
selectedAddressesobjectSelected Address Details Object
addressIdstringShipping Address Id
addressTypestringShipping Address Type
citystringShipping City
complementstringShipping Complement
countrystringShipping Country in ISO 3166 ALPHA-3 abbreviation
geoCoordinatesobjectShipping Geo Coordinates Array
neighborhoodstringShipping Neighborhood
numberstringShipping Number
postalCodestringShipping Postal Code
receiverNamestringShipping Receiver Name
referencestringShipping Reference
statestringShipping State
streetstringShipping Street
trackingHintsarrayArray of tracking hint objects, containing "courierName", "trackingId", "trackingLabel", and "trackingUrl"
statusstringOrder Status
statusDescriptionstringStatus Description
storePreferencesDataobjectStore Preferences Data Object
countryCodestringCountry Code in ISO 3166 ALPHA-3 abbreviation
currencyCodestringCurrency Code in ISO 4217
currencyFormatInfoobjectCurrency Format Info Object
CurrencyDecimalDigitsintegerCurrency Decimal Digits
CurrencyDecimalSeparatorstringCurrency Decimal Separator
CurrencyGroupSeparatorstringCurrency Group Separator
CurrencyGroupSizeintegerCurrency Group Size
StartsWithCurrencySymbolbooleanIf Starts With Currency Symbol
currencyLocaleintegerLCID Decimal
currencySymbolstringCurrency Symbol
timeZonestringOrder Time Zone
totalsobjectTotals Object
idstringTotals Ids, expected values: "Items", "Discounts", "Shipping" and "Tax"
namestringTotals ID Description
valueintegerTotals Value
valueintegerOrder Value

🚧

If you use integrations that consume price data, such as checkout or order integrations, note that the field sellingPrice may be subject to rounding discrepancies. We recommend retrieving data from the priceDefinition data structure instead.

Language
Authentication
URL
Click Try It! to start a request and see the response here!