{"method":"GET","path":"https://api.revcent.com/v2/products","summary":"Get Products","description":"Returns a list of products previously created. The date_start, date_end, page and limit URL parameters are required. The difference between date_start and date_end cannot exceed a 90 day period.","operationId":"GetProducts","parameters":[{"description":"The date range start date as a unix timestamp in seconds.","in":"query","name":"date_start","required":true,"schema":{"type":"integer","format":"unix-time"},"style":"form"},{"description":"The date range end date as a unix timestamp in seconds.","in":"query","name":"date_end","required":true,"schema":{"type":"integer","format":"unix-time"},"style":"form"},{"description":"A limit on the number of objects to be returned. Limit can range between 1 and 25, and the default is 25.","in":"query","name":"limit","required":true,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25},"style":"form"},{"description":"Used for pagination, i.e. to skip to specific page of results.","in":"query","name":"page","required":true,"schema":{"type":"integer","format":"int32"},"style":"form"},{"name":"product_type_filter","in":"query","description":"To filter items based on product type.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["basic","subscription","subscription_only","trial","trial_only"]}},"style":"form","explode":true},{"name":"product_group_filter","in":"query","description":"To filter items based on one or more associated product groups.","required":false,"schema":{"type":"array","items":{"type":"string","description":"A 20 character product group ID.","minLength":20,"maxLength":20}},"style":"form","explode":true},{"name":"shop_filter","in":"query","description":"To filter items based on one or more associated shops.","required":false,"schema":{"type":"array","items":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20}},"style":"form","explode":true},{"name":"fulfillment_account_filter","in":"query","description":"To filter items based on one or more associated fulfillment accounts.","required":false,"schema":{"type":"array","items":{"type":"string","description":"A 20 character fulfillment account ID.","minLength":20,"maxLength":20}},"style":"form","explode":true},{"name":"subscription_profile_filter","in":"query","description":"To filter items based on one or more associated subscription profiles.","required":false,"schema":{"type":"array","items":{"type":"string","description":"A 20 character subscription profile ID.","minLength":20,"maxLength":20}},"style":"form","explode":true},{"name":"project_filter","in":"query","description":"To filter items based on one or more associated projects.","required":false,"schema":{"type":"array","items":{"type":"string","description":"A 20 character project ID.","minLength":20,"maxLength":20}},"style":"form","explode":true},{"description":"To filter items based on one or more metadata name/value pair objects.","explode":true,"in":"query","name":"metadata_filter","required":false,"schema":{"items":{"additionalProperties":false,"required":["name","value"],"properties":{"name":{"type":"string","description":"The metadata name which must be present in an items metadata along with a matching value."},"value":{"type":"string","description":"The metadata value associated with the metadata name. To filter ignoring the metadata value and just filter based on the presence of the metadata name, you can set the value to 'METADATA_NAME_EXISTS' and it will filter for items that have the metadata name regardless of the value."}},"type":"object"},"type":"array"},"style":"deepObject"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1]},"current_count":{"description":"The current number of items in the results.","type":"integer"},"current_page":{"description":"The current page for the items in the results.","type":"integer"},"results":{"items":{"type":"object","additionalProperties":false,"properties":{"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time"},"additional_id":{"description":"An array of additional IDs for the product.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"description":"The name of the additional ID.","type":"string"},"value":{"description":"The value of the additional ID.","type":"string"}}}},"bundle_settings":{"description":"The specific bundle settings, if this is a bundle product.","type":"object","additionalProperties":false,"properties":{"products":{"description":"An array of products included in the bundle.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"title":"Product ID","type":"string","description":"A 20 character product ID.","minLength":20,"maxLength":20},"name":{"description":"The product name.","type":"string"},"quantity":{"description":"The quantity for the specific product within the bundle.","type":"integer"},"price":{"description":"The price for the specific product within the bundle.","type":"number","format":"float"}}}},"unbundle_method":{"description":"How the bundle product will be unbundled. Either on sale or at fulfillment.","type":"string","enum":["unbundle_at_fulfillment","unbundle_at_sale"]}}},"cost":{"description":"Your product cost. Used for calculating profits.","type":"number"},"description":{"description":"The product short description.","type":"string"},"description_html":{"description":"The product long description, in HTML format.","type":"string"},"enabled":{"description":"Whether the product is currently enabled.","type":"boolean"},"id":{"title":"Product ID","type":"string","description":"A 20 character product ID.","minLength":20,"maxLength":20},"images":{"type":"array","description":"Images for the product.","items":{"additionalProperties":false,"properties":{"featured":{"type":"boolean","description":"Whether the product image is the featured image to display."},"file_name":{"type":"string","description":"The image file name, combine with file_ext."},"file_ext":{"type":"string","description":"The image file extenstion, combine with file_name."},"image_width":{"description":"The image width in pixels.","type":"integer"},"image_height":{"description":"The image height in pixels.","type":"integer"},"mimetype":{"type":"string","description":"The image file mimetype."},"base_url":{"type":"string","description":"The root URL where the image is hosted. Combine with file_name and file_ext for a complete URL."},"full_url":{"type":"string","description":"The full URL for embedding or downloading the image."}}}},"images_url":{"description":"The base URL in which the image is hosted.","type":"string"},"internal_id":{"description":"The internal ID for the product.","type":"string"},"is_bundle_product":{"description":"Indicates whether the product is a bundle of other products.","type":"boolean"},"is_shippable":{"description":"Indicates whether the product is shippable.","type":"boolean"},"name":{"description":"The product name.","type":"string"},"price":{"description":"The product sale price.","type":"number","format":"float"},"price_subscription":{"description":"The products subscription renewal price.","type":"number","format":"float"},"price_trial":{"description":"The products' trial expiration price.","type":"number","format":"float"},"product_group":{"description":"An array of product group IDs the product is within.","type":"array","items":{"type":"string","description":"A 20 character product group ID.","minLength":20,"maxLength":20}},"shipping_attributes":{"type":"object","additionalProperties":false,"description":"Contains shipping details for the product.","properties":{"weight":{"description":"The product weight in pounds.","type":"string"},"length":{"description":"The product length in inches.","type":"string"},"width":{"description":"The product width in inches.","type":"string"},"height":{"description":"The product height in inches.","type":"string"},"fulfillment_account":{"description":"The fulfillment account associated with the product.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"A 20 character fulfillment account ID.","minLength":20,"maxLength":20},"name":{"description":"The fulfillment account name.","type":"string"}}}}},"sku":{"description":"The product.","type":"string"},"subscription_profile":{"description":"The subscription profile related to the item.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"A 20 character subscription profile ID.","minLength":20,"maxLength":20},"name":{"description":"Subscription profile name","type":"string"},"description":{"description":"Subscription profile description.","type":"string"},"occurrences":{"description":"Whether there are a max number of renewals allowed.","type":"string","enum":["indefinite","specific"]},"occurrences_value":{"description":"If occurrences is specific, the max number of renewals until a subscription is ended.","type":"integer"},"subscription_specific":{"description":"Whether the subscription profile was made for a specific subscription. I.e. tailored to the customers' needs.","type":"boolean"},"subscription_id":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20},"frequency_unit":{"description":"The unit frequency for the subscription profile.","type":"object","additionalProperties":false,"properties":{"unit_value":{"description":"The frequency value.","type":"integer"},"unit":{"description":"The frequency unit.","type":"string"}}},"frequency":{"description":"The type of frequency in which the subscription renews.","type":"string","enum":["unit","calendar","fiscal"]}}},"trial_days":{"description":"The total number of days a trial will last if the product is purchased.","type":"integer"},"trial_shipping_setting":{"description":"If the product is a trial, the shipping settings.","type":"string","enum":["trial_expiration","trial_creation","both_trial_expiration_creation"]},"url":{"description":"The product purchase URL.","type":"string"},"google_product_category":{"type":"string","description":"The Google product category ID for the product."},"msrp":{"type":"number","description":"The MSRP of the product. Optional, meant for display purposes."},"is_price_sale":{"type":"boolean","description":"Whether the product is currently on sale. Optional, meant for display purposes."},"price_sale":{"type":"number","description":"The sale price of the product, if is_price_sale is true. Optional, meant for display purposes. Does not affect the actual price used for transactions, which is determined by the price field."},"is_discount":{"type":"boolean","description":"Whether the product is currently discounted. Optional, meant for display purposes."},"discount_rate":{"type":"number","description":"The discount rate of the product, if is_discount is true. Optional, meant for display purposes."},"in_stock":{"type":"boolean","description":"Whether the product is currently in stock. Optional, meant for display purposes."},"stock":{"type":"integer","description":"The current stock quantity of the product. Optional, meant for display purposes."},"brand":{"type":"string","description":"The product brand. Optional, meant for display purposes."},"material":{"type":"string","description":"The product material. Optional, meant for display purposes."},"age_group":{"type":"string","description":"The product age group. Optional, meant for display purposes.","enum":["adult","kids","toddler","infant","newborn"]},"condition":{"type":"string","description":"The product condition. Optional, meant for display purposes.","enum":["new","used","refurbished"]},"rating_value":{"type":"number","format":"float","description":"The product rating value. Optional, meant for display purposes. If provided, should be a value between 0 and 5."},"rating_count":{"type":"integer","description":"The product rating count. Optional, meant for display purposes."},"upc":{"type":"string","description":"The product UPC. Recommended if wishing to list via agentic commerce."},"isbn":{"type":"string","description":"The product ISBN."},"asin":{"type":"string","description":"The product ASIN."},"mpn":{"type":"string","description":"The product MPN."},"ean":{"type":"string","description":"The product EAN."},"project":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"A 20 character project ID.","minLength":20,"maxLength":20},"name":{"description":"The project name.","type":"string"}}},"description":"One or more projects associated with the product, if applicable."},"third_party_shop":{"description":"The originating user third party shop, if applicable.","additionalProperties":false,"properties":{"id":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20},"name":{"description":"The user shop name.","type":"string"},"third_party":{"description":"The site third party shop associated with the user shop, if applicable.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The third party ID.","minLength":20,"maxLength":20},"name":{"description":"The third party name.","type":"string"}}}}},"metadata":{"items":{"additionalProperties":false,"properties":{"name":{"type":"string","description":"A name paired to the value for the metadata object. Limited to 100 characters in length.","minLength":1,"maxLength":100},"value":{"type":"string","description":"A value paired to the name for the metadata object. Limited to 255 characters in length.","minLength":1,"maxLength":255}},"type":"object","required":["name","value"]},"type":"array","description":"An array of metadata objects, each metadata object being a name and value pair."},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time"}}},"type":"array"},"total_count":{"description":"The total number of items found given the date_start and date_end query parameters.","type":"integer"},"total_pages":{"description":"The total number of pages given the date_start, date_end and limit query parameters.","type":"integer"}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","enum":[0]},"error_code":{"description":"The specific error code.","type":"string"},"message":{"description":"A human readable description of the error.","type":"string"},"result":{"description":"A description of the API call result.","type":"string"}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}