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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

heightintegerOptional

Query parameter height used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

imagestringOptional

Query parameter image used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

orderintegerOptional

Query parameter order used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

productintegerOptional

Query parameter product used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

statusstringOptional

Query parameter status used to filter results based on specific conditions.

widthintegerOptional

Query parameter width used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2

get

/products/product-images/

GET /api/v1/remote/1/data-warehouse/products/product-images/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "created_date": "2026-03-06T22:13:17.861Z",
      "height": 1,
      "id": 1,
      "image": "https://example.com",
      "modified_date": "2026-03-06T22:13:17.861Z",
      "order": 1,
      "product": 1,
      "status": "active",
      "width": 1
    }
  ]
}

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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this product image.

Responses

200

Successful response for status code 200.

application/json

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

heightinteger · max: 2147483647 · nullableOptional

The field defines the height of the image in pixels.

idintegerOptional

Unique identifier for the record.

imagestring · uriOptional

This field defines the URL or path to the product's image.

modified_datestring · date-timeOptional

This field defines the last updated date.

orderinteger · max: 32767Optional

The field defines the order of the category node.

productintegerOptional

The field defines the product ID associated with the product price.

statusstring · enumOptional

Current status of the record (e.g., active, inactive).

Possible values:

widthinteger · max: 2147483647 · nullableOptional

The field defines the width of the image in pixels.

404

Object not found.

application/json

get

/products/product-images/{id}/

GET /api/v1/remote/1/data-warehouse/products/product-images/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "created_date": "2026-03-06T22:13:17.861Z",
  "height": 1,
  "id": 1,
  "image": "https://example.com",
  "modified_date": "2026-03-06T22:13:17.861Z",
  "order": 1,
  "product": 1,
  "status": "active",
  "width": 1
}

get

/products/products/

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

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

attribute_setintegerOptional

Query parameter attribute_set used to filter results based on specific conditions.

attributesanyOptional

Query parameter attributes used to filter results based on specific conditions.

attributes_kwargsanyOptional

Query parameter attributes_kwargs used to filter results based on specific conditions.

base_codestringOptional

Query parameter base_code used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

custom_attribute_setintegerOptional

Query parameter custom_attribute_set used to filter results based on specific conditions.

data_sourceintegerOptional

Query parameter data_source used to filter results based on specific conditions.

extra_attributesanyOptional

Query parameter extra_attributes used to filter results based on specific conditions.

group_productsinteger[]Optional

Query parameter group_products used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

is_activebooleanOptional

Query parameter is_active used to filter results based on specific conditions.

is_form_requiredbooleanOptional

Query parameter is_form_required used to filter results based on specific conditions.

is_listablebooleanOptional

Query parameter is_listable used to filter results based on specific conditions.

is_seller_productbooleanOptional

Query parameter is_seller_product used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

listable_productintegerOptional

Query parameter listable_product used to filter results based on specific conditions.

listing_codestringOptional

Query parameter listing_code used to filter results based on specific conditions.

localized_attributesanyOptional

Query parameter localized_attributes used to filter results based on specific conditions.

localized_attributes_kwargsanyOptional

Query parameter localized_attributes_kwargs used to filter results based on specific conditions.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

namestringOptional

Query parameter name used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

parentintegerOptional

Query parameter parent used to filter results based on specific conditions.

pretty_urlintegerOptional

Query parameter pretty_url used to filter results based on specific conditions.

product_typestringOptional

Query parameter product_type used to filter results based on specific conditions.

skustringOptional

Query parameter sku used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

uuidstring · uuidOptional

Query parameter uuid used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2

get

/products/products/

GET /api/v1/remote/1/data-warehouse/products/products/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "attribute_set": 1,
      "attributes": null,
      "attributes_kwargs": null,
      "base_code": "text",
      "created_date": "2026-03-06T22:13:17.861Z",
      "custom_attribute_set": 1,
      "data_source": 1,
      "extra_attributes": null,
      "group_products": [
        1
      ],
      "id": 1,
      "is_active": true,
      "is_form_required": true,
      "is_listable": true,
      "is_seller_product": true,
      "listable_product": 1,
      "listing_code": "text",
      "localized_attributes": null,
      "localized_attributes_kwargs": null,
      "modified_date": "2026-03-06T22:13:17.861Z",
      "name": "text",
      "parent": 1,
      "pretty_url": 1,
      "product_type": "-1",
      "sku": "text",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this product.

Responses

200

Successful response for status code 200.

application/json

attribute_setinteger · nullableOptional

The field defines the attribute set ID that the product belongs to.

attributesanyOptional

The field defines the attributes of the category node.

attributes_kwargsanyOptional

The field defines the details of the category node.

base_codestring · max: 255 · nullableOptional

The field defines the base code for the product.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

custom_attribute_setinteger · nullableOptional

The field defines the custom attribute set (if any) associated with the product.

data_sourceinteger · nullableOptional

The field defines the data source associated with the product (if applicable).

extra_attributesanyOptional

The field defines additional custom attributes for the product.

group_productsinteger[]Optional

The field defines the grouped products (if any) associated with the main product.

idintegerOptional

Unique identifier for the record.

is_activebooleanOptional

Boolean flag indicating whether the condition is met.

is_form_requiredbooleanOptional

Boolean flag indicating whether the condition is met.

is_listablebooleanOptional

Boolean flag indicating whether the condition is met.

is_seller_productbooleanOptional

Boolean flag indicating whether the condition is met.

listable_productinteger · nullableOptional

The field defines whether the product is part of a listable set (if applicable).

listing_codestring · max: 512 · nullableOptional

The field defines the listing code for the product (if applicable).

localized_attributesanyOptional

The field defines the category node that has been translated into other languages.

localized_attributes_kwargsanyOptional

The field defines the details of the translations for the category node attributes.

modified_datestring · date-timeOptional

This field defines the last updated date.

namestring · max: 255Optional

The full name or label associated with the record.

parentinteger · nullableOptional

The field defines the ID of the associated basket item, if there is a related basket item.

pretty_urlinteger · nullableOptional

The field defines the pretty URL of the category.

product_typestring · enumOptional

The classification or type related to this field.

Possible values:

skustring · max: 255Optional

The field defines the SKU (Stock Keeping Unit) for the product.

uuidstring · uuidOptional

Unique identifier for the record.

404

Object not found.

application/json

get

/products/products/{id}/

GET /api/v1/remote/1/data-warehouse/products/products/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "attribute_set": 1,
  "attributes": null,
  "attributes_kwargs": null,
  "base_code": "text",
  "created_date": "2026-03-06T22:13:17.861Z",
  "custom_attribute_set": 1,
  "data_source": 1,
  "extra_attributes": null,
  "group_products": [
    1
  ],
  "id": 1,
  "is_active": true,
  "is_form_required": true,
  "is_listable": true,
  "is_seller_product": true,
  "listable_product": 1,
  "listing_code": "text",
  "localized_attributes": null,
  "localized_attributes_kwargs": null,
  "modified_date": "2026-03-06T22:13:17.861Z",
  "name": "text",
  "parent": 1,
  "pretty_url": 1,
  "product_type": "-1",
  "sku": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

PreviousProduct Alerts NextRedirects

Last updated 8 months ago

Was this helpful?