[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides erp integration guide in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/getting-started)

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide)

[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-set-up-catalog)

[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-import-prices)

[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-import-inventory)

[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/import-customer-data)

[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-set-up-order-integration)

[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-import-products)

[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-set-up-order-processing)

[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-updating-and-deleting-information)

[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/faq-erp-integration)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/recaptcha)

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/getting-started)

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide)

[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-set-up-catalog)

[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-import-prices)

[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-import-inventory)

[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/import-customer-data)

[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-set-up-order-integration)

[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-import-products)

[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-set-up-order-processing)

[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-updating-and-deleting-information)

[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/faq-erp-integration)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/recaptcha)

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides)

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide)

Back office integration guide (ERP/PIM/WMS)

Use our APIs to build a complete back-office integration

> This guide refers mostly to ERPs. But keep in mind that integrating PIMs and WMSs basically follows the same principles and the content will point out whenever that is not the case.

An ecommerce operation may use a range of software to better manage its resources and information. In this guide, we take a look at the best ways to integrate these systems with your VTEX store. This allows your store to optimize operations by creating efficient communications between VTEX and other software.

Each operation has its specific needs and we do not recommend any particular software. However, here are some examples used by different operations:

* Enterprise Resource Planning (ERP) and Warehouse Management System (WMS)
   * Aquilon
   * Aptean Catalyst
   * Brightpearl
   * ECI Software Solutions
   * IBM Sterling WMS
   * JDA
   * Microsoft
   * Oracle Netsuite
   * Sage
   * SAP
   * Manhattan
* Product Information Manager (PIM)
   * Akeneo
   * Simplus
   * IBM Product Master
   * Informatica
   * inRiver
   * Widen Collective

For a complete back-office integration, you should use our APIs to send your Products, Pricing, and Inventory to VTEX and to receive your Orders from VTEX. In order to provide more detail on this data flow, this overview is split into the initial setup and the ongoing integration flow.

> Check the new [Catalog onboarding guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey.

## Initial setup

To get your integration up and running, you need to perform some configuration steps and then set up the middleware that will handle the ongoing flow. See the steps below.

### Configuration

Import prices

\- [Set base price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices)

\- [Set fixed prices for specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices%23set-fixed-prices-for-specific-contexts)

\- Set base price...Set up catalog

\- [Category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog)

\- [Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-brands)

\- [Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-specifications-groups)

\- [Groups](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-specifications-groups)

\- [Fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-specification-fields)

\- [Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-specification-values)

\- Category tree...Import products

\- [Import product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products)

\- [Import product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23import-product-specifications)

\- [Add product to trade policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23add-product-to-trade-policy)

\- [Import SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23import-sku)

\- [Import SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23import-sku-specifications)

\- [Import SKU image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23import-sku-image)

\- Import product...Import inventory

\- [Create warehouses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-inventory)

\- [Update SKU inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-inventory%23update-sku-inventory)

\- Create warehouses...Text is not SVG - cannot display

> Note that some of these steps are also used in the ongoing integration. For example, the registering of products and inventory.

#### Import customer data

When implementing an ecommerce project, it may be necessary to import customer data from other systems, such as Customer Relationship Management (CRM) applications.

Unlike the processes shown in the image above, this import does not require a specific order relative to other processes.

See the [Import customer data integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data) to learn how to perform this process using [Master Data v2](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data-v2--3JJ1mlzuo88w22gO0gy0QS%23).

### Middleware setup

Set up order processing

\- [Change order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing)

\- [Cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23cancel-order)

\- [Invoicing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23invoice-order)

\- [Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23order-tracking)

\- Change order...Set up order integration

\- [Configure feed or hook](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration)

\- Configure feed or hookText is not SVG - cannot display

After the configuration, you must set up your middleware to be able to send and receive information from VTEX according to events in the routine of your operation.

There are many different ways to do this and your store’s technical team must decide what processes suit your needs. Solutions can be divided into two main groups:

* Integration platforms: third-party Platform as a Service companies whose product allows you to create VTEX integrations with minimal development effort.
* In-house developing: when choosing this path, keep in mind that that you must not only build the software, but maintain the ongoing integration. For example, the middleware must be able to handle scalability issues that come with sales peaks such as may occur in a black friday event.

## Ongoing middleware flow

Once you have configurated your store and set up the middleware, the general flow of information will look something like this:

Store backoffice

Store backoffice

VTEX

VTEX

**Catalog**

Catalog

**Pricing**

Pricing

**Logistics**

Logistics

**ERP**

ERP

**WMS**

WMS

[Product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-product-updates)

Product updates

[Order flow notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23receive-order-flow-notification)

Order flow notification

**Orders**

Orders

[Pricing updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-pricing-updates)

Pricing updates

[Tracking information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-tracking-information)

Tracking information

[Inventory updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information%23inventory-updates)

Inventory updates

[Invoice ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-invoice-information)

Invoice

[Order information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23get-order-information)

Order information

[Cancelation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-order-cancelations)

Cancelation

[Order change](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-order-changes)

Order changeText is not SVG - cannot display

Each of the requests or processes represented by the arrows in the diagram above, is triggered by a different event in the day-to-day operation of an ecommerce. See details on the following sessions.

### Send product updates

**Trigger:** Whenever there are product updates in your ERP or PIM.

There are many business reasons that may lead to product updates to your store, be it adding new SKUs, editing existing ones, or removing them from your store. The goal here is for your integration to automatically pick up product updates from the ERP and send them to VTEX APIs.

Learn more about how to implement this in our [Product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information%23product-updates) guide.

### Send pricing updates

**Trigger:** Whenever there are price changes in your ERP or PIM.

Similar to product updates, there are different reasons as to why stores change their prices. In any case, whenever you decide to change your store’s prices, you should set up the integration to automatically send these updates from the ERP to VTEX.

Learn more in our guide [Pricing updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information%23pricing-updates).

### Receive order flow notification

**Trigger:** Whenever any order gets to one of the statuses predetermined by you.

In VTEX’s Order Management System (OMS) orders go through a [predetermined flow](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-on-the-oms--tutorials%5F196). By setting up your order integration, you ensure your ERP gets notified whenever any order reaches some specific stages in its life cycle.

For example, the status `ready-for-handling` tells you that the order has been paid for and the grace period has expired. On the other hand, `request-cancel` means your customer wishes that the order be canceled.

To learn more see [Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration).

### Get order information

**Trigger:** When your store needs to take action regarding a specific order.

When setting up order integration you may configure variate notifications for different stages that an order goes through. Some or all of these stages may prompt your store to take action based on the order’s specific information.

For instance, when an order gets to `ready-for-handling` it is time to pick and pack. For an order that got to `request-cancel`, you should assess the order’s situation and take action accordingly.

To learn more check [Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration).

### Send invoice information

**Trigger:** When your ERP has generated the invoice for the order.

To learn more see [Invoice order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23invoice-order).

### Send tracking information

**Trigger:** When the assigned carrier makes tracking information available for a given order.

In VTEX order management, tracking information is tied to the order’s invoice. Learn more in [Order tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23order-tracking).

### Send order changes

**Trigger:** When the store needs to change items or values of an existing order.

Order changes may be needed in various scenarios, such as when an item in the order is actually out of stock.

To learn more see [Change order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order).

For marketplaces, it may also be necessary to perform changes in sellers. Learn more with our [Change seller guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller)

### Send order cancelations

**Trigger:** When your store needs to cancel an order.

To learn more see [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23cancel-order).

> Make sure you have gone through our [Platform Overview guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview) and have [created the appKey and appToken](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication%23api-keys) for the system you want to integrate with VTEX. You can find the Application Keys page by clicking on your **profile's avatar**, which is marked with the initial from your email, then going to **Account settings > Application keys.**

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide.md)

[Subscriptions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide//docs/guides/subscriptions)[Set up catalogNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide//docs/guides/erp-integration-set-up-catalog)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

ON THIS PAGE

[Initial setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23initial-setup)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23configuration)[Middleware setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23middleware-setup)

[Ongoing middleware flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23ongoing-middleware-flow)

[Send product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-product-updates)[Send pricing updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-pricing-updates)[Receive order flow notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23receive-order-flow-notification)[Get order information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23get-order-information)[Send invoice information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-invoice-information)[Send tracking information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-tracking-information)[Send order changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-order-changes)[Send order cancelations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-order-cancelations)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide.md)

Copy page

On this page

ON THIS PAGE

[Initial setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23initial-setup)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23configuration)[Middleware setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23middleware-setup)

[Ongoing middleware flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23ongoing-middleware-flow)

[Send product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-product-updates)[Send pricing updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-pricing-updates)[Receive order flow notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23receive-order-flow-notification)[Get order information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23get-order-information)[Send invoice information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-invoice-information)[Send tracking information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-tracking-information)[Send order changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-order-changes)[Send order cancelations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-order-cancelations)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] How do I use the VTEX apps vtexbr.pickup selector app? Provide documentation and configuration details.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/functional-apps)

[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexarg.abtester)

[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.abandoned-cart-service)

[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.badges)

[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.broadcaster)

[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.catalog-images)

[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.checkout-ui-custom)

[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.checkout-ui-settings)

[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.messages)

[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.product-context)

[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector)

[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.rewriter)

[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.responsive-values)

[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.search-graphql)

[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.session-client)

[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.store-icons)

[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.store-sitemap)

[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.telemarketing)

[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/assembly-options-app)

[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/affiliates-program-app)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/functional-apps)

[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexarg.abtester)

[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.abandoned-cart-service)

[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.badges)

[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.broadcaster)

[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.catalog-images)

[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.checkout-ui-custom)

[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.checkout-ui-settings)

[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.messages)

[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.product-context)

[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector)

[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.rewriter)

[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.responsive-values)

[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.search-graphql)

[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.session-client)

[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.store-icons)

[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.store-sitemap)

[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.telemarketing)

[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/assembly-options-app)

[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/affiliates-program-app)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/vtex-io-deprecated-apps)

---

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/vtex-io-apps)

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/functional-apps)

Pickup point selector

Community extension

Version: 3.0.1

Latest version: 3.0.1

> This app is no longer maintained by VTEX. This means support and maintenance are no longer provided.

[![{"base64":"  ","img":{"width":110,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)

The pickup point selector app adds a block to your store, which allows shoppers to add a product to cart and select a pickup point for it with a single action.

The app creates a list of available pickup points by running a simulation with the selected SKU and the zipcode provoded by the shopper.

> Warning: This app should only be used inside the product page, since one of its dependencies is the `product-context`.

## Configuration

Follow the steps below to configure the app on your store theme.

### 1\. Install the app in your workspace and account.

To do this, you can go to the [Pickup point selector page](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtexbr-pickup-selector/p) in the VTEX app store or run this command in your terminal:

`1

vtex install vtexbr.pickup-selector

`

### 2\. Add the app as a theme dependency in the `manifest.json` file.

See an example of how to do this:

`1

 "peerDependencies": {

2

 "vtexbr.pickup-selector": "2.x"

3

 }

`

Now, you are able to use all the [blocks](#blocks) exported by the **pickup-selector** app and its respective [props](#props).

### 3\. Adding the main block

Declare the app's main block in a given theme template or inside another block from the theme. See the code example below.

`1

 "pickup-selector": {

2

 "children": [

3

 "pickup-selector-zipcode-input",

4

 "pickup-selector-search-sla-button",

5

 "pickup-selector-sla-list"

6

 ]

7

 }

`

> Note that the [blocks](#blocks) `pickup-selector-zipcode-input`, `pickup-selector-search-sla-button` and `pickup-selector-sla-list` are required inside the main block. But you can use them in any order you want. You can also use flex-layout if needed.

### 4\. Configuring the `pickup-selector-sla-list`

The only [block](#blocks) that should be used inside this one is the `pickup-selector-option-card`. We do this so that you can be free to style the option card as you want, and we will use that as a template for all the options. Below you can see an example.

`1

 "pickup-selector-sla-list": {

2

 "children": [

3

 "pickup-selector-option-card"

4

 ]

5

 }

`

### 5\. Configuring the `pickup-selector-option-card`

You are free to style this block as you wish.

The app provides [blocks](#blocks) that will help with the information about the pickup point. They are the following:

* `pickup-selector-option-card-pickup-point-name`
* `pickup-selector-option-card-pickup-point-address`
* `pickup-selector-option-card-pickup-point-distance`
* `pickup-selector-option-card-pickup-point-sla`

The only mandatory block inside this one is the `pickup-selector-option-card-add-product-button`.

Below you can see and example of this:

`1

 "pickup-selector-option-card": {

2

 "children": [

3

 "flex-layout.col#card-container"

4

 ]

5

 },

6

7

 "flex-layout.col#card-container": {

8

 "children": [

9

 "flex-layout.row#card-header",

10

 "product-separator",

11

 "flex-layout.row#card-body"

12

 ]

13

 },

14

15

 "flex-layout.row#card-header": {

16

 "props": {

17

 "colSizing": "auto"

18

 },

19

 "children": [

20

 "pickup-selector-option-card-pickup-point-distance",

21

 "pickup-selector-option-card-pickup-point-name"

22

 ]

23

 },

24

25

 "flex-layout.row#card-body": {

26

 "props": {

27

 "colSizing": "auto"

28

 },

29

 "children": [

30

 "flex-layout.col#card-body-address",

31

 "flex-layout.col#card-body-call-to-action"

32

 ]

33

 },

34

35

 "flex-layout.col#card-body-address": {

36

 "children": [

37

 "pickup-selector-option-card-pickup-point-address"

38

 ]

39

 },

40

41

 "flex-layout.col#card-body-call-to-action": {

42

 "children":[

43

 "pickup-selector-option-card-pickup-point-sla",

44

 "pickup-selector-option-card-add-product-button"

45

 ]

46

 }

`

Using the configuration above, the end result would look like this:

![{"base64":"  ","img":{"width":626,"height":548,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":26049,"url":"https://user-images.githubusercontent.com/8519076/136956522-eb7fab05-66dd-4356-9fe2-62d857e32341.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/8519076/136956522-eb7fab05-66dd-4356-9fe2-62d857e32341.png)

## Blocks

Check out the full list of exported blocks below:

| Block name                                        | Description                                                                                |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| pickup-selector                                   | Main block.                                                                                |
| pickup-selector-zipcode-input                     | Shows the zipcode input.                                                                             |
| pickup-selector-search-sla-button                 | Button used to search the pickup SLA options based on the provided postal code and the selected SKU. |
| pickup-selector-sla-list                          | List that shows the card with the avaiable pickup options.                                           |
| pickup-selector-option-card                       | Card with pickup option information.                                                                 |
| pickup-selector-option-card-pickup-point-name     | Pickup point name.                                                                                |
| pickup-selector-option-card-pickup-point-address  | Pickup point address.                                                                                |
| pickup-selector-option-card-pickup-point-distance | Distance to pickup point (in Km).                                                                    |
| pickup-selector-option-card-pickup-point-sla      | Pickup point SLA.                                                                                |
| pickup-selector-option-card-add-product-button    | Button that adds the product to cart and selects the pickup point.                                   |

### Props

Some of these blocks accept props as described below:

#### `pickup-selector-option-card-pickup-point-distance` props

| Prop name      | Type   | Description                                                                                | Default value |
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| distanceSystem | string | This prop is used to calculate the distance displayed by the block, it accepts metric (shows distance in Km) and imperial (shows distance in Mi). | metric        |

#### `pickup-selector-option-card-add-product-button` props

| Prop name          | Type    | Description                                                                                | Default value |
| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| customPixelEventId | string  | This prop should only be used with [minicart.v2](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minicart). It defines the ID for the event that is sent by the button upon user interaction. Should be the same ID configured on **minicart.v2** so that the drawer opens on successfully adding the product to the cart. | undefined     |
| showToastFeedback  | boolean | This prop is a fallback in order to support minicart.v1. This will show a toast with feedback on successfully adding the product to the cart.                                                                                | false         |

## Customization

In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).

| CSS Handles                      |
| -------------------------------- |
| pickupPointOptionCard            |
| pickupPointAddress               |
| pickupPointDistance              |
| pickupPointName                  |
| pickupPointSla                   |
| pickupSelectorContainer          |
| pickupSelectorSlaList            |
| searchSlaButtonContainer         |
| selectPickupPointButtonContainer |
| zipcodeInputContainer            |

[Product Context« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.product-context)[RewriterNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.rewriter)

See also

[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%23configuration)

[1\. Install the app in your workspace and account.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%231-install-the-app-in-your-workspace-and-account)[2\. Add the app as a theme dependency in the manifest.json file.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%232-add-the-app-as-a-theme-dependency-in-the-manifestjson-file)[3\. Adding the main block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%233-adding-the-main-block)[4\. Configuring the pickup-selector-sla-list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%234-configuring-the-pickup-selector-sla-list)[5\. Configuring the pickup-selector-option-card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%235-configuring-the-pickup-selector-option-card)

[Blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%23blocks)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%23props)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%23customization)

Was this helpful?

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)