[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 order canceling improvements 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/order-canceling-improvements/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/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/order-canceling-improvements/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/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/order-canceling-improvements/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/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/order-canceling-improvements/updates/release-notes)

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/orders-feed)

[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-modifications)

[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/change-seller)

[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements)

[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/actions-orders)

Subscriptions

---

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/order-canceling-improvements/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides)

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

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

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

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/troubleshooting)

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/orders-feed)

[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-modifications)

[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/change-seller)

[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements)

[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/actions-orders)

Subscriptions

---

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/order-canceling-improvements/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides)

Orders

[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements)

Order canceling improvements

There are many scenarios where canceling an order is necessary, whether on behalf of sellers, marketplaces or shoppers. To cover multiple scenarios, we made the following improvements in order cancellation:

* [Cancel order requested by shopper](#cancel-order-requested-by-shopper): When the marketplace customer care service cancels an order after a shopper requests it, now the seller is notified about the cancellation reason and whether or not it was made on behalf of the shopper.
* [Deny cancel order](#deny-cancel-order): After the [cancellation window](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196) period – or grace period –, now the seller can deny cancellation requests.

In each case, both seller and marketplace will be notified about changes, have access to information about each other's reasons for canceling and/or denying a cancel request, and sellers will know when the shopper requested the cancellation.

For information about this feature in VTEX Admin, see [Declining order cancelation](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/declining-order-cancelation--F2n0h1TeQ5td540Gjyff4).

> In this article, the term marketplace will refer to VTEX marketplace and seller to VTEX seller. For more information, see [Marketplace strategies at VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials%5F402).

## Permissions

Using the endpoints mentioned in this article requires having the `Cancel order` [resource](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) associated with the user or integration key. This resource is included in the following [predefined roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):

For more information, see [users](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-users--tutorials%5F512) and [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) at VTEX.

## Cancel order requested by shopper

With the [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) endpoint, now it is possible to indicate if the canceling request was demanded by the shopper or not. This is possible because of the new request body field `requestedByUser`. This is useful for sellers to know when the marketplace cancels an order on behalf of the shopper.

A common scenario is when the shopper contacts the marketplaces customer care service via telephone, for example, and requests an order cancellation. In the cancellation request, the customer care now can inform both marketplace and seller that the cancellation was demanded by the shopper.

> The [order flow](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196) for canceling orders remains the same.

### Diagram

The following image shows the flow when canceling an order on behalf of the shopper:

![{"base64":"  ","img":{"width":4024,"height":796,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":45844,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Orders/cancel_by_user.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Orders/cancel_by_user.png)

The step by step is the following:

1. The shopper contacts the marketplace customer care service to cancel an order.
2. The customer care cancels it using the [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) endpoint. The request body contains the reason for order cancellation and indicates if it was requested by the shopper.
3. The cancel order request notifies the seller about the cancellation reason and if the request came from the shopper or not.
4. VTEX seller cancels the order.

### Cancel order endpoint

See below the [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) endpoint, where `orderId` corresponds to the ID of the order been canceled:

**POST -** `https://{accountName}.{environment}.com.br/api/oms/pvt/orders/{orderId}/cancel`

**cURL**

`1

curl --request post \

2

--url 'https://{accountname}.{environment}.com.br/api/oms/pvt/orders/{orderId}/cancel' \

3

--header 'Accept: application/json' \

4

--header 'Content-Type: application/json' \

5

--header 'X-VTEX-API-AppKey: ' \

6

--header 'X-VTEX-API-AppToken: ' \

7

--data '{

8

 "reason": "string",

9

 "requestedByUser": boolean

10

 }'

`

### Request body

See below a request body example:

`1

{

2

 "reason" : "reason for cancellation",

3

 "requestedByUser" : true

4

}

`

The following table presents the request body fields’ description:

| Field           | Type    | Description                                                                                |
| --------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| reason          | string  | Brief explanation of why the order is being canceled.                                                                                |
| requestedByUser | boolean | When set as true, the cancellation was requested by the shopper, and when set as false, the cancellation was not canceled on behalf of the shopper. |

### Response body

See below a response body example:

`1

{

2

 "date": "2023-08-04T15:45:02.1306363+00:00",

3

 "orderId": "1351761719659-01",

4

 "receipt": "38e0e47da2934847b489216d208cfd91"

5

}

`

The following table presents the response body fields’ description:

| Field   | Type   | Description                                                                                |
| ------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| date    | string | Date and time of when the platform processed the cancellation request. The format is according to ISO 8601 YYYY-MM-DDThh:mm:ssTZD, meaning a complete date plus hours, minutes, seconds and a decimal fraction of a second. For example, 2023-08-04T15:45:02.1306363+00:00. |
| orderId | string | ID that identifies the order being canceled.                                                                                |
| receipt | string | Protocol code generated by the update. It may be null.                                                                                |

### Response status codes

The possible response status codes are shown in the table below:

| Status Code               | Description                                                                                |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| 200 OK                    | The order was successfully canceled.                                                                                |
| 403 Forbidden             | Unauthorized request. Update the credentials used in the request and try again.                                      |
| 404 Not Found             | The requested order was not found. Check the order ID and try again.                                                 |
| 429 Too Many Requests     | We were unable to process the request due to the high volume of submissions. Wait a few minutes before trying again. |
| 500 Internal Server Error | An unexpected application error occurred. Review the request data and try again.                                     |

### Order after cancellation

After the seller agrees to cancel the order, as requested by the marketplace on behalf of the shopper, it reaches the `canceled` [status](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196). By using one of the endpoints below, both seller and marketplace can retrieve cancellation information:

* GET - [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-)
* GET - [Retrieve user order details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/user/orders/-orderId-)

The information will be in the `cancellationData` object of the response body, as shown in the example below:

`1

"cancellationData": {

2

 "requestedByUser": true,

3

 "reason": "cancelation reason",

4

 "cancellationDate": "2023-08-04T15:45:02.1306363Z",

5

 "cancellationRequestId": "85835ab408514b52aa139e4236ce0c33"

6

 }

`

> Seller and marketplace will get the same order cancellation information.

The fields’ description are shown below:

| Response body field   | Type    | Description                                                                                |
| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cancellationData      | object  | Object with information about the order cancellation.                                                                                |
| requestedByUser       | boolean | When set as true, the cancellation was requested by the shopper, and when set as false, the cancellation was not canceled on behalf of the shopper.                                                                                |
| reason                | string  | Explanation of why the order was canceled.                                                                                |
| cancellationDate      | string  | Date and time of when the platform processed the cancellation request. The format is according to [ISO 8601](https://read.calvincode.net/reader?url=https://www.w3.org/TR/NOTE-datetime) YYYY-MM-DDThh:mm:ssTZD, meaning a complete date plus hours, minutes, seconds and a decimal fraction of a second. For example, 2023-08-04T15:45:02.1306363+00:00 It could also be 2023-08-04T15:45:02.1306363Z, where Z stands for zone in Time Zone Designator (TZD). Z is equal to +hh:mm or \-hh:mm. |
| cancellationRequestId | string  | ID that identifies the cancellation operation.                                                                                |

## Deny cancel order

In the order flow, there is a [cancellation window](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196) period – or grace period – in which an order can be automatically canceled by the shopper. Except for that period, now the seller can deny order cancel requests, regardless if the cancellation request came from the shopper or the marketplace.

A common scenario for using this endpoint is when the marketplace works with sellers whose products are made on demand by each purchase. If a shopper contacts the marketplace customer care service via telephone demanding the order cancellation, and the marketplace cancels the order, now the seller can deny the cancellation request.

> To deny an order cancellation request, the order status in the marketplace and seller must be the following:
>
> * **Marketplace status:** `waiting-for-seller-decision`.
> * **Seller status:** `cancellation-requested`.

### Diagram

The following image shows the flow of denying an order’s cancel request outside the cancellation window:

![{"base64":"  ","img":{"width":4212,"height":2121,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":107517,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Orders/deny_cancel_request.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Orders/deny_cancel_request.png)

The step by step is the following:

1. The shopper contacts the marketplace to cancel an order.
2. After receiving the request, the marketplace sends a cancellation request to the seller.
> At this point, the [order status](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196) for the marketplace is `waiting-for-seller-decision`.
3. If the order is within the cancellation window period, this order is automatically canceled, which is the platform default behavior. The next steps are for when the order is no longer within the cancellation window.
4. The seller receives the cancel order request and decides to accept it or not. The next steps are for when the seller decides not to cancel the order.
5. The seller’s request to deny the order cancellation and that notifies the marketplace, with the reason included.
6. After the marketplace receives the denial request, the order moves on in the order workflow, from the status below:
   * **For the marketplace**: `payment-approved`.
   * **For the seller**: `ready-for-handling` or `handling`, depending on which was the status before the cancel request.
7. **Optional:** marketplace can, via webhook, notify a subscribed shopper about the order change in `payment-approved` and `cancellation-request-denied` status. It is also possible for some applications to collect the order cancellation denial reason given by the seller and inform the shopper.

### Deny cancel order endpoint

See below the endpoint deny order cancellation, where `orderId` corresponds to the ID of the order witches cancellation is being denied:

**POST -** `https://{accountName}.{environment}.com.br/api/orders/pvt/document/{orderId}/deny-cancellation-request`

**cURL**

`1

curl --request post \

2

--url 'https://{accountname}.{environment}.com.br/api/orders/pvt/document/{orderId}/deny-cancellation-request' \

3

--header 'Accept: application/json' \

4

--header 'Content-Type: application/json' \

5

--header 'X-VTEX-API-AppKey: ' \

6

--header 'X-VTEX-API-AppToken: ' \

7

--data '{

8

 "cancellationRequestId": "cancellationRequestId",

9

 "denyReason": "dIt isnandRIt isasOn"

10

 }'

`

### Request body

See below a request body example:

`1

{

2

 "cancellationRequestId": "85835ab408514b52aa139e4236ce0c33",

3

 "denyReason": "reason for seller giving deny"

4

}

`

The following table presents the request body fields’ description:

| Field                 | Type   | Description                                                                                | Mandatory |
| --------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| cancellationRequestId | string | Unique identifier of an order requested to be canceled. This ID format is a sequence of numbers and letters. The cancellationRequestId is generated by the endpoint Cancel order, and can be found in the responses of the following endpoints: Get order Retrieve user order details | Yes       |
| denyReason            | string | Brief explanation of why the seller will deny order cancellation.                                                                                | Yes       |

### Response body

The endpoint does not return a response body in the successful `200 OK` response.

### Response status codes

The possible response status codes are shown in the table below:

| Status Code               | Description                                                                                |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 200 OK                    | The order cancellation was successfully denied.                                                                                |
| 400 Bad Request           | The request was not processed, some possible reasons are: Cancellation request ID not found. Order already canceled. Order workflow not found. Invalid order status. The acceptable status for the seller is cancellation-requested , and for the marketplace is waiting-for-seller-decision. |
| 403 Forbidden             | Unauthorized request. Update the credentials used in the request and try again.                                                                                |
| 404 Not Found             | The requested order was not found. Check the order ID and try again.                                                                                |
| 429 Too Many Requests     | We were unable to process the request due to the high volume of submissions. Wait a few minutes before trying again.                                                                                |
| 500 Internal Server Error | An unexpected application error occurred. Review the request data and try again.                                                                                |

### Order after cancellation

After the seller denies the cancellation request made by the marketplace outside the cancellation window, the related information can be retrieved both by marketplace and seller using one of the endpoints below:

* GET - [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-)
* GET - [Retrieve user order details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/user/orders/-orderId-)

The information will be in the `cancellationRequests` array of the response body, as shown in the example below:

`1

"cancellationRequests": [

2

 {

3

 "id": "85835ab408514b52aa139e4236ce0c33",

4

 "reason": "Cancelation Reason",

5

 "cancellationRequestDate": "2023-07-24T19:44:59.6667459Z",

6

 "requestedByUser": true,

7

 "deniedBySeller": true,

8

 "deniedBySellerReason": "reason of deny",

9

 "cancellationRequestDenyDate": "2023-07-24T19:45:03.4550528Z"

10

 }

11

 ]

`

> Seller and marketplace will get the same denial cancellation information.

The fields’ description are shown below:

| Response body field         | Type    | Description                                                                                |
| --------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cancellationRequests        | array   | Array with information regarding the order witches cancellation was denied.                                                                                |
| id                          | string  | ID that identifies the original cancellation operation made by the marketplaces or its customer care service using the [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) endpoint.                                                                                |
| reason                      | string  | Explanation of why there was a request for canceling the order.                                                                                |
| cancellationRequestDate     | string  | Date and time of when the platform processed the cancellation request. The format is [ISO 8601](https://read.calvincode.net/reader?url=https://www.w3.org/TR/NOTE-datetime) YYYY-MM-DDThh:mm:ssTZD, a complete date plus hours, minutes, seconds and a decimal fraction of a second. For example, 2023-08-04T15:45:02.1306363+00:00 It could also be 2023-08-04T15:45:02.1306363Z, where Z stands for zone in Time Zone Designator (TZD), and Z is equal to +hh:mm or \-hh:mm. |
| requestedByUser             | boolean | When set as true, the cancellation was requested by the shopper, and when set as false, the cancellation was not canceled on behalf of the shopper.                                                                                |
| deniedBySeller              | boolean | When set as true, the seller denied the order cancellation, and when set as false, the seller did not deny it.                                                                                |
| deniedBySellerReason        | string  | Reason given by the seller for denying order cancellation.                                                                                |
| cancellationRequestDenyDate | string  | Date and time of when the seller’s request to deny order cancellation was processed. The format is ISO 8601 YYYY-MM-DDThh:mm:ssTZD, a complete date plus hours, minutes, seconds and a decimal fraction of a second. For example, 2023-08-04T15:45:02.1306363+00:00 It could also be 2023-08-04T15:45:02.1306363Z, where Z stands for zone in Time Zone Designator (TZD), and Z is equal to +hh:mm or \-hh:mm.                          |

Contributors

3

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

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

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

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/Orders/order-canceling-improvements.md)

[Change seller« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements//docs/guides/change-seller)[Actions in ordersNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements//docs/guides/actions-orders)

Contributors

3

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

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

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

ON THIS PAGE

[Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23permissions)

[Cancel order requested by shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23cancel-order-requested-by-shopper)

[Diagram](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23diagram)[Cancel order endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23cancel-order-endpoint)[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23request-body)[Response body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-body)[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-status-codes)[Order after cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23order-after-cancellation)

[Deny cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23deny-cancel-order)

[Diagram](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23diagram)[Deny cancel order endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23deny-cancel-order-endpoint)[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23request-body)[Response body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-body)[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-status-codes)[Order after cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23order-after-cancellation)

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/Orders/order-canceling-improvements.md)

Copy page

On this page

ON THIS PAGE

[Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23permissions)

[Cancel order requested by shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23cancel-order-requested-by-shopper)

[Diagram](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23diagram)[Cancel order endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23cancel-order-endpoint)[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23request-body)[Response body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-body)[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-status-codes)[Order after cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23order-after-cancellation)

[Deny cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23deny-cancel-order)

[Diagram](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23diagram)[Deny cancel order endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23deny-cancel-order-endpoint)[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23request-body)[Response body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-body)[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-status-codes)[Order after cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23order-after-cancellation)

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] Provide a guide on guides calling commerce apis 3 using vtex io clients 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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/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/calling-commerce-apis-3-using-vtex-io-clients/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/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/calling-commerce-apis-3-using-vtex-io-clients/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/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/calling-commerce-apis-3-using-vtex-io-clients/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/app-development-guides)

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-service)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-on-vtex-io)

[1\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)

[2\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)

[3\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)

[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-conclusion)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-clients)

Handling events

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/configuring-dynamic-routes-in-vtex-io-services)

[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-developing-service-configuration-apps)

[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/node-builder-7x-migration-guide)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/app-development-guides)

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-service)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-on-vtex-io)

[1\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)

[2\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)

[3\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)

[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-conclusion)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-clients)

Handling events

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/configuring-dynamic-routes-in-vtex-io-services)

[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-developing-service-configuration-apps)

[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/node-builder-7x-migration-guide)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/app-development)

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/app-development-guides)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-on-vtex-io)

[3\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)

3\. Using VTEX IO clients

Now equipped with knowledge on authenticating API calls in VTEX IO, let's dive into the practical aspect of calling VTEX Core Commerce APIs using native [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients). In this guide, we'll specifically leverage the `Catalog` client to retrieve SKU details within the VTEX platform.

In VTEX IO, Clients act as abstractions for external services, simplifying external requests in backend services. We strogly recommend using pre-built Clients from the [@vtex/clients](https://read.calvincode.net/reader?url=https://github.com/vtex/io-clients) package for VTEX Core Commerce services and [developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients) for external providers (e.g., [Google Maps API](https://read.calvincode.net/reader?url=https://developers.google.com/maps/apis-by-platform)).

## Installing the `@vtex/clients` package

The [@vtex/clients](https://read.calvincode.net/reader?url=https://github.com/vtex/io-clients) package is a TypeScript library featuring pre-configured Clients for accessing VTEX Core Commerce APIs' capabilities. To use it in your app, change to the `node` folder and install the `@vtex/clients` package by running the command presented in the right panel.

## Configuring the Catalog client

Update your app's client `node/clients/index.ts` by importing the `Catalog` Client from the `@vtex/clients` library and exporting it to your `Clients` object. From now on, any function in your app can use the `Catalog` Client via `ctx.clients.catalog`. Also, thanks to TypeScript typing capabilities, autocomplete will become available for the methods exported by the `Catalog` client.

![{"base64":"  ","img":{"width":512,"height":259,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":35149,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/calling-commerce-apis-3-using-vtex-io-clients.jpeg"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/calling-commerce-apis-3-using-vtex-io-clients.jpeg)

## Using the Catalog client

Now, let's use the `getSkuById` method from the `Catalog` client to retrieve information from a Stock Keeping Unit (SKU) in the VTEX Catalog. To do so, we will update the `status` route logic to read the `code` parameter as an SKU ID and return SKU details.

Open the `node/middlewares/status.ts` file and update it as in the following:

* Extract the `catalog` client from the `ctx` received in the middleware functions. Learn more about Destructuring on the [Mozilla docuentation](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring%5Fassignment).
* Extract the variable `code`, which will be used as the `code` parameter of our route (`/_v/status/:code`).
* Call the `getSkuById` method from the `Catalog` client. This method will internally call the necessary endpoints of the Catalog API, passing the `code` parameter as the SKU ID to be searched. Also, since this is an asynchronous call, ensure to use the `await` to wait for it.

## Declaring the necessary policies

Usually, native Clients are already automatically configured to make authenticated calls using the app token. Nevertheless, you still need to declare that your app will be making requests for some service.

To do so, open the `manifest.json` file and add the highlighted code in the right panel to the `policies` section. This will allow your app to make calls to the Catalog API.

## Fetching the SKU data

With the app linked to your development workspace, copy and send a GET request to the public URL that your service is exposing. Paste in the address bar `https://{workspace}--{account}.myvtex.com/_v/status/1` to find information about the SKU ID `1`. The expected result should be a JSON with the SKU data, fetched from the Catalog API.

Terminal

`1

cd node && yarn add @vtex/clients

`

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7026595%3Fv%3D4%26w=64%26q=75)](https://github.com/henriquessb)

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

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/vtex-io/Calling Commerce APIs/calling-commerce-apis-3-using-vtex-io-clients.md)

[2\. Discovering VTEX Commerce APIs and authentication« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients//docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)[Calling Commerce APIs - ConclusionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients//docs/guides/calling-commerce-apis-conclusion)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7026595%3Fv%3D4%26w=64%26q=75)](https://github.com/henriquessb)

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

ON THIS PAGE

[Installing the @vtex/clients package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23installing-the-vtexclients-package)

[Configuring the Catalog client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23configuring-the-catalog-client)

[Using the Catalog client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23using-the-catalog-client)

[Declaring the necessary policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23declaring-the-necessary-policies)

[Fetching the SKU data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23fetching-the-sku-data)

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/vtex-io/Calling Commerce APIs/calling-commerce-apis-3-using-vtex-io-clients.md)

Copy page

On this page

ON THIS PAGE

[Installing the @vtex/clients package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23installing-the-vtexclients-package)

[Configuring the Catalog client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23configuring-the-catalog-client)

[Using the Catalog client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23using-the-catalog-client)

[Declaring the necessary policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23declaring-the-necessary-policies)

[Fetching the SKU data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23fetching-the-sku-data)

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 store footer 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/vtex.store-footer/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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/vtex.store-footer/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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/vtex.store-footer/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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/vtex.store-footer/updates/release-notes)

VTEX IO Apps

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

[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.add-to-cart-button)

[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/Autocomplete)

[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/banner)

[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.breadcrumb)

[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-footer)

[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/google-one-tap-login)

[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-header)

[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.locale-switcher)

[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.login)

[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.menu)

[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.minicart)

[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.order-placed)

[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-customizer)

[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-highlights)

[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-identifier)

[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-list)

[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-price)

[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-quantity)

[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-specifications)

[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary)

[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryattachmentlist)

[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummarybuybutton)

[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummarydescription)

[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryimage)

[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummarylist)

[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryname)

[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryshelf)

[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryskuselector)

[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryskuname)

[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.rich-text)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search)

[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/suggestions)

[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/didyoumean)

[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search-result)

[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-image)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.add-to-cart-button)

[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/Autocomplete)

[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/banner)

[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.breadcrumb)

[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-footer)

[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/google-one-tap-login)

[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-header)

[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.locale-switcher)

[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.login)

[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.menu)

[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.minicart)

[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.order-placed)

[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-customizer)

[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-highlights)

[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-identifier)

[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-list)

[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-price)

[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-quantity)

[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-specifications)

[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary)

[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryattachmentlist)

[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummarybuybutton)

[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummarydescription)

[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryimage)

[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummarylist)

[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryname)

[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryshelf)

[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryskuselector)

[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryskuname)

[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.rich-text)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search)

[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/suggestions)

[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/didyoumean)

[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search-result)

[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-image)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

Footer

Official extension

Version: 2.27.0

Latest version: 2.27.0

Footer is a store component that shows information about the store such as address, social networks and payment methods. Furthermore, it is possible to add hyperlinks for privacy policy, FAQ, benefits and attendance. This app is used by store theme.

![{"base64":"  ","img":{"width":3276,"height":540,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":112205,"url":"https://user-images.githubusercontent.com/284515/70253374-dde10680-1761-11ea-8a81-856cec500f89.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/284515/70253374-dde10680-1761-11ea-8a81-856cec500f89.png)

## Configuration

1. Import the `vtex.store-footer`'s app to your theme's dependencies in the `manifest.json`, for example:

`1

 dependencies: {

2

 "vtex.store-footer: 2.x"

3

 }

`

1. Define the `footer` block. For example:

`1

{

2

 "footer": {

3

 "blocks": ["footer-layout.desktop", "footer-layout.mobile"]

4

 },

5

 "footer-layout.desktop": {

6

 "children": [

7

 "flex-layout.row#footer-desktop"

8

 ]

9

 },

10

 "footer-layout.mobile": {

11

 "children": [

12

 "flex-layout.row#footer-mobile"

13

 ]

14

 },

15

 "flex-layout.row#footer-desktop": {

16

 "children": [

17

 "social-networks",

18

 "accepted-payment-methods",

19

 "powered-by"

20

 ]

21

 },

22

 "flex-layout.row#footer-mobile": {

23

 "children": [

24

 "social-networks",

25

 "accepted-payment-methods",

26

 "powered-by"

27

 ]

28

 },

29

 "social-networks": {

30

 "props": {

31

 "socialNetworks": [

32

 { "url": "https://facebook.com/foo", "name": "Facebook" },

33

 { "url": "https://twitter.com/foo", "name": "Twitter" }

34

 ]

35

 }

36

 },

37

 "accepted-payment-methods": {

38

 "props": {

39

 "paymentMethods": ["mastercard", "visa", "diners club"]

40

 }

41

 }

42

}

`

`social-networks`:

| Prop name      | Type                 | Description                          |
| -------------- | -------------------- | ------------------------------------ |
| title          | string               | Text to show above of list of links  |
| socialNetworks | Array(SocialNetwork) | Array of social networks             |
| showInColor    | boolean              | Whether the icons are colored or not |

SocialNetwork

| Prop name | Type   | Description                                                      |
| --------- | ------ | ---------------------------------------------------------------- |
| url       | string | Link to the social network profile                               |
| name      | enum   | Possible values: facebook, twitter, linkedin, youtube, pinterest |

`accepted-payment-methods`:

| Prop name      | Type    | Description                                    |
| -------------- | ------- | ---------------------------------------------- |
| paymentMethods | Array   | Possible values: mastercard, visa, diners club |
| showInColor    | boolean | Whether the icons are colored or not           |

`powered-by`:

| Prop name   | Type    | Description                          |
| ----------- | ------- | ------------------------------------ |
| showInColor | boolean | Whether the icons are colored or not |

## 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).

`footer-layout`:

| CSS Handles        |
| ------------------ |
| footerLayout       |
| footerLayoutSpacer |

`social-networks`:

| CSS Handles             |
| ----------------------- |
| socialNetworksTitle     |
| socialNetworksContainer |
| socialNetworkWrapper    |
| socialNetworkLink       |
| socialNetworkImage      |

`accepted-payment-methods`:

| CSS Handles                    |
| ------------------------------ |
| acceptedPaymentMethodContainer |
| paymentMethodIcon              |
| paymentMethodIconImage         |

`powered-by`:

| CSS Handles    |
| -------------- |
| poweredBy      |
| poweredByImage |
| poweredByLink  |

[Breadcrumb« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.breadcrumb)[Google One-Tap LoginNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/google-one-tap-login)

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/vtex.store-footer/docs/apps/vtex.store-footer%23configuration)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-footer%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=)