API - Products

The Products resource contains several methods that return product specific information.

Method Name: listProducts, listPreviousProducts, listNextProducts

Retrieve a list of our products. The list will contain 25 products at a time with links to the next and previous pages.

The methods listPreviousProducts and listNextProducts are pagination methods.

• Method: GET

• Parameters:

  • Limit — Min Value: 0, Max Value: 25.
  • Offset — Min Value: 0

• Request Headers: Accept, Authorization, Host

• Request Message Body: None

• Response Headers: Content-Length, Content-Type, Content-Location

• Response Message Body: List of products

• Response Status: 200, 400, 401, 403, 404

• Media Types:

  • application/vnd.koleimports.ds.product+xml
  • application/vnd.koleimports.ds.product+json

Request Parameters:

GET /products?limit=25&offset=0
Host: example.com 
Authorization: Basic {id}:{api_key} 
Accept: application/vnd.koleimports.ds.product+xml

Example CURL Request:

curl -H "Accept: application/vnd.koleimports.ds.product+xml" "https://{id}:{api_key}@api.koleimports.com/products?limit=1&offset=0"

Example Response:

HTTP/1.1 200 OK 
Content-Type: application/vnd.koleimports.ds.product+xml
Content-Length: 1804
Content-Location: https://api.koleimports.com/products?limit=25&offset=0

<?xml version="1.0" encoding="utf-8"?>
<products>
    <product>
        <sku></sku>
        <upc></upc>
        <title></title>
        <description></description>
        <type></type>
        <brand></brand>
        <colors></colors>
        <materials></materials>
        <attributes></attributes>
        <tags></tags>
        <category_id></category_id>
        <category></category>
        <subcategory_id></subcategory_id>
        <subcategory></subcategory>
        <inventory></inventory>
        <is_closeout></is_closeout>
        <unit_weight></unit_weight>
        <created></created>
        <modified></modified>
        <images>
            <image>
                <size></size>
                <url></url>
            </image>
        </images>
        <tiers>
            <tier>
                <quantity></quantity>
                <price></price>
            </tier>
        </tiers>
        <sale>
            <on_sale></on_sale>
            <sale_name></sale_name>
            <start_date></start_date>
            <end_date></end_date>
        </sale>
        <links>
            <link>
                <method></method>
                <media_type></media_type>
                <url></url>
            </link>
        </links>
    </product>
    <links>
        <link>
            <method>listNextProducts</method>
            <media_type>application/vnd.koleimports.ds.product+xml</media_type>
            <url>https://api.koleimports.com/products/?limit=25&amp;offset=25</url>
        </link>
    </links>
</products>

Response Field Definitions

The listProducts, listPreviousProducts and listNextProducts methods are collection methods. See getOrder for field definitions.

Method Name: getProduct

Retrieve information about a product by SKU.

• Method: GET

• Parameters: None

• Request Headers: Accept, Authorization, Host

• Request Message Body: None

• Response Headers: Content-Length, Content-Type, Content-Location

• Response Message Body: Product Information

• Response Status: 200, 400, 401, 403, 404

• Media Types:

  • application/vnd.koleimports.ds.product+xml
  • application/vnd.koleimports.ds.product+json

Request Parameters:

GET /products/{SKU}
Host: example.com 
Authorization: Basic {id}:{api_key} 
Accept: application/vnd.koleimports.ds.product+xml

Example CURL Request:

curl -H "Accept: application/vnd.koleimports.ds.product+xml" "https://{id}:{api_key}@api.koleimports.com/products/{SKU}"

Example Response:

HTTP/1.1 200 OK 
Content-Type: application/vnd.koleimports.ds.product+xml
Content-Length: 1804
Content-Location: https://api.koleimports.com/products/{SKU}

<?xml version="1.0" encoding="utf-8"?>
<product>
    <sku></sku>
    <upc></upc>
    <title></title>
    <description></description>
    <type></type>
    <brand></brand>
    <colors></colors>
    <materials></materials>
    <attributes></attributes>
    <tags></tags>
    <category_id></category_id>
    <category></category>
    <subcategory_id></subcategory_id>
    <subcategory></subcategory>
    <inventory></inventory>
    <is_closeout></is_closeout>
    <unit_weight></unit_weight>
    <created></created>
    <modified></modified>
    <images>
        <image>
            <size></size>
            <url></url>
        </image>
    </images>
    <tiers>
        <tier>
            <quantity></quantity>
            <price></price>
        </tier>
    </tiers>
    <sale>
        <on_sale></on_sale>
        <sale_name></sale_name>
        <start_date></start_date>
        <end_date></end_date>
    </sale>
    <links>
        <link>
            <method></method>
            <media_type></media_type>
            <url></url>
        </link>
    </links>
</product>

Response Body Field Definitions