Retrieve a list of orders that have been processed
Call
https://app.avasam.com/apiseeker/OrdersView/SeekerGetOrdersListWithFilter
Request
|
Field name |
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":"user@email.com",
"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":"user@email.com",
"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
}
]
}
}