Skip to main content

Seller API

Request-token - Authentication token for API

You need to request a valid token for your API calls using your consumer and secret keys

Confirm your authorisation to access data through the API by requesting a token.

Returns authorisation token and ClientID.

Call

https://app.avasam.com/api/auth/request-token

tip

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. Otherwise the server may return an error.

Parameters

The header details for this call are as follows:

FieldTypeDescriptionIs Required
Consumer_keystringRequested from user management in AvasamTrue
secret_keystringRequested from user management in AvasamTrue

Request body

You must first get a consumer key and secret key from your seller account first.

The call is structured as follows:

{  
"consumer_key":string,
"secret_key":string
}

Response

FieldTypeDescriptionNotes
access_tokenStringAccess token for API callsEssential for seller API calls to the account
expires_atStringTime and date to request new token

Response body

The response from Avasam will come in the following form:

{  
"access_token": "1111111-1111-1111-1111-111111111111",
"expires_at": "2021-12-22T17:36:19.8066912+00:00"
}

Tips

  • Store the ‘access_token’ value separately for repeated use in other calls until it expires.
  • Store the "expires_at" value to ensure that you can request a new token when the current one expires.
  • Authentication calls are not counted against your API rate limit.

Creating an API key to use the Avasam API

To use the Avasam API to integrate with your seller account, you must first create an API key

If you need to create a new key, and have not created one previously

  1. Click on settings.
  2. Select the user management option.
  3. Click the API keys button in top right corner of the screen.
  4. If you cannot see the consumer key and secret key fields, click on the eye icons to reveal them.
  5. Click on the generate key button.
  6. You will be returned to the user list.
  7. Copy the consumer key and secret key fields for use in API calls.
  8. Click on the user name to open the details of the account including API details.
  9. You can control the rights given by apps using the API keys, in the access rights section.
    1. By default the system will assign basic rights. You can turn rights on or off to match the needs for your usage.
  10. Click save if you make any changes to apply them.

If you need to use webhooks with an API key

  1. Create a key using the above method if you haven't done so already.
  2. Click on the account user name to open the account details.
  3. Scroll down to the webhook section.
  4. Enter the verification token.
  5. Enter the stock update endpoint location and click test to verify. This is the location Avasam will send stock update notifications to for your sourced products when their stock levels change.
    1. If an error is returned, please check the location you have entered is correct before clicking test again.
  6. Enter the price update endpoint location and click test to verify.
    1. If an error is returned, please check the location you have entered is correct before clicking test again.
  7. Click save to apply the updated configuration.
tip

Verification token: You can create a JWT token to verify requests.

You can verify a request using the Request ID in the request and the Request ID in the JWT payload.

tip

Request body: (Content type: Application/json)

{  
requestId:string (Request id for verify jwt data is correct or not),
on: DateTime (UTC request sent time),
token:string (jwt token created using verification token provided in configuration)
data:[
(List of products which stock has change)
{
sku:string (Product sku),
quantity:int (New product quantity),
updatedOn:DateTime (When stock updated)
}
]
}

Response body: 200 (OK)
When you receive this notification you need to acknowledge it using the Avasam API:
api-seller/Product/AcknowledgeStockUpdate

CreateSellerOrder

Create a new order for one of your customers

Call

https://app.avasam.com/apiseeker/Order/CreateSellerOrder

tip

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:

FieldTypeDescriptionIs Required
AuthkeystringAuthorization key for the Avasam accounttrue
Reference NumberstringAvasam order reference numbertrue
Shipping Service NamestringSeller’s shipping service name as configured in Avasamtrue
NotesstringOrder notesfalse

Item list

FieldTypeDescriptionIs Required
SKUstringAvasam SKU of product in ordertrue
StockIntegerNumber of products specified in ordertrue

Delivery Info

FieldTypeDescriptionIs Required
NameStringRecipient of ordertrue
AddressStringPostal address for order order (Street and number, flat, etctrue
CityStringPostal town or city for ordertrue
CountryStringCountry to deliver ordertrue
Post CodeStringPostcode for order deliverytrue
Phone NoStringContact phone number for ordertrue
EmailStringEmail address for orderfalse

Request body

The call is structured as follows:

{
"Authkey":"f24822fdFae74F4c",
"ReferenceNumber":"ODS1435627",
"Itemlist":[
{
"SKU":"Accesorry Stand Kitch",
"Stock":2
},
{
"SKU":"K312CP",
"Stock":5
}
],
"ShippingServiceName":"Test Demo",
"Notes":"Test Notes 0411",
"DeliveryInfo": {
"Address":"UK",
"City":"London",
"Country":"United Kingdom",
"Name":"Ollie",
"PhoneNo":"09876543212",
"PostCode":"NW10 7JB",
"Email":"[email protected]"
}
}

Response

FieldTypeDescription
Error CodeintError code of order response 0 = no error 1 = error
MessageStringError body for order request
idIntAlways returns 0

Response body

The response from Avasam will come in the following form:

{
"ErrorCode": 0,
"Message": "Order created successfully.",
"id": 0
}

GetSellerProductList

Returns full details of the products in the seller's inventory

Call

https://app.avasam.com/apiseeker/Products/GetSellerProductList

tip

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:

FieldTypeDescriptionIs Required
PageIntSpecifies the page number to return (eg ‘Page 3’ returns records between 20 and 29 inclusive)true
LimitIntDefine 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

FieldTypeDescription
SKUStringReturns the SKU for the item in this row
PriceIntDisplays the item’s cost price to sellers
TitleStringDisplays the item’s title
BarCodeStringDisplays the item’s unique Barcode (EAN,ISBN, etc)
VatIntDisplays the item’s sales tax/VAT rate as a percentage
Customer GroupStringDisplays the item’s affiliated Customer Group (if any)
ImageStringDisplays the path to the item’s main image
CategoryStringDisplays the item’s assigned category in the inventory
DescriptionStringDisplays the item’s description
Minimum LevelIntDisplays the item’s minimum stock level for stock control/reordering purpose
Retail PriceDoubleDisplays the item’s RRP
Product DepthDoubleDisplays the item’s size (Depth)
Product WeightDoubleDisplays the item’s weight
Product WidthDoubleDisplays the item’s size (Width)
HeightDoubleDisplays the item’s size (Height)
Product ImageStringDisplays the path to the item’s image
Extended PropertiesExtendedPropertiesDisplays a list of the item’s extended properties (product specifics)
Is VariationBooleanConfirms whether the current SKU is a Variation Parent
VariationsVariationsDisplays the list of items who are a part of this variation if ‘IsVariation’=true
Multi TitleMultiTitleDisplays the item’s other titles if multiple titles are associated with it
Multi DescriptionMultiDescriptionDisplays the item’s other descriptions if multiple descriptions are associated with it
Category IdStringDisplays the ID number of the item’s assigned category

Extended properties

FieldTypeDescription
NameStringDisplays the title of the item’s current Extended Property in the list
ValueStringDisplays the value of the item’s current Extended Property in the list

Variations

FieldTypeDescription
SKUStringDisplays the SKU of the item currently shown in the list of variations
TitleStringDisplays the title of the item currently shown in the list of variations
Is ActiveIntDisplays the status (Active (1)/Inactive(0)) of the item currently shown in the list of variations
Is SelectedIntDisplays the status (Yes (1)/No (0)) of the item currently shown in the list of variations

Multi title

FieldTypeDescription
enStringDisplays the title(s) of the item currently selected as part of a list

Multi description

FieldTypeDescription
enStringDisplays 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.

GetInventoryListWithFilter

Return a filtered list of sourced products

Call

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

tip

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 nameTypeDescriptionIs Required
SupplierstringSearch for SKU name or product title textFalse
SortbystringHeader field name to sort results byTrue
SortStatusstringDefine order to sort by column field (Ascending/descending)True
limitintDefine the max number of records per page (eg ‘10’ would return 10 per page, so 120 returns would be 12 pages)True
PriceDelimeterstringUsed to filter by price by returning an operator, such as >False
PriceValueDoubleUsed to filter by price by specifying the number value to go with PriceDelimeterFalse
StockValuestringUsed to filter by stock level by returning an operator, such as >False
StockDoubleUsed to filter by stock level by specifying the number value to go with StockValueFalse
VariationstringReturn only Variations (true/false)False
CategorystringSearch category filter data using category idFalse
CategoryNamestringSearch category filter data using category nameFalse
IsMappedstringReturn only mapped products (True/false) Used value only ‘Yes’ or ‘No’False
PriceMaxValuestringUsed to filter by price by returning a second operator, such as >False
PriceMaxDelimeterDoubleUsed to filter by price by specifying the number value to go with PriceMaxValueFalse
pageintSpecifies 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

FieldTypeDescription
dataList - SellerProductListDetailsModelDisplays a list of the item’s product data
totallongDisplay product data total count

SellerProductListDetailsModel

FieldTypeDescription
GetUpdatePriceobjectDisplay price update value
_idstringDisplay product unique id
SKUstringDisplay product SKU name
PricedoubleDisplay product price value
RetailPricedoubleDisplay product retail price value
TitlestringDisplay product title name
imagestringDisplay product image path link
IsActiveboolDisplay product active yes
CategorystringDisplay product category name
CategoryIdstringDisplay for the category id
CreateOnDateTimeDisplay for the product create date time
UpdateOnDateTimeDisplay product updated date time
TypeSellerProductTypeDisplay seller product type value – WishList, Product
limitintDisplay product limit total count
pageintDisplay product page number
ListingStatusstringDisplay product listing status name
IsCreatedInLinnworksboolDisplay if product created in Linnworks(yes/no)
StockintDisplay product stock value
NumberstringDisplay product’s Avasam SKU
HasVariationsboolDisplay product parent product data yes or no
ListingsList- SellerListings-Display seller listing data list
VATPercentagedoubleDisplay product VAT percentage
PriceIncVatdoubleDisplay product price including VAT
RetailPriceIncVatdoubleDisplay product retail price (RRP) including VAT
descriptionstringDisplay product description
isMappedboolProduct mapped to listing(yes/no)
authkeystringDisplay supplier unique code
ShipperidstringDisplay supplier unique id
seekeridstringDisplay seller unique id

SellerListings

FieldTypeDescription
ChannelstringDisplay listing channel name
AccountstringDisplay listing channel account name
StatusstringDisplay channel status name like (‘Listed Externally’, ‘Listed’, ‘Error’)
RefrenceIdstringDisplay listing channel reference unique id
ErrorListDisplay 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

}

AddNewOrder

Create a new order in Avasam

Call

https://app.avasam.com/apiseeker/OrdersCreation/AddNewOrder

tip

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:

FieldTypeDescriptionIs Required
GeneralInfoGeneralInfoModelUsed for general detail dataTRUE
CustomerInfoAddressModelUsed for customer detail dataTRUE
CustomerTypeStringAlways blankFALSE
ItemsList - ItemModelUsed for order item detailTRUE
ShippingservicenameStringUsed for shipping service nameTRUE
ShippingserviceidStringUsed for shipping service idTRUE
ShippingservicechargeStringUsed for shipping service charge valueTRUE
SupplierCodeStringAlways blankFALSE
NotesStringUsed for order note detailsFALSE
OrderTypeStringUsed for order type detail create order time only one type used like – ‘Queue’TRUE
IsSelfboolAlways falseFALSE

GeneralInfoModel

FieldTypeDescriptionIs Required
ReferenceNumStringUsed for order reference numberTRUE
ReceivedDateDateTimeUsed for order creation date timeTRUE
NameStringUsed for delivery customer full nameTRUE
FirstNameStringUsed for delivery customer first nameTRUE
SurNameStringUsed for customer surnameTRUE
AddressStringUsed for shipping addressTRUE
CityStringUsed for shipping city nameTRUE
PostCodeStringUsed for shipping post codeTRUE
CountyStringUsed for shipping country nameTRUE
PhoneNoStringUsed for customer phone numberFALSE
EmailStringUsed for delivery customer email idFALSE
ErrorList -StringAlways blankFALSE
SourceStringUsed for order’s source nameTRUE
SubSourceStringUsed for order’s subsource nameFALSE

AddressModel (CustomerInfo)

FieldTypeDescriptionIs Required
ReferenceNumStringUsed for order reference numberTRUE
ReceivedDateDateTimeUsed for order creation date timeTRUE
NameStringUsed for delivery customer full nameTRUE
FirstNameStringUsed for delivery customer first nameTRUE
SurNameStringUsed for customer surnameTRUE
AddressStringUsed for shipping addressTRUE
CityStringUsed for shipping city nameTRUE
PostCodeStringUsed for shipping post codeTRUE
CountyStringUsed for shipping country nameTRUE
PhoneNoStringUsed for customer phone numberFALSE
EmailStringUsed for delivery customer email idFALSE
ErrorList -StringAlways blankFALSE
SourceStringUsed for order’s source nameTRUE
SubSourceStringUsed for order’s subsource nameFALSE

ItemModel

FieldTypeDescriptionIs Required
_idStringUsed for item unique idFALSE
SKUStringUsed for product Avasam SKU numberTRUE
NumberstringUsed for product Avasam SKUTRUE
PriceDoubleUsed for product priceTRUE
CostpriceDoubleUsed for product cost priceTRUE
TitleStringUsed for Product title valueTRUE
BarCodeStringUsed for product barcode valueFALSE
VatDoubleUsed for product vat valueTRUE
PackQtyintUsed for create order in use product count valueTRUE
ImageStringUsed for product image pathTRUE
AuthkeyStringUsed for supplier codeTRUE
IsSelectedboolUsed to show if product is selected (yes/no)TRUE
ActualPackQtyintUsed for product pack quantityTRUE
VatPerDoubleUsed for product VAT valueTRUE
DiscountPerdoubleUsed for discount per product valueTRUE

Request body

The call is structured as follows:

{  

"GeneralInfo":

{

"ReferenceNum":"ODS8267541",

"ReceivedDate":"21/01/2021 15:00",

"Name":"MrUser",

"FirstName":"Mr",

"SurName":"User",

"Address":"9, big circle society,OP Road",

"City":"Park Royal",

"PostCode":"NW10 7JB",

"County":"United Kingdom",

"PhoneNo":"+4433011377",

"Email":"[email protected]",

"Error":[],

"Source":"Avasam",

"SubSource":""

},

"CustomerInfo":

{

"ReferenceNum":"ODS8267541",

"ReceivedDate":"21/01/2021 15:00",

"Name":"MrUser",

"FirstName":"Mr",

"SurName":"User",

"Address":"9, big circle society,OP Road",

"City":"Park Royal",

"PostCode":"NW10 7JB",

"County":"United Kingdom",

"PhoneNo":"+4433011377",

"Email":"[email protected]",

"Error":[],

"Source":"Avasam",

"SubSource":""

},

"CustomerType":"",

"Items":
[
{

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

"SKU":"S036570016",

"Number":"S036570016",

"Price":12,

"costprice":23,

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

"BarCode":null,

"Vat":20,

"PackQty":1,

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

"authkey":"GB010003",

"IsSelected":true,

"ActualPackQty":220,

"VatPer":20,

"DiscountPer":5

}
],

"shippingservicename":"Expedited Tracked ( 1 to 2 days)",

"shippingserviceid":"1",

"shippingservicecharge":12.5,

"SupplierCode":"select",

"Notes":"New order create.",

"OrderType":"Queue",

"IsSelf":false

}

Response

FieldTypeDescription
ErrorCodeintError code of order response: 0 = no error: 1 = error
MessageStringError body for order request
idintAlways returns 0

Response body

The response from Avasam will come in the following form:

{  
"ErrorCode": 0,
"Message":
"Order created successfully.","id": 0
}

SellerStockList

Retrieve information about your products

Call

https://app.avasam.com/apiseeker/Products/SellerStockList

tip

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:

FieldTypeDescriptionIs Required
LimitintDefine the max number of records per page (eg ‘10’ would return 10 per page, so 120 returns would be 12 pages)True
PageintSpecifies the page number to return (eg ‘Page 3’ returns records between 20 and 29 inclusive)True

Request body

The call is structured as follows:

{
"limit":10,
"page":0
}

Response

FieldTypeDescription
SKUStringAvasam SKU for the product
StockIntegerStock level for product in Avasam.

Response body

The response from Avasam will come in the following form:

[
{
"SKU": "Giorgio Armani.",
"Stock": 1477
},
{
"SKU": "Hard Disk 1TB",
"Stock": 500
},
{
"SKU": "Himalaya",
"Stock": 1491
},
{
"SKU": "Lee Cooper",
"Stock": 1443
},
{
"SKU": "Nike Shoes",
"Stock": 1499
},
{
"SKU": "Printer",
"Stock": 1438
},
{
"SKU": "Saint Lauren",
"Stock": 1497
},
{
"SKU": "Puma",
"Stock": 1450
},
{
"SKU": "Samsung A7 Mobile",
"Stock": 655
},
{
"SKU": "Skemi",
"Stock": 0
}
]

GetProcessOrderList

Retrieve a list of orders that have been processed

Call

https://app.avasam.com/apiseeker/OrdersView/SeekerGetOrdersListWithFilter

tip

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.

Request

FieldTypeDescriptionIs Required
FromDateDateTimeShows the earliest date of order(s) to dispatchTRUE
ToDateDateTimeShows latest date of order(s) to dispatchTRUE
DateDispalystringSpecify order dispatch period name (Today, Last 7 days, etc...)TRUE
CustomerstringOrder search value – Filter by Customer nameFALSE
OrderStatusstringFilter orders by status (eg -Dispatch)TRUE
PaymentStatusstringUsed to filter by payment status list – Paid, UnPaidFALSE
SortbystringUsed to specify sort order (up & down) – see SortStatusTRUE
SortStatusstringSpecify field title to sort byTRUE
limitintSpecify max response data size – limit as no of responses (10, 25, 60, 100 )TRUE
pageintSpecify page numberTRUE

Request body

The call is structured as follows:

{
"FromDate":"2020-11-21T18:30:00.000Z",
"ToDate":"2021-01-21T13:51:48.281Z",
"DateDispaly":"Last 60 days",
"Customer":"",
"OrderStatus":"Dispatch",
"PaymentStatus":"All",
"Sortby":"ChRecdDate",
"SortStatus":"down",
"limit":"60",
"page":0
}

Response

FieldTypeDescription
dataList - AvasamOrder>Display order dispatch detail list
TotallongDisplay total dispatched order count
AuthkeystringDisplay supplier unique id
OrderTicketList - OrderTicketListDisplay ordertickets list
Process Date TimeStringShows the date and time the order was marked as processed.

AvasamOrder

FieldTypeDescription
_idstringDisplay the dispatch order unique id
NumberstringDisplay the dispatch order number
SellerRefstringDisplay the order reference number
SellerOrderIdstringDisplay the order reference number (where channel returns multiple values)
SellerOtherRefstringDisplay the seller reference number(where channel returns multiple values)
SupplierRefstringAlways blank
SupplierOrderIdstringAlways blank
SupplierOtherRefstringDisplay the If supplier uses other order management software (any extra id required to handle order status)
IsChildboolIf order is merged or split and order is a child then this is "True", else "False"
ParentIdstringIf order is merged or split then show main order id where order is merged or split from
IsParentboolIf order is merged or split and order is the parent then this is "True", else "False"
StatusOrderStatusDisplay the order status value list like (QUEUE, AWAITING_PAYMENT, DRAFT, CREATED, ERROR, CANCELLED_REQUEST, CANCELLED, DISPATCH_QUEUE, DISPATCH, RETURN_REQUEST, RETURN, QUEUE_EDIT, AWAITING_PAYMENT_EDIT, UPDATE_PENDING_SUPPLIER, CREATE_PENDING_SUPPLIER, DISPATCH_ERROR, REPAYMENT, MERGE, INPROCESS, CANCEL_PARTIAL_ORDER)
PaymentStatusstringDisplay the order payment status like – Paid, UnPaid
ChannelstringDisplay the channel name
AccountstringDisplay the channel account name
InvIdstringDisplay the order invoice unique id
InvNumberstringDisplay the order invoice number
SellerIdstringDisplay the seller unique id
SupplierIdstringAlways blank
AuthKeystringDisplay supplier unique code
CustomerOrderCustomerDisplay the order shipping customer details data see OrderCustomer
ShippingOrderShippingDisplay order shipping name, charge, etc.. data details see OrderShipping
PaymentOrderPaymentDisplay order payment data details. See OrderPayment
OptionOrderOptionDisplay other details data
ItemsList OrderItemDisplay order item data details list. See OrderItem
RetrunItemList OrderItemDisplay return order data detail s (use only data available at the time of request, otherwise blank/null
UnpiadAmountdoubleDisplay unpaid order amount
PaidAmountdoubleDisplay order paid amount
VATdoubleDisplay the order VATamount
SubTotaldoubleDisplay the order subtotal value
TotaldoubleDisplay order total amount
DiscountdoubleDisplay the order discount value
DiscountPerdoubleDisplay the order discount per item value
SurchargedoubleDisplay the order surcharge value
ErrorList stringDisplay the order’s error list data details
ErrorTypeOrderErrorTypeDisplay the order error type list - NONE, PRODUCTNOTMAPP, PRODUCTMISSING, PRODUCTNOTSOURCE, PARENTPRODUCT, SHIPPINGNOTMAPP, SHIPPINGNOTFOUND, PROCESSORDERERROR, RESTRICTEDPRODUCT, OUTOFSTOCK, OTHERERROR, PAYMENTERROR
IsShipperPayoutboolDisplay if shipper has been paid out for this order payout
ProcessedboolDisplay if the Order is processed or not
IsProcessAtSeekerboolDisplay if the Order was process by the seeker
IsDeletedboolDisplay If the order is deleted
IsReturnRequestDraftboolDisplay If order has a draft return in place
IsReturnRequestboolDisplay If order has had a return request submitted to supplier
ManifestPrintedboolHas supplier printed shipping label and manifested?
SellerNamestringDisplay the name of seller
LabelPrintedboolDisplay if the shipping label is printed
IsInvoicedboolsDisplay iforder invoice has been created
NotesList OrderNotesDisplay aList of order notes see OrderNotes
DespatchByDateTimeDisplay When order dispatch or required to dispatch order on given time
MetaDataDictionary string, stringDisplay other order details not in existing fields
HistoriesList HistoryDisplay history records of any action taken on orders See History
CreatedDateTimeDisplay the order creation date time
ChRecdDateDateTimeDisplay the date or time the order was changed/updated
DispatchDateTimeDisplay the order dispatch date time
LastUpdateDateTimeDisplay the last time the order updated
IsCreditNotesboolDisplay if the order has a credit note
ReturnStatusstringDisplay the order Return order status as Accepted or Rejected (Default rejected?)
CurrencystringDisplay the order currency (eg GBP)

OrderItem

FieldTypeDescription
ItemIdstringDisplay for the order item unique id
SKUstringDisplay for the order item supplier SKU value
sCodestringDisplay for the order item avasam SKU value
TitlestringDisplay for the order item title value
BarcodestringDisplay for the order item barcode value
QtyintDisplay for the order item total quantity
UnitPricedoubleDisplay for the order item unit price value
VATPerdoubleDisplay for the order item vat percentage
VATdoubleDisplay for the order item vat
DiscountPerdoubleDisplay for the order item discount percentage
DiscountdoubleDisplay for the order item discount
SubTotaldoubleDisplay for the order item subtotal count value
TotaldoubleDisplay for the order item total value
AuthkeystringDisplay for the order item supplier code
ReturnQuantityintDisplay for the order item return quantity total value
ReasonstringDisplay for the order item return reason value
CostIncTaxdoubleDisplay for the order item cost price including tax value
WeightdoubleDisplay for the order item weight value
HeightdoubleDisplay for the order item height value
WidthdoubleDisplay for the order item width value
DepthdoubleDisplay for the order item depth value
VatExclboolDisplay for the order item vat excluding boolean value
VatIncudingdoubleDisplay for the order item vat including value

OrderNotes

FieldTypeDescription
UserstringDisplay for the order type value like – Avasam, Import, Channel name
NotesstringDisplay for the order notes message
OnDateTimeDisplay for the create order date time
SelfboolDisplay for the boolean value

OrderCustomer

FieldTypeDescription
NamestringDisplay for the delivery user name
AddressAddressDisplay for the address detail see Address
BillingAddressAddressDisplay for the billing address detail see Address

Address

FieldTypeDescription
EmailAddressstringDisplay for the user email id
Address1stringDisplay for the user address line 1
Address2stringDisplay for the user address line 2
Address3stringDisplay for the user address line 3
TownstringDisplay for the user town name
PostCodestringDisplay for the user postcode
CountrystringDisplay for the user country name
FullNamestringDisplay for the user full name
PhoneNumberstringDisplay for the user phone number

OrderShipping

FieldTypeDescription
ShippingNamestringDisplay for the order shipping name
ShippingProviderstringDisplay for the order shipping provider name
WeightdoubleDisplay for the order shipping weight value
TotaldoubleDisplay for the order shipping total value
VATPerdoubleDisplay for the order shipping vat percentage value
VATdoubleDisplay for the order shipping vat
TrackingNumberstringDisplay for the order tracking number

OrderPayment

FieldTypeDescription
RefNumberstringDisplay for the order payment reference number
TypestringDisplay for the order payment type
TotaldoubleDisplay for the order payment total value
OnDateTimeDisplay for the order payment date time

History

FieldTypeDescription
NamestringDisplay for the order action name
ActionstringDisplay for the order updated action type name
OnDateTimeDisplay for the order action updated date time

OrderTicketList

FieldTypeDescription
OrderidstringDisplay the order id
TotalticketintDisplay the total number of raised tickets for this order
TicketidsList - stringDisplay tickets raised against this order
TicketidStatusList - CustomerSupportStatusDisplay the raised tickets and their status list (OPEN, REPLY, CLOSED, HOLD, CUSTOMERREPLY, SUPPLIERREPLY, INPROGRESS)
ReturnOrdersList - stringDisplay a list of return order numbers
TotalreturnorderintDisplay the total returned number count

Response body
The response from Avasam will come in the following form:

{
"data":
[
{
"_id":"00000000-0000-0000-0000-000000000000",
"Number":"100-01-4233",
"SellerRef":"1128",
"SellerOrderId":"1128",
"SellerOtherRef":"1128",
"SupplierRef":"",
"SupplierOrderId":"",
"SupplierOtherRef":
"100-01-4233",
"IsChild":false,
"ParentId":"00000000-0000-0000-0000-000000000000",
"IsParent":false,
"Status":19,
"PaymentStatus":"Paid",
"Channel":"WooCommerce",
"Account":"Test12122020",
"InvId":"00000000-0000-0000-0000-000000000000",
"InvNumber":"INGB003-11-20224",
"SellerId":"00000000-0000-0000-0000-000000000000",
"SupplierId":null,
"AuthKey":"GB010003",
"Customer":
{
"Name":"MR User",
"Address":
{
"EmailAddress":"[email protected]",
"Address1":"19 Golden cross Road",
"Address2":"19 Golden cross Road",
"Address3":"",
"Town":"London",
"PostCode":"L3 5UN",
"Country":"United Kingdom",
"FullName":"MR User",
"PhoneNumber":"079 1482 4823",
},
"BillingAddress":
{
"EmailAddress":"[email protected]",          
"Address1":"19 Golden cross Road",          
"Address2":"19 Golden cross Road",
"Address3":"",
"Town":"London",          
"PostCode":"L3 5UN",       
"Country":"United Kingdom",
"FullName":"MR User",
"PhoneNumber":"079 1482 4823",
}
},
"Shipping":
{       
"ShippingName":"Standard Tracked ( 2 to 4 days)",       
"ShippingProvider":"Royal Mail",       
"Weight":20.0,       
"Total":5.3,       
"VATPer":1.3,       
"VAT":0.07,       
"TrackingNumber":"1234567890"
},
"Payment":
{       
"RefNumber":null,       
"Type":null,       
"Total":0.0,       
"On":"0001-01-01T00:00:00Z"
},
"Option":
{       
"Name":null,       
"Value":null,       
"IsPrivate":false
},
"Items":
[
{       
"ItemId":"00000000-0000-0000-0000-000000000000",       
"SKU":"S036570016",       
"sCode":"Test56789",       
"Title":"New Product T-shirt",       
"Barcode":"",       
"Qty":1,       
"UnitPrice":12.0,       
"VATPer":20.0,       
"VAT":2.28,       
"DiscountPer":5.0,       
"Discount":0.6,       
"SubTotal":12.0,       
"Total":13.68,       
"authkey":"GB010003",       
"ReturnQuantity":0,       
"Reason":null,       
"CostIncTax":0.0,       
"Weight":20.0,       
"Height":20.0,       
"Width":20.0,       
"Depth":20.0,       
"VatExcl":true,       
"VatIncuding":0.0
}
],
"RetrunItem":[],
"UnpiadAmount":21.07,
"PaidAmount":0.0,
"VAT":2.28,
"SubTotal":12.0,
"Total":18.98,
"Discount":0.6,
"DiscountPer":0.0,
"Surcharge":2.09,
"Error":
[
],
"ErrorType":0,
"IsShipperPayout":true,
"Processed":true,
"IsProcessAtSeeker":true,
"IsDeleted":false,
"IsReturnRequestDraft":false,
"IsReturnRequest":false,
"ManifestPrinted":false,
"SellerName":"Mr Seller",
"LabelPrinted":false,
"IsInvoiced":true,"Notes":
[
{       
"User":"Automation",       
"Notes":"",       
"On":"2020-12-24T09:43:08.313Z",        "
Self":false
}
],
"DespatchBy":"2020-12-25T09:42:45.655Z",
"MetaData":
{       
"CancellationReason":"Partial refund",       
"ShippingRefund":"5.3"
},
"Histories":
[
{       
"Name":"Stock S036570016",       
"Action":"1",       
"On":"2020-12-24T09:43:08.496Z"}],
"Created":"2020-12-24T09:43:08.313Z",
"ChRecdDate":"2020-12-24T09:40:50Z",
"Dispatch":"2020-12-24T09:53:10.749Z",
"LastUpdate":"2021-01-15T14:12:37.357Z",
"IsCreditNotes":false,
"ReturnStatus":"",
"Currency":"GBP"}],"total":1,
"authkey":null,"OrderTicket":
[
{       
"Orderid":"00000000-0000-0000-0000-000000000000",       
"Totalticket":0,       
"Ticketids":[],       
"TicketidStatus":
[
],       
"ReturnOrders":[],       
"Totalreturnorder":0
}
]
}