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:

Field	Type	Description	Is Required
Consumer_key	string	Requested from user management in Avasam	True
secret_key	string	Requested from user management in Avasam	True

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

Field	Type	Description	Notes
access_token	String	Access token for API calls	Essential for seller API calls to the account
expires_at	String	Time 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

Click on settings.
Select the user management option.
Click the API keys button in top right corner of the screen.
If you cannot see the consumer key and secret key fields, click on the eye icons to reveal them.
Click on the generate key button.
You will be returned to the user list.
Copy the consumer key and secret key fields for use in API calls.
Click on the user name to open the details of the account including API details.
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.
Click save if you make any changes to apply them.

If you need to use webhooks with an API key

Create a key using the above method if you haven't done so already.
Click on the account user name to open the account details.
Scroll down to the webhook section.
Enter the verification token.
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.
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.
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:

Field	Type	Description	Is Required
Authkey	string	Authorization key for the Avasam account	true
Reference Number	string	Avasam order reference number	true
Shipping Service Name	string	Seller’s shipping service name as configured in Avasam	true
Notes	string	Order notes	false

Item list

Field	Type	Description	Is Required
SKU	string	Avasam SKU of product in order	true
Stock	Integer	Number of products specified in order	true

Delivery Info

Field	Type	Description	Is Required
Name	String	Recipient of order	true
Address	String	Postal address for order order (Street and number, flat, etc	true
City	String	Postal town or city for order	true
Country	String	Country to deliver order	true
Post Code	String	Postcode for order delivery	true
Phone No	String	Contact phone number for order	true
Email	String	Email address for order	false

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

Field	Type	Description
Error Code	int	Error code of order response 0 = no error 1 = error
Message	String	Error body for order request
id	Int	Always 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

Parameters

The header details for this call are as follows:

Field	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	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	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	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	Type	Description
en	String	Displays the title(s) of the item currently selected as part of a list

Multi description

Field	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.

GetInventoryListWithFilter

Return a filtered list of sourced products

Call

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

tip

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	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  
      
}

AddNewOrder

Create a new order in Avasam

Call

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

tip

Parameters

The header details for this call are as follows:

Field	Type	Description	Is Required
GeneralInfo	GeneralInfoModel	Used for general detail data	TRUE
CustomerInfo	AddressModel	Used for customer detail data	TRUE
CustomerType	String	Always blank	FALSE
Items	List - ItemModel	Used for order item detail	TRUE
Shippingservicename	String	Used for shipping service name	TRUE
Shippingserviceid	String	Used for shipping service id	TRUE
Shippingservicecharge	String	Used for shipping service charge value	TRUE
SupplierCode	String	Always blank	FALSE
Notes	String	Used for order note details	FALSE
OrderType	String	Used for order type detail create order time only one type used like – ‘Queue’	TRUE
IsSelf	bool	Always false	FALSE

GeneralInfoModel

Field	Type	Description	Is Required
ReferenceNum	String	Used for order reference number	TRUE
ReceivedDate	DateTime	Used for order creation date time	TRUE
Name	String	Used for delivery customer full name	TRUE
FirstName	String	Used for delivery customer first name	TRUE
SurName	String	Used for customer surname	TRUE
Address	String	Used for shipping address	TRUE
City	String	Used for shipping city name	TRUE
PostCode	String	Used for shipping post code	TRUE
County	String	Used for shipping country name	TRUE
PhoneNo	String	Used for customer phone number	FALSE
Email	String	Used for delivery customer email id	FALSE
Error	List -String	Always blank	FALSE
Source	String	Used for order’s source name	TRUE
SubSource	String	Used for order’s subsource name	FALSE

AddressModel (CustomerInfo)

Field	Type	Description	Is Required
ReferenceNum	String	Used for order reference number	TRUE
ReceivedDate	DateTime	Used for order creation date time	TRUE
Name	String	Used for delivery customer full name	TRUE
FirstName	String	Used for delivery customer first name	TRUE
SurName	String	Used for customer surname	TRUE
Address	String	Used for shipping address	TRUE
City	String	Used for shipping city name	TRUE
PostCode	String	Used for shipping post code	TRUE
County	String	Used for shipping country name	TRUE
PhoneNo	String	Used for customer phone number	FALSE
Email	String	Used for delivery customer email id	FALSE
Error	List -String	Always blank	FALSE
Source	String	Used for order’s source name	TRUE
SubSource	String	Used for order’s subsource name	FALSE

ItemModel

Field	Type	Description	Is Required
_id	String	Used for item unique id	FALSE
SKU	String	Used for product Avasam SKU number	TRUE
Number	string	Used for product Avasam SKU	TRUE
Price	Double	Used for product price	TRUE
Costprice	Double	Used for product cost price	TRUE
Title	String	Used for Product title value	TRUE
BarCode	String	Used for product barcode value	FALSE
Vat	Double	Used for product vat value	TRUE
PackQty	int	Used for create order in use product count value	TRUE
Image	String	Used for product image path	TRUE
Authkey	String	Used for supplier code	TRUE
IsSelected	bool	Used to show if product is selected (yes/no)	TRUE
ActualPackQty	int	Used for product pack quantity	TRUE
VatPer	Double	Used for product VAT value	TRUE
DiscountPer	double	Used for discount per product value	TRUE

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

Field	Type	Description
ErrorCode	int	Error code of order response: 0 = no error: 1 = error
Message	String	Error body for order request
id	int	Always 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

Parameters

The header details for this call are as follows:

Field	Type	Description	Is Required
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
Page	int	Specifies 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

Field	Type	Description
SKU	String	Avasam SKU for the product
Stock	Integer	Stock 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

Field	Type	Description	Is Required
FromDate	DateTime	Shows the earliest date of order(s) to dispatch	TRUE
ToDate	DateTime	Shows latest date of order(s) to dispatch	TRUE
DateDispaly	string	Specify order dispatch period name (Today, Last 7 days, etc...)	TRUE
Customer	string	Order search value – Filter by Customer name	FALSE
OrderStatus	string	Filter orders by status (eg -Dispatch)	TRUE
PaymentStatus	string	Used to filter by payment status list – Paid, UnPaid	FALSE
Sortby	string	Used to specify sort order (up & down) – see SortStatus	TRUE
SortStatus	string	Specify field title to sort by	TRUE
limit	int	Specify max response data size – limit as no of responses (10, 25, 60, 100 )	TRUE
page	int	Specify page number	TRUE

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

Field	Type	Description
data	List - AvasamOrder>	Display order dispatch detail list
Total	long	Display total dispatched order count
Authkey	string	Display supplier unique id
OrderTicket	List - OrderTicketList	Display ordertickets list
Process Date Time	String	Shows the date and time the order was marked as processed.

AvasamOrder

Field	Type	Description
_id	string	Display the dispatch order unique id
Number	string	Display the dispatch order number
SellerRef	string	Display the order reference number
SellerOrderId	string	Display the order reference number (where channel returns multiple values)
SellerOtherRef	string	Display the seller reference number(where channel returns multiple values)
SupplierRef	string	Always blank
SupplierOrderId	string	Always blank
SupplierOtherRef	string	Display the If supplier uses other order management software (any extra id required to handle order status)
IsChild	bool	If order is merged or split and order is a child then this is "True", else "False"
ParentId	string	If order is merged or split then show main order id where order is merged or split from
IsParent	bool	If order is merged or split and order is the parent then this is "True", else "False"
Status	OrderStatus	Display 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)
PaymentStatus	string	Display the order payment status like – Paid, UnPaid
Channel	string	Display the channel name
Account	string	Display the channel account name
InvId	string	Display the order invoice unique id
InvNumber	string	Display the order invoice number
SellerId	string	Display the seller unique id
SupplierId	string	Always blank
AuthKey	string	Display supplier unique code
Customer	OrderCustomer	Display the order shipping customer details data see OrderCustomer
Shipping	OrderShipping	Display order shipping name, charge, etc.. data details see OrderShipping
Payment	OrderPayment	Display order payment data details. See OrderPayment
Option	OrderOption	Display other details data
Items	List OrderItem	Display order item data details list. See OrderItem
RetrunItem	List OrderItem	Display return order data detail s (use only data available at the time of request, otherwise blank/null
UnpiadAmount	double	Display unpaid order amount
PaidAmount	double	Display order paid amount
VAT	double	Display the order VATamount
SubTotal	double	Display the order subtotal value
Total	double	Display order total amount
Discount	double	Display the order discount value
DiscountPer	double	Display the order discount per item value
Surcharge	double	Display the order surcharge value
Error	List string	Display the order’s error list data details
ErrorType	OrderErrorType	Display the order error type list - NONE, PRODUCTNOTMAPP, PRODUCTMISSING, PRODUCTNOTSOURCE, PARENTPRODUCT, SHIPPINGNOTMAPP, SHIPPINGNOTFOUND, PROCESSORDERERROR, RESTRICTEDPRODUCT, OUTOFSTOCK, OTHERERROR, PAYMENTERROR
IsShipperPayout	bool	Display if shipper has been paid out for this order payout
Processed	bool	Display if the Order is processed or not
IsProcessAtSeeker	bool	Display if the Order was process by the seeker
IsDeleted	bool	Display If the order is deleted
IsReturnRequestDraft	bool	Display If order has a draft return in place
IsReturnRequest	bool	Display If order has had a return request submitted to supplier
ManifestPrinted	bool	Has supplier printed shipping label and manifested?
SellerName	string	Display the name of seller
LabelPrinted	bool	Display if the shipping label is printed
IsInvoiced	bools	Display iforder invoice has been created
Notes	List OrderNotes	Display aList of order notes see OrderNotes
DespatchBy	DateTime	Display When order dispatch or required to dispatch order on given time
MetaData	Dictionary string, string	Display other order details not in existing fields
Histories	List History	Display history records of any action taken on orders See History
Created	DateTime	Display the order creation date time
ChRecdDate	DateTime	Display the date or time the order was changed/updated
Dispatch	DateTime	Display the order dispatch date time
LastUpdate	DateTime	Display the last time the order updated
IsCreditNotes	bool	Display if the order has a credit note
ReturnStatus	string	Display the order Return order status as Accepted or Rejected (Default rejected?)
Currency	string	Display the order currency (eg GBP)

OrderItem

Field	Type	Description
ItemId	string	Display for the order item unique id
SKU	string	Display for the order item supplier SKU value
sCode	string	Display for the order item avasam SKU value
Title	string	Display for the order item title value
Barcode	string	Display for the order item barcode value
Qty	int	Display for the order item total quantity
UnitPrice	double	Display for the order item unit price value
VATPer	double	Display for the order item vat percentage
VAT	double	Display for the order item vat
DiscountPer	double	Display for the order item discount percentage
Discount	double	Display for the order item discount
SubTotal	double	Display for the order item subtotal count value
Total	double	Display for the order item total value
Authkey	string	Display for the order item supplier code
ReturnQuantity	int	Display for the order item return quantity total value
Reason	string	Display for the order item return reason value
CostIncTax	double	Display for the order item cost price including tax value
Weight	double	Display for the order item weight value
Height	double	Display for the order item height value
Width	double	Display for the order item width value
Depth	double	Display for the order item depth value
VatExcl	bool	Display for the order item vat excluding boolean value
VatIncuding	double	Display for the order item vat including value

OrderNotes

Field	Type	Description
User	string	Display for the order type value like – Avasam, Import, Channel name
Notes	string	Display for the order notes message
On	DateTime	Display for the create order date time
Self	bool	Display for the boolean value

OrderCustomer

Field	Type	Description
Name	string	Display for the delivery user name
Address	Address	Display for the address detail see Address
BillingAddress	Address	Display for the billing address detail see Address

Address

Field	Type	Description
EmailAddress	string	Display for the user email id
Address1	string	Display for the user address line 1
Address2	string	Display for the user address line 2
Address3	string	Display for the user address line 3
Town	string	Display for the user town name
PostCode	string	Display for the user postcode
Country	string	Display for the user country name
FullName	string	Display for the user full name
PhoneNumber	string	Display for the user phone number

OrderShipping

Field	Type	Description
ShippingName	string	Display for the order shipping name
ShippingProvider	string	Display for the order shipping provider name
Weight	double	Display for the order shipping weight value
Total	double	Display for the order shipping total value
VATPer	double	Display for the order shipping vat percentage value
VAT	double	Display for the order shipping vat
TrackingNumber	string	Display for the order tracking number

OrderPayment

Field	Type	Description
RefNumber	string	Display for the order payment reference number
Type	string	Display for the order payment type
Total	double	Display for the order payment total value
On	DateTime	Display for the order payment date time

History

Field	Type	Description
Name	string	Display for the order action name
Action	string	Display for the order updated action type name
On	DateTime	Display for the order action updated date time

OrderTicketList

Field	Type	Description
Orderid	string	Display the order id
Totalticket	int	Display the total number of raised tickets for this order
Ticketids	List - string	Display tickets raised against this order
TicketidStatus	List - CustomerSupportStatus	Display the raised tickets and their status list (OPEN, REPLY, CLOSED, HOLD, CUSTOMERREPLY, SUPPLIERREPLY, INPROGRESS)
ReturnOrders	List - string	Display a list of return order numbers
Totalreturnorder	int	Display 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
        }
        ]
}

Request-token - Authentication token for API​

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

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​

CreateSellerOrder​

Create a new order for one of your customers​

GetSellerProductList​

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

Request Body​

GetInventoryListWithFilter​

Return a filtered list of sourced products​

AddNewOrder​

Create a new order in Avasam​

SellerStockList​

Retrieve information about your products​

GetProcessOrderList​

Retrieve a list of orders that have been processed​

Request-token - Authentication token for API

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

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

CreateSellerOrder

Create a new order for one of your customers

GetSellerProductList

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

Request Body

GetInventoryListWithFilter

Return a filtered list of sourced products

AddNewOrder

Create a new order in Avasam

SellerStockList

Retrieve information about your products

GetProcessOrderList

Retrieve a list of orders that have been processed