Products

PreviousIntroduction NextPackages

Was this helpful?

PRD108: Search Catalog

get

Authorizations

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset.

Default: 1

limitinteger · min: 1Optional

Specifies the row count of the current page.

Default: 10

querystringRequired

Value to search in the marketplace catalog.

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses

200

application/json

Responseall of

401

Unauthorized

application/json

500

Unexpected error.

get

GET /api/i2/products/search/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://seller-center.akinon.com/api/i2/resource?page=2&limit=10",
  "previous": null,
  "results": [
    {
      "id": "9db60fcc-90ff-4ce3-9761-57d8bdf138d4",
      "name": "Akinon Red T-shirt",
      "base_code": "AKN-TSHRT",
      "sku": "AKN-TSHRT",
      "category": "07be580a-ad72-4778-b309-1d02d6c2acec",
      "attributes": {
        "COLOR": "Red",
        "SIZE": "S",
        "ESTIMATED_SHIPPING_DURATION": 1
      },
      "images": [
        "https://placehold.co/1920x1080?text=Akinon%20Red%20T-shirt"
      ],
      "videos": [
        "https://placehold.co/1920x1080.mp4?text=Akinon%20Red%20T-shirt"
      ],
      "updated_at": "2025-05-22T11:42:32.935Z",
      "created_at": "2025-05-22T11:42:32.935Z"
    }
  ]
}

PRD102: Get Products

get

Authorizations

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset.

Default: 1

limitinteger · min: 1Optional

Specifies the row count of the current page.

Default: 10

namestringOptional

Filter by exact value of the name field.

name__containsstringOptional

Filter by values in the name field that contain the specified string (case-sensitive).

name__icontainsstringOptional

Filter by values in the name field that contain the specified string (case-insensitive).

base_codestringOptional

Filter by exact value of the base_code field.

base_code__containsstringOptional

Filter by values in the base_code field that contain the specified string (case-sensitive).

base_code__icontainsstringOptional

Filter by values in the base_code field that contain the specified string (case-insensitive).

skustringOptional

Filter by exact value of the sku field.

sku__containsstringOptional

Filter by values in the sku field that contain the specified string (case-sensitive).

sku__icontainsstringOptional

Filter by values in the sku field that contain the specified string (case-insensitive).

categorystring · uuidOptional

Filter by exact value of the category field.

category__instring · uuid[]Optional

Filter by category field using a comma-separated list (CSV format).

attribute__KEYstringOptional

Filter by exact value of the attribute with the specified key.

attribute__KEY__iexactstringOptional

Filter by exact (case-insensitive) value of the attribute with the specified key.

attribute__KEY__containsstringOptional

Filter by values in the attribute with the specified key that contain the specified string (case-sensitive).

attribute__KEY__icontainsstringOptional

Filter by values in the attribute with the specified key that contain the specified string (case-insensitive).

attribute__KEY__startswithstringOptional

Filter by values in the attribute with the specified key that start with the specified string.

attribute__KEY__istartswithstringOptional

Filter by values in the attribute with the specified key that start with the specified string (case-insensitive).

attribute__KEY__endswithstringOptional

Filter by values in the attribute with the specified key that end with the specified string.

attribute__KEY__iendswithstringOptional

Filter by values in the attribute with the specified key that end with the specified string (case-insensitive).

approvedbooleanOptional

Indicates whether the product is approved.

Default: true

updated_atstring · date-timeOptional

Filters data where the "updated_at" field is exactly equal to a specified value.

updated_at__gtstring · date-timeOptional

Filters data where the "updated_at" field is greater than a specified value.

updated_at__gtestring · date-timeOptional

Filters data where the "updated_at" field is greater than or equal to a specified value.

updated_at__ltstring · date-timeOptional

Filters data where the "updated_at" field is less than a specified value.

updated_at__ltestring · date-timeOptional

Filters data where the "updated_at" field is less than or equal to a specified value.

created_atstring · date-timeOptional

Filters data where the "created_at" field is exactly equal to a specified value.

created_at__gtstring · date-timeOptional

Filters data where the "created_at" field is greater than a specified value.

created_at__gtestring · date-timeOptional

Filters data where the "created_at" field is greater than or equal to a specified value.

created_at__ltstring · date-timeOptional

Filters data where the "created_at" field is less than a specified value.

created_at__ltestring · date-timeOptional

Filters data where the "created_at" field is less than or equal to a specified value.

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses

200

application/json

Responseall of

401

Unauthorized

application/json

500

Unexpected error.

get

GET /api/i2/products/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://seller-center.akinon.com/api/i2/resource?page=2&limit=10",
  "previous": null,
  "results": [
    {
      "name": "Akinon Red T-shirt",
      "base_code": "AKN-TSHRT",
      "sku": "AKN-TSHRT",
      "category": "07be580a-ad72-4778-b309-1d02d6c2acec",
      "attributes": {
        "COLOR": "Red",
        "SIZE": "S",
        "ESTIMATED_SHIPPING_DURATION": 1
      },
      "images": [
        "https://placehold.co/1920x1080?text=Akinon%20Red%20T-shirt"
      ],
      "videos": [
        "https://placehold.co/1920x1080.mp4?text=Akinon%20Red%20T-shirt"
      ],
      "prices": [
        {
          "price_list": "4c7c6e4e-2655-4e9b-8012-69395b40b0cf",
          "currency_type": "USD",
          "retail_price": "99.99",
          "price": "89.99",
          "tax_rate": "0.08"
        }
      ],
      "stocks": [
        {
          "stock_list": "4c7c6e4e-2655-4e9b-8012-69395b40b0cf",
          "unit_type": "qty",
          "stock": "90",
          "sold_quantity_unreported": "10"
        }
      ],
      "updated_at": "2025-05-22T11:42:32.935Z",
      "created_at": "2025-05-22T11:42:32.935Z"
    }
  ]
}

PRD107: Get Batch Request

get

Authorizations

Path parameters

idstring · uuidRequired

Responses

200

application/json

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

get

GET /api/i2/products/batch-requests/{id} HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "f3909f53-a535-40cc-8d50-de0cd047aedd",
  "registry": "Resource (Reference Number)",
  "request_file": "https://akinon.com/imports/f3909f53-a535-40cc-8d50-de0cd047aedd.json",
  "success_file": "https://akinon.com/imports/f3909f53-a535-40cc-8d50-de0cd047aedd-s.json",
  "error_file": "https://akinon.com/imports/f3909f53-a535-40cc-8d50-de0cd047aedd-e.json",
  "status": 1,
  "state": {
    "total": 1,
    "succeeded": 1,
    "failed": 1
  },
  "processed_in": 1,
  "updated_at": "2025-05-22T11:42:32.935Z",
  "created_at": "2025-05-22T11:42:32.935Z"
}

PRD101: Upsert Products

post

Authorizations

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Body

namestringRequired

Name of the product.

Example: Akinon Red T-shirt

base_codestringRequired

Base code associated with the product.

Example: AKN-TSHRT

skustringRequired

Stock Keeping Unit (SKU) code for the product.

Example: AKN-TSHRT

categorystring · uuidRequired

Unique identifier for the category associated with the product.

Example: 07be580a-ad72-4778-b309-1d02d6c2acec

productstring · uuidOptional

Unique identifier for the product can be found in the catalog (PRD108). This value is used to link the product that is being processed to the given catalog product.

Example: e7ff9b80-6c00-4730-b99c-d9c5d0ba4a30

attributesobjectRequired

Attributes associated with the product.

Default: {}Example: {"COLOR":"Red","SIZE":"S","ESTIMATED_SHIPPING_DURATION":1}

imagesstring[]Optional

Images associated with the product.

Example: https://placehold.co/1920x1080?text=Akinon%20Red%20T-shirt

videosstring[]Optional

Videos associated with the product.

Example: https://placehold.co/1920x1080.mp4?text=Akinon%20Red%20T-shirt

restrict_for_othersboolOptional

Determines whether the product, once approved, will be restricted to the other sellers. If set to false, the product will be available to all sellers.

Responses

202

application/json

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

500

Unexpected error.

post

POST /api/i2/products/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 659

[
  {
    "name": "Akinon Red T-shirt",
    "base_code": "AKN-TSHRT",
    "sku": "AKN-TSHRT",
    "category": "07be580a-ad72-4778-b309-1d02d6c2acec",
    "product": "e7ff9b80-6c00-4730-b99c-d9c5d0ba4a30",
    "attributes": {
      "COLOR": "Red",
      "SIZE": "S",
      "ESTIMATED_SHIPPING_DURATION": 1
    },
    "images": [
      "https://placehold.co/1920x1080?text=Akinon%20Red%20T-shirt"
    ],
    "videos": [
      "https://placehold.co/1920x1080.mp4?text=Akinon%20Red%20T-shirt"
    ],
    "prices": [
      {
        "price_list": "4c7c6e4e-2655-4e9b-8012-69395b40b0cf",
        "currency_type": "USD",
        "retail_price": "99.99",
        "price": "89.99",
        "tax_rate": "0.08"
      }
    ],
    "stocks": [
      {
        "stock_list": "4c7c6e4e-2655-4e9b-8012-69395b40b0cf",
        "stock": "90",
        "unit_type": "qty"
      }
    ],
    "restrict_for_others": null
  }
]

{
  "batch_request_id": "4b306686-cabb-4dd4-bf28-31679957c229"
}

PRD103: Delete Products

delete

Authorizations

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Body

skustringRequired

Stock Keeping Unit (SKU) code for the product.

Example: AKN-TSHRT-RD

Responses

202

application/json

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

500

Unexpected error.

delete

DELETE /api/i2/products/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 24

[
  {
    "sku": "AKN-TSHRT-RD"
  }
]

{
  "batch_request_id": "4b306686-cabb-4dd4-bf28-31679957c229"
}

PRD104: Upsert Prices & Stocks

post

Authorizations

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Body

itemsall ofOptional

Responses

202

application/json

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

500

Unexpected error.

post

POST /api/i2/products/prices-and-stocks/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 238

[
  {
    "sku": "AKN-TSHRT-RD",
    "price_list": "4c7c6e4e-2655-4e9b-8012-69395b40b0cf",
    "currency_type": "USD",
    "retail_price": "99.99",
    "price": "89.99",
    "tax_rate": "0.08",
    "stock_list": "4c7c6e4e-2655-4e9b-8012-69395b40b0cf",
    "stock": "90",
    "unit_type": "qty"
  }
]

{
  "batch_request_id": "4b306686-cabb-4dd4-bf28-31679957c229"
}

PRD105: Upsert Prices

post

Authorizations

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Body

itemsall ofOptional

Responses

202

application/json

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

500

Unexpected error.

post

POST /api/i2/products/prices/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 155

[
  {
    "sku": "AKN-TSHRT-RD",
    "price_list": "4c7c6e4e-2655-4e9b-8012-69395b40b0cf",
    "currency_type": "USD",
    "retail_price": "99.99",
    "price": "89.99",
    "tax_rate": "0.08"
  }
]

{
  "batch_request_id": "4b306686-cabb-4dd4-bf28-31679957c229"
}

PRD106: Upsert Stocks

post

Authorizations

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Body

itemsall ofOptional

Responses

202

application/json

400

Missing required field(s), invalid data or invalid action.

application/json

401

Unauthorized

application/json

500

Unexpected error.

post

POST /api/i2/products/stocks/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 107

[
  {
    "sku": "AKN-TSHRT-RD",
    "stock_list": "4c7c6e4e-2655-4e9b-8012-69395b40b0cf",
    "stock": "90",
    "unit_type": "qty"
  }
]

{
  "batch_request_id": "4b306686-cabb-4dd4-bf28-31679957c229"
}