1. API
  2. Supplier API

NewGetCustProductListWithSupplierCode

Retrieve product information from Avasam

You can retrieve information about one or more product with this command. 'SearchKeyWord' can be a full or partial SKU or product name.

 

Call

https://app.avasam.com/api/ProductCatalog/NewGetCustProductListWithSupplierCode/Select/GB010003/Test56789/0/10/SKU/up

 

Parameters

The header details for this call are as follows:

Field name

Type

Description

Is Required

Description

CustProId

string

Specify the product ID (filter list)

False

This value is returned by the login method for authorising access to the API

CustSupplierCode

string

Specify the specific supplier code (filter list)

True

This value is returned by ‘GetCustomerList’, and represents the seller

SKU

string

Search by product IDor product title

True

Product name or SKU

page

int

Define the page number to return from the search

True

Page number. Where you have specified a page size limit (‘Limit’), you should specify which page you want in the call. If ‘Limit’ is specified, you must specify ‘Page Number’

limit

int

Define the max number of records per page (eg ‘10’ would return 10 per page, so 120 would return 12 pages)

True

The maximum number of records returned per page by a single call. A call including ‘Limit’ also requires ‘Page Number’

sortby

string

Specify a field name to sort the list returned by that field

True

 

sorttype

string

Specify the direction of the sort from sortby (up, down)

True

 

Request body

{

"CustProId":"Select",    
"CustSupplierCode":"GB0103",    
"SKU":" Test56789",  
"page":"0",  
"Limit":"10",  
"sortby": "SKU",  
"sorttype": "up"
}

Response

Field

Type

Description

data

List<ProductFeed>

Display search product data list (See ProductFeed)

total

Long

Display search product data total record count

HasError

bool

Display if there was an error (yes or no)

Message

string

Display search status message

ProductFeed

Field

Type

Description

_id

string

Displays current ow number

SKU

string

Displays the product supplier SKU name

Number

string

Displays the product’s Avasam number

Price

double

Display the product price

Costprice

double

Display the product cost price

Title

string

Display the product title

BarCode

string

Display for the barcode value

Vat

double

Display for the product’s VAT rate

PackQty

int

Display the quantity of the product in stock/available

Image

string

Display the product’s main image path

Video

string

Display the product video link

IsActive

bool

Display the boolean value

IsVarP

bool

Display if the product is a variation parent (yes or no)

SKUSmall

string

Product stock zero at a time value display ‘Product is out of stock’ otherwise blank value

StockUpdateOn

DateTime

Display the date and time the stock level was last updated

PriceUpdateOn

DateTime

Display the date and time the cost price was last updated

Category

string

Display for the category name

CategoryId

string

Display for the category id

Response body

The response from Avasam will come in the following form:

{

"data":

[{

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

        "SKU":"Test56789",

        "Number":"S036570016",

        "Price":12.0,

        "costprice":23.0,

        "Title":"New Product T-shirt",

        "BarCode":null,

        "Vat":20.0,

        "PackQty":0,

        "image":"https://avasam.s3.amazonaws.com/avasam/05d86d7a-326e-47e9-b391-688579013619/07b2e4c3-b223-4caf-a556-147761eeca44.jpg",

        "video":null,

        "IsActive":false,

        "IsVarP":false,

        "SKUSmall":"Product is out of stock",

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

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

        "Category":null,

        "CategoryId":null

}],

"total":1,

"HasError":true,

"Message":""

}