Plataformas Digitais - Brazil
  1. Orderplaced
Plataformas Digitais - Brazil
  • SPDBR Journey API
  • Service PDP
    • Get Product by Slug V2
      GET
    • Get Translate review
      GET
    • Get product review
      GET
    • Get Product by Slug
      GET
  • Service Search
    • Search
      • Search Products by Term
      • teste, preco na busca
    • Autocomplete
      • Get Autocomplete suggestions
    • Recommendation
      • Pages Recommendations V3
    • TopSearch
  • Service Member
    • Address
      • UpdateAddress
      • AddAddress
      • RemoveAddress
      • GetAddress
    • Consent
      • UpdateConsent
      • GetConsent
    • Store
      • UpdateFavoriteStore
      • DeleteSportPratice
      • AddSportPratice
      • GetFavoriteStore
    • Purchase
      • GetPurchase
    • Profile
      • UpdateProfile
      • GetProfile
    • Login
      • RefreshToken
      • RefreshMemberToken
      • UserToken
    • User
      • UserDataCpf
      • UserDataCpf
  • Member Login
  • Service Checkout APP
    • Full Vtex
      • OrderForm
      • Items
      • Profile
      • Update Payment Data
      • Start Transaction
      • Send Payment Data
      • Proccess Order
    • APP
      • Cart
        • Get Or Create orderForm
        • Add Cart Items
        • Remove Cart Items
      • Profile
        • Check Guest checkout Eligibility
        • Guest Add Profile Data
        • Autenticated Profile
      • Shipping
        • Address
      • Payment
        • Guest Update Payment Method
        • Autenticated Update Payment Method
        • Guest Transaction
        • Autenticated Transaction
        • Send Payment Data
        • Process Order
      • Orderplaced
        • Autenticated OrderPlaced
          GET
        • Guest OrderPlaced
          GET
      • Shared
        • Clear orderForm Messages
        • Add Preference Data
        • Add Coupon
    • WEB
      • Create cart
      • Get cart
  • Service Omni
    • Orders
      • Get Orders
  • Service Events
    • List all events
  • Service app
    • Pix Email
      • Send Pix Email
  1. Orderplaced

Guest OrderPlaced

Developing
Testing Env
https://testing--decathlonstore.myvtex.com
Testing Env
https://testing--decathlonstore.myvtex.com
GET
/_v/private/v2/app/rn/oms/user/orders/{orderGroup}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://testing--decathlonstore.myvtex.com/_v/private/v2/app/rn/oms/user/orders/{{orderGroup}}'
Response Response Example
{
    "value": 0,
    "clientProfileData": {
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "document": "string",
        "documentType": "string",
        "phone": "string",
        "corporateName": null,
        "tradeName": null,
        "corporateDocument": null,
        "stateInscription": null,
        "corporatePhone": null,
        "isCorporate": true,
        "profileCompleteOnLoading": true,
        "profileErrorOnLoading": true,
        "customerClass": null,
        "userProfileId": "string",
        "isProspect": true
    },
    "payments": [
        {
            "id": "string",
            "paymentSystem": "string",
            "paymentSystemName": "string",
            "value": 0,
            "installments": 0,
            "connectorResponses": {
                "Tid": "string",
                "ReturnCode": null,
                "Message": null,
                "authId": "string",
                "nsu": "string",
                "acquirer": "string"
            },
            "referenceValue": 0,
            "cardHolder": null,
            "cardNumber": null,
            "firstDigits": null,
            "lastDigits": null,
            "cvv2": null,
            "expireMonth": null,
            "expireYear": null,
            "url": "string",
            "koinUrl": null,
            "tid": "string",
            "redemptionCode": null,
            "giftCardId": null,
            "giftCardProvider": null,
            "giftCardAsDiscount": null,
            "group": "string",
            "dueDate": null,
            "paymentOrigin": null,
            "accountId": null,
            "parentAccountId": null,
            "bankIssuedInvoiceIdentificationNumber": "string",
            "bankIssuedInvoiceIdentificationNumberFormatted": "string",
            "bankIssuedInvoiceBarCodeNumber": "string",
            "bankIssuedInvoiceBarCodeType": "string",
            "billingAddress": null,
            "paymentDetails": [
                "string"
            ]
        }
    ],
    "status": "string",
    "marketingData": {
        "utmSource": "string",
        "utmPartner": null,
        "utmMedium": "string",
        "utmCampaign": null,
        "utmipage": null,
        "utmiPart": null,
        "utmiCampaign": "string",
        "coupon": null,
        "marketingTags": [
            "string"
        ]
    },
    "cashbackUsedAmount": 0,
    "totals": [
        {
            "id": "string",
            "name": "string",
            "value": 0,
            "alternativeTotals": [
                {
                    "id": "string",
                    "name": "string",
                    "value": 0
                }
            ]
        }
    ],
    "totalPackages": 0,
    "orderId": "string",
    "affiliation": [
        "string"
    ],
    "qtdItems": 0,
    "packages": [
        {
            "numPackage": 0,
            "items": [
                {
                    "sellerSku": "string",
                    "priceTable": null,
                    "priceValidUntil": "string",
                    "callCenterOperator": null,
                    "commission": 0,
                    "freightCommission": 0,
                    "taxCode": "string",
                    "catalogProvider": "string",
                    "bundleItems": [
                        "string"
                    ],
                    "components": [
                        "string"
                    ],
                    "costPrice": null,
                    "lockId": null,
                    "uniqueId": "string",
                    "id": "string",
                    "productId": "string",
                    "productRefId": "string",
                    "refId": "string",
                    "ean": "string",
                    "name": "string",
                    "skuName": "string",
                    "modalType": null,
                    "parentItemIndex": null,
                    "parentAssemblyBinding": null,
                    "assemblies": [
                        "string"
                    ],
                    "tax": 0,
                    "customTax": 0,
                    "price": 0,
                    "listPrice": 0,
                    "manualPrice": null,
                    "manualPriceAppliedBy": null,
                    "sellingPrice": 0,
                    "rewardValue": 0,
                    "isGift": true,
                    "additionalInfo": {
                        "dimension": {
                            "cubicweight": 0,
                            "height": 0,
                            "length": 0,
                            "weight": 0,
                            "width": 0
                        },
                        "brandName": "string",
                        "brandId": "string",
                        "offeringInfo": null,
                        "offeringType": null,
                        "offeringTypeId": null,
                        "categoriesIds": "string",
                        "productClusterId": "string",
                        "commercialConditionId": "string"
                    },
                    "preSaleDate": null,
                    "productCategoryIds": "string",
                    "productCategories": {
                        "72371487": "string",
                        "72371488": "string",
                        "72371499": "string",
                        "72371526": "string",
                        "72371552": "string",
                        "72371715": "string"
                    },
                    "quantity": 0,
                    "seller": "string",
                    "sellerChain": [
                        "string"
                    ],
                    "imageUrl": "string",
                    "detailUrl": "string",
                    "attachments": [
                        "string"
                    ],
                    "attachmentOfferings": [
                        "string"
                    ],
                    "offerings": [
                        "string"
                    ],
                    "priceTags": [
                        {
                            "name": "string",
                            "value": 0,
                            "rawValue": 0,
                            "isPercentual": true,
                            "identifier": "string",
                            "owner": "string"
                        }
                    ],
                    "availability": "string",
                    "measurementUnit": "string",
                    "unitMultiplier": 0,
                    "manufacturerCode": "string",
                    "priceDefinition": {
                        "calculatedSellingPrice": 0,
                        "total": 0,
                        "sellingPrices": [
                            {
                                "value": 0,
                                "quantity": 0
                            }
                        ],
                        "reason": null
                    }
                }
            ],
            "shipping": {
                "shippingEstimate": "string",
                "deliveryChannel": "string",
                "completeAddress": "string"
            }
        }
    ]
}

Request

Path Params
orderGroup
string 
required
Example:
{{orderGroup}}
Cookie Params
Vtex_CHKO_Auth
string 
required
Cookie set by VTEX during the transaction process.

Responses

🟢200OK
application/json
Body
value
integer 
optional
clientProfileData
object 
optional
email
string 
optional
firstName
string 
optional
lastName
string 
optional
document
string 
optional
documentType
string 
optional
phone
string 
optional
corporateName
null 
optional
tradeName
null 
optional
corporateDocument
null 
optional
stateInscription
null 
optional
corporatePhone
null 
optional
isCorporate
boolean 
optional
profileCompleteOnLoading
boolean 
optional
profileErrorOnLoading
boolean 
optional
customerClass
null 
optional
userProfileId
string 
optional
isProspect
boolean 
optional
payments
array [object {32}] 
optional
id
string 
optional
paymentSystem
string 
optional
paymentSystemName
string 
optional
value
integer 
optional
installments
integer 
optional
connectorResponses
object 
optional
referenceValue
integer 
optional
cardHolder
null 
optional
cardNumber
null 
optional
firstDigits
null 
optional
lastDigits
null 
optional
cvv2
null 
optional
expireMonth
null 
optional
expireYear
null 
optional
url
string 
optional
koinUrl
null 
optional
tid
string 
optional
redemptionCode
null 
optional
giftCardId
null 
optional
giftCardProvider
null 
optional
giftCardAsDiscount
null 
optional
group
string 
optional
dueDate
null 
optional
paymentOrigin
null 
optional
accountId
null 
optional
parentAccountId
null 
optional
bankIssuedInvoiceIdentificationNumber
string 
optional
bankIssuedInvoiceIdentificationNumberFormatted
string 
optional
bankIssuedInvoiceBarCodeNumber
string 
optional
bankIssuedInvoiceBarCodeType
string 
optional
billingAddress
null 
optional
paymentDetails
array[string]
optional
status
string 
optional
marketingData
object 
optional
utmSource
string 
optional
utmPartner
null 
optional
utmMedium
string 
optional
utmCampaign
null 
optional
utmipage
null 
optional
utmiPart
null 
optional
utmiCampaign
string 
optional
coupon
null 
optional
marketingTags
array[string]
optional
cashbackUsedAmount
integer 
optional
totals
array [object {4}] 
optional
id
string 
optional
name
string 
optional
value
integer 
optional
alternativeTotals
array [object {3}] 
optional
totalPackages
integer 
optional
orderId
string 
optional
affiliation
array[string]
optional
qtdItems
integer 
optional
packages
array [object {3}] 
optional
numPackage
integer 
optional
items
array [object {51}] 
optional
shipping
object 
optional
Previous
Autenticated OrderPlaced
Next
Clear orderForm Messages
Built with