Products

get
Authorizations
AuthorizationstringRequired
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
chevron-right
200

OK

application/json
get
/i2/products/search/

PRD102: Get Products

get
Authorizations
AuthorizationstringRequired
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
chevron-right
200

OK

application/json
get
/i2/products/

PRD101: Upsert Products

post
Authorizations
AuthorizationstringRequired
Header parameters
Accept-LanguagestringOptional

Specifies the communication language of the API.

Bodyobject[]
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
post
/i2/products/

PRD103: Delete Products

delete
Authorizations
AuthorizationstringRequired
Header parameters
Accept-LanguagestringOptional

Specifies the communication language of the API.

Bodyobject[]
skustringRequired

Stock Keeping Unit (SKU) code for the product.

Example: AKN-TSHRT-RD
Responses
delete
/i2/products/

PRD104: Upsert Prices & Stocks

post
Authorizations
AuthorizationstringRequired
Header parameters
Accept-LanguagestringOptional

Specifies the communication language of the API.

Bodyall of[]
Responses
post
/i2/products/prices-and-stocks/

PRD105: Upsert Prices

post
Authorizations
AuthorizationstringRequired
Header parameters
Accept-LanguagestringOptional

Specifies the communication language of the API.

Bodyall of[]
Responses
post
/i2/products/prices/

PRD106: Upsert Stocks

post
Authorizations
AuthorizationstringRequired
Header parameters
Accept-LanguagestringOptional

Specifies the communication language of the API.

Bodyall of[]
Responses
post
/i2/products/stocks/

PRD107: Get Batch Request

get
Authorizations
AuthorizationstringRequired
Path parameters
idstring · uuidRequired
Responses
chevron-right
200

OK

application/json
idstring · uuidOptional

Unique identifier for the batch request.

Example: f3909f53-a535-40cc-8d50-de0cd047aedd
registrystringOptional

Resource type for the batch request.

Example: Resource (Reference Number)
request_filestring · uriOptional

URL for the batch request data. This field will contain an array of objects, each representing a successful record. Following example taken from a batch request for updating stocks via PRD106:

  [
    {
        "sku": "SP-0",
        "stock": "10"
    },
    {
        "sku": "SP-1",
        "stock": "10"
    },
    {
        "sku": "SP-2",
        "stock": "10"
    },
    {
        "sku": "SP-3",
        "stock": "10"
    },
    {
        "sku": "SP-4",
        "stock": "10"
    },
    {
        "sku": "SP-5",
        "stock": "10"
    },
    {
        "sku": "SP-6",
        "stock": "10"
    },
    {
        "sku": "SP-7",
        "stock": "10"
    },
    {
        "sku": "SP-8",
        "stock": "10"
    },
    {
        "sku": "SP-9",
        "stock": "10"
    }
]
Example: https://akinon.com/imports/f3909f53-a535-40cc-8d50-de0cd047aedd.json
success_filestring · uriOptional

URL for the successful data of the batch request. This field will contain an array of objects, each representing a successful record. Following example taken from a batch request for updating stocks via PRD106:

  [
    {
        "sku": "SP-0",
        "stock": "10"
    },
    {
        "sku": "SP-1",
        "stock": "10"
    },
    {
        "sku": "SP-2",
        "stock": "10"
    },
    {
        "sku": "SP-3",
        "stock": "10"
    },
    {
        "sku": "SP-4",
        "stock": "10"
    },
    {
        "sku": "SP-5",
        "stock": "10"
    },
    {
        "sku": "SP-6",
        "stock": "10"
    },
    {
        "sku": "SP-7",
        "stock": "10"
    },
    {
        "sku": "SP-8",
        "stock": "10"
    },
    {
        "sku": "SP-9",
        "stock": "10"
    }
]
Example: https://akinon.com/imports/f3909f53-a535-40cc-8d50-de0cd047aedd-s.json
error_filestring · uriOptional

URL for the failed data of the batch request. This field will contain an array of objects including an errors property which describes the reason for the failure, each representing a failed record. Following example taken from a batch request for updating stocks via PRD106:

  [
    {
        "sku": "SP-0",
        "stock": "10",
        "errors: [
            {"sku": "A product with the given SKU is not found."}
        ]
    },
    {
        "sku": "SP-1",
        "stock": "10",
        "errors: [
            {"sku": "A product with the given SKU is not found."}
        ]
    },
    {
        "sku": "SP-2",
        "stock": "10",
        "errors: [
            {"sku": "A product with the given SKU is not found."}
        ]
    },
    {
        "sku": "SP-3",
        "stock": "10",
        "errors: [
            {"sku": "A product with the given SKU is not found."}
        ]
    },
    {
        "sku": "SP-4",
        "stock": "10",
        "errors: [
            {"sku": "A product with the given SKU is not found."}
        ]
    },
    {
        "sku": "SP-5",
        "stock": "10",
        "errors: [
            {"sku": "A product with the given SKU is not found."}
        ]
    },
    {
        "sku": "SP-6",
        "stock": "10",
        "errors: [
            {"sku": "A product with the given SKU is not found."}
        ]
    },
    {
        "sku": "SP-7",
        "stock": "10",
        "errors: [
            {"sku": "A product with the given SKU is not found."}
        ]
    },
    {
        "sku": "SP-8",
        "stock": "10",
        "errors: [
            {"sku": "A product with the given SKU is not found."}
        ]
    },
    {
        "sku": "SP-9",
        "stock": "10",
        "errors: [
            {"sku": "A product with the given SKU is not found."}
        ]
    }
]
Example: https://akinon.com/imports/f3909f53-a535-40cc-8d50-de0cd047aedd-e.json
statusstring · enumOptional

Status of the batch import request. The values are;

  • (1) Pending: The batch request is queued up and waiting to be processed.
  • (2) Processing: The batch request is currently being actively processed.
  • (3) Succeeded: The batch request has been successfully completed for all records.
  • (4) Partially Succeeded: The batch request has been partially completed, with some records failing.
  • (5) Failed: The batch request has failed to complete.
Possible values:
processed_inintegerOptional

Time, in seconds, taken to process the batch request.

updated_atstring · date-timeOptional

Timestamp indicating when the batch request was last updated.

created_atstring · date-timeOptional

Timestamp indicating when the batch request was created.

get
/i2/products/batch-requests/{id}

Last updated

Was this helpful?