VTEX SKU API

The SKU API from VTEX — 10 operation(s) for sku.

Documentation

📖
Documentation
https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works
📖
Documentation
https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet
📖
Documentation
https://developers.vtex.com/docs/guides/catalog-api-seller-portal-overview
📖
Documentation
https://developers.vtex.com/docs/guides/catalog-overview
📖
Documentation
https://developers.vtex.com/docs/guides/checkout-overview
📖
Documentation
https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0
📖
Documentation
https://help.vtex.com/en/tutorial/data-subject-rights--6imchxTx09icupKMbzHVIM
📖
Documentation
https://developers.vtex.com/docs/api-reference/do-api
📖
Documentation
https://developers.vtex.com/docs/guides/managing-vtex-gift-cards
📖
Documentation
https://developers.vtex.com/docs/guides/gift-card-integration-guide
📖
Documentation
https://developers.vtex.com/docs/guides/faststore/headless-cms-overview
📖
Documentation
https://developers.vtex.com/docs/api-reference/vtex-id-api
📖
Documentation
https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.search@1.0.8
📖
Documentation
https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj
📖
Documentation
https://developers.vtex.com/docs/guides/search-overview
📖
Documentation
https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3
📖
Documentation
https://developers.vtex.com/docs/guides/fulfillment
📖
Documentation
https://developers.vtex.com/docs/guides/marketplace-overview
📖
Documentation
https://developers.vtex.com/updates/release-notes/marketplace-protocol-documentation-update
📖
Documentation
https://developers.vtex.com/docs/guides/external-marketplace-integration-guide
📖
Documentation
https://developers.vtex.com/docs/guides/external-seller-integration-connector
📖
Documentation
https://developers.vtex.com/docs/guides/external-seller-integration-guide
📖
Documentation
https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw
📖
Documentation
https://help.vtex.com/en/tutorial/understanding-the-message-center--tutorials_84
📖
Documentation
https://developers.vtex.com/docs/guides/orders-overview
📖
Documentation
https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data
📖
Documentation
https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m
📖
Documentation
https://developers.vtex.com/docs/guides/payments-integration-guide
📖
Documentation
https://help.vtex.com/en/tutorial/vtex-pick-and-pack-last-mile--HN7WKV0xoq2ssVjsJlfzr
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-io-documentation-policies
📖
Documentation
https://developers.vtex.com/docs/guides/pricing-hub
📖
Documentation
https://developers.vtex.com/docs/guides/pricing-overview
📖
Documentation
https://developers.vtex.com/docs/guides/profile-system
📖
Documentation
https://developers.vtex.com/docs/guides/promotions-overview
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings
📖
Documentation
https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors
📖
Documentation
https://developers.vtex.com/docs/guides/sessions-system-overview
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-shipping-network
📖
Documentation
https://help.vtex.com/en/tutorial/sku-bindings--1SmrVgNwjJX17hdqwLa0TX
📖
Documentation
https://developers.vtex.com/docs/guides/subscriptions
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.search/suggestions
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-tracking

Specifications

OpenAPI Specification

vtex-sku-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account SKU API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
tags:
- name: SKU
paths:
  /api/catalog-seller-portal/skus/_search:
    get:
      tags:
      - SKU
      summary: VTex Search for SKU
      description: " >\U0001F4D8 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Retrieves general information about an SKU taking into consideration the defined search criteria. It is mandatory to use at least one query parameter.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| CatalogV2 | Management | **Product Read** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: SearchSKU
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: from
        in: query
        description: The first page of the interval of the product list.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '1'
      - name: to
        in: query
        description: The last page of the interval of the product list.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '50'
      - name: id
        in: query
        description: SKU unique idenfier number.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 1
      - name: externalid
        in: query
        description: SKU reference unique identifier number in the store.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 123456789
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                data:
                - id: '2'
                  productId: '2'
                  externalId: '1909621862'
                _metadata:
                  total: 1
                  from: 1
                  to: 15
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: List with information about the SKU.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: SKU unique identifier number.
                        productId:
                          type: string
                          description: Product unique identifier number.
                        externalId:
                          type: string
                          description: Unique identifier number of the association of the SKU with a Franchise Account.
                  _metadata:
                    type: object
                    description: Information about the organization and exhibition of the SKU list.
                    properties:
                      total:
                        type: integer
                        description: Total of SKUs on the list.
                      from:
                        type: integer
                        description: The first page of the interval of the SKU list.
                      to:
                        type: integer
                        description: The last page of the interval of the SKU list.
  /api/catalog-seller-portal/skus/ids:
    get:
      tags:
      - SKU
      summary: VTex Get List of SKUs
      description: " >\U0001F4D8 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Retrieves general information about all SKUs.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| CatalogV2 | Management | **Product Write** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: ListSKU
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: from
        in: query
        description: The first page of the interval of the product list.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '1'
      - name: to
        in: query
        description: The last page of the interval of the product list.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '50'
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                data:
                - '1'
                - '2'
                _metadata:
                  total: 2
                  from: 1
                  to: 5
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: List with information about the SKU.
                    items:
                      type: string
                      description: SKU unique identifier number.
                  _metadata:
                    type: object
                    description: Information about the organization and exhibition of the SKU list.
                    properties:
                      total:
                        type: integer
                        description: Total of SKUs on the list.
                      from:
                        type: integer
                        description: The first page of the interval of the SKU list.
                      to:
                        type: integer
                        description: The last page of the interval of the SKU list.
  /api/catalog_system/pvt/sku/stockkeepingunitids:
    get:
      tags:
      - SKU
      summary: VTex List all SKU IDs
      description: "Retrieves the IDs of all SKUs in your store. Presents the results with page size and pagination.\r\n> \U0001F4D8 Onboarding guide \r\n>\r\n> Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Content | **SKUs** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: ListallSKUIDs
      parameters:
      - name: page
        in: query
        description: Number of the page from where you need to retrieve SKU IDs.
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 1
      - name: pagesize
        in: query
        description: Size of the page from where you need retrieve SKU IDs. The maximum value is `1000`.
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 25
      - $ref: '#/components/parameters/Content-Type_2'
      - $ref: '#/components/parameters/Accept_2'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: Array composed by SKU IDs, in the search context.
                items:
                  type: integer
                  format: int32
                  description: SKU ID.
              example:
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
      deprecated: false
  /api/catalog_system/pvt/sku/stockkeepingunitbyid/{skuId}:
    get:
      tags:
      - SKU
      summary: VTex Get SKU and context
      description: "Retrieves context of an SKU.\r\n> \U0001F4D8 Onboarding guide \r\n>\r\n> Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Content | **SKUs** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: SkuContext
      parameters:
      - $ref: '#/components/parameters/Content-Type_2'
      - $ref: '#/components/parameters/Accept_2'
      - name: skuId
        in: path
        description: SKU's unique identifier number.
        required: true
        style: simple
        schema:
          type: integer
          example: 2001773
      - name: sc
        in: query
        description: Trade policy's unique identifier number.
        required: false
        style: form
        schema:
          type: integer
          example: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSKUandContext'
              example:
                Id: 2001773
                ProductId: 2001426
                NameComplete: Tabela de Basquete
                ComplementName: ''
                ProductName: Tabela de Basquete
                ProductDescription: Tabela de Basquete
                SkuName: Tabela de Basquete
                ProductRefId: 0987
                TaxCode: ''
                IsActive: true
                IsTransported: true
                IsInventoried: true
                IsGiftCardRecharge: false
                ImageUrl: http://ambienteqa.vteximg.com.br/arquivos/ids/168952-55-55/7508800GG.jpg
                DetailUrl: /tabela-de-basquete/p
                CSCIdentification: null
                BrandId: '2000018'
                BrandName: MARCA ARGOLO TESTE
                IsBrandActive: true
                Dimension:
                  cubicweight: 81.6833
                  height: 65
                  length: 58
                  weight: 10000
                  width: 130
                RealDimension:
                  realCubicWeight: 274.1375
                  realHeight: 241
                  realLength: 65
                  realWeight: 9800
                  realWidth: 105
                ManufacturerCode: ''
                IsKit: false
                KitItems: []
                Services: []
                Categories: []
                CategoriesFullPath:
                - /1/10/
                - /1/
                - /20/
                Attachments:
                - Id: 3
                  Name: Mensagem
                  Keys:
                  - nome;20
                  - foto;40
                  Fields:
                  - FieldName: nome
                    MaxCaracters: '20'
                    DomainValues: Adalberto,Pedro,João
                  - FieldName: foto
                    MaxCaracters: '40'
                    DomainValues: null
                  IsActive: true
                  IsRequired: false
                Collections: []
                SkuSellers:
                - SellerId: '1'
                  StockKeepingUnitId: 2001773
                  SellerStockKeepingUnitId: '2001773'
                  IsActive: true
                  FreightCommissionPercentage: 0
                  ProductCommissionPercentage: 0
                SalesChannels:
                - 1
                - 2
                - 3
                - 10
                Images:
                - ImageUrl: http://ambienteqa.vteximg.com.br/arquivos/ids/168952/7508800GG.jpg
                  ImageName: ''
                  FileId: 168952
                - ImageUrl: http://ambienteqa.vteximg.com.br/arquivos/ids/168953/7508800_1GG.jpg
                  ImageName: ''
                  FileId: 168953
                - ImageUrl: http://ambienteqa.vteximg.com.br/arquivos/ids/168954/7508800_2GG.jpg
                  ImageName: ''
                  FileId: 168954
                Videos:
                - www.google.com
                SkuSpecifications:
                - FieldId: 102
                  FieldName: Cor
                  FieldValueIds:
                  - 266
                  FieldValues:
                  - Padrão
                  IsFilter: false
                  FieldGroupId: 11
                  FieldGroupName: Especificações
                ProductSpecifications:
                - FieldId: 7
                  FieldName: Faixa Etária
                  FieldValueIds:
                  - 58
                  - 56
                  - 55
                  - 52
                  FieldValues:
                  - 5 a 6 anos
                  - 7 a 8 anos
                  - 9 a 10 anos
                  - Acima de 10 anos
                  IsFilter: true
                  FieldGroupId: 17
                  FieldGroupName: NewGroupName 2
                - FieldId: 23
                  FieldName: Fabricante
                  FieldValueIds: []
                  FieldValues:
                  - Xalingo
                  IsFilter: false
                  FieldGroupId: 17
                  FieldGroupName: NewGroupName 2
                ProductClustersIds: 176,187,192,194,211,217,235,242
                PositionsInClusters:
                  '151': 3
                  '152': 0
                  '158': 1
                ProductClusterNames:
                  '151': asdfghj
                  '152': George
                  '158': Coleção halloween
                ProductClusterHighlights:
                  '151': asdfghj
                  '152': George
                ProductCategoryIds: /59/
                IsDirectCategoryActive: false
                ProductGlobalCategoryId: null
                ProductCategories:
                  '59': Brinquedos
                CommercialConditionId: 1
                RewardValue: 100.0
                AlternateIds:
                  Ean: '8781'
                  RefId: '878181'
                AlternateIdValues:
                - '8781'
                - '878181'
                EstimatedDateArrival: null
                MeasurementUnit: un
                UnitMultiplier: 2.0
                InformationSource: Indexer
                ModalType: null
                KeyWords: basquete, tabela
                ReleaseDate: '2020-01-06T00:00:00'
                ProductIsVisible: true
                ShowIfNotAvailable: true
                IsProductActive: true
                ProductFinalScore: 0
      deprecated: false
  /api/catalog/pvt/stockkeepingunit:
    get:
      tags:
      - SKU
      summary: VTex Get SKU by RefId
      description: "Retrieves information about a specific SKU by its `RefId`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Content | **SKUs** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      parameters:
      - $ref: '#/components/parameters/Content-Type_2'
      - $ref: '#/components/parameters/Accept_2'
      - name: RefId
        in: query
        required: true
        description: SKU reference ID.
        schema:
          type: string
          example: '1'
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                Id: 1
                ProductId: 1
                IsActive: true
                Name: Royal Canin Feline Urinary 500g
                RefId: '0001'
                PackagedHeight: 6.0
                PackagedLength: 24.0
                PackagedWidth: 14.0
                PackagedWeightKg: 550.0
                Height: 0.0
                Length: 0.0
                Width: 0.0
                WeightKg: 0.0
                CubicWeight: 1.0
                IsKit: false
                CreationDate: '2020-03-12T15:42:00'
                RewardValue: 0.0
                EstimatedDateArrival: null
                ManufacturerCode: ''
                CommercialConditionId: 1
                MeasurementUnit: un
                UnitMultiplier: 1.0
                ModalType: null
                KitItensSellApart: false
                Videos: []
              schema:
                type: object
                properties:
                  Id:
                    type: integer
                    description: SKU unique identifier.
                  ProductId:
                    type: integer
                    description: ID of the product associated with this SKU.
                  IsActive:
                    type: boolean
                    description: Defines if the SKU is active (`true`) or not (`false`).
                  ActivateIfPossible:
                    type: boolean
                    description: When set to `true`, this attribute will automatically update the SKU as active once associated with an image or an active component.
                  Name:
                    type: string
                    description: 'SKU name, meaning the variation of the previously added product. For example: **Product** - _Fridge_, **SKU** - _110V_.'
                  RefId:
                    type: string
                    description: Reference code used internally for organizational purposes. Must be unique. Required only if `Ean` is not informed, but can be used alongside `Ean` as well.
                  Ean:
                    type: string
                    description: EAN code. Required only if `RefId` is not informed, but can be used alongside `RefId` as well.
                  PackagedHeight:
                    type: number
                    description: Height used for shipping calculation.
                  PackagedLength:
                    type: number
                    description: Length used for shipping calculation.
                  PackagedWidth:
                    type: number
                    description: Width used for shipping calculation.
                  PackagedWeightKg:
                    type: integer
                    description: Weight used for shipping calculation, in the measurement unit [configured in the store](https://help.vtex.com/en/tutorial/filling-in-system-settings--tutorials_269), which by default is in grams.
                  Height:
                    type: number
                    description: SKU real height.
                  Length:
                    type: number
                    description: SKU real length.
                  Width:
                    type: number
                    description: SKU real width.
                  WeightKg:
                    type: number
                    description: Weight of the SKU in the measurement [configured in the store](https://help.vtex.com/en/tutorial/filling-in-system-settings--tutorials_269), which by default is in grams.
                  CubicWeight:
                    type: number
                    description: '[Cubic weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).'
                  IsKit:
                    type: boolean
                    description: Defines whether the SKU is made up of one or more SKUs (part of a kit) (`true`) or not (`false`). Must be enabled if you are adding a kit. Once activated, this definition cannot be reverted.
                  CreationDate:
                    type: string
                    description: Date and time of the SKU's creation.
                  RewardValue:
                    type: number
                    description: Credit that the customer receives when finalizing an order that includes the SKU. By filling this field out with `1`, the customer receives credit on the site in the selected currency, e.g. U$ 1.
                  EstimatedDateArrival:
                    type: string
                    description: SKU estimated arrival date in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format, when the product is on pre-sale. You must take into consideration both the launch date and the freight calculation for the arrival date.
                    nullable: true
                  ManufacturerCode:
                    type: string
                    description: Identifier provided by the manufacturers to identify their product. This field should be filled in if the product has a specific manufacturer's code.
                  CommercialConditionId:
                    type: integer
                    description: Commercial condition ID, used to define SKU specific promotions or installment rules. In case of no specific condition, use `1` (default value). This field does not accept `0`. Learn more at [Registering a commercial condition](https://help.vtex.com/tutorial/registering-a-commercial-condition--tutorials_445).
                    default: 1
                  MeasurementUnit:
                    type: string
                    description: Measurement unit. This field should only be used when it is necessary to convert the unit of measure for sale. For example, if a product is sold in boxes, but customers want to buy per square meter (m²). In common cases, use `"un"`.
                  UnitMultiplier:
                    type: number
                    description: Multiple number of SKU. If the multiplier is 5.0000, the product can be added in multiple quantities of 5, 10, 15, 20, onward.
                  ModalType:
                    type: string
                    nullable: true
                    description: Links an unusual type of SKU that needs special transportation, such as meat, glass, or a mattress, to a carrier specialized in delivering it. This field should be filled in with the name of the modal (e.g. "Chemicals" or "Refrigerated products"). To learn more about this feature, read our articles [How the modal works](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) and [Setting up modal for carriers](https://help.vtex.com/en/tutorial/configure-modal--3jhLqxuPhuiq24UoykCcqy).
                  KitItensSellApart:
                    type: boolean
                    description: Defines if kit components can be sold apart.
                  Videos:
                    type: array
                    description: Videos URLs.
                    items:
                      type: string
                      description: Video URL.
    post:
      tags:
      - SKU
      summary: VTex Create SKU
      description: "Creates a new SKU.\r\n\r\nIf there is a need to create a new SKU with a specific custom ID, specify the `Id` (integer) in the request. Otherwise, VTEX will generate the ID automatically.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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 

# --- truncated at 32 KB (127 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-sku-api-openapi.yml