VTEX SKU EAN API

The SKU EAN API from VTEX — 3 operation(s) for sku ean.

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-ean-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account SKU EAN 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 EAN
paths:
  /api/catalog_system/pvt/sku/stockkeepingunitbyean/{ean}:
    get:
      tags:
      - SKU EAN
      summary: VTex Get SKU by EAN
      description: "Retrieves an SKU by its EAN ID.\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: SkubyEAN
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: ean
        in: path
        description: EAN of the SKU which you need to retrieve details from.
        required: true
        style: simple
        schema:
          type: string
          example: '1234567890123'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSKUAltID'
              example:
                Id: 2001773
                ProductId: 2001426
                NameComplete: Tabela de Basquete
                ProductName: Tabela de Basquete
                ProductDescription: Tabela de Basquete
                SkuName: Tabela de Basquete
                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
                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: []
                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
                SkuSpecifications:
                - FieldId: 102
                  FieldName: Cor
                  FieldValueIds:
                  - 266
                  FieldValues:
                  - Padrão
                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
                - FieldId: 23
                  FieldName: Fabricante
                  FieldValueIds: []
                  FieldValues:
                  - Xalingo
                ProductClustersIds: 176,187,192,194,211,217,235,242
                ProductCategoryIds: /59/
                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: null
                ModalType: ''
      deprecated: false
  /api/catalog/pvt/stockkeepingunit/{skuId}/ean:
    get:
      tags:
      - SKU EAN
      summary: VTex Get EAN by SKU ID
      description: "Retrieves the EAN of the SKU.\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'
      - $ref: '#/components/parameters/Accept'
      - name: skuId
        in: path
        required: true
        description: SKU's unique numerical identifier.
        schema:
          type: integer
          example: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: Array with EANs associated with the SKU.
                items:
                  type: string
                  description: EAN.
              example:
              - '1234567890123'
    delete:
      tags:
      - SKU EAN
      summary: VTex Delete all SKU EAN values
      description: "Deletes all EAN values of an SKU.\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'
      - $ref: '#/components/parameters/Accept'
      - name: skuId
        in: path
        required: true
        description: SKU's unique numerical identifier.
        schema:
          type: integer
          example: 1
      responses:
        '200':
          description: OK
  /api/catalog/pvt/stockkeepingunit/{skuId}/ean/{ean}:
    post:
      tags:
      - SKU EAN
      summary: VTex Create SKU EAN
      description: "Creates or updates the EAN value of an SKU.\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'
      - $ref: '#/components/parameters/Accept'
      - name: skuId
        in: path
        required: true
        description: SKU's unique numerical identifier.
        schema:
          type: integer
          example: 1
      - name: ean
        in: path
        required: true
        description: EAN.
        schema:
          type: string
          example: '1234567'
      responses:
        '200':
          description: OK
    delete:
      tags:
      - SKU EAN
      summary: VTex Delete SKU EAN
      description: "Deletes the EAN value of an SKU.\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'
      - $ref: '#/components/parameters/Accept'
      - name: skuId
        in: path
        required: true
        description: SKU's unique numerical identifier.
        schema:
          type: integer
          example: 1
      - name: ean
        in: path
        required: true
        description: EAN number.
        schema:
          type: string
          example: ABC123
      responses:
        '200':
          description: OK
components:
  schemas:
    SkuSpecification:
      required:
      - FieldId
      - FieldName
      - FieldValueIds
      - FieldValues
      type: object
      description: Object containing related SKU specifications.
      properties:
        FieldId:
          type: integer
          format: int32
          description: Specification field ID.
        FieldName:
          type: string
          description: Specification field Name.
        FieldValueIds:
          type: array
          items:
            type: integer
            format: int32
            description: Specification value ID.
          description: Array with related specification values IDs.
        FieldValues:
          type: array
          items:
            type: string
          description: Array with related specification values.
      example:
        FieldId: 102
        FieldName: Cor
        FieldValueIds:
        - 266
        FieldValues:
        - Padrão
    Image:
      required:
      - ImageUrl
      - ImageName
      - FileId
      type: object
      description: Object containing SKU images details.
      properties:
        ImageUrl:
          type: string
          description: Image URL.
        ImageName:
          type: string
          description: Image label.
          nullable: true
        FileId:
          type: integer
          format: int32
          description: SKU image ID.
      example:
        ImageUrl: http://ambienteqa.vteximg.com.br/arquivos/ids/168952/7508800GG.jpg
        ImageName: ''
        FileId: 168952
    SkuSeller:
      required:
      - SellerId
      - StockKeepingUnitId
      - SellerStockKeepingUnitId
      - IsActive
      - FreightCommissionPercentage
      - ProductCommissionPercentage
      type: object
      description: Object containing related SKU sellers data.
      properties:
        SellerId:
          type: string
          description: SKU seller ID. This is the ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.
        StockKeepingUnitId:
          type: integer
          format: int32
          description: SKU ID.
        SellerStockKeepingUnitId:
          type: string
          description: SKU ID for the SKU seller.
        IsActive:
          type: boolean
          description: Defines if the SKU is active.
        FreightCommissionPercentage:
          type: number
          description: Registered value for Seller Freight Commission.
        ProductCommissionPercentage:
          type: number
          description: Registered value for Seller product Commission.
      example:
        SellerId: '1'
        StockKeepingUnitId: 2001773
        SellerStockKeepingUnitId: '2001773'
        IsActive: true
        FreightCommissionPercentage: 0
        ProductCommissionPercentage: 0
    Field:
      required:
      - FieldName
      - MaxCaracters
      - DomainValues
      type: object
      properties:
        FieldName:
          type: string
          description: Attachment field name.
        MaxCaracters:
          type: string
          description: Maximum number of characters accepted in the attachment field.
        DomainValues:
          type: string
          nullable: true
          description: Allowed key values.
      example:
        FieldName: nome
        MaxCaracters: '20'
        DomainValues: Adalberto,Pedro,João
    Attachment:
      required:
      - Id
      - Name
      - Keys
      - Fields
      - IsActive
      - IsRequired
      type: object
      description: Object containing information about SKU attachments.
      properties:
        Id:
          type: integer
          format: int32
          description: Attachment ID.
        Name:
          type: string
          description: Attachment Name.
        Keys:
          type: array
          items:
            type: string
          description: Attachment Keys.
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/Field'
          description: Array containing Attachment fields.
        IsActive:
          type: boolean
          description: Defines if the Attachment is active or not.
        IsRequired:
          type: boolean
          description: Defines if the Attachment is required or not.
      example:
        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
    ProductSpecification:
      required:
      - FieldId
      - FieldName
      - FieldValueIds
      - FieldValues
      type: object
      properties:
        FieldId:
          type: integer
          format: int32
          description: Specification field ID.
        FieldName:
          type: string
          description: Specification name. Limited to 100 characters.
        FieldValueIds:
          type: array
          items:
            type: integer
            format: int32
            description: Specification value ID.
          description: Array with related specification values IDs.
        FieldValues:
          type: array
          items:
            type: string
          description: Array with related specification values.
      example:
        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
    AlternateIds:
      type: object
      description: Array with alternate SKU IDs, such as EAN and `RefId`.
      properties:
        Ean:
          type: string
          description: SKU EAN.
        RefId:
          type: string
          description: SKU reference ID.
      example:
        Ean: '8781'
        RefId: '878181'
    GetSKUAltID:
      required:
      - Id
      - ProductId
      - NameComplete
      - ProductName
      - ProductDescription
      - SkuName
      - IsActive
      - IsTransported
      - IsInventoried
      - IsGiftCardRecharge
      - ImageUrl
      - DetailUrl
      - CSCIdentification
      - BrandId
      - BrandName
      - Dimension
      - RealDimension
      - ManufacturerCode
      - IsKit
      - KitItems
      - Services
      - Categories
      - Attachments
      - Collections
      - SkuSellers
      - SalesChannels
      - Images
      - SkuSpecifications
      - ProductSpecifications
      - ProductClustersIds
      - ProductCategoryIds
      - ProductGlobalCategoryId
      - ProductCategories
      - CommercialConditionId
      - RewardValue
      - AlternateIds
      - AlternateIdValues
      - EstimatedDateArrival
      - MeasurementUnit
      - UnitMultiplier
      - InformationSource
      - ModalType
      type: object
      properties:
        Id:
          type: integer
          format: int32
          description: SKU ID.
        ProductId:
          type: integer
          format: int32
          description: Product ID.
        NameComplete:
          type: string
          description: Product name and SKU name combined.
        ComplementName:
          type: string
          description: Product complement name.
        ProductName:
          type: string
          description: Product name.
        ProductDescription:
          type: string
          description: Product description. HTML is allowed.
        ProductRefId:
          type: string
          description: Product reference ID.
        TaxCode:
          type: string
          description: SKU tax code.
        SkuName:
          type: string
          description: SKU name.
        IsActive:
          type: boolean
          description: Defines if the SKU is active or not.
        IsTransported:
          type: boolean
          deprecated: true
          description: Deprecated field.
        IsInventoried:
          type: boolean
          deprecated: true
          description: Deprecated field.
        IsGiftCardRecharge:
          type: boolean
          description: Defines if the purchase of the SKU will generate reward value for the customer.
        ImageUrl:
          type: string
          description: SKU image URL.
        DetailUrl:
          type: string
          description: Product slug.
        CSCIdentification:
          type: string
          nullable: true
          description: SKU seller identification.
        BrandId:
          type: string
          description: Brand ID.
        BrandName:
          type: string
          description: Brand name.
        Dimension:
          $ref: '#/components/schemas/Dimension'
        RealDimension:
          $ref: '#/components/schemas/RealDimension'
        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.
        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.
        KitItems:
          type: array
          description: Array with SKU IDs of bundle components.
          items:
            type: string
            description: SKU ID of each bundle component.
        Services:
          type: array
          description: Array with service IDs that are related to the SKU.
          items:
            type: string
            description: Service IDs of each service related to the SKU.
        Categories:
          type: array
          description: Categories of the related product.
          items:
            type: string
            description: Category ID.
        CategoriesFullPath:
          type: array
          description: Path of categories of the related product.
          items:
            type: string
            description: Path composed by category IDs separated by `/`.
        Attachments:
          type: array
          description: Array with attachment IDs that are related to the product.
          items:
            $ref: '#/components/schemas/Attachment'
        Collections:
          type: array
          description: Array with collections IDs that are related to the product.
          items:
            type: string
            description: Collection ID.
        SkuSellers:
          type: array
          description: Array with related sellers data.
          items:
            $ref: '#/components/schemas/SkuSeller'
        SalesChannels:
          type: array
          description: Array of trade policy IDs.
          items:
            type: integer
            format: int32
            description: Trade policy ID.
        Images:
          type: array
          description: Array of objects with SKU image details.
          items:
            $ref: '#/components/schemas/Image'
        SkuSpecifications:
          type: array
          description: Array with related SKU specifications.
          items:
            $ref: '#/components/schemas/SkuSpecification'
        ProductSpecifications:
          type: array
          description: Array with related product specifications.
          items:
            $ref: '#/components/schemas/ProductSpecification'
        ProductClustersIds:
          type: string
          description: Product cluster IDs separated by comma (`,`).
        PositionsInClusters:
          type: object
          description: 'Product clusters position in each cluster. Structure: "{Product cluster ID}": {Position}.


            `{Product cluster ID}` is a string, while `{Position}` is an integer.'
          additionalProperties:
            type: integer
            description: Product cluster ID.
            additionalProperties:
              type: integer
              description: Position.
        ProductClusterNames:
          type: object
          description: 'Product clusters names. Structure: "{Product cluster ID}": "{Product cluster name}". Both the key and the value are strings.'
          additionalProperties:
            type: string
            description: Product cluster ID.
            additionalProperties:
              type: string
              description: Product cluster name.
        ProductClusterHighlights:
          type: object
          description: 'Product clusters highlights. Structure: "{Product cluster ID}": "{Product cluster name}". Both the key and the value are strings.'
          additionalProperties:
            type: string
            description: Product cluster ID.
            additionalProperties:
              type: string
              description: Product cluster highlight.
        ProductCategoryIds:
          type: string
          description: Category path composed by category IDs separated by `/`.
        IsDirectCategoryActive:
          type: boolean
          description: Indicates if the direct product category is active or not.
        ProductGlobalCategoryId:
          type: integer
          nullable: true
          description: Product global category ID.
        ProductCategories:
          type: object
          description: 'Object containing product categories. Structure: "{CategoryID}": "{CategoryName}". Both the key and the value are strings.'
          additionalProperties:
            type: string
            description: Category ID.
            additionalProperties:
              type: string
              description: Category name.
        CommercialConditionId:
          type: integer
          format: int32
          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
        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.
        AlternateIds:
          $ref: '#/components/schemas/AlternateIds'
        AlternateIdValues:
          type: array
          description: Array with values of alternative SKU IDs.
          items:
            type: string
            description: Alternative SKU ID.
        EstimatedDateArrival:
          type: string
          nullable: true
          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.
        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 produ

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