Catalogs

get

/catalogs/category-nodes/

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

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

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

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

/catalogs/category-nodes/

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": "2026-03-06T21:57:19.864Z",
      "depth": 1,
      "id": 1,
      "localized_attributes": null,
      "localized_attributes_kwargs": null,
      "modified_date": "2026-03-06T21:57:19.864Z",
      "name": "text",
      "numchild": 1,
      "order": 1,
      "path": "text",
      "pretty_url": 1,
      "sort_option": 1,
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

get

/catalogs/category-nodes/{id}/

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this category node.

Responses

200

Successful response for status code 200.

application/json

attributesanyOptional

The field defines the attributes of the category node.

attributes_kwargsanyOptional

The field defines the details of the category node.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

depthinteger · max: 2147483647Optional

This field defines the depth as the level of the node in the tree, starting from zero.

idintegerOptional

Unique identifier for the record.

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: 64Optional

The full name or label associated with the record.

numchildinteger · max: 2147483647Optional

This field defines the numchild as the number of direct children the node has.

orderinteger · min: -2147483648 · max: 2147483647Optional

The field defines the order of the category node.

pathstring · max: 255Optional

This field defines the path as the hierarchical route from the root to the node.

pretty_urlinteger · nullableOptional

The field defines the pretty URL of the category.

sort_optioninteger · nullableOptional

The field defines the ID of the sort option applied to order the category.

uuidstring · uuidOptional

Unique identifier for the record.

404

Object not found.

application/json

get

/catalogs/category-nodes/{id}/

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": "2026-03-06T21:57:19.864Z",
  "depth": 1,
  "id": 1,
  "localized_attributes": null,
  "localized_attributes_kwargs": null,
  "modified_date": "2026-03-06T21:57:19.864Z",
  "name": "text",
  "numchild": 1,
  "order": 1,
  "path": "text",
  "pretty_url": 1,
  "sort_option": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

get

/catalogs/product-prices/

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

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.

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

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

/catalogs/product-prices/

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": "2026-03-06T21:57:19.864Z",
      "currency_type": "try",
      "extra_field": null,
      "id": 1,
      "modified_date": "2026-03-06T21:57:19.864Z",
      "price": "text",
      "price_type": "default",
      "product": 1,
      "retail_price": "text",
      "tax_rate": "text"
    }
  ]
}

get

/catalogs/product-prices/{id}/

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this product price.

Responses

200

Successful response for status code 200.

application/json

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

currency_typestring · enumOptional

The classification or type related to this field.

Possible values:

extra_fieldany · nullableOptional

The field defines additional fields or attributes related to the product.

idintegerOptional

Unique identifier for the record.

modified_datestring · date-timeOptional

This field defines the last updated date.

pricestring · decimalOptional

The field defines the actual price of the product.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

price_typestring · enumOptional

The classification or type related to this field.

Possible values:

productintegerOptional

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

retail_pricestring · decimal · nullableOptional

The field defines the retail price of the product.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

tax_ratestring · decimalOptional

The field defines the tax rate applied to the product.

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$

404

Object not found.

application/json

get

/catalogs/product-prices/{id}/

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": "2026-03-06T21:57:19.864Z",
  "currency_type": "try",
  "extra_field": null,
  "id": 1,
  "modified_date": "2026-03-06T21:57:19.864Z",
  "price": "text",
  "price_type": "default",
  "product": 1,
  "retail_price": "text",
  "tax_rate": "text"
}

get

/catalogs/product-stocks/

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

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.

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

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

/catalogs/product-stocks/

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": "2026-03-06T21:57:19.864Z",
      "extra_field": null,
      "id": 1,
      "modified_date": "2026-03-06T21:57:19.864Z",
      "product": 1,
      "sold_quantity_unreported": 1,
      "stock": 1,
      "unit_type": "qty"
    }
  ]
}

get

/catalogs/product-stocks/{id}/

Retrieve data from /api/v1/data-warehouse/catalogs/product-stocks/ endpoint. 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 stock.

Responses

200

Successful response for status code 200.

application/json

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

extra_fieldany · nullableOptional

The field defines additional fields or attributes related to the product.

idintegerOptional

Unique identifier for the record.

modified_datestring · date-timeOptional

This field defines the last updated date.

productintegerOptional

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

sold_quantity_unreportedinteger · max: 2147483647Optional

stockinteger · max: 2147483647Optional

unit_typestring · enumOptional

The classification or type related to this field.

Possible values:

404

Object not found.

application/json

get

/catalogs/product-stocks/{id}/

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": "2026-03-06T21:57:19.864Z",
  "extra_field": null,
  "id": 1,
  "modified_date": "2026-03-06T21:57:19.864Z",
  "product": 1,
  "sold_quantity_unreported": 1,
  "stock": 1,
  "unit_type": "qty"
}

PreviousCampaigns NextCities

Last updated 8 months ago

Was this helpful?