Retrieve

View as Markdown
Returns information for a single product by its unique identifier.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

product_idstringRequired
Merchant product ID

Query parameters

include_product_selection_rulesbooleanOptionalDefaults to false

For rotating products this param returns a product_selection_rules list with all selection_list_elements

include_product_free_trialsbooleanOptionalDefaults to false

When set to true, a product_free_trial_configurations list is included with the product’s free trial configurations

Response

200
merchantstringOptional
groupslist of objectsOptional
namestringOptional
pricestringOptional
image_urlstringOptional
detail_urlstringOptional
external_product_idstringOptional
skustringOptional
autoship_enabledbooleanOptionalDefaults to true
premier_enabledintegerOptionalDefaults to 0
createdstringOptional
last_updatestringOptional
livebooleanOptionalDefaults to true
discontinuedbooleanOptionalDefaults to true
offer_profilestring or nullOptional
extra_dataanyOptional
incentive_groupanyOptional
product_typestringOptional
autoship_by_defaultbooleanOptionalDefaults to true
everyintegerOptionalDefaults to 0
every_periodintegerOptionalDefaults to 0
product_free_trial_configurationslist of objectsOptional

Only included when include_product_free_trials=true is passed. Free trial configurations for the product; empty if none exist.

Errors

403
Forbidden Error
404
Not Found Error