action vtex_productby_ref_id { label: "Get Product by RefId" description: "Retrieves a specific product by its Reference ID." provider: vtex method: GET path: "/api/catalog_system/pvt/products/productgetbyrefid/{refId}" encoding: json input: { type: "object" properties: { Accept: { type: "string" } "Content-Type": { type: "string" } refId: { type: "string" } } required: ["Accept", "Content-Type", "refId"] 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: "ID of the product Brand." } CategoryId: { type: "integer" description: "ID of product Category." } DepartmentId: { type: "integer" description: "ID of product department." } Description: { type: "string" description: "Product Description, HTML is allowed." } DescriptionShort: { type: "string" description: "Product Short Description." } Id: { type: "integer" description: "ID of the Product." } IsActive: { type: "boolean" description: "If the product is Active." } IsVisible: { type: "boolean" description: "If the product are visible in search and list pages." } KeyWords: { type: "string" description: "Alternatives Keywords to improve the product findability." } LinkId: { type: "string" description: "Category URL." } ListStoreId: { type: "array" description: "Array with the ID of all the trade policies that are related to the product." items: { type: "integer" description: "Trade policy ID." } } LomadeeCampaignCode: { type: "string" description: "This is a legacy field. Do not take this information into consideration." } MetaTagDescription: { type: "string" description: "Meta Description for the Product page." } Name: { type: "string" description: "Name of the Product." } RefId: { type: "string" description: "Product Reference ID." } ReleaseDate: { type: "string" description: "Product Release Date, for list ordering and product cluster highlight." } ShowWithoutStock: { type: "boolean" description: "If the product can be visible without stock." } SupplierId: { type: "integer" description: "Product Supplier ID." } TaxCode: { type: "string" description: "SKU Tax Code." } 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." } } } }