GetInventoryListWithFilter

Return a filtered list of sourced products

Call

https://app.avasam.com/apiseeker/ProductModule/GetInventoryListWithFilter

Parameters

The header details for this call are as follows:

Field name

Type

Description

Is Required

Supplier

string

Search for SKU name or product title text

False

Sortby

string

Header field name to sort results by

True

SortStatus

string

Define order to sort by column field (Ascending/descending)

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

PriceDelimeter

string

Used to filter by price by returning an operator, such as >

False

PriceValue

Double

Used to filter by price by specifying the number value to go with PriceDelimeter

False

StockValue

string

Used to filter by stock level by returning an operator, such as >

False

Stock

Double

Used to filter by stock level by specifying the number value to go with StockValue

False

Variation

string

Return only Variations (true/false)

False

Category

string

Search category filter data using category id

False

CategoryName

string

Search category filter data using category name

False

IsMapped

string

Return only mapped products (True/false) Used value only ‘Yes’ or ‘No’

False

PriceMaxValue

string

Used to filter by price by returning a second operator, such as >

False

PriceMaxDelimeter

Double

Used to filter by price by specifying the number value to go with PriceMaxValue

False

page

int

Specifies the page number to return (eg ‘Page 3’ returns records between 20 and 29 inclusive)

True

The call is structured as follows:

Request body

{

"Supplier":"",
"Sortby":"SKU",
"SortStatus":"down",
"limit":"10",
"PriceDelimeter":"0",
"PriceValue":0,
"StockValue":"0",
"Stock":0,
"Variation":"",
"Category":"",
"CategoryName":"",
"IsMapped":"",
"PriceMaxValue":0,
"PriceMaxDelimeter":"0",
"page":0
}

Response

Field

Type

Description

data

List<SellerProductListDetailsModel>

Displays a list of the item’s product data

total

long

Display product data total count

SellerProductListDetailsModel

Field

Type

Description

GetUpdatePrice

object

Display price update value

_id

string

Display product unique id

SKU

string

Display product SKU name

Price

double

Display product price value

RetailPrice

double

Display product retail price value

Title

string

Display product title name

image

string

Display product image path link

IsActive

bool

Display product active yes

Category

string

Display product category name

CategoryId

string

Display for the category id

CreateOn

DateTime

Display for the product create date time

UpdateOn

DateTime

Display product updated date time

Type

SellerProductType

Display seller product type value – WishList, Product

limit

int

Display product limit total count

page

int

Display product page number

ListingStatus

string

Display product listing status name

IsCreatedInLinnworks

bool

Display if product created in Linnworks(yes/no)

Stock

int

Display product stock value

Number

string

Display product’s Avasam SKU

HasVariations

bool

Display product parent product data yes or no

Listings

List<SellerListings>

Display seller listing data list

VATPercentage

double

Display product VAT percentage

PriceIncVat

double

Display product price including VAT

RetailPriceIncVat

double

Display product retail price (RRP) including VAT

description

string

Display product description

isMapped

bool

Product mapped to listing(yes/no)

authkey

string

Display supplier unique code

Shipperid

string

Display supplier unique id

seekerid

string

Display seller unique id

SellerListings

Field

Type

Description

Channel

string

Display listing channel name

Account

string

Display listing channel account name

Status

string

Display channel status name like (‘Listed Externally’, ‘Listed’, ‘Error’)

RefrenceId

string

Display listing channel reference unique id

Error

List<string>

Display listing channel error list

Response body

The response from Avasam will come in the following form:

{

"data":

[{

"GetUpdatePrice":null,

"_id":"00000000-0000-0000-0000-000000000000",

"SKU":"2358Green",

"Price":4.68,

"RetailPrice":6.55,

"Title":"50ft Expandable Garden Hose - Green HOSE-50FT",

"image":"https://avasam.s3.amazonaws.com/avasam/GB010001/57bed52d-c21b-4b10-bde8-c6041ed8a8b4.jpg",

"IsActive":false,

"Category":"Home & Garden",

"CategoryId":"22",

"CreateOn ":"0001-01-01T00:00:00",

"UpdateOn":"0001-01-01T00:00:00",

"Type":0,

"limit":0,

"page":0,

"ListingStatus":"",

"IsCreatedInLinnworks":false,

"Stock":400,

"Number":"ZIZ002358_Green",

"HasVariations":false,

"Listings":[{

   Channel: "Shopify",

   Account: "TestAVASAM_Inttest",

   Status: "Error",

   RefrenceId: "",

   Error: ["You need to add option values for Title"]

}],

"VATPercentage":20.0,

"PriceIncVat":5.616,

"RetailPriceIncVat":0.0,

"description":null,

"isMapped":false,

"authkey":"",

"shipperid":"",

"seekerid":"00000000-0000-0000-0000-000000000000"

}],

"total":131

}