VTEX SKU Service Type API

openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account SKU Service Type 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 Service Type
paths:
  /api/catalog/pvt/skuservicetype:
    post:
      tags:
      - SKU Service Type
      summary: VTex Create SKU service type
      description: "Creates a new SKU service type.\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 | Commercial | **SKU type management** |\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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SKUServiceTypeRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SKUServiceTypeResponse'
              example:
                Id: 2
                Name: Test API SKU services
                IsActive: true
                ShowOnProductFront: true
                ShowOnCartFront: true
                ShowOnAttachmentFront: true
                ShowOnFileUpload: true
                IsGiftCard: true
                IsRequired: true
  /api/catalog/pvt/skuservicetype/{skuServiceTypeId}:
    get:
      tags:
      - SKU Service Type
      summary: VTex Get SKU service type
      description: "Retrieves information about an existing SKU service type.\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 | Commercial | **SKU type management** |\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: skuServiceTypeId
        in: path
        required: true
        description: SKU service type unique identifier.
        schema:
          type: integer
          example: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SKUServiceTypeResponse'
              example:
                Id: 2
                Name: Test API SKU services
                IsActive: true
                ShowOnProductFront: true
                ShowOnCartFront: true
                ShowOnAttachmentFront: true
                ShowOnFileUpload: true
                IsGiftCard: true
                IsRequired: true
    put:
      tags:
      - SKU Service Type
      summary: VTex Update SKU service type
      description: "Updates an existing SKU service type.\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 | Commercial | **SKU type management** |\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: skuServiceTypeId
        in: path
        required: true
        description: SKU service type unique identifier.
        schema:
          type: integer
          example: 1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SKUServiceTypeRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SKUServiceTypeResponse'
              example:
                Id: 2
                Name: Test API SKU services
                IsActive: true
                ShowOnProductFront: true
                ShowOnCartFront: true
                ShowOnAttachmentFront: true
                ShowOnFileUpload: true
                IsGiftCard: true
                IsRequired: true
    delete:
      tags:
      - SKU Service Type
      summary: VTex Delete SKU service type
      description: "Deletes an existing SKU service type.\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 | Commercial | **SKU type management** |\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: skuServiceTypeId
        in: path
        required: true
        description: SKU service type unique identifier.
        schema:
          type: integer
          example: 1
      responses:
        '200':
          description: OK
components:
  schemas:
    SKUServiceTypeRequest:
      type: object
      required:
      - Name
      - IsActive
      - ShowOnProductFront
      - ShowOnCartFront
      - ShowOnAttachmentFront
      - ShowOnFileUpload
      - IsGiftCard
      - IsRequired
      properties:
        Name:
          type: string
          description: SKU service type name. Maximum of 100 characters.
          default: Test API Sku Services
        IsActive:
          type: boolean
          description: Defines if the SKU service type is active or not.
          default: true
        ShowOnProductFront:
          type: boolean
          description: Deprecated field.
          example: false
          deprecated: true
        ShowOnCartFront:
          type: boolean
          description: Defines if the SKU service type is displayed on the cart screen.
          example: false
        ShowOnAttachmentFront:
          type: boolean
          description: Defines if the SKU service type has an attachment.
          example: false
        ShowOnFileUpload:
          type: boolean
          description: Defines if the SKU service type can be associated with an attachment or not.
          example: false
        IsGiftCard:
          type: boolean
          description: Defines if the SKU service type is displayed as a Gift Card.
          example: false
        IsRequired:
          type: boolean
          description: Defines if the SKU service type is mandatory.
          example: false
    SKUServiceTypeResponse:
      type: object
      properties:
        Id:
          type: integer
          description: SKU service type ID.
          example: 2
        Name:
          type: string
          description: SKU service type name. Maximum of 100 characters.
          example: Test API Sku Services
        IsActive:
          type: boolean
          description: Defines if the SKU service type is active or not.
          example: true
        ShowOnProductFront:
          type: boolean
          description: Deprecated field.
          example: false
          deprecated: true
        ShowOnCartFront:
          type: boolean
          description: Defines if the SKU service type is displayed on the cart screen.
          example: false
        ShowOnAttachmentFront:
          type: boolean
          description: Defines if the SKU service type has an attachment.
          default: false
        ShowOnFileUpload:
          type: boolean
          description: Defines if the SKU service type can be associated with an attachment or not.
          default: false
        IsGiftCard:
          type: boolean
          description: Defines if the SKU service type is displayed as a Gift Card.
          default: false
        IsRequired:
          type: boolean
          description: Defines if the SKU service type is mandatory.
          default: false
      example:
        Id: 2
        Name: Test API SKU services
        IsActive: true
        ShowOnProductFront: true
        ShowOnCartFront: true
        ShowOnAttachmentFront: true
        ShowOnFileUpload: true
        IsGiftCard: true
        IsRequired: true
  parameters:
    Accept:
      name: Accept
      in: header
      description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
      required: true
      style: simple
      schema:
        type: string
        default: application/json
    Content-Type:
      name: Content-Type
      in: header
      description: Type of the content being sent.
      required: true
      style: simple
      schema:
        type: string
        default: application/json
  securitySchemes:
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'