v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB

SKU complement

Create SKU complement

Creates a new SKU complement on a parent SKU.

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
Catalog	Content	SKUs

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.

post/api/catalog/pvt/skucomplement

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

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

Request body

ParentSkuIdinteger required

ID of the parent SKU, where the complement is inserted.

SkuIdinteger required

ID of the SKU which will be inserted as a complement in the parent SKU.

ComplementTypeId1 | 2 | 3 | 5 required

Complement type ID. This represents the type of the complement. The possible values are: 1 for Accessory; 2 for Suggestion; 3 for Similar product; 5 for Show together.

Example request

{
  "ParentSkuId": 1,
  "SkuId": 1,
  "ComplementTypeId": 1
}

Response

Idinteger

SKU complement's unique numerical identifier.

SkuIdinteger

ID of the SKU which will be inserted as a complement in the parent SKU.

ParentSkuIdinteger

ID of the parent SKU, where the complement will be inserted.

ComplementTypeId1 | 2 | 3 | 4 | 5

Complement type ID. This represents the type of the complement. The possible values are: 1 for Accessory; 2 for Suggestion; 3 for Similar product; 5 for Show together.