{ } API Explorer Support

Seller API

Authorisation

Login

To access the Avasam API, you must first confirm your authorisation to access data. This is done using your account details (primary account email address and password).

A successful authorisation call returns information as a token. This should be stored and used for other calls to the Avasam API.

Successful authorisation also returns a ClientID- this is used for access verification for some secure methods and account-specific API calls.

Call

https://api.avasam.com/api/Login/ApiAccess

Parameters

The header details for this call are as follows:

Name Type Limit Is required Description
Email String 100 Required Email address for login
Password String 50 Required Password For login

Request body

The call is structured as follows:

Request Data: { 
    "Email":" ", 
    "Password":" "
    }

Response

Name Type Is required Description
Error Boolean Not required If the request is unsuccessful, return error type
Message String Not required If the request is unsuccessful, return error specifics
Client ID String Required Unique identifier
Business name String Not required The name of the customer’s business
Auth key String Required 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,<br>
"Message":" ",<br>
"ClientID":"00000000-0000-0000-0000-000000000000 ",<br>
"businessname":" ",<br>
"authkey":" ",<br>
"token":"00000000-0000-0000-0000-000000000000 ",<br>
"IsEnableProductCreation":false,<br>
"Action":"seeker.html",<br>
"EndPoint":"https://api.avasam.com/"<br>
}
  • 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.

Get authorization token api

Method - POST

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

Request Body

{
   "Email":"[email protected]",
   "Password":"#[email protected]%"
}

Notes: This API cannot be used if Two-Step authentication is enabled.

Field name Type Description Is Required
Email String Specify valid Avasam user ID as email address. true
Password String Specify valid Avasam password. true

Request Body

{
    "UserMasterId": "c33ae299-56b1-44bb-8cc5-64d9572a7a80",
    "Error": false,
    "adyentype": "live",
    "showspecific": "False",
    "RelatedSupplier": "",
    "Message": "",
    "appVersion": "v1.2",
    "ClientID": "c33ae299-56b1-44bb-8cc5-64d9572a7a80",
    "businessname": "Quantic",
    "SupplierSpecificSeller": false,
    "authkey": "",
    "token": "0d009602-7eac-4d32-8544-f5550a868cae",
    "IsEnableProductCreation": false,
    "UserType": "seller",
    "EndPoint": "https://api.avasam.com/",
    "Action": "seeker.html",
    "CodeVerify": true
}
Field name Type Description
User Master Id String Returns unique master ID for specified User
Error Boolean Confirms if verification on user Id successful (True or False). If False, no further data is returned
adyentype String This field for internal use only, always returns ‘live’
Show specific String Internal use only. Returns ‘True’ or ‘False’
Related Supplier String If account is a Supplier-Specific Seller (SupplierSpecificSeller=true) then this will return the Supplier Name
Message String Displays additional information where Error=true
App Version String Holds the current version of the Avasam app
Client ID String Returns the User ID for the current customer
Business name String Returns the Business Name of the current customer
Supplier Specific Seller Boolean Confirms if account is a Supplier-Specific-Seller (true/false). If true, see ‘RelatedSupplier’ for the Supplier Name
Auth key String Returns unique authentication string for account
token String Returns the account’s verification token value
Is Enable Product Creation Boolean If a supplier account, this confirms if the supplier can create new products. Only valid if UserType=’Supplier’
User Type String Specifies Avasam account type. Returns ‘supplier’ or ‘seller’
End Point String Returns the URL to be used for all API calls for this account.
Action String Internal use only. Disregard.
Code Verify Boolean If account has Two-Step verification enabled, this will return true – The API does not work if Two-Step verification is enabled Do not make further API calls for this account until CodeVerify=false

Get Process Order List

Method - POST

URL - https://app.avasam.com/apiseeker/Order/GetProcessOrderList

Header

• Authorization: Get this token from other documents - User Get Authorization Token API.docx, eg ‘6446988d-12bb-4536-8e96-27dee0d7ebf0’

• Content-Type: - application/json

Request Body

{
    "Limit":10,
    "Page":0,
    "FromDate":"2019-01-02T16:19:03.357Z",
    "ToDate": "2019-11-11T16:19:03.357Z" 
}
Field name 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
From Date Date time Specifies start date time for search. true
To Date Date time Specifies end date time for search. true

Request Body

[
    {
        "AvasamOrderId": "10001",
        "OrderReferenceId": "701200",
        "ShippingServiceName": "Delco",
        "TrackingNumber": "123",
        "ProcessDateTime": "2019-10-21T10:29:36.139Z"
    },
    {
        "AvasamOrderId": "10002",
        "OrderReferenceId": "701201",
        "ShippingServiceName": "",
        "TrackingNumber": "100021707",
        "ProcessDateTime": "2019-07-17T13:52:28.043Z"
    },
    {
        "AvasamOrderId": "10003",
        "OrderReferenceId": "701212",
        "ShippingServiceName": "",
        "TrackingNumber": "100031707",
        "ProcessDateTime": "2019-07-17T13:52:44.107Z"
    },
    {
        "AvasamOrderId": "10004",
        "OrderReferenceId": "25465",
        "ShippingServiceName": "",
        "TrackingNumber": "",
        "ProcessDateTime": "2019-07-23T08:30:33.517Z"
    },
    {
        "AvasamOrderId": "10009",
        "OrderReferenceId": "ODS1798452",
        "ShippingServiceName": "Delco",
        "TrackingNumber": "8998985959",
        "ProcessDateTime": "2019-05-16T14:33:06.429Z"
    },
    {
        "AvasamOrderId": "10014",
        "OrderReferenceId": "ODS2695138",
        "ShippingServiceName": "Delco",
        "TrackingNumber": "66666666666",
        "ProcessDateTime": "2019-05-29T15:12:00.759Z"
    },
    {
        "AvasamOrderId": "10020",
        "OrderReferenceId": "ODS6273954",
        "ShippingServiceName": "Delco",
        "TrackingNumber": "",
        "ProcessDateTime": "2019-09-17T14:47:33.021Z"
    },
    {
        "AvasamOrderId": "10024",
        "OrderReferenceId": "ODS5783694",
        "ShippingServiceName": "B2B48 NON-POD - With Business Orders",
        "TrackingNumber": "123TEST",
        "ProcessDateTime": "2019-09-20T10:45:30.852Z"
    },
    {
        "AvasamOrderId": "10063",
        "OrderReferenceId": "22230522",
        "ShippingServiceName": "Delco",
        "TrackingNumber": "100632709",
        "ProcessDateTime": "2019-09-27T08:14:55.908Z"
    },
    {
        "AvasamOrderId": "10066",
        "OrderReferenceId": "ODS4589673",
        "ShippingServiceName": "MCV",
        "TrackingNumber": "111111",
        "ProcessDateTime": "2019-05-23T09:08:46.319Z"
    }
]
Field name Type Description
Avasam Order Id String Shows the Avasam order ID.
Order Reference Id String Shows the order ID used by the selling channel.
Shipping Service Name String Shows the shipping service used for the order.
Tracking Number String Shows the tracking number, if any, stored for the order.
Process Date Time String Shows the date and time the order was marked as processed.

Seller Stock List

Method - POST

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

Header

• Authorization: Get this token from other documents - User Get Authorization Token API.docx, eg ‘6446988d-12bb-4536-8e96-27dee0d7ebf0’

• Content-Type: - application/json

Request Body

{
    "limit":10,
    "page":0 
}
Field name Type Description Is Required
Limit Integer Define the max number of records per page (eg ‘10’ would return 10 per page, so 120 returns would be 12 pages) true
Page Integer Specifies the page number to return (eg ‘Page 3’ returns records between 20 and 29 inclusive) true

Request Body

[
    {
        "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
    }
]
Field name Type Description
SKU String Avasam SKU for the product
Stock Integer Stock level for product in Avasam.

Seller Create Orders Api

Method - POST

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

Header

• Authorization: Get this token from other documents - User Get Authorization Token API.docx, eg ‘6446988d-12bb-4536-8e96-27dee0d7ebf0’

• Content-Type:- application/json

Request Body

{
    "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]"
    }
} 
Field name 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 – add multiple products in order of related supplier which is added in seller’s inventory

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

• Delivery Info – delivery information of order

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

{
"ErrorCode": 0,
"Message": "Order created successfully.",
"id": 0
}
Field name 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

Get Seller Product List

Method - POST

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

Header

• Authorization: 6446988d-12bb-4536-8e96-27dee0d7ebf0 (Get this token from other documents - User Get Authorization Token API.docx)

• Content-Type:- application/json

Request Body

{
    "Page":0,
    "Limit":10
}
Field name 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

[
    {
"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"
    }
]
Field name 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

ExtendedProperties

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

Multi Description

Field name Type Description
en String Displays the description(s) of the item currently selected as part of a list