Baskets

get

https://sandbox.akinon.com/api/v1/remote/1/data-warehousehttps://sandbox.commerce.akinon.com/api/v1/data-warehouse

/baskets/basket-items/

This method returns details about a specific item in a shopping basket, including its ID, quantity, product reference, and version. It also includes information such as the associated basket ID, product ID, and any additional attributes (like tax rate, unit price, image, and extra product details), if available.

Authorizations

tokenAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

attributesany · nullableOptional

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

attributes_kwargsany · nullableOptional

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

basketintegerOptional

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

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.

datasourceintegerOptional

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

extra_product_priceintegerOptional

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

extra_product_stockintegerOptional

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

localized_attributesany · nullableOptional

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

localized_attributes_kwargsany · nullableOptional

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.

pageintegerOptional

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

parentintegerOptional

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

productintegerOptional

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

quantityintegerOptional

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

referencestringOptional

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

unit_pricenumberOptional

Query parameter unit_price 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

/baskets/basket-items/

HTTPcURLJavaScriptPython

GET /api/v1/remote/1/data-warehouse/baskets/basket-items/ 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,
      "basket": 1,
      "created_date": "2026-03-06T22:42:20.204Z",
      "currency_type": "try",
      "datasource": 1,
      "extra_product_price": 1,
      "extra_product_stock": 1,
      "id": 1,
      "image": "https://example.com",
      "localized_attributes": null,
      "localized_attributes_kwargs": null,
      "modified_date": "2026-03-06T22:42:20.204Z",
      "parent": 1,
      "product": 1,
      "quantity": 1,
      "reference": "text",
      "tax_rate": "text",
      "unit_price": "text",
      "version": 1
    }
  ]
}

get

https://sandbox.akinon.com/api/v1/remote/1/data-warehousehttps://sandbox.commerce.akinon.com/api/v1/data-warehouse

/baskets/basket-items/{id}/

This method returns details about a specific item in a shopping basket, including its ID, quantity, product reference, and version. It also includes information such as the associated basket ID, product ID, and any additional attributes (like tax rate, unit price, image, and extra product details), if available. This endpoint retrieves a specific record by its unique identifier.

Authorizations

tokenAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this basket item.

Responses

200

Successful response for status code 200.

application/json

attributesany · nullableOptional

The field defines the attributes of the category node.

attributes_kwargsany · nullableOptional

The field defines the details of the category node.

basketintegerOptional

This field defines the ID of the basket that contains the product.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

currency_typestring · enumOptional

The classification or type related to this field.

Possible values:

datasourceinteger · nullableOptional

The field defines the ID that indicates which seller the item belongs to.

extra_product_priceinteger · nullableOptional

The field defines the ID of the extra product price associated with the product. If not specified, the default price applies.

extra_product_stockinteger · nullableOptional

The field defines the ID of the extra product stock associated with the product. If not specified, the default stock applies.

idintegerOptional

Unique identifier for the record.

imagestring · uri · nullableOptional

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

localized_attributesany · nullableOptional

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

localized_attributes_kwargsany · nullableOptional

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

modified_datestring · date-timeOptional

This field defines the last updated date.

parentinteger · nullableOptional

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

productintegerOptional

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

quantityinteger · max: 2147483647Optional

This field defines the quantity of the product.

referencestring · max: 255Optional

This field defines a reference for the basket item.

tax_ratestring · decimal · nullableOptional

The field defines the tax rate applied to the product.

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

unit_pricestring · decimal · nullableOptional

This field defines the unit price of the product.

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

versionintegerOptional

record revision number

404

Object not found.

application/json

get

/baskets/basket-items/{id}/

HTTPcURLJavaScriptPython

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

{
  "attributes": null,
  "attributes_kwargs": null,
  "basket": 1,
  "created_date": "2026-03-06T22:42:20.204Z",
  "currency_type": "try",
  "datasource": 1,
  "extra_product_price": 1,
  "extra_product_stock": 1,
  "id": 1,
  "image": "https://example.com",
  "localized_attributes": null,
  "localized_attributes_kwargs": null,
  "modified_date": "2026-03-06T22:42:20.204Z",
  "parent": 1,
  "product": 1,
  "quantity": 1,
  "reference": "text",
  "tax_rate": "text",
  "unit_price": "text",
  "version": 1
}

get

https://sandbox.akinon.com/api/v1/remote/1/data-warehousehttps://sandbox.commerce.akinon.com/api/v1/data-warehouse

/baskets/baskets/

This method returns details about a specific shopping basket, including its ID, status, creation and modification timestamps, version, and associated voucher code. It also provides information about the user and any namespaces linked to the basket, if applicable.

Authorizations

tokenAuth

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.

namespacestringOptional

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

pageintegerOptional

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

sortstringOptional

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

statusstring · enumOptional

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

Possible values:

userintegerOptional

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

voucher_codestringOptional

Query parameter voucher_code 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

/baskets/baskets/

HTTPcURLJavaScriptPython

GET /api/v1/remote/1/data-warehouse/baskets/baskets/ 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:42:20.204Z",
      "id": 1,
      "modified_date": "2026-03-06T22:42:20.204Z",
      "namespace": "text",
      "status": "active",
      "user": 1,
      "version": 1,
      "voucher_code": "text"
    }
  ]
}

get

https://sandbox.akinon.com/api/v1/remote/1/data-warehousehttps://sandbox.commerce.akinon.com/api/v1/data-warehouse

/baskets/baskets/{id}/

This method returns details about a specific shopping basket, including its ID, status, creation and modification timestamps, version, and associated voucher code. It also provides information about the user and any namespaces linked to the basket, if applicable. This endpoint retrieves a specific record by its unique identifier.

Authorizations

tokenAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this basket.

Responses

200

Successful response for status code 200.

application/json

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

idintegerOptional

Unique identifier for the record.

modified_datestring · date-timeOptional

This field defines the last updated date.

namespacestring · max: 128 · nullableOptional

The full name or label associated with the record.

statusstring · enumOptional

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

Possible values:

userinteger · nullableOptional

This field defines the user who triggered the event.

versionintegerOptional

record revision number

voucher_codestring · max: 128 · nullableOptional

The field defines the code of the voucher applied to the basket.

404

Object not found.

application/json

get

/baskets/baskets/{id}/

HTTPcURLJavaScriptPython

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

{
  "created_date": "2026-03-06T22:42:20.204Z",
  "id": 1,
  "modified_date": "2026-03-06T22:42:20.204Z",
  "namespace": "text",
  "status": "active",
  "user": 1,
  "version": 1,
  "voucher_code": "text"
}