Supplier API

GetAllTheOrdersWithFilter

You can retrieve orders placed by your sellers from Avasam via the API

Call

/apiseeker/OrdersView/GetAllTheOrdersWithFilter

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	Is required	Description
Email	String	Required	Email address for login
Customer Id	String	Required	Unique customer ID. See customer list
From Date	String	Required	Earliest date to limit the returned results by
To Date	String	Required	Latest date to limit the returned results by
Is Today	Boolean	Required	If ‘True’, call will only retrieve information for current day. Supersedes ‘From Date’ and ‘To Date’
Payment	String	Required	Filter returned results by payment method
Shipping	String	Required	Filter returned results based on shipping provider used to dispatch order where processed
Sub-Source	String	Required	Filter returned results based on the selling channel they originated from
Type	String	Required	Not actively used now. Retained for future usage
Limit	Integer	Required	Specify the maximum number of results to return in a page If used, must also specify ‘Page’
Page	Integer	Required	Specify the page number to return If used, must specify ‘Limit’
Shipper-Type	String	Required	Filter results based on shipping method used to dispatch order where processed

Request body

The call is structured as follows:

Request Data: { "Email":"", "CustomerID":"", "IsToday":"TRUE", "Limit":"20", "Page":"2" }

Response

Field	Type	Is required	Description
Processed	Bool	Required	If TRUE, then order has been dispatched, if FALSE then order still awaiting dispatch
Processed Date Time	String	Not required	Date and time of dispatch, if ‘Dispatch’ is TRUE.

General info

Name	Type	Is required	Description
Reference Num	String	Required	Avasam order reference number
External Reference Num	String	Not required	Selling channel order reference number
Received Date	String	Required	Date/time order received
Source	String	Not required	Source (channel type) for order
Subsource	String	Not required	Subsource (name) of channel for order
Label Printed	Bool	Not required	Shows TRUE if shipping label has been printed for order
Label Error	String	Not required	Includes error message returned if shipping label could not be printed
Invoice Printed	Bool	Not required	Shows TRUE if invoice has been printed for order
PickList Printed	Bool	Not required	Shows TRUE if pick list has been printed for order
Notes	Int	Not required	Returns number of Notes for order, if any
Part Shipped	Bool	Required	If TRUE, not all of order has been dispatched and some awaits delivery
Dispatch By Date	String	Required	Latest date order can/should be dispatched
NumItems	Inte	Required	Total number of items in the order

Shipping info

Name	Type	Is required	Description
Vendor	String	Not required	Customer’s email address for ID purposes
Postal Service ID	String	Required	Customer’s address
Postal Service Name	String	Required	Customer’s address/city
Total Weight	String	Required	Customer’s postcode
Item Weight	String	Required	Customer’s address/country
Package Category ID	String	Not required	Packaging category ID
Package Category	String	Not required	Packaging category
Package Type ID	String	Not required	Packaging type ID
Package Type	String	Not required	Packaging type
Postage Cost	Double	Required	Cost of postage including sales tax/VAT
Postage Cost	Ex-Tax	Double Required	Cost of postage without sales tax/VAT
Tracking number	String	Not required	If sent using tracked shipping method, holds tracking number
Manual Adjust	Bool	Required	Only set to TRUE if order edited in Avasam following download

Customer info

Name	Type	Is required	Description
Channel Buyer Name	String	Not required	Customer IDon sales channel
Email Address	String	Not required	Customer’s email address for Id purposes
Address1	String	Required	Customer’s shipping address
Address2	String	Not required	Customer’s shipping address
Address3	String	Not required	Customer’s shipping address
Town	String	Required	Customer’s shipping address/town
Region	String	Required	Customer’s shipping address/region
Postcode	String	Required	Customer’s shipping address/postcode
Country	String	Required	Customer’s shipping address/country
Full Name	String	Required	Customer’s name
Company	String	Not required	Customer’s company name
Phone Number	String	Not required	Customer’s telephone number
Country ID	String	Required	Avasam ID for the specified country

Billing address

Name	Type	Is required	Description
Email Address	String	Not required	Customer’s email address
Address1	String	Required	Customer’s billing address
Address2	String	Not required	Customer’s billing address
Address2	String	Not required	Customer’s billing address
Town	String	Not required	Customer’s billing address/town
Region	String	Not required	Customer’s billing address/(region/county)
Postcode	String	Not required	Customer’s billing address/postcode
Country	String	Required	Customer’s address/country
Full Name	String	Not required	Customer’s full name
Company	String	Not required	Customer’s business name
Telephone	String	Not required	Customer’s telephone number
Country ID	String	Required	Avasam ID for the specified country

Totals info

Name	Type	Is required	Description
Subtotal	Double	Required	Total value of the items in the order, ex tax and postage
Postage Cost	Double	Required	Cost of shipping ex tax
Tax	Double	Required	Tax for total order value
Total Charge	Double	Required	Total order value ex tax
Payment Method	String	Required	Avasam recorded payment method
Payment Method ID	String	Required	Avasam internal ID for recorded payment method
Profit Margin	Double	Required	Profit (total value excluding tax less cost)
Total Discount	Double	Required	Total value of any discounts applied to the order cost
Currency	String	Required	The currency the order was invoiced and paid in
Country Tax-Rate	Double	Required	Basic sales tax rate for the country the order was placed in

Items

Name	Type	Is required	Description
Order ID	String	Not required	Avasam order ID
Item ID	String	Required
Stock Item ID	String	Required
Item Number	String	Required
SKU	String	Required
Item Source	Object	Not required	Supplier of item
Title	String	Required	Item title/name
Quantity	Int	Required	Item title/name
Category Name	String	Not required	Avasam category
Composite Availability	Object	Not required	Confirms items available, where item is a composite/bundle
Row ID	String	Not required	Row ID within order
Stock Levels Specified	Bool	Not required	If true, then supplier holds levels for an item. Often false for services
On Order	Int	Not required	Quantity on order from supplier
In Order Book	Int	Not required	Quantity currently in unfulfilled orders
Level	Int	Not required	Quantity on shelf
Minimum Level	Int	Not required	Minimum level specified for supplier to trigger re-order
Available Stock	Int	Not required	Stock on shelf less items in unfulfilled orders – usually the value sent to listings to avoid overselling
Price Per Unit	Double	Required	Cost per item
Unit Cost	Double	Required	Item cost ex tax
Discount	Double	Not required	Discount amount (if applied)
Tax	Double	Not required
Tax Rate	Double	Not required	Sales tax rate
Cost	Double	Not required	Item cost price to seller ex VAT
Cost Inc Tax	Double	Not required	Item cost price inc VAT/sales tax
Composite Sub-Items	List	Not required	If composite - list of parent items that will be shipped/included in the order
Is Service	Bool	Not required	If true, the item line represents a service, not a product (i.e.giftwrap)
Sales Tax	Double	Not required	Total sales tax paid
Tax Cost Inclusive	Bool	Not required	Does cost price include tax? TRUE/FALSE
Part shipped	Bool	Not required	If ‘true’, only part of the items in this row has been dispatched, possibly due to stock availability
Weight	Double	Not required	Total weight of items in this row
Barcode Number	String	Not required	Barcode for item
Market	Int	Not required
Channel SKU	String	Not required	SKU of item in original listing
Channel Title	String	Not required	Title of Item in original listing
Has Image	Bool	Not required	If TRUE, the item has one or more images saved in Avasam
Image ID	Object	Not required	Reference for item main image in Avasam
Additional Info	List	Not required	Contains a list of entries containing additional item information
Stock Level Indicator	Int	Not required
Bin Rack	Object	Not required	Item’s physical location reference
Return Quantity	Int	Not required	If any return requests have been made against this order, shows the number of items returned
Amount	Double	Not required	If any return requests have been made against this order, shows the value of items returned
Reason	String	Not required	If any return requests have been made against this order, shows the reason given for the return(s)

Response body

The response from Avasam will come in the following form:

{
    "data":
            [
                {
                    "_id":"cb2d8e7d-2d83-4926-ba61-b6b9037fd30a",
                    "ShipperId":null,
                    "OrderId":"cb2d8e7d-2d83-4926-ba61-b6b9037fd30a",
                    "NumOrderId":"20600",
                    "Processed":true,
                    "ProcessedDateTime":"2018-12-14T10:17:24.271Z",
                    "FulfilmentLocationId":"",
                    "GeneralInfo":
                                    {
                                        "Status":1,
                                        "LabelPrinted":false,
                                        "LabelError":"",
                                        "InvoicePrinted":false,
                                        "PickListPrinted":false,
                                        "Notes":0,
                                        "PartShipped":false,
                                        "Marker":0,
                                        "ReferenceNum":"ODS1245873",
                                        "ExternalReferenceNum":"ODS1245873",
                                        "ReceivedDate":"2018-12-14T10:11:39.722Z",
                                        "Source":"DIRECT",
                                        "SubSource":"-",
                                        "HoldOrCancel":false,
                                        "DespatchByDate":"2018-12-14T10:11:39.72Z",
                                        "NumItems":1
                                    },
                    "ShippingInfo": {
                                        "Vendor":"",
                                        "PostalServiceId":"FEDEX",
                                        "PostalServiceName":"FEDEX",
                                        "TotalWeight":0.0,
                                        "ItemWeight":0.0,
                                        "PackageCategoryId":"00000000-0000-0000-0000-000000000000",
                                        "PackageCategory":"",
                                        "PackageTypeId":"00000000-0000-0000-0000-000000000000",
                                        "PackageType":"",
                                        "PostageCost":10.0,
                                        "PostageCostExTax":10.0,
                                        "TrackingNumber":"testing for process sync",
                                        "ManualAdjust":false
                                    },
                    "CustomerInfo": {
                                        "ChannelBuyerName":"",
                                        "Address":
                                                    {
                                                        "EmailAddress":"",
                                                        "Address1":"test",
                                                        "Address2":"",
                                                        "Address3":"",
                                                        "Town":"test",
                                                        "Region":"",
                                                        "PostCode":"test",
                                                        "Country":"Anguilla",
                                                        "FullName":"test",
                                                        "Company":"",
                                                        "PhoneNumber":"",
                                                        "CountryId":"8eed01c8-df37-40e6-bf74-c8d0376047b8"
                                                    },
                                        "BillingAddress":
                                                    {
                                                        "EmailAddress":"",
                                                        "Address1":"test",
                                                        "Address2":"",
                                                        "Address3":"",
                                                        "Town":"test",
                                                        "Region":"",
                                                        "PostCode":"test",
                                                        "Country":"Anguilla",
                                                        "FullName":"test",
                                                        "Company":"",
                                                        "PhoneNumber":"",
                                                        "CountryId":"8eed01c8-df37-40e6-bf74-c8d0376047b8"
                                                    }
                                    },
                    "TotalsInfo":   {
                                        "Subtotal":156.0,
                                        "PostageCost":10.0,
                                        "Tax":9.85,
                                        "TotalCharge":160.25,
                                        "PaymentMethod":"",
                                        "PaymentMethodId":"00000000-0000-0000-0000-000000000000",
                                        "ProfitMargin":0.0,
                                        "TotalDiscount":15.6,
                                        "Currency":null,
                                        "CountryTaxRate":0.0
                                    },
                    "FolderName":   [
                                    ],
                    "Items":    [
                                    {
                                        "OrderId":"00000000-0000-0000-0000-000000000000",
                                        "ItemId":"722bd9c6-af78-406c-9e70-1bc6abc4369b",
                                        "StockItemId":"722bd9c6-af78-406c-9e70-1bc6abc4369b",
                                        "ItemNumber":"",
                                        "SKU":"Producttest1",
                                        "ItemSource":"",
                                        "Title":"Producttest1",
                                        "Quantity":1,
                                        "CategoryName":"",
                                        "CompositeAvailablity":"",
                                        "RowId":null,
                                        "StockLevelsSpecified":true,
                                        "OnOrder":0,
                                        "InOrderBook":0,
                                        "Level":0,
                                        "MinimumLevel":0,
                                        "AvailableStock":0,
                                        "PricePerUnit":48.65,
                                        "UnitCost":51.0,
                                        "Discount":10.0,
                                        "Tax":2.75,
                                        "TaxRate":6.0,
                                        "Cost":51.0,
                                        "CostIncTax":48.65,
                                        "CompositeSubItems":
                                        [
                                        ],
                                        "IsService":false,
                                        "SalesTax":0.0,
                                        "TaxCostInclusive":false,
                                        "PartShipped":false,
                                        "Weight":0.0,
                                        "BarcodeNumber":"",
                                        "Market":0,
                                        "ChannelSKU":"Producttest1",
                                        "ChannelTitle":"Producttest1",
                                        "HasImage":false,
                                        "ImageId":"",
                                        "AdditionalInfo":
                                        [
                                        ],
                                        "StockLevelIndicator":0,
                                        "BinRack":"",
                                        "ReturnQuantity":0,
                                        "Amount":0.0,
                                        "Reason":null
                                    },
                                    {
                                        "OrderId":"00000000-0000-0000-0000-000000000000",
                                        "ItemId":"746753a3-4577-4fdd-8573-3a98cccd6b06",
                                        "StockItemId":"746753a3-4577-4fdd-8573-3a98cccd6b06",
                                        "ItemNumber":"",
                                        "SKU":"Producttest2",
                                        "ItemSource":"",
                                        "Title":"Producttest2",
                                        "Quantity":1,
                                        "CategoryName":"",
                                        "CompositeAvailablity":"",
                                        "RowId":null,
                                        "StockLevelsSpecified":true,
                                        "OnOrder":0,
                                        "InOrderBook":0,
                                        "Level":0,
                                        "MinimumLevel":0,
                                        "AvailableStock":0,
                                        "PricePerUnit":50.08,
                                        "UnitCost":52.0,
                                        "Discount":10.0,
                                        "Tax":3.28,
                                        "TaxRate":7.0,
                                        "Cost":52.0,
                                        "CostIncTax":50.08,
                                        "CompositeSubItems":
                                        [
                                        ],
                                        "IsService":false,
                                        "SalesTax":0.0,
                                        "TaxCostInclusive":false,
                                        "PartShipped":false,
                                        "Weight":0.0,
                                        "BarcodeNumber":"",
                                        "Market":0,
                                        "ChannelSKU":"Producttest2",
                                        "ChannelTitle":"Producttest2",
                                        "HasImage":false,
                                        "ImageId":"",
                                        "AdditionalInfo":
                                        [
                                        ],
                                        "StockLevelIndicator":0,
                                        "BinRack":"",
                                        "ReturnQuantity":0,
                                        "Amount":0.0,
                                        "Reason":null
                                    },

                                ],
    "total":2
}

GetCustomerList

Retrieve details about customers

Retrieve customer details to enable you to build orders for them.

Returns customer details including address and email.

Call

apiseeker/OrdersCreation/GetCustomerList/{Seller Name Or Email Address}

tip

Parameters

The header details for this call are as follows:

Name	Type	Limit	Is required	Description
Sellername or email address	String	100	Required	Seller name or email address

Request body

The call is structured as follows:

Request Data: 
                {   
                    “Name” or “Email address”   
                }

Response

Name	Type	Is required	Description
Business Name	String	Not required	Name of the business as a string
Contact Name	String	Not required	Name of the contact at the customer
Address1	String	Required	Customer’s address
Address2	String	Not required	Customer’s address
Address3	String	Not required	Customer’s address
Country	String	Required	Customer’s country
Postcode	String	Required	Customer’s postcode
Telephone	String	Not required	Customer’s telephone number
Mobile number	String	Not required	Customer’s telephone number
Email Address	String	Required	Customer’s email address
Credit Account	Boolean	Required	Does customer have a credit account – true or false
Credit Limit	Double	Required	If ‘Credit Account’ is true, maximum credit allowed
Payment terms	String	Not required	Maximum time for credit to be repaid if ‘Credit Account’ is true
Surcharge	String	Not required	If a surcharge is applied for customer, then whether it is a fixed value or %
Surcharge Value	Double	Not required	Amount of surcharge
Vatable	Boolean	Required	Does the product need to have VAT added
Customer Group	String	Not required	If customer is allocated to a group, include group name
Status	String	Required	Customer account status in Avasam
Is Active	Boolean	Required	Is customer account currently active and in use
Amount Deposits	String	Not required	Amount held as deposit
Outstanding Balanace	Double	Required	Current total money to pay
Location ID	String	Required	Location information
Password	String	Required	Password value in database
Is Shipper	Boolean	Required	Is account a shipper (true) or supplier(false)
Type	String	Required	Account information

Response body

The response from Avasam will come in the following form:

[    
 { "_id":"dc663f77-0bc4-4d18-93cc-afef2089f44d",   
    "BusinessName":"-",   
    "ContactName":"-",   
    "Address1":"Address 1",   
    "Address2":"Address 2",   
    "Address3":"Address 3",   
    "Country":"India",   
    "Postcode":"445566",   
    "Telephone":"-",   
    "MobileNumber":"-",   
    "EmailAddress":"-",   
    "CreditAccount":true,   
    "CreditLimit":100.0,   
    "PaymentTerms":"15",   
    "Surcharge":"%",   
    "SurchargeValue":"10",   
    "Vatable":true,   
    "CustomerGroup":"-",   
    "Status":"Active",   
    "IsActive":true,   
    "AmountDeposits":0,   
    "OutStandingBalance":0,   
    "LocationId":"-",   
    "Password":"-",   
    "IsShipper":false,   
    "Type":"-",   
    "LinnToken":null,   
    "SessionToken":"-",   
    "LinnServer":”-”,   
    "DbName":"-",   
    "CreatedDate":"2018-12-12T09:39:40.283Z",   
    "LoginToken":”-”,   
    "SubSource":"-",   
    "InvoiceCreationTime":"-",   
    "InvoicePreference":"-",   
    "PreferenceOn":"-",   
    "IsInvoiceCreated":false,   
    "LastInvoiceCreatedOn":"2018-11-27T08:40:31.448Z",   
    "Currency":”-”,   
    "Notes":"-",   
    "authkey":"TESTKEY”,   
    "shipperid":"977b6bb9-fac4-4dbb-b237-8c513e6122dc",   
    "seekerid":"885dc301-83d2-4242-9d46-78aca2ed0e07"   
  }   
] 

Tips

Store the relevant customer record(s) for use in later order creation.
Store the ‘SupplierAuthKey’ value for later calls.

CreateNewOrder

Create an order in Avasam for a customer

Creating an order is only possible once you have a customer and one or more products to add to their records.

Call

https://app.avasam.com/api/OrdersCreation/CreateNewOrder

tip

Parameters

The header details for this call are as follows:

Field name	Type	Description	Is required
GeneralInfo	GeneralInfoModel	Shows detailsfor order (see GeneralInfoModel)	TRUE
CustomerInfo	AddressModel	Shows customer-specific details (see AddressModel)	TRUE
CustomerID	String	Contains the selected seller’s unique id	TRUE
Items	List- ItemModel	Used for order item details (See ItemModel)	TRUE
Notes	String	Any notes associated with order at creation	FALSE
ShippingService	String	The selected shipping service name	TRUE
OrderType	String	Specify the order type (eg Seller)	TRUE
IsSelf	bool	If supplier created the order manually, set as yes.	FALSE

GeneralInfoModel

Field name	Type	Description	Is required
ReferenceNum	String	Order reference number	TRUE
ReceivedDate	DateTime	The date &time the order was created	TRUE
Name	String	Shippingaddress – customer’s full name	TRUE
Address	String	Shipping address building address	TRUE
City	String	Shipping city name	TRUE
PostCode	String	Shipping address post code	TRUE
County	String	Shipping address country name	TRUE
PhoneNo	String	Customer phone number	FALSE
Email	String	Customer email address	FALSE
Source	String	Specifies the source of the order (eg Amazon, eBay etc)	TRUE
SubSource	String	Specifies the source of the order (internal reference)	FALSE
Error	List - String	Always blank	FALSE
ShippingService	String	Avasam shipping service name	TRUE
FirstName	String	Shipping address customer first name	TRUE
SurName	String	Shipping address customer surname	TRUE

AddressModel

Field name	Type	Description	Is required
ReferenceNum	String	Order reference number	TRUE
ReceivedDate	DateTime	The date & time the order was created	TRUE
Name	String	Shipping address – customer’s full name	TRUE
Address	String	Shipping address building address	TRUE
City	String	Shipping city name	TRUE
PostCode	String	Shipping address post code	TRUE
County	String	Shipping address country name	TRUE
PhoneNo	String	Customer phone number	FALSE
Email	String	Customer email address	FALSE
Source	String	Specifies the source of the order (eg Amazon, eBay etc)	TRUE
SubSource	String	Specifies the source of the order (internal reference)	FALSE
Error	List - String	Always blank	FALSE
ShippingService	String	Avasam shipping service name	TRUE
FirstName	String	Shipping address customer first name	TRUE
SurName	String	Shipping address customer surname	TRUE

ItemModel

Field name	Type	Description	Is required
_id	String	Item unique id (internal reference)	FALSE
SKU	String	Avasam SKU (External ID)	TRUE
Number	string	Avasam SKU	TRUE
Price	Double	Product RRP	TRUE
Costprice	Double	Product cost price for seller	TRUE
Title	String	Product title	TRUE
Vat	Double	Product VAT rate	TRUE
PackQty	int	How many items included in order when a single SKU item is purchased	TRUE
Image	String	Product main image path	TRUE
IsSelected	bool	Specify if product has been selected (yes or no)	TRUE
ActualPackQty	int	Total number of item in order	TRUE
Discount	double	Used for product discount value	TRUE

Request body

The call is structured as follows:

{

    "GeneralInfo":

    {
        "ReferenceNum":"ODS7529463",

        "ReceivedDate":"22/01/2021, 19:19",

        "Name":"Test user Test user surname",

        "Address":"Test address detail",

        "City":"London",

        "PostCode":"Ygv2637",

        "County":"United Kingdom",

        "PhoneNo":"8787656578",

        "Email":"[email protected]",

        "Source":"Avasam",

        "SubSource":"",

        "Error":[],

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

        "FirstName":"Test user",

        "SurName":"Test user surname"
    },

    "CustomerInfo":

    {

        "ReferenceNum":"ODS7529463",

        "ReceivedDate":"22/01/2021, 19:19",

        "Name":"Test user Test user surname",

        "Address":"Test address detail",

        "City":"London",

        "PostCode":"Ygv2637",

        "County":"United Kingdom",

        "PhoneNo":"8787656578",

        "Email":"[email protected]",

        "Source":"Avasam",

        "SubSource":"",

        "Error":[],

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

        "FirstName":"Test user",

        "SurName":"Test user surname"

    },

    "CustomerID":"00000000-0000-0000-0000-000000000000",

    "Items":
    [
        {
            "_id":"00000000-0000-0000-0000-000000000000",

            "SKU":"Test56789",

            "Number":"S036570016",

            "Price":12,

            "costprice":23,

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

            "Vat":20,

            "PackQty":1,

            "image":"",

            "IsSelected":true,

            "ActualPackQty":99,

            "Discount":"0"
        }
    ],

    "Notes":"test create order note",

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

    "OrderType":"Sellers",

    "IsSelf":false

}

Response

The response from Avasam will come in the following form:

Field name	Type	Description
ErrorCode	int	Specifies if an error has been returned 0 = no error 1 = error Should this be Boolean? - No, because we have use int value
Message	String	Error body for order request
id	int	Always returns 0

Response body

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

SellerGetOrdersListWithFilter

Call

https://app.avasam.com/api/SellerOrdersView/SellerGetOrdersListWithFilter

tip

Parameters

The header details for this call are as follows:

Field name	Type	Description	Is required
FromDate	DateTime	Order range start date	TRUE
ToDate	DateTime	Order range end date	TRUE
DateDispaly	string	String value to define range (eg Today, Yesterday)	TRUE
Customer	string	Search parameter for filtering for specific customer(s)	FALSE
OrderStatus	string	Specifies the current status of the orders that should be returned (inc ‘Dispatched’, ‘Return’)	FALSE
PaymentStatus	string	Specify a payment status to filter by	FALSE
Sortby	string	Specify sort direction for SortStatus (up or down)	TRUE
SortStatus	string	Specify a field name from AvasamOrder to sort the list by	TRUE
limit	int	Specify the number of records per page	TRUE
page	int	Specify which page number to return	TRUE

Request body

The call is structured as follows:

{
    "FromDate":"2020-11-23T18:30:00.000Z",
    "ToDate":"2021-01-23T06:11:28.328Z",
    "DateDispaly":"Last 60 days",
    "Customer":"",
    "OrderStatus":"All",
    "PaymentStatus":"All",
    "Sortby":"ChRecdDate",
    "SortStatus":"down",
    "limit":"60",
    "page":0
}

Response

Field name	Type	Description
data	List - AvasamOrder	Includes a list of all matching orders and details
Total	long	Display total count of orders returned

AvasamOrder

Field name	Type	Description
_id	string	Display the order’s unique ID
Number	string	Display the internal Avasam order number
SellerRef	string	Display the order’s reference number from channel
SellerOrderId	string	Display the order reference number (may be same as SellerRef)
SellerOtherRef	string	Display the order reference number (may be same as SellerRef and SellerOtherId)
SupplierOtherRef	string	Supports additional order reference from external order management software
IsChild	bool	If order has been merged or split &order is the child ("True") else "False"
ParentId	string	Display parent order ID if IsChild=True
IsParent	bool	If order has been merged or split &order is the parent("True") else "False"
Status	OrderStatus	Order status value list – 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	Order payment status
Channel	string	Order channel name
Account	string	Order channel account name
InvId	string	Order invoice unique id
InvNumber	string	Order invoice number
SellerId	string	Seller unique id
SupplierId	string	Always blank
AuthKey	string	Supplier unique code
Customer	OrderCustomer	Display order customer details
Shipping	OrderShipping	Display order shipping details
Payment	OrderPayment	Display order payment details.
Option	OrderOption	Display other details associated with order
Items	List-OrderItem	List of order items.
RetrunItem	List-OrderItem	List of order items flagged for return.
UnpiadAmount	double	If order not fully paid, show balance owing
PaidAmount	double	Show balance paid for order
VAT	double	Show VAT amount on order
SubTotal	double	Order subtotal (Ex VAT)
Total	double	Order total value (Inc VAT)
Discount	double	Show total discount applied to order
DiscountPer	double	Discount applied per product
Surcharge	double	The value of any surcharges applied to order
Error	List-string	Display for the order error list data details
ErrorType	OrderErrorType	Display order error type (Value list here – NONE, PRODUCTNOTMAPP, PRODUCTMISSING, PRODUCTNOTSOURCE, PARENTPRODUCT, SHIPPINGNOTMAPP, SHIPPINGNOTFOUND, PROCESSORDERERROR, RESTRICTEDPRODUCT, OUTOFSTOCK, OTHERERROR, PAYMENTERROR
IsShipperPayout	bool	Confirm if order payment has been disbursed to supplier.
GeneralInfoStatus	int	General info sting
Processed	bool	Is order marked as processed?
IsProcessAtSeeker	bool	If order processed, was order processed by seller instead of supplier? (default False)
IsDeleted	bool	If order is marked as deleted, set as True
IsReturnRequestDraft	bool	If order has a return request in process, but not submitted, set as True
IsReturnRequest	bool	If order has had a return request submitted, set as True
ManifestPrinted	bool	If supplier has printed a label and manifest has been printed for it
SellerName	string	Sellername
LabelPrinted	bool	Order label printed
IsInvoiced	bools	Order Invoice raised in Avasam
Notes	List-OrderNotes	Order notes (as list)
DespatchBy	DateTime	Latest date and time order must be dispatched by
MetaData	Dictionary-string, string	Misc order data not covered in other fields for completeness
Histories	List-History	List of actions taken against order
Created	DateTime	Order placed on channel (date and time)
ChRecdDate	DateTime	Order created in Avasam (date and time)
Dispatch	DateTime	If order dispatched, specify date and time
LastUpdate	DateTime	Last action or change on order (date and time)
IsCreditNotes	bool	If credit note has been raised against order set True
ReturnStatus	string	If order has been returned, set True
Currency	string	Currency that order was placed in (GBP)

OrderItem

Field name	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 name	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 name	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 name	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 name	Type	Description
ShippingName	string	Display for the order shipping name
ShippingId	string	Display for the order shipping id
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 name	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 name	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

Response body

The response from Avasam will come in the following form:

{
    "data":
            [
                {
                    "_id":"00000000-0000-0000-0000-000000000000",
                    "Number":"29350248331",
                    "SellerRef":"ODS59413",
                    "SellerOrderId":"ODS59413",
                    "SellerOtherRef":null,
                    "SupplierOtherRef":"29350248331",
                    "IsChild":false,"ParentId":"00000000-0000-0000-0000-000000000000",
                    "IsParent":false,
                    "Status":9,
                    "PaymentStatus":"Paid",
                    "Channel":"Web",
                    "Account":"Avasam Seller",
                    "InvId":"00000000-0000-0000-0000-000000000000",
                    "InvNumber":"INGB0132935210122",
                    "SellerId":"00000000-0000-0000-0000-000000000000",
                    "SupplierId":"",
                    "AuthKey":"GB01003",
                    "Customer":
                                {
                                    "Name":"Testing User",        
                                    "Address":        
                                    {        
                                        "EmailAddress":"",        
                                        "Address1":"Z-211",        
                                        "Address2":"",        
                                        "Address3":"",        
                                        "Town":"Baroda",        
                                        "PostCode":"350015",        
                                        "Country":"India",        
                                        "FullName":"Testing User",        
                                        "PhoneNumber":"+918899776655"        
                                    },        
                                    "BillingAddress":        
                                    {        
                                        "EmailAddress":"",        
                                        "Address1":"Z-211",        
                                        "Address2":"",        
                                        "Address3":"",        
                                        "Town":"Ahmedabad",        
                                        "PostCode":"350015",        
                                        "Country":"India",        
                                        "FullName":"Testing User",        
                                        "PhoneNumber":"+918899776655"        
                                    }
                                },
                    "Shipping":
                        {
                            "ShippingName":"Standard",        
                            "ShippingId":"2",        
                            "Weight":22.0,        
                            "Total":6.0,        
                            "VATPer":20.0,        
                            "VAT":1.0,        
                            "TrackingNumber":""
                        },
                    "Payment":
                        {        
                            "RefNumber":"00000000-0000-0000-0000-000000000000",        
                            "Type":"Deposit",        
                            "Total":19.68,        
                            "On":"2021-01-22T14:22:29.999Z"
                        },
                    "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":"GB01003",        
                                "ReturnQuantity":0,        
                                "Reason":null,       
                                "CostIncTax":0.0,        
                                "Weight":22.0,        
                                "Height":20.0,        
                                "Width":20.0,        
                                "Depth":20.0,        
                                "VatExcl":true,        
                                "VatIncuding":0.0
                            }
                        ],
                    "RetrunItem":
                        [
                            {        
                                "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":"GB01003",        
                                "ReturnQuantity":1,        
                                "Reason":"Faulty item",        
                                "CostIncTax":0.0,        
                                "Weight":22.0,        
                                "Height":0.0,        
                                "Width":0.0,        
                                "Depth":0.0,        
                                "VatExcl":true,        
                                "VatIncuding":0.0
                            }
                        ],
                    "UnpiadAmount":0.0,
                    "PaidAmount":19.68,
                    "VAT":2.28,
                    "SubTotal":12.0,
                    "Total":19.68,
                    "Discount":0.6,
                    "DiscountPer":0.0,
                    "Surcharge":0.0,
                    "Error":[],
                    "ErrorType":0,
                    "IsShipperPayout":false,
                    "GeneralInfoStatus":0,
                    "Processed":true,
                    "IsProcessAtSeeker":true,
                    "IsDeleted":false,
                    "IsReturnRequestDraft":false,
                    "IsReturnRequest":true,
                    "ManifestPrinted":false,
                    "SellerName":null,
                    "LabelPrinted":false,
                    "IsInvoiced":true,"Notes":
                        [       
                            {        
                                User: "Import",         
                                Notes: "demo order",         
                                On: "2020-12-30T10:38:37.187Z",         
                                Self: false
                            }
                        ],
                    "DespatchBy":"2021-01-25T23:59:00Z",
                    "MetaData":
                        {        
                        "ReturnNo":"RTN5186729"
                        },
                    "Histories":
                        [
                            {        
                                "Name":"OrderCreate",        
                                "Action":"OrderCreateDate",        
                                "On":"2021-01-22T14:22:27.333Z"
                            },
                            {        
                                "Name":"Stock S036570016",        
                                "Action":"1",        
                                "On":"2021-01-22T14:22:28.895Z"
                            }
                        ],
                    "Created":"2021-01-22T14:22:27.334Z",
                    "ChRecdDate":"2021-01-22T14:22:27.334Z",
                    "Dispatch":"2021-01-22T14:26:03.859Z",
                    "LastUpdate":"2021-01-23T00:27:08.099Z",
                    "IsCreditNotes":false,
                    "ReturnStatus":"Return requested","Currency":"GBP"
                }
            ],   
    "total":1
}

Confirm authorisation to access Avasam

Confirm your authorisation to access data with your email address and password. Returns authorisation token and ClientID.

Call

https://app.avasam.com/api/Signup/Login

tip

Parameters

The header details for this call are as follows:

Field name	Type	Description	Is required
Email	string	Used for user login email id (used base64 encrypt email)	True
Password	string	Used for user login password (used base64 encrypt password)	True
Code	string	Always blank	False
CheckMultiLogin	string	Used for multi login option yes or no	False

Request body

The call is structured as follows:

{   
    "Email":"Z2F0YXBlaDY2MUBhaWNsYmQuY29t",  
    "Password":"MTIzNEBxd2VBUw==",  
    "Code":"",  
    "CheckMultiLogin":"yes"  
}

Response

Field name	Type	Is required	Description
Error	bool	Display error status (yes or no)	If the request is unsuccessful, return error type
ClientID	String	Display the unique client id	If the request is unsuccessful, return error specifics
token	String	Display the unique id token value for the user	Unique identifier
EndPoint	String	Display the API endpoint path	The name of the customer’s business
Action	String	Display the user login panel path	Authorisation string for the connection
Token	String	Required	Verification value used for later connections to Avasam
Is Enable Product Creation	Boolean	Required	Confirm if products can be created in this account
Action	String	Not required
End Point	String	Required	Specifies the end point address for all future API queries

Response body

The response from Avasam will come in the following form:

{   
    "Error":false,  
    "ClientID":"00000000-0000-0000-0000-000000000000",  
    "token":"00000000-0000-0000-0000-000000000000",  
    "EndPoint":"https://api.avasam.com/",  
    "Action":"shipper.html",  
}

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.

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

tip

Parameters

The header details for this call are as follows:

Field	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 id 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":""

}

GetAllTheOrdersWithFilter​

You can retrieve orders placed by your sellers from Avasam via the API​

GetCustomerList​

Retrieve details about customers​

CreateNewOrder​

Create an order in Avasam for a customer​

SellerGetOrdersListWithFilter​

Supplier - Login​

Confirm authorisation to access Avasam​

NewGetCustProductListWithSupplierCode​

Retrieve product information from Avasam​

GetAllTheOrdersWithFilter

You can retrieve orders placed by your sellers from Avasam via the API

GetCustomerList

Retrieve details about customers

CreateNewOrder

Create an order in Avasam for a customer

SellerGetOrdersListWithFilter

Supplier - Login

Confirm authorisation to access Avasam

NewGetCustProductListWithSupplierCode

Retrieve product information from Avasam