v50

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

Delete affiliate by ID

Deletes the specified affiliate configuration by 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:

ProductCategoryResource
CheckoutCheckoutResourcesSave Order Configuration
CheckoutCheckoutResourcesSave 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.

delete/fulfillment/pvt/affiliates/{affiliateId}

Path parameters

affiliateIdstring required
Example:LNG

Three-letter identifier defined during the affiliate configuration creation.

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

No Content