Get Product

The Get Products method returns the information about a Product of the selected or the downstream Reseller by Product ID.

An API token of a Manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating manager's information.

The Manager's API token specified in an API request determines the current Reseller and downstream Resellers accessible within a method.

GET {base_url}/api/v3/customer_store/resellers/{reseller_id}/products/{product_id}

Arguments

Name	Parameter Type	Data type	Required/Optional	Description
X-Api-Token	header	string	Required	API token of a Manager that performs the operation (see Viewing and updating manager's information)
Content-Type	header	string	Required	Media type of the request. Specify the following: application/vnd.api+json
Accept	header	string	Required	Supported media types of the answer. Specify the following: application/vnd.api+json
base_url	path	string	Required	ActivePlatform URL
reseller_id	path	integer	Required	ID of the current Reseller or any of its downstream Resellers (see Viewing and updating reseller general information)
product_id	path	integer	Required	ID of the Product
plan_currency	query	bool	Optional	Defines whether the Plan currency will be used for prices in the Product (see also Managing Customer Store currency): true — prices in every Plan are displayed in the currency of this Plan. false — all prices are displayed in the Reseller currency (by default). If the Plan currency differs from the Reseller currency, the prices are recalculated with the current exchange rate (see Managing currency rates).

Response model

Name						Data type	Description
data						object	Response data
	id					integer	Product ID
	type					string	Data type
	attributes					object	Product information
		created_at				date	Date and time of the Product creation
		updated_at				date	Date and time when the Product was updated
		name				string	Product name
		type				string	Product type
		category				object	Information about the Product category
			data			object	Product category data (see Creating a product category)
				id		integer	Product category ID
				type		string	Data type
				attributes		object	Product category information
					created_at	date	Date and time of the Product category creation
					updated_at	date	Date and time when the Product category was updated
					key	string	Product category key
					name	string	Product category name
					description	string	Description of the Product category
					priority	integer	Product category priority
					logo	string	Link to the Product category logo file
		description				string	Description of the Product
		license-agreement				string	Link to the License agreement of the Product
		privacy-policy				string	Link to the Privacy policy of the Product
		public				bool	Indication whether the Product is available in Storefront: true — the Product is published and displayed in Storefront false — the Product is not published and not displayed in Storefront
		vendor				object	Information about the Vendor
					name	string	Vendor name
					logo	string	Link to the Vendor logo file
		plans				array of objects	Information about the Plans linked to the Product
			created_at			date	Date and time of the Plan creation
			updated_at			date	Date and time when the Plan was updated
			id			integer	Plan ID
			status			string	Status of the Plan (for the list of Plans statuses, see Viewing the list of plans)
			name			string	Name of the Plan
			description			string	Plan details description
			sku			string	SKU of the Plan
			public			bool	Indication whether the Plan is available for sale: true — the Plan is available for sale false — the Plan is not available for sale
			plan_class			string	Name of the Service Term (see Managing service terms)
			plan_class_id			integer	ID of the Service Term (see Managing Service Terms)
			billing_type			string	Billing type of the Plan
			singleton			bool	The Singleton option of the Plan: true — a customer can have only one Subscription to the Plan false — a customer can have several Subscriptions to the Plan
			fixed_price			bool	The Fixed price option of the Plan: true — a customer pays for the Subscription and ordering additional Resources the same price as it was set at the moment of the Subscription order. The new price will be applied only after the Subscription is renewed false — the Plan prices are not fixed for customers
			auto_renewal			bool	Indicates the status of the Auto-renew option of the Plan: true — the Auto-renew option is activated false — the Auto-renew option is not activated
			currency			object	Information about the currency used for displaying the Plan fees. Defined by the plan_currency parameter
				precision		integer	Number of decimal places for currency subunits (for example, for cents, the precision is 2).
				unit		string	Displayed name for the currency units
				separator		string	Decimal separator
				delimiter		string	Separator for groups of thousands
				format		string	Format — display order of units and amount: %n — amount %u — units
				iso_code		string	Currency code ISO 4217 alpha-3
			resources			array of objects	Resources of the Plan
				created_at		date	Date and time of the Resource creation
				updated_at		date	Date and time when the Resource was updated
				id		integer	ID of the Resource in the Plan
				name		string	Name the Resource
				key		string	Key the Resource
				unit_of_measure		string	Unit of measure of the Resource: unit — the Resource is measurable. The Resource amount is specified. boolean — the Resource is non-measurable. The Resource amount is not required and: true — the Resource is included in the Plan false — the Resource is not included in the Plan
				status		string	Status of the Resource: active inactive deleted
				included		integer	Amount of the Resource included in the Plan by default (included Resources are part of the Subscription price)
				minimum		integer	Minimum amount of the Resource (together with the included amount) available for ordering (see Plan Resources)
				limit		integer	Maximum amount of the Resource available for ordering. The limit value can be equal to 0 in the following cases: The Resource is unlimited (unlimited_units=true) The Resource is not unlimited (unlimited_units=false) but the minimum and limit amounts of the Resource equals to 0 (minimum=0 and limit=0)
				public		bool	Availability of the Resource: true — the Resource is available for ordering false — the Resource is not available for ordering
				unlimited		bool	Attribute of the unlimited Resource: true — the Resource is unlimited false — the Resource is not unlimited
				fees		object	Information about fees of the Resource
					setup	float	Setup fee of the Resource
					overuse	float	Overuse fee of the Resource
					recurring	float	Monthly recurring fee of the Resource
					renewal	float	Renewal fee of the Resource
			periods			array of objects	Plan Periods
				created_at		date	Date and time of the Plan Period creation
				updated_at		date	Date and time when the Plan Period was updated
				id		integer	ID of the Plan Period
				endless		bool	Indicator of the endless Plan Period: true — the Plan Period is endless (perpetual) false — the Plan Period is not endless. For the Plan Period duration, see duration
				trial		bool	Plan Period type: true — trial Plan Period false — commercial Plan Period
				public		bool	Availability of the Plan Period: true — the Plan Period is available for ordering false — the Plan Period is not available for ordering
				status		string	Status of the Plan Period: active deleted
				description		string	Plan Period details description
				durations		object	Plan Period duration
					value	integer	Duration of the Plan Period. For an endless Plan Period, `value = null`
					type	string	Unit of measure of the Plan Period duration. For an endless Plan Period, `type = null`
				fees		object	Information about fees of the Plan Period
					setup	float	Setup fee of the Plan for the Plan Period
					recurring	float	Monthly recurring fee of the Plan for the Plan Period
					transfer	float	Transfer fee of a domain for the Plan Period. The transfer fee is applied if domains are available as a Resource in the Service
					renewal	float	Renewal fee of the Plan for the Plan Period
		support				object	Information about technical support of the Product
			phone			string	Phone number of technical support
			email			string	Email of technical support
			url			string	Link to the Service Desk of the Product
			details			string	Detailed information about technical support
		market				object	Marketing information about the Product for Storefront (see the Marketing tab in Creating a product)
			created_at			date	Date and time of the Marketing information creation
			updated_at			date	Date and time when the Marketing information was updated
			name			string	Product name
			description			string	Product description
			screenshots			array of objects	Information about screenshots of the Product
				title		string	Screenshot title
				url		string	Link to the screenshot
			video_url			array of objects	Information about videos of the Product
				title		string	Video title
				url		string	Link to the video
			documentation_url			array of objects	Information about documentation of the Product
				title		string	Document title
				url		string	Link to the document
			benefits			array of objects	Information about benefits of the Product
				title		string	Benefit title
				description		string	Benefit description
			image			string	Link to the Product logo file
meta						object	Additional response data
	currency					string	Reseller currency code ISO 4217 alpha-3

Request example

GET /api/v3/customer_store/resellers/1/products/878
Host: https://test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Response example

{
    "data": {
        "id": "878",
        "type": "products",
        "attributes": {
            "created_at": "2020-06-17T13:59:15.810+03:00",
            "updated_at": "2020-09-23T15:07:01.846+03:00",
            "name": "G Suite for migration",
            "type": "saas",
            "category": {
                "data": {
                    "id": "190",
                    "type": "product_categories",
                    "attributes": {
                        "created_at": "2017-09-14T16:27:16.566+03:00",
                        "updated_at": "2020-03-11T10:46:45.422+03:00",
                        "key": "default",
                        "name": "default",
                        "description": "",
                        "priority": 0,
                        "logo": null
                    }
                }
            },
            "description": "",
            "license_agreement": null,
            "privacy_policy": null,
            "public": false,
            "vendor": {
                "name": "G Suite magration",
                "logo": "https://test.activeplatform.com/images/product/vendor_logo/878/plesk%20logo.jpg"
            },
            "plans": [
                {
                    "created_at": "2020-06-17T13:59:16.418+03:00",
                    "updated_at": "2020-06-17T13:59:16.880+03:00",
                    "id": 1864,
                    "status": "active",
                    "name": "G Suite Basic гибкий план",
                    "description": "G Suite Basic – это пакет приложений для совместной работы, который включает корпоративную почту, общие календари, сервисы для редактирования и хранения документов в Интернете, инструменты для видеоконференций и многое другое.",
                    "sku": null,
                    "public": false,
                    "plan_class": "gsuitemigration",
                    "plan_class_id": 13078,
                    "billing_type": "csp_monthly",
                    "singleton": false,
                    "fixed_price": false,
                    "auto_renewal": false,
                    "currency": {
                        "precision": 2,
                        "unit": "руб.",
                        "separator": ".",
                        "delimiter": " ",
                        "format": "%n %u",
                        "iso_code": "RUB"
                    },
                    "resources": [
                        {
                            "created_at": "2020-06-17T13:59:16.820+03:00",
                            "updated_at": "2020-06-17T13:59:16.820+03:00",
                            "id": 4763,
                            "name": "Пользователь",
                            "key": null,
                            "unit_of_measure": "unit",
                            "status": "active",
                            "included": 0,
                            "minimum": 1,
                            "limit": 750,
                            "public": true,
                            "unlimited": false,
                            "fees": {
                                "setup": "0.0",
                                "overuse": "0.0",
                                "recurring": "6.2",
                                "renewal": "0.0"
                            }
                        },
                        {
                            "created_at": "2020-06-17T13:59:16.472+03:00",
                            "updated_at": "2020-06-17T13:59:16.472+03:00",
                            "id": 4754,
                            "name": "Предоставление доступа к сервисам Google Drive storage Upgrade 8TB на 1 учетную запись, на 1 месяц",
                            "key": null,
                            "unit_of_measure": "unit",
                            "status": "active",
                            "included": 0,
                            "minimum": 0,
                            "limit": 750,
                            "public": true,
                            "unlimited": false,
                            "fees": {
                                "setup": "0.0",
                                "overuse": "0.0",
                                "recurring": "9.6",
                                "renewal": "0.0"
                            }
                        },
                        {
                            "created_at": "2020-06-17T13:59:16.800+03:00",
                            "updated_at": "2020-06-17T13:59:16.800+03:00",
                            "id": 4762,
                            "name": "Предоставление доступа к сервисам Google Vault на 1 учетную запись, на 1 месяц",
                            "key": null,
                            "unit_of_measure": "unit",
                            "status": "active",
                            "included": 0,
                            "minimum": 0,
                            "limit": 750,
                            "public": true,
                            "unlimited": false,
                            "fees": {
                                "setup": "0.0",
                                "overuse": "0.0",
                                "recurring": "6.2",
                                "renewal": "0.0"
                            }
                        }
                    ],
                    "periods": [
                        {
                            "created_at": "2020-06-17T13:59:16.857+03:00",
                            "updated_at": "2020-06-17T13:59:16.857+03:00",
                            "id": 3280,
                            "endless": false,
                            "trial": false,
                            "public": true,
                            "status": "active",
                            "description": null,
                            "durations": {
                                "value": 1,
                                "type": "month"
                            },
                            "fees": {
                                "setup": "0.0",
                                "recurring": "0.0",
                                "transfer": "0.0",
                                "renewal": "0.0"
                            }
                        },
                        {
                            "created_at": "2020-06-17T13:59:16.838+03:00",
                            "updated_at": "2020-06-17T13:59:16.838+03:00",
                            "id": 3279,
                            "endless": true,
                            "trial": false,
                            "public": true,
                            "status": "active",
                            "description": null,
                            "durations": {
                                "value": null,
                                "type": null
                            },
                            "fees": {
                                "setup": "0.0",
                                "recurring": "0.0",
                                "transfer": "0.0",
                                "renewal": "0.0"
                            }
                        }
                    ]
                },
                {
                    "created_at": "2020-06-17T13:59:16.031+03:00",
                    "updated_at": "2020-06-17T13:59:16.409+03:00",
                    "id": 1863,
                    "status": "active",
                    "name": "G Suite Basic годовой план с помесячной оплатой",
                    "description": "G Suite Basic – это пакет приложений для совместной работы, который включает корпоративную почту, общие календари, сервисы для редактирования и хранения документов в Интернете, инструменты для видеоконференций и многое другое.",
                    "sku": null,
                    "public": false,
                    "plan_class": "gsuitemigration",
                    "plan_class_id": 13078,
                    "billing_type": "csp_monthly",
                    "singleton": false,
                    "fixed_price": false,
                    "auto_renewal": false,
                    "currency": {
                        "precision": 2,
                        "unit": "руб.",
                        "separator": ".",
                        "delimiter": " ",
                        "format": "%n %u",
                        "iso_code": "RUB"
                    },
                    "resources": [
                        {
                            "created_at": "2020-06-17T13:59:16.108+03:00",
                            "updated_at": "2020-06-17T13:59:16.108+03:00",
                            "id": 4742,
                            "name": "Пользователь",
                            "key": null,
                            "unit_of_measure": "unit",
                            "status": "active",
                            "included": 0,
                            "minimum": 1,
                            "limit": 750,
                            "public": true,
                            "unlimited": false,
                            "fees": {
                                "setup": "0.0",
                                "overuse": "0.0",
                                "recurring": "2.65",
                                "renewal": "0.0"
                            }
                        },
                        {
                            "created_at": "2020-06-17T13:59:16.154+03:00",
                            "updated_at": "2020-06-17T13:59:16.154+03:00",
                            "id": 4744,
                            "name": "Предоставление доступа к сервисам Google Drive storage Upgrade 8TB на 1 учетную запись, на 1 месяц",
                            "key": null,
                            "unit_of_measure": "unit",
                            "status": "active",
                            "included": 0,
                            "minimum": 0,
                            "limit": 750,
                            "public": true,
                            "unlimited": false,
                            "fees": {
                                "setup": "0.0",
                                "overuse": "0.0",
                                "recurring": "9.6",
                                "renewal": "0.0"
                            }
                        },
                        {
                            "created_at": "2020-06-17T13:59:16.326+03:00",
                            "updated_at": "2020-06-17T13:59:16.326+03:00",
                            "id": 4752,
                            "name": "Предоставление доступа к сервисам Google Vault на 1 учетную запись, на 1 месяц",
                            "key": null,
                            "unit_of_measure": "unit",
                            "status": "active",
                            "included": 0,
                            "minimum": 0,
                            "limit": 750,
                            "public": true,
                            "unlimited": false,
                            "fees": {
                                "setup": "0.0",
                                "overuse": "0.0",
                                "recurring": "6.2",
                                "renewal": "0.0"
                            }
                        }
                    ],
                    "periods": [
                        {
                            "created_at": "2020-06-17T13:59:16.360+03:00",
                            "updated_at": "2020-06-17T13:59:16.360+03:00",
                            "id": 3278,
                            "endless": false,
                            "trial": false,
                            "public": true,
                            "status": "active",
                            "description": null,
                            "durations": {
                                "value": 1,
                                "type": "year"
                            },
                            "fees": {
                                "setup": "0.0",
                                "recurring": "0.0",
                                "transfer": "0.0",
                                "renewal": "0.0"
                            }
                        }
                    ]
                }
            ],
            "support": {
                "phone": "",
                "email": "",
                "url": "",
                "details": ""
            },
            "market": {
                "created_at": "2020-06-17T13:59:16.939+03:00",
                "updated_at": "2021-04-08T10:43:58.165+03:00",
                "name": "G Suite migration",
                "description": "Пакет облачных служб и приложений для совместной работы по подписке. В пакет входят популярные веб-приложения Google в том числе Gmail, Google Диск, Google Hangouts, Google Календарь и Google Документы.  Помимо этого, они предоставляют дополнительные возможности для корпоративных клиентов, такие как адреса Электронной почты в домене компании, 30 ГБ и более для хранения писем и документов, а также круглосуточная поддержка по телефону и электронной почте. Поскольку Google Suite является облачным решением, то все пользовательские данные хранятся в защищенных дата-центрах Google, а не на локальных серверах клиента, как при использовании стандартного специализированного ПО.",
                "screenshots": [],
                "video_url": [],
                "documentation_url": [
                    {
                        "title": "",
                        "url": "https://docs.activeplatform.com/"
                    }
                ],
                "benefits": [],
                "image": null
            }
        }
    },
    "meta": {
        "currency": "RUB"
    }
}