find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/vtex-trade-policy-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: VTex Catalog Trade Policy 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: Trade Policy
paths:
  /api/catalog/pvt/product/{productId}/salespolicy:
    get:
      tags:
      - Trade Policy
      summary: VTex Get Trade Policies by product ID
      description: 'Retrieves a list of Trade Policies associated to a product based on the product''s ID.

        ## Response body example


        ```json

        [

        {

        "ProductId": 1,

        "StoreId": 1

        },

        {

        "ProductId": 1,

        "StoreId": 2

        },

        {

        "ProductId": 1,

        "StoreId": 3

        },

        {

        "ProductId": 1,

        "StoreId": 4

        }

        ]

        ```'
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: productId
        in: path
        required: true
        description: Product's unique numerical identifier.
        schema:
          type: integer
          example: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  description: Object containing the product ID and the trade policy ID.
                  properties:
                    ProductId:
                      type: integer
                      description: Product's unique numerical identifier.
                      example: 1
                    StoreId:
                      type: integer
                      description: Trade policy's unique numerical identifier.
                      example: 1
      operationId: getApiCatalogPvtProductByProductIdSalespolicy
      x-operation-id-source: derived
  /api/catalog/pvt/product/{productId}/salespolicy/{tradepolicyId}:
    post:
      tags:
      - Trade Policy
      summary: VTex Associate product with trade policy
      description: Associates an existing trade policy with a product.
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: productId
        in: path
        required: true
        description: Product's unique numerical identifier.
        schema:
          type: integer
          example: 1
      - name: tradepolicyId
        in: path
        required: true
        description: Trade policy's unique numerical identifier.
        schema:
          type: integer
          example: 1
      responses:
        '200':
          description: OK
      operationId: postApiCatalogPvtProductByProductIdSalespolicyByTradepolicyId
      x-operation-id-source: derived
    delete:
      tags:
      - Trade Policy
      summary: VTex Remove product from trade policy
      description: Disassociates a trade policy of a product.
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: productId
        in: path
        required: true
        description: Product's unique numerical identifier.
        schema:
          type: integer
          example: 1
      - name: tradepolicyId
        in: path
        required: true
        description: Trade policy's unique numerical identifier.
        schema:
          type: integer
          example: 1
      responses:
        '200':
          description: OK
      operationId: deleteApiCatalogPvtProductByProductIdSalespolicyByTradepolicyId
      x-operation-id-source: derived
  /api/catalog_system/pvt/sku/stockkeepingunitidsbysaleschannel:
    get:
      tags:
      - Trade Policy
      summary: VTex List all SKUs of a trade policy
      description: Retrieves a list of SKU IDs of a trade policy.
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: sc
        in: query
        required: true
        description: Trade policy's unique numerical identifier.
        style: form
        schema:
          type: integer
          example: 1
      - name: page
        in: query
        required: false
        description: Page number.
        schema:
          type: integer
          example: 1
      - name: pageSize
        in: query
        required: false
        description: Number of items in the page.
        schema:
          type: integer
          example: 1
      - name: onlyAssigned
        in: query
        required: false
        description: If set as `false`, it allows the user to decide if the SKUs that are not assigned to a specific trade policy should be also returned.
        schema:
          type: boolean
          example: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
              - 405380
              - 405381
              - 405382
              - 405383
              - 405384
              - 405385
              - 405386
              - 405387
              - 405388
              - 405389
              - 405390
              - 405391
              - 405392
              - 405393
              - 405394
              - 405395
              - 405396
              - 405397
              - 405398
              - 405399
              - 405400
              - 405556
              schema:
                type: array
                description: List of SKU IDs of the trade policy.
                items:
                  type: integer
                  example: 1
      operationId: getApiCatalogSystemPvtSkuStockkeepingunitidsbysaleschannel
      x-operation-id-source: derived
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.'