Catalogs

get

This method returns details about a specific category node, including its ID, name, path, and depth in the category hierarchy. It also includes the number of child nodes, sorting order, associated pretty URL, and timestamps for creation and modification.

Authorizations
Query parameters
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.

created_datestring · date-timeOptional

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

depthintegerOptional

Query parameter depth 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.

limitintegerOptional

Limits the number of results returned in the response.

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.

numchildintegerOptional

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

orderintegerOptional

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

pageintegerOptional

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

pathstringOptional

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

pretty_urlintegerOptional

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

sortstringOptional

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

sort_optionintegerOptional

Query parameter sort_option 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
get
GET /api/v1/remote/1/data-warehouse/catalogs/category-nodes/ 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": [
    {
      "attributes": null,
      "attributes_kwargs": null,
      "created_date": "2025-06-27T09:42:08.220Z",
      "depth": 1,
      "id": 1,
      "localized_attributes": null,
      "localized_attributes_kwargs": null,
      "modified_date": "2025-06-27T09:42:08.220Z",
      "name": "text",
      "numchild": 1,
      "order": 1,
      "path": "text",
      "pretty_url": 1,
      "sort_option": 1,
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}
get

This method returns details about a specific category node, including its ID, name, path, and depth in the category hierarchy. It also includes the number of child nodes, sorting order, associated pretty URL, and timestamps for creation and modification. This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this category node.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/catalogs/category-nodes/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "attributes": null,
  "attributes_kwargs": null,
  "created_date": "2025-06-27T09:42:08.220Z",
  "depth": 1,
  "id": 1,
  "localized_attributes": null,
  "localized_attributes_kwargs": null,
  "modified_date": "2025-06-27T09:42:08.220Z",
  "name": "text",
  "numchild": 1,
  "order": 1,
  "path": "text",
  "pretty_url": 1,
  "sort_option": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}
get

This method returns details about a specific product’s price, including its ID, price type (e.g., 'default'), currency type, retail price, tax rate, and the actual price. It also provides any extra fields and the associated product ID.

Authorizations
Query parameters
created_datestring · date-timeOptional

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

currency_typestringOptional

Query parameter currency_type 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.

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.

pageintegerOptional

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

pricenumberOptional

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

price_typestringOptional

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

productintegerOptional

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

retail_pricenumberOptional

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

sortstringOptional

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

tax_ratenumberOptional

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

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/catalogs/product-prices/ 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": "2025-06-27T09:42:08.220Z",
      "currency_type": "try",
      "extra_field": null,
      "id": 1,
      "modified_date": "2025-06-27T09:42:08.220Z",
      "price": "text",
      "price_type": "default",
      "product": 1,
      "retail_price": "text",
      "tax_rate": "text"
    }
  ]
}
get

This method returns details about a specific product’s price, including its ID, price type (e.g., 'default'), currency type, retail price, tax rate, and the actual price. It also provides any extra fields and the associated product ID. This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this product price.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/catalogs/product-prices/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "created_date": "2025-06-27T09:42:08.220Z",
  "currency_type": "try",
  "extra_field": null,
  "id": 1,
  "modified_date": "2025-06-27T09:42:08.220Z",
  "price": "text",
  "price_type": "default",
  "product": 1,
  "retail_price": "text",
  "tax_rate": "text"
}
get

Retrieve data from /api/v1/data-warehouse/catalogs/product-stocks/ endpoint.

Authorizations
Query parameters
created_datestring · date-timeOptional

Query parameter created_date 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.

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.

pageintegerOptional

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

productintegerOptional

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

sold_quantity_unreportedintegerOptional

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

sortstringOptional

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

stockintegerOptional

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

unit_typestringOptional

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

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/catalogs/product-stocks/ 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": "2025-06-27T09:42:08.220Z",
      "extra_field": null,
      "id": 1,
      "modified_date": "2025-06-27T09:42:08.220Z",
      "product": 1,
      "sold_quantity_unreported": 1,
      "stock": 1,
      "unit_type": "qty"
    }
  ]
}
get

Retrieve data from /api/v1/data-warehouse/catalogs/product-stocks/ endpoint. This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this product stock.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/catalogs/product-stocks/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "created_date": "2025-06-27T09:42:08.220Z",
  "extra_field": null,
  "id": 1,
  "modified_date": "2025-06-27T09:42:08.220Z",
  "product": 1,
  "sold_quantity_unreported": 1,
  "stock": 1,
  "unit_type": "qty"
}

Was this helpful?