Grow your business

Show SKUs prices and availability by region

Pedro Oliveira
Pedro Oliveira
Created at
3/9/2019

The Region features allows a store to display different prices and availability according to the regions catered to by the Sellers White Label of that store.

To use to Region feature, it is necessary that:

  1. The Sessions System (VTEX Session) is installed in your store
  2. Sellers White Label can deliver orders from your store to determined ZIP code areas.
  3. The session has information about the zip code and country of the user who is browsing in a store

Setting up delivery in Franchise Account/Seller White Label

The price and availability by region will be displayed in the main store according to the delivery configuration of a SKU for a particular zip code range. This zip code area is registered with a carrier of the Franchise Account that acts as the Seller White Label for your store.

To configure delivery, follow the steps below:

  1. Access the admin of the Franchise Account that acts as Seller White Label of your store
  2. Access Inventory & shipping and click on Dashboard
  3. Register a carrier. The ZIP codes operated by this carrier will be taken into account to display the price and availability by region in the main store
  4. Register a Dock
  5. Register an Inventory
  6. Add stock for SKUs that will be delivered through the configured route
Remember: For a SKU to appear as available for sale, it needs to have stock and price associated with it.

Functioning of the Region feature

The Region feature is one of the features made available by the session system installation. It aims to regionalize user experience of the store. It allows, for example, for sellers to set their own prices and that the marketplaces display them according to the client’s region.

After you install the VTEX Session app and set up delivery of a SKU to a White Label Seller from your store, it is necessary for the session system to identify the zip code and country of the user browsing the store to show the custom price and availability by region.

This information about ZIP code and country can be stored in the cookie vtex_session, due to a purchase made previously by the user, or can be entered via JavaScript in the session.

To enter the country and zip code in the session, you must perform a POST in the following route: {{account-name}}.{{environment}}.com.br/api/sessions/{{session_token}}

Below is an example of a body to be sent to POST:

{
	"public":{
		"country":{
			"value":"USA"
		},
		"postalCode":{
			"value":"32004"
		}
	}
}

Or, for cases of geo-coordinates:

{
	"public":{
		"country":{
			"value":"USA"
		},
		"geoCoordinates":{
			"value":"22.123,-14.1"
		}
	}
}

To verify that the session has updated the country and zip code data, simply do a GET on the route below and search for thecountry and Post Code fields: {{account-name}}.{{environment}}.com.br/api/sessions/{{session_token}}?items=*

After updating the page where the SKUs are being viewed in the store, the price and availability information will be updated according to the region specified in the country and zip code information.

Still got questions?
Ask the community
Find solutions and share ideas in VTEX's community.
Talk to our experts
Get in touch if you have something specific to ask about the platform.
  • PT
  • ES
VTEX website