Plataformas Digitais - Brazil
HomeLink
Multiple Menus
  • Link1
  • Link2
HomeLink
Multiple Menus
  • Link1
  • Link2
  1. Shipping
  • SPDBR Journey API
  • Service PDP
    • Get Product by Slug
      GET
    • Get Product by Slug V2
      GET
    • Get Product by id V2
      GET
    • Get Translate review
      GET
    • Get product review
      GET
    • SPDBR-2559
      POST
  • Service Search
    • Search
      • Search Products by Term
      • teste, preco na busca
    • Autocomplete
      • Get Autocomplete suggestions
    • Recommendation
      • Pages
        • Home Recommendations
        • Product Recommendations
        • Cart Recommendations
        • Category Recommendations
    • TopSearch
  • Service Member
    • Address
      • UpdateAddress
      • AddAddress
      • RemoveAddress
      • GetAddress
    • Consent
      • UpdateConsent
      • GetConsent
    • Store
      • UpdateFavoriteStore
      • DeleteSportPratice
      • AddSportPratice
      • GetFavoriteStore
    • Purchase
      • GetPurchase
    • Profile
      • UpdateProfile
      • GetProfile
      • Get member identity
    • 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
          POST
      • Payment
        • Guest Update Payment Method
        • Autenticated Update Payment Method
        • Guest Transaction
        • Autenticated Transaction
        • Send Payment Data
        • Process Order
      • Orderplaced
        • Autenticated OrderPlaced
        • Guest OrderPlaced
      • Shared
        • Clear orderForm Messages
        • Add Preference Data
        • Add Coupon
    • WEB
      • Create cart
      • Get cart
  • Service Omni
    • Orders
      • Get Orders
  • Service Presencial Events
    • List all events
    • Get event by ID
    • [PRIVATE] List my events
    • [PRIVATE] Get registration by event ID
    • [PRIVATE] Subscribe for event
  • Service app
    • Pix Email
      • Send Pix Email
  • Service DY
    • Receive products
    • Send products
  1. Shipping

Address

Developing
Prod Env
http://decathlonstore.myvtex.com
Prod Env
http://decathlonstore.myvtex.com
POST
http://decathlonstore.myvtex.com
/_v/private/v2/app/rn/checkout/pub/orderForm/{orderFormId}/attachments/shippingData
Attache address data to the orderForm.
If an access token is not provided, the response will return obfuscated address information for security.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http://decathlonstore.myvtex.com/_v/private/v2/app/rn/checkout/pub/orderForm/{{orderFormId}}/attachments/shippingData' \
--header 'accesstoken;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "selectedAddresses": [
        {
            "addressType": "residential",
            "receiverName": "s",
            "addressId": "5230283319615",
            "isDisposable": false,
            "postalCode": "06719460",
            "city": "Cotia",
            "state": "SP",
            "country": "BRA",
            "street": "Rua dos Coqueirais",
            "number": "265",
            "neighborhood": "Jardim PetrĂ³polis",
            "complement": "ap 8"
        }
    ],
    "logisticsInfo": {
        "itemIndex": 0,
        "selectedSla": "Correios",
        "selectedDeliveryChannel": "delivery"
    }
}'
Response Response Example
{
    "orderFormId": "string",
    "salesChannel": "string",
    "loggedIn": true,
    "isCheckedIn": true,
    "storeId": null,
    "checkedInPickupPointId": null,
    "allowManualPrice": true,
    "canEditData": true,
    "userProfileId": "string",
    "userType": null,
    "ignoreProfileData": true,
    "value": 0,
    "messages": [
        "string"
    ],
    "items": [
        {
            "uniqueId": "string",
            "id": "string",
            "productId": "string",
            "productRefId": "string",
            "refId": "string",
            "ean": "string",
            "name": "string",
            "skuName": "string",
            "modalType": null,
            "parentItemIndex": null,
            "parentAssemblyBinding": null,
            "assemblies": [
                "string"
            ],
            "priceValidUntil": "string",
            "tax": 0,
            "price": 0,
            "listPrice": 0,
            "manualPrice": null,
            "manualPriceAppliedBy": null,
            "sellingPrice": 0,
            "rewardValue": 0,
            "isGift": true,
            "additionalInfo": {
                "dimension": null,
                "brandName": "string",
                "brandId": "string",
                "offeringInfo": null,
                "offeringType": null,
                "offeringTypeId": null
            },
            "preSaleDate": null,
            "productCategoryIds": "string",
            "productCategories": {
                "72371487": "string",
                "72371488": "string",
                "72371495": "string"
            },
            "quantity": 0,
            "seller": "string",
            "sellerChain": [
                "string"
            ],
            "imageUrl": "string",
            "detailUrl": "string",
            "components": [
                "string"
            ],
            "bundleItems": [
                "string"
            ],
            "attachments": [
                "string"
            ],
            "attachmentOfferings": [
                "string"
            ],
            "offerings": [
                "string"
            ],
            "priceTags": [
                "string"
            ],
            "availability": "string",
            "measurementUnit": "string",
            "unitMultiplier": 0,
            "manufacturerCode": null,
            "priceDefinition": {
                "calculatedSellingPrice": 0,
                "total": 0,
                "sellingPrices": [
                    {
                        "value": 0,
                        "quantity": 0
                    }
                ],
                "reason": null
            },
            "taxCode": "string",
            "additionalInformation": {
                "analytics": {
                    "amplitude": {
                        "gender": null,
                        "carc_quantity": null,
                        "cac_quantity": null,
                        "shopping_tool": null,
                        "availability": null,
                        "product_id": "string",
                        "name": "string",
                        "product_type": "string",
                        "seller_name": "string",
                        "brand": "string",
                        "sport": "string",
                        "universe": "string",
                        "department": "string",
                        "sub_department": "string",
                        "family": "string",
                        "list_price": 0,
                        "display_price": 0,
                        "color": "string",
                        "sku_code": "string",
                        "size": "string",
                        "quantity": 0,
                        "purchase_price": 0,
                        "purchase_value": 0
                    }
                },
                "color": "string",
                "size": "string",
                "sellerOffer": {
                    "price": 0,
                    "listPrice": 0,
                    "hasDiscount": true,
                    "cashPrice": 0,
                    "cashDiscountPercentage": 0
                }
            }
        }
    ],
    "selectableGifts": [
        "string"
    ],
    "totalizers": [
        {
            "id": "string",
            "name": "string",
            "value": 0
        }
    ],
    "shippingData": {
        "address": {
            "addressType": "string",
            "receiverName": "string",
            "addressId": "string",
            "isDisposable": true,
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "street": "string",
            "number": "string",
            "neighborhood": "string",
            "complement": "string",
            "reference": null,
            "geoCoordinates": [
                "string"
            ]
        },
        "logisticsInfo": [
            {
                "itemIndex": 0,
                "selectedSla": null,
                "selectedDeliveryChannel": "string",
                "addressId": "string",
                "slas": [
                    "string"
                ],
                "shipsTo": [
                    "string"
                ],
                "itemId": "string",
                "deliveryChannels": [
                    {
                        "id": "string"
                    }
                ]
            }
        ],
        "selectedAddresses": [
            {
                "addressType": "string",
                "receiverName": "string",
                "addressId": "string",
                "isDisposable": true,
                "postalCode": "string",
                "city": "string",
                "state": "string",
                "country": "string",
                "street": "string",
                "number": "string",
                "neighborhood": "string",
                "complement": "string",
                "reference": null,
                "geoCoordinates": [
                    "string"
                ]
            }
        ],
        "availableAddresses": [
            {
                "addressType": "string",
                "receiverName": "string",
                "addressId": "string",
                "isDisposable": true,
                "postalCode": "string",
                "city": "string",
                "state": "string",
                "country": "string",
                "street": "string",
                "number": "string",
                "neighborhood": "string",
                "complement": "string",
                "reference": "string",
                "geoCoordinates": [
                    "string"
                ]
            }
        ],
        "pickupPoints": [
            {
                "friendlyName": "string",
                "address": {
                    "addressType": "string",
                    "receiverName": null,
                    "addressId": "string",
                    "isDisposable": true,
                    "postalCode": "string",
                    "city": "string",
                    "state": "string",
                    "country": "string",
                    "street": "string",
                    "number": "string",
                    "neighborhood": "string",
                    "complement": "string",
                    "reference": null,
                    "geoCoordinates": [
                        0
                    ]
                },
                "additionalInfo": "string",
                "id": "string",
                "isActive": null,
                "businessHours": [
                    {
                        "DayOfWeek": 0,
                        "OpeningTime": "string",
                        "ClosingTime": "string"
                    }
                ]
            }
        ],
        "contactInformation": [
            "string"
        ]
    },
    "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
    },
    "paymentData": {
        "updateStatus": "string",
        "installmentOptions": [
            {
                "paymentSystem": "string",
                "bin": null,
                "paymentName": null,
                "paymentGroupName": null,
                "value": 0,
                "installments": [
                    {
                        "count": 0,
                        "hasInterestRate": true,
                        "interestRate": 0,
                        "value": 0,
                        "total": 0,
                        "sellerMerchantInstallments": [
                            {
                                "id": "string",
                                "count": 0,
                                "hasInterestRate": true,
                                "interestRate": 0,
                                "value": 0,
                                "total": 0
                            }
                        ]
                    }
                ]
            }
        ],
        "paymentSystems": [
            {
                "id": 0,
                "name": "string",
                "groupName": "string",
                "validator": {
                    "regex": "string",
                    "mask": "string",
                    "cardCodeRegex": "string",
                    "cardCodeMask": "string",
                    "weights": [
                        0
                    ],
                    "useCvv": true,
                    "useExpirationDate": true,
                    "useCardHolderName": true,
                    "useBillingAddress": true
                },
                "stringId": "string",
                "template": "string",
                "requiresDocument": true,
                "displayDocument": true,
                "isCustom": true,
                "description": null,
                "requiresAuthentication": true,
                "dueDate": "string",
                "availablePayments": null
            }
        ],
        "payments": [
            {
                "paymentSystem": "string",
                "bin": null,
                "accountId": null,
                "tokenId": null,
                "installments": 0,
                "referenceValue": 0,
                "value": 0,
                "merchantSellerPayments": [
                    {
                        "id": "string",
                        "installments": 0,
                        "referenceValue": 0,
                        "value": 0,
                        "interestRate": 0,
                        "installmentValue": 0
                    }
                ]
            }
        ],
        "giftCards": [
            {
                "redemptionCode": null,
                "provider": "string",
                "value": 0,
                "balance": 0,
                "name": "string",
                "caption": "string",
                "id": "string",
                "inUse": true,
                "isSpecialCard": true,
                "groupName": "string"
            }
        ],
        "giftCardMessages": [
            "string"
        ],
        "availableAccounts": [
            "string"
        ],
        "availableTokens": [
            "string"
        ],
        "availableAssociations": {}
    },
    "marketingData": {
        "utmSource": "string",
        "utmMedium": "string",
        "utmCampaign": null,
        "utmipage": null,
        "utmiPart": null,
        "utmiCampaign": "string",
        "coupon": null,
        "marketingTags": [
            "string"
        ]
    },
    "sellers": [
        {
            "id": "string",
            "name": "string",
            "logo": "string"
        }
    ],
    "clientPreferencesData": {
        "locale": "string",
        "optinNewsLetter": true
    },
    "commercialConditionData": null,
    "storePreferencesData": {
        "countryCode": "string",
        "saveUserData": true,
        "timeZone": "string",
        "currencyCode": "string",
        "currencyLocale": 0,
        "currencySymbol": "string",
        "currencyFormatInfo": {
            "currencyDecimalDigits": 0,
            "currencyDecimalSeparator": "string",
            "currencyGroupSeparator": "string",
            "currencyGroupSize": 0,
            "startsWithCurrencySymbol": true
        }
    },
    "giftRegistryData": null,
    "openTextField": null,
    "invoiceData": null,
    "customData": null,
    "itemMetadata": {
        "items": [
            {
                "id": "string",
                "seller": "string",
                "name": "string",
                "skuName": "string",
                "productId": "string",
                "refId": "string",
                "ean": "string",
                "imageUrl": "string",
                "detailUrl": "string",
                "assemblyOptions": [
                    "string"
                ]
            }
        ]
    },
    "hooksData": null,
    "ratesAndBenefitsData": {
        "rateAndBenefitsIdentifiers": [
            "string"
        ],
        "teaser": [
            "string"
        ]
    },
    "subscriptionData": null,
    "merchantContextData": null,
    "purchaseAgentsData": null,
    "itemsOrdination": null
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

đŸŸ¢200Success
application/json
Body

Modified at 2025-05-22 10:51:58
Previous
Autenticated Profile
Next
Guest Update Payment Method
Built with