Retrieve a list of products

Authorizations

CLIENT-ID

string

header

required

API-KEY

string

header

required

API-PASSWORD

string

header

required

Query Parameters

limit

integer

default:

200

The number of products to return per page.

page

integer

default:

Page number of the products listing.

product_type

string

The type of product you would like returned, either physical or digital. Leave blank to return all products.

Response

200 - application/json

current_page

integer

The current page that you are on.

products

object[]

An array of products and their data.

products.additional_images

object[]

An array of URLs of the additional images for the product. This might be empty depending on the product.

products.attributes

object[]

Only available for variable products. An array of attribute details connected to the product.

products.digital_physical

string

Determine if the product is a Physical product or Digital product. This will either be physical or digital.

products.featured_image

string

A full URL of the main product image

products.price

string

Only available for simple products. This will be the price of the product

products.price_currency

string

Only available for simple products. This will be the currency that the price is in

products.product_description

string

Full description of the product.

products.product_id

integer

The product id used to identify the product on our site.

products.product_name

string

Full name of the product.

products.product_short_description

string

The short description of the product used to store important information about the product.

products.product_sku

string

The SKU of the product.

products.product_type

string

Determine if the product is a simple product or variable product with variable meaning that it has variations. This will either be simple or variable

products.product_vendor

object[]

An array of vendor details.

products.shipping_cost

string

The cost of shipping this item

products.shipping_details

object[]

An array of shipping details.

products.stock_qty

string

The total amount of stock available

products.stock_status

string

The stock status of the product and if it is in stock or not. Values can be either in_stock or out_of_stock

products.track_inventory

string

Will either be Y or N on if we track the inventory for this product

products.variations

object[]

Only available for variable products. An array of variations and prices connected to the product.

total_pages

integer

Total amount of pages.

total_products

integer

This is the total amount of products available for you to view and import.

total_products_in_query

integer

The total amount of products in this query.

API Reference

Products

Orders

Elliephant Credit

Authorizations

Query Parameters

Response