v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-282624202.6 KB

Affiliates

Get affiliate by ID

Retrieves the specified affiliate configuration by affiliate ID.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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 for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/fulfillment/pvt/affiliates/{affiliateId}

Path parameters

affiliateIdstring required

Example:LNG

Three-letter identifier defined during the affiliate configuration creation. Vowels are not allowed.

accountNamestring required

Example:apiexamples

Name of the VTEX account that belongs to the marketplace. The notification will be posted into this account.

environmentstring required

Environment to use. Used as part of the URL.

Headers

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Content-Typestring required

Type of the content being sent.

Response

idstring

Three-letter identifier defined during the affiliate configuration creation. Vowels are not allowed.

followUpEmailstring

Email address in which the user will receive notifications about the integration.

useSellerPaymentMethodboolean

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.

namestring

Affiliate name.

salesChannelstring

Number of the sales channel that will define the catalog assortment, prices, and the shipping strategy of items sent to the marketplace.

searchURIEndpointstring 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, fill in the value: https://{endpointDoAfiliado}/api/notification/. Learn more in our article How to confugure the affiliate endpoint.

searchURIEndpointVersionstring

Search URI endpoint version. The default option is the only one available.

searchURIEndpointAvailableVersionsstring[]

Search URI endpoint available versions.

minimumValueAccumulatedinteger nullable

Minimum value accumulated in the cart to checkout the order.