# Products

## GET /products/product-images/

> This method retrieves image data for products, including image links and associated metadata such as the image dimensions, status, and the product to which the image belongs.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedProductImageList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/ProductImage"},"type":"array"}},"type":"object"},"ProductImage":{"properties":{"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"height":{"description":"The field defines the height of the image in pixels.","maximum":2147483647,"minimum":0,"nullable":true,"type":"integer"},"id":{"description":"Unique identifier for the record.","type":"integer"},"image":{"description":"This field defines the URL or path to the product's image.","format":"uri","type":"string"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"order":{"description":"The field defines the order of the category node.","maximum":32767,"minimum":0,"type":"integer"},"product":{"description":"The field defines the product ID associated with the product price.","type":"integer"},"status":{"$ref":"#/components/schemas/ProductImageStatusEnum","description":"Current status of the record (e.g., active, inactive)."},"width":{"description":"The field defines the width of the image in pixels.","maximum":2147483647,"minimum":0,"nullable":true,"type":"integer"}},"type":"object"},"ProductImageStatusEnum":{"description":"* `active` - Active\n* `disabled` - Disabled","enum":["active","disabled"],"type":"string"}}},"paths":{"/products/product-images/":{"get":{"description":"This method retrieves image data for products, including image links and associated metadata such as the image dimensions, status, and the product to which the image belongs.","operationId":"products_product_images_list","parameters":[{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `height` used to filter results based on specific conditions.","in":"query","name":"height","schema":{"type":"integer"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Query parameter `image` used to filter results based on specific conditions.","in":"query","name":"image","schema":{"type":"string"}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `order` used to filter results based on specific conditions.","in":"query","name":"order","schema":{"type":"integer"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `product` used to filter results based on specific conditions.","in":"query","name":"product","schema":{"type":"integer"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `status` used to filter results based on specific conditions.","in":"query","name":"status","schema":{"type":"string"}},{"description":"Query parameter `width` used to filter results based on specific conditions.","in":"query","name":"width","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProductImageList"}}},"description":"Successful response for status code 200."}},"tags":["products"]}}}}
```

## GET /products/product-images/{id}/

> This method retrieves image data for products, including image links and associated metadata such as the image dimensions, status, and the product to which the image belongs. This endpoint retrieves a specific record by its unique identifier.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"ProductImage":{"properties":{"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"height":{"description":"The field defines the height of the image in pixels.","maximum":2147483647,"minimum":0,"nullable":true,"type":"integer"},"id":{"description":"Unique identifier for the record.","type":"integer"},"image":{"description":"This field defines the URL or path to the product's image.","format":"uri","type":"string"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"order":{"description":"The field defines the order of the category node.","maximum":32767,"minimum":0,"type":"integer"},"product":{"description":"The field defines the product ID associated with the product price.","type":"integer"},"status":{"$ref":"#/components/schemas/ProductImageStatusEnum","description":"Current status of the record (e.g., active, inactive)."},"width":{"description":"The field defines the width of the image in pixels.","maximum":2147483647,"minimum":0,"nullable":true,"type":"integer"}},"type":"object"},"ProductImageStatusEnum":{"description":"* `active` - Active\n* `disabled` - Disabled","enum":["active","disabled"],"type":"string"}}},"paths":{"/products/product-images/{id}/":{"get":{"description":"This method retrieves image data for products, including image links and associated metadata such as the image dimensions, status, and the product to which the image belongs. This endpoint retrieves a specific record by its unique identifier.","operationId":"products_product_images_retrieve","parameters":[{"description":"A unique integer value identifying this product image.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductImage"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["products"]}}}}
```

## GET /products/products/

> This method retrieves detailed information about the available products, including attributes, product types, and various configurations.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedProductList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/Product"},"type":"array"}},"type":"object"},"Product":{"properties":{"attribute_set":{"description":"The field defines the attribute set ID that the product belongs to.","nullable":true,"type":"integer"},"attributes":{"description":"The field defines the attributes of the category node."},"attributes_kwargs":{"description":"The field defines the details of the category node."},"base_code":{"description":"The field defines the base code for the product.","maxLength":255,"nullable":true,"type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"custom_attribute_set":{"description":"The field defines the custom attribute set (if any) associated with the product.","nullable":true,"type":"integer"},"data_source":{"description":"The field defines the data source associated with the product (if applicable).","nullable":true,"type":"integer"},"extra_attributes":{"description":"The field defines additional custom attributes for the product."},"group_products":{"description":"The field defines the grouped products (if any) associated with the main product.","items":{"type":"integer"},"type":"array"},"id":{"description":"Unique identifier for the record.","type":"integer"},"is_active":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"is_form_required":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"is_listable":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"is_seller_product":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"listable_product":{"description":"The field defines whether the product is part of a listable set (if applicable).","nullable":true,"type":"integer"},"listing_code":{"description":"The field defines the listing code for the product (if applicable).","maxLength":512,"nullable":true,"type":"string"},"localized_attributes":{"description":"The field defines the category node that has been translated into other languages."},"localized_attributes_kwargs":{"description":"The field defines the details of the translations for the category node attributes."},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"name":{"description":"The full name or label associated with the record.","maxLength":255,"type":"string"},"parent":{"description":"The field defines the ID of the associated basket item, if there is a related basket item.","nullable":true,"type":"integer"},"pretty_url":{"description":"The field defines the pretty URL of the category.","nullable":true,"type":"integer"},"product_type":{"$ref":"#/components/schemas/ProductTypeEnum","description":"The classification or type related to this field."},"sku":{"description":"The field defines the SKU (Stock Keeping Unit) for the product.","maxLength":255,"type":"string"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"},"ProductTypeEnum":{"description":"* `-1` - Pre Product\n* `0` - Simple\n* `1` - Product Meta\n* `2` - Bundle\n* `3` - Grouped\n* `-2` - Pre Miscellaneous\n* `4` - Miscellaneous\n* `5` - Offer","enum":["-1","0","1","2","3","-2","4","5"],"type":"string"}}},"paths":{"/products/products/":{"get":{"description":"This method retrieves detailed information about the available products, including attributes, product types, and various configurations.","operationId":"products_products_list","parameters":[{"description":"Query parameter `attribute_set` used to filter results based on specific conditions.","in":"query","name":"attribute_set","schema":{"type":"integer"}},{"description":"Query parameter `attributes` used to filter results based on specific conditions.","in":"query","name":"attributes","schema":{}},{"description":"Query parameter `attributes_kwargs` used to filter results based on specific conditions.","in":"query","name":"attributes_kwargs","schema":{}},{"description":"Query parameter `base_code` used to filter results based on specific conditions.","in":"query","name":"base_code","schema":{"type":"string"}},{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `custom_attribute_set` used to filter results based on specific conditions.","in":"query","name":"custom_attribute_set","schema":{"type":"integer"}},{"description":"Query parameter `data_source` used to filter results based on specific conditions.","in":"query","name":"data_source","schema":{"type":"integer"}},{"description":"Query parameter `extra_attributes` used to filter results based on specific conditions.","in":"query","name":"extra_attributes","schema":{}},{"description":"Query parameter `group_products` used to filter results based on specific conditions.","explode":true,"in":"query","name":"group_products","schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Query parameter `is_active` used to filter results based on specific conditions.","in":"query","name":"is_active","schema":{"type":"boolean"}},{"description":"Query parameter `is_form_required` used to filter results based on specific conditions.","in":"query","name":"is_form_required","schema":{"type":"boolean"}},{"description":"Query parameter `is_listable` used to filter results based on specific conditions.","in":"query","name":"is_listable","schema":{"type":"boolean"}},{"description":"Query parameter `is_seller_product` used to filter results based on specific conditions.","in":"query","name":"is_seller_product","schema":{"type":"boolean"}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `listable_product` used to filter results based on specific conditions.","in":"query","name":"listable_product","schema":{"type":"integer"}},{"description":"Query parameter `listing_code` used to filter results based on specific conditions.","in":"query","name":"listing_code","schema":{"type":"string"}},{"description":"Query parameter `localized_attributes` used to filter results based on specific conditions.","in":"query","name":"localized_attributes","schema":{}},{"description":"Query parameter `localized_attributes_kwargs` used to filter results based on specific conditions.","in":"query","name":"localized_attributes_kwargs","schema":{}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `name` used to filter results based on specific conditions.","in":"query","name":"name","schema":{"type":"string"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `parent` used to filter results based on specific conditions.","in":"query","name":"parent","schema":{"type":"integer"}},{"description":"Query parameter `pretty_url` used to filter results based on specific conditions.","in":"query","name":"pretty_url","schema":{"type":"integer"}},{"description":"Query parameter `product_type` used to filter results based on specific conditions.","in":"query","name":"product_type","schema":{"type":"string"}},{"description":"Query parameter `sku` used to filter results based on specific conditions.","in":"query","name":"sku","schema":{"type":"string"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `uuid` used to filter results based on specific conditions.","in":"query","name":"uuid","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProductList"}}},"description":"Successful response for status code 200."}},"tags":["products"]}}}}
```

## GET /products/products/{id}/

> This method retrieves detailed information about the available products, including attributes, product types, and various configurations. This endpoint retrieves a specific record by its unique identifier.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"Product":{"properties":{"attribute_set":{"description":"The field defines the attribute set ID that the product belongs to.","nullable":true,"type":"integer"},"attributes":{"description":"The field defines the attributes of the category node."},"attributes_kwargs":{"description":"The field defines the details of the category node."},"base_code":{"description":"The field defines the base code for the product.","maxLength":255,"nullable":true,"type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"custom_attribute_set":{"description":"The field defines the custom attribute set (if any) associated with the product.","nullable":true,"type":"integer"},"data_source":{"description":"The field defines the data source associated with the product (if applicable).","nullable":true,"type":"integer"},"extra_attributes":{"description":"The field defines additional custom attributes for the product."},"group_products":{"description":"The field defines the grouped products (if any) associated with the main product.","items":{"type":"integer"},"type":"array"},"id":{"description":"Unique identifier for the record.","type":"integer"},"is_active":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"is_form_required":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"is_listable":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"is_seller_product":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"listable_product":{"description":"The field defines whether the product is part of a listable set (if applicable).","nullable":true,"type":"integer"},"listing_code":{"description":"The field defines the listing code for the product (if applicable).","maxLength":512,"nullable":true,"type":"string"},"localized_attributes":{"description":"The field defines the category node that has been translated into other languages."},"localized_attributes_kwargs":{"description":"The field defines the details of the translations for the category node attributes."},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"name":{"description":"The full name or label associated with the record.","maxLength":255,"type":"string"},"parent":{"description":"The field defines the ID of the associated basket item, if there is a related basket item.","nullable":true,"type":"integer"},"pretty_url":{"description":"The field defines the pretty URL of the category.","nullable":true,"type":"integer"},"product_type":{"$ref":"#/components/schemas/ProductTypeEnum","description":"The classification or type related to this field."},"sku":{"description":"The field defines the SKU (Stock Keeping Unit) for the product.","maxLength":255,"type":"string"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"},"ProductTypeEnum":{"description":"* `-1` - Pre Product\n* `0` - Simple\n* `1` - Product Meta\n* `2` - Bundle\n* `3` - Grouped\n* `-2` - Pre Miscellaneous\n* `4` - Miscellaneous\n* `5` - Offer","enum":["-1","0","1","2","3","-2","4","5"],"type":"string"}}},"paths":{"/products/products/{id}/":{"get":{"description":"This method retrieves detailed information about the available products, including attributes, product types, and various configurations. This endpoint retrieves a specific record by its unique identifier.","operationId":"products_products_retrieve","parameters":[{"description":"A unique integer value identifying this product.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["products"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.akinon.com/commerce-openapis/data-warehouse/products.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.