---
title: "List affiliates"
method: GET
path: "/fulfillment/pvt/affiliates"
tags: ["Affiliates"]
---

# List affiliates

`GET /fulfillment/pvt/affiliates`

## Request

- Base URL: `https://apiexamples.vtexcommercestable.com.br/api`
- URL: `https://apiexamples.vtexcommercestable.com.br/api/fulfillment/pvt/affiliates`
- Auth: API key in header `X-VTEX-API-AppKey` and API key in header `X-VTEX-API-AppToken`

Lists all [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) configurations in a store.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Checkout | CheckoutResources | **Save Order Configuration** |
| Checkout | CheckoutResources | **Save OrderForm Configuration** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `accountName` string, required
- `environment` string, required

## Headers

- `Accept` string, required
- `Content-Type` string, required

## Response `200`

OK

- object[]: Array containing all configured affiliates in the store.
  - `id` string: Three-letter identifier defined during the affiliate configuration creation. Vowels are not allowed.
  - `followUpEmail` string: Email address in which the user will receive notifications about the integration.
  - `useSellerPaymentMethod` boolean: Indicates if the store uses the payment split, seller payment method, (`true`) or not (`false`). Recommended for use only in VTEX-with-VTEX integrations because of compatibility of payment methods.
  - `name` string: Affiliate name.
  - `salesChannel` string: Number of the sales channel that will define the catalog assortment, prices, and the shipping strategy of items sent to the marketplace.
  - `searchURIEndpoint` string, nullable: URL of the application that will receive products, price, and inventory notifications, among others. The Search Endpoint should be filled with the value: `http://productnotification.vtexcommerce.com.br/api/notification/{NameOfMarketplace}/{SellerID}`. For [external marketplaces](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-an-external-marketplace), fill in the value: `https://{endpointDoAfiliado}/api/notification/`. Learn more in our article [How to confugure the affiliate endpoint](https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update#how-to-configure-the-affiliate-endpoint).
  - `searchURIEndpointVersion` string: Search URI endpoint version. The default option is the only one available.
  - `searchURIEndpointAvailableVersions` string[]: Search URI endpoint available versions.
  - `minimumValueAccumulated` integer, nullable: Minimum value accumulated in the cart to checkout the order.

## Changes

- **2025-05-06** `2e8857075176`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vtex/apis/marketplace-api/changes/fulfillment/pvt/affiliates/get.md)

---

[API](https://skmtc.dev/vtex/apis/marketplace-api.md) - [All operations](https://skmtc.dev/vtex/apis/marketplace-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/marketplace-api/revisions/6e80df6595ec?raw)