Returns full details of the products in the seller's inventory
Call
https://app.avasam.com/apiseeker/Products/GetSellerProductList
When using the Avasam API, remember that it must be called correctly, using the appropriate method (such as POST) described in this article, and with a valid token (Which can be obtained using the Login call). Otherwise the server may return an error.
Parameters
The header details for this call are as follows:
| Field name | Type | Description | Is Required |
|---|---|---|---|
| Page | Int | Specifies the page number to return (eg ‘Page 3’ returns records between 20 and 29 inclusive) | true |
| Limit | Int | Define the max number of records per page (eg ‘10’ would return 10 per page, so 120 returns would be 12 pages) | true |
Request Body
The call is structured as follows:
{
"Page":0,
"Limit":10
}
Response
| Field name | Type | Description |
|---|---|---|
| SKU | String | Returns the SKU for the item in this row |
| Price | Int | Displays the item’s cost price to sellers |
| Title | String | Displays the item’s title |
| BarCode | String | Displays the item’s unique Barcode (EAN,ISBN, etc) |
| Vat | Int | Displays the item’s sales tax/VAT rate as a percentage |
| Customer Group | String | Displays the item’s affiliated Customer Group (if any) |
| Image | String | Displays the path to the item’s main image |
| Category | String | Displays the item’s assigned category in the inventory |
| Description | String | Displays the item’s description |
| Minimum Level | Int | Displays the item’s minimum stock level for stock control/reordering purpose |
| Retail Price | Double | Displays the item’s RRP |
| Product Depth | Double | Displays the item’s size (Depth) |
| Product Weight | Double | Displays the item’s weight |
| Product Width | Double | Displays the item’s size (Width) |
| Height | Double | Displays the item’s size (Height) |
| Product Image | String | Displays the path to the item’s image |
| Extended Properties | ExtendedProperties | Displays a list of the item’s extended properties (product specifics) |
| Is Variation | Boolean | Confirms whether the current SKU is a Variation Parent |
| Variations | Variations | Displays the list of items who are a part of this variation if ‘IsVariation’=true |
| Multi Title | MultiTitle | Displays the item’s other titles if multiple titles are associated with it |
| Multi Description | MultiDescription | Displays the item’s other descriptions if multiple descriptions are associated with it |
| Category Id | String | Displays the ID number of the item’s assigned category |
Extended properties
| Field name | Type | Description |
|---|---|---|
| Name | String | Displays the title of the item’s current Extended Property in the list |
| Value | String | Displays the value of the item’s current Extended Property in the list |
Variations
| Field name | Type | Description |
|---|---|---|
| SKU | String | Displays the SKU of the item currently shown in the list of variations |
| Title | String | Displays the title of the item currently shown in the list of variations |
| Is Active | Int | Displays the status (Active (1)/Inactive(0)) of the item currently shown in the list of variations |
| Is Selected | Int | Displays the status (Yes (1)/No (0)) of the item currently shown in the list of variations |
Multi title
| Field name | Type | Description |
|---|---|---|
| en | String | Displays the title(s) of the item currently selected as part of a list |
Multi description
| Field name | Type | Description |
|---|---|---|
| en | String | Displays the description(s) of the item currently selected as part of a list |
Response body
The response from Avasam will come in the following form:
[
{
"SKU": "Food1",
"Price": 20.0,
"Title": "Food Cookies1",
"BarCode": "66666666",
"Vat": 1.0,
"CustomerGroup": "Seller Group",
"Image": "https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg",
"Category": "Food1.0",
"Description": "A cookie is a baked or cooked food that is small, flat and sweet. It usually contains flour, sugar and some type of oil or fat. It may include other ingredients such as raisins, oats, chocolate chips, nuts, etc. ... Cookies are often served with beverages such as milk, coffee or tea.",
"MinimumLevel": 60,
"RetailPrice": 30.0,
"ProductDepth": 0.5,
"ProductWeight": 1.5,
"ProductWidth": 4.3,
"Height": 1.15,
"ProductImage": [
"https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg",
"https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg"
],
"ExtendedProperties": [
{
"Name": "Color",
"Value": "Black"
}
],
"IsVariation": false,
"Variations": null,
"MultiTitle": {
"en": "Food Cookies1"
},
"MultiDescription": {
"en": "A cookie is a baked or cooked food that is small, flat and sweet. It usually contains flour, sugar and some type of oil or fat. It may include other ingredients such as raisins, oats, chocolate chips, nuts, etc. ... Cookies are often served with beverages such as milk, coffee or tea."
},
"CategoryId": "7f53d458-43cb-4b58-9e70-248e14003f0f"
},
{
"SKU": "Electronics1",
"Price": 30.0,
"Title": "Electronics item1",
"BarCode": "85749612",
"Vat": 1.0,
"CustomerGroup": "Seller Group",
"Image": "https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg",
"Category": "Electronics",
"Description": "Electrical equipment includes any machine powered by electricity. It usually consists of an enclosure, a variety of electrical components, and often a power switch.",
"MinimumLevel": 60,
"RetailPrice": 50.0,
"ProductDepth": 0.5,
"ProductWeight": 1.5,
"ProductWidth": 4.3,
"Height": 1.15,
"ProductImage": [
"https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg",
"https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg"
],
"ExtendedProperties": [
{
"Name": "Color",
"Value": "Gray"
}
],
"IsVariation": false,
"Variations": null,
"MultiTitle": {
"en": "Electronics item1"
},
"MultiDescription": {
"en": "Electrical equipment includes any machine powered by electricity. It usually consists of an enclosure, a variety of electrical components, and often a power switch."
},
"CategoryId": "13fff481-2e63-4f38-b66a-13c5015617d6"
},
{
"SKU": "Electronics6",
"Price": 35.0,
"Title": "Electronics item6",
"BarCode": "98765474",
"Vat": 6.0,
"CustomerGroup": "Seller Group",
"Image": "https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg",
"Category": "Electronics",
"Description": "Electrical equipment includes any machine powered by electricity. It usually consists of an enclosure, a variety of electrical components, and often a power switch.",
"MinimumLevel": 50,
"RetailPrice": 65.0,
"ProductDepth": 0.5,
"ProductWeight": 1.5,
"ProductWidth": 4.3,
"Height": 1.15,
"ProductImage": [
"https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg",
"https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg"
],
"ExtendedProperties": [
{
"Name": "Color",
"Value": "Orange"
}
],
"IsVariation": false,
"Variations": null,
"MultiTitle": {
"en": "Electronics item6"
},
"MultiDescription": {
"en": "Electrical equipment includes any machine powered by electricity. It usually consists of an enclosure, a variety of electrical components, and often a power switch."
},
"CategoryId": "13fff481-2e63-4f38-b66a-13c5015617d6"
},
{
"SKU": "Sports & Outdoors 1",
"Price": 50.0,
"Title": "Sports & Outdoors Game",
"BarCode": "95475632",
"Vat": 1.0,
"CustomerGroup": "Seller Group",
"Image": "https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg",
"Category": "35160",
"Description": "This genre has been popular throughout the history of video games and is competitive, just like real-worldsports.",
"MinimumLevel": 40,
"RetailPrice": 95.0,
"ProductDepth": 2.6,
"ProductWeight": 1.9,
"ProductWidth": 5.3,
"Height": 6.23,
"ProductImage": [
"https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg",
"https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg"
],
"ExtendedProperties": [
{
"Name": "Default",
"Value": "Default value"
}
],
"IsVariation": false,
"Variations": null,
"MultiTitle": {
"en": "Sports & Outdoors Game"
},
"MultiDescription": {
"en": "This genre has been popular throughout the history of video gamesand is competitive, just like real-worldsports."
},
"CategoryId": "35160"
},
{
"SKU": "K314CP",
"Price": 16.66,
"Title": "2 pc. Frying Pan Set",
"BarCode": "5.06005E+12",
"Vat": 20.0,
"CustomerGroup": "Samcom Micro",
"Image": "https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg",
"Category": "25105102",
"Description": "This set of 2 frying pans have the added benefit of innovative Cermalon ceramic coating which creates a non-stick base, allowing you to cook without fats and oils, in turn giving you healthier meals.",
"MinimumLevel": 3,
"RetailPrice": 24.99,
"ProductDepth": 35.0,
"ProductWeight": 1.25,
"ProductWidth": 59.0,
"Height": 16.0,
"ProductImage": [
"https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/787bd216-59fc-47d5-9466-2262dc59510a.jpg"
],
"ExtendedProperties": null,
"IsVariation": false,
"Variations": null,
"MultiTitle": {
"en": "2 pc. Frying Pan Set"
},
"MultiDescription": {
"en": "This set of 2 frying pans have the added benefit of innovative Cermalon ceramic coating which creates a non-stick base, allowing you to cook without fats and oils, in turn giving you healthier meals."
},
"CategoryId": "25105102"
}
]
Tips
- Store the ‘Token’ value separately for repeated use in other calls until it expires.
- Store the ‘ClientID’ value for later calls.
- API Access calls are not counted against your API rate limit.
- Use the ‘End Point’ URL for any API calls following this result.