VTEX Commercial Conditions API

openapi: 3.2.0
info:
  title: VTex Catalog Commercial Conditions API
  description: '> Check the new Catalog onboarding guide.'
  version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL.
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey: []
  appToken: []
- VtexIdclientAutCookie: []
tags:
- name: Commercial Conditions
paths:
  /api/catalog_system/pvt/commercialcondition/list:
    get:
      tags:
      - Commercial Conditions
      summary: VTex Get all commercial conditions
      description: 'Lists all commercial conditions on the store.

        ## Response body example


        ```json

        [

        {

        "Id": 1,

        "Name": "Padrão",

        "IsDefault": true

        },

        {

        "Id": 2,

        "Name": "Teste Fast",

        "IsDefault": false

        }

        ]

        ```'
      operationId: GetAllCommercialConditions
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                example:
                - Id: 1
                  Name: Padrão
                  IsDefault: true
                - Id: 2
                  Name: Secundária
                  IsDefault: false
                - Id: 3
                  Name: Parcelamento 18x
                  IsDefault: false
                items:
                  type: object
                  description: Object with information of the commercial condition.
                  example:
                    Id: 1
                    Name: Padrão
                    IsDefault: true
                  properties:
                    Id:
                      type: integer
                      description: Commercial condition ID.
                      example: 1
                    Name:
                      type: string
                      description: Commercial condition name.
                      example: Padrão
                    IsDefault:
                      type: boolean
                      description: Defines if the commercial condition is default (`true`) or not (`false`).
                      example: true
  /api/catalog_system/pvt/commercialcondition/{commercialConditionId}:
    get:
      tags:
      - Commercial Conditions
      summary: VTex Get commercial condition
      description: 'Retrieves information of a commercial condition by its ID.

        ## Response body example


        ```json

        {

        "Id": 1,

        "Name": "Padrão",

        "IsDefault": true

        }

        ```'
      operationId: GetCommercialConditions
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: commercialConditionId
        in: path
        required: true
        description: Commercial condition unique numerical identifier.
        schema:
          type: integer
          example: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: Object with information of the commercial condition.
                example:
                  Id: 1
                  Name: Padrão
                  IsDefault: true
                properties:
                  Id:
                    type: integer
                    description: Commercial condition ID.
                    example: 1
                  Name:
                    type: string
                    description: Commercial condition name.
                    example: Padrão
                  IsDefault:
                    type: boolean
                    description: If the commercial condition is default (`true`) or not (`false`).
                    example: true
components:
  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:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
      description: Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken
      description: Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    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.'