action vtex_get_productbyid {
  label: "Get Product by ID"
  description: "Retrieves a specific Product by its ID. This information is exactly what is needed to create a new Product. 
\n> 📘 Onboarding guide 
\n>
\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."
  provider: vtex
  method: GET
  path: "/api/catalog/pvt/product/{productId}"
  encoding: json
  input: {
    type: "object"
    properties: {
      Accept: {
        type: "string"
      }
      "Content-Type": {
        type: "string"
      }
      productId: {
        type: "string"
      }
    }
    required: ["Accept", "Content-Type", "productId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      AdWordsRemarketingCode: {
        type: "string"
        description: "This is a legacy field. Do not take this information into consideration."
      }
      BrandId: {
        type: "integer"
        description: "Brand ID associated with this product."
      }
      CategoryId: {
        type: "integer"
        description: "Category ID associated with this product."
      }
      DepartmentId: {
        type: "integer"
        description: "Department ID according to the product's category."
      }
      Description: {
        type: "string"
        description: "Product description."
      }
      DescriptionShort: {
        type: "string"
        description: "Short product description. This information can be displayed on both the product page and the shelf, using the following controls:
\n Store Framework:  `$product.DescriptionShort`.
\n Legacy CMS Portal: `<vtex.cmc:productDescriptionShort/>`.
\n"
      }
      Id: {
        type: "integer"
        description: "Product’s unique numerical identifier."
      }
      IsActive: {
        type: "boolean"
        description: "Activate (`true`) or inactivate (`false`) product."
      }
      IsVisible: {
        type: "boolean"
        description: "Shows (`true`) or hides (`false`) the product in search result and product pages, but the product can still be added to the shopping cart. Usually applicable for gifts."
      }
      KeyWords: {
        type: "string"
        description: "Store Framework: Deprecated. 
\nLegacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). \"Television\", for example, can have a substitute word like \"TV\". This field is important to make your searches more comprehensive.
\n"
      }
      LinkId: {
        type: "string"
        description: "Slug that will be used to build the product page URL. If it not informed, it will be generated according to the product's name replacing spaces and special characters by hyphens (`-`)."
      }
      LomadeeCampaignCode: {
        type: "string"
        description: "This is a legacy field. Do not take this information into consideration."
      }
      MetaTagDescription: {
        type: "string"
        description: "Brief description of the product for SEO. It is recommended not to exceed 150 characters."
      }
      Name: {
        type: "string"
        description: "Product's name. Limited to 150 characters."
      }
      RefId: {
        type: "string"
        description: "Product Reference Code."
      }
      ReleaseDate: {
        type: "string"
        description: "Used to assist in the ordering of the search result of the site. Using the `O=OrderByReleaseDateDESC` query string, you can pull this value and show the display order by release date. This attribute is also used as a condition for dynamic collections."
      }
      Score: {
        type: "integer"
        description: "Value used to set the priority on the search result page."
      }
      ShowWithoutStock: {
        type: "boolean"
        description: "If `true`, activates the [Notify Me](https://help.vtex.com/en/tutorial/setting-up-the-notify-me-option--2VqVifQuf6Co2KG048Yu6e) option when the product is out of stock."
      }
      SupplierId: {
        type: "integer"
      }
      TaxCode: {
        type: "string"
        description: "Product tax code, used for tax calculation."
      }
      Title: {
        type: "string"
        description: "Product's Title tag. Limited to 150 characters. It is presented in the browser tab and corresponds to the title of the product page. This field is important for SEO."
      }
    }
  }
}