Overview
You can use this endpoint to retrieve data for multiple sales orders, using an existing Saved View. To consume it, you must be an Authenticated User. As soon as you receive a valid token, you need to pass it to the call. Additionally, you need a valid ID of an existing saved view. For information on how you can get existing saved views, see Get Order Saved Views.
Endpoint
The endpoint for the XX server would be:
https://xx.api.sellercloud.com/rest/api/orders/getallbyview?ViewID=100&pageNumber=1&pageSize=50
For your server, the endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/orders/GetAllByView?ViewID=100&pageNumber=1&pageSize=50
Request
- Method Type: HttpGet
- Authorization: Use Bearer Token + token received from token authentication
- Header info: Content-Type: application/json
- Query parameters:
| Parameters | Data Type | Description | Is Required |
| pageNumber | integer | Page number that will be retrieved. | Yes |
| pageSize | integer | Number of orders per page. | Yes |
| viewID | integer | The ID of an existing saved view. You can use this endpoint to retrieve your saved view IDs. | Yes |
Response
- If the user is authenticated and provides a valid page number and page size, then the response will be Status Code 200 => OK and orders metadata in JSON format.
- If the user is not authenticated, then the response will be Status Code 401 => Not Valid Token.
- In case of an error, the response will be Status Code 500 => Internal Server Error.
Response Body
{
"Items": [
{
"ID": 0,
"OrderSourceOrderID": "string",
"OrderSource": 0,
"MarketingSourceID": 0,
"OrderSubType": 0,
"bExported": true,
"bRushOrder": true,
"IsGiftOrder": true,
"IsBlackListed": true,
"ShippingStatus": 0,
"PaymentStatus": 0,
"StatusCode": 0,
"Dropship": 0,
"FirstName": "string",
"LastName": "string",
"TimeOfOrder": "2026-07-17T13:37:35.454Z",
"GrandTotal": 0,
"CompanyName": "string",
"UserID": 0,
"SalesRepEmail": "string",
"SalesRepId": 0,
"ShipDate": "2026-07-17T13:37:35.454Z",
"ShippedByUserID": 0,
"PackageType": "string",
"OrderShippingPromiseDate": "2026-07-17T13:37:35.454Z",
"CreatedOn": "2026-07-17T13:37:35.454Z",
"DeliveryDate": "2026-07-17T13:37:35.454Z",
"HomeCountryCode": 0,
"Country": "string",
"LastUpdated": "2026-07-17T13:37:35.454Z",
"Payments": [
{
"ID": 0,
"TransactionReferenceNumber": "string",
"PaidAmount": 0,
"PaymentDate": "2026-07-17T13:37:35.454Z",
"PaymentType": 1,
"PaymentMethod": 1,
"PaymentStatus": 0,
"Note": "string"
}
],
"DestinationState": "string",
"DestinationCountry": "string",
"ShippingAddress": {
"ClientID": 0,
"UserID": 0,
"HomePhoneExt": "string",
"PhoneNumberExt": "string",
"IsShippingAddress": true,
"IsBillingAddress": true,
"AddressClassification": 0,
"Notes": "string",
"HomePhone": "string",
"EmailAddress": "string",
"AddressStatus": 0,
"AddressSource": 0,
"ID": 0,
"FirstName": "string",
"MiddleInitial": "string",
"LastName": "string",
"CompanyName": "string",
"StreetLine1": "string",
"StreetLine2": "string",
"City": "string",
"StateName": "string",
"StateCode": "string",
"PostalCode": "string",
"CountryName": "string",
"CountryCode": "string",
"PhoneNumber": "string",
"FaxNumber": "string",
"WebSiteURL": "string"
},
"BillingAddress": {
"ClientID": 0,
"UserID": 0,
"HomePhoneExt": "string",
"PhoneNumberExt": "string",
"IsShippingAddress": true,
"IsBillingAddress": true,
"AddressClassification": 0,
"Notes": "string",
"HomePhone": "string",
"EmailAddress": "string",
"AddressStatus": 0,
"AddressSource": 0,
"ID": 0,
"FirstName": "string",
"MiddleInitial": "string",
"LastName": "string",
"CompanyName": "string",
"StreetLine1": "string",
"StreetLine2": "string",
"City": "string",
"StateName": "string",
"StateCode": "string",
"PostalCode": "string",
"CountryName": "string",
"CountryCode": "string",
"PhoneNumber": "string",
"FaxNumber": "string",
"WebSiteURL": "string"
},
"OrderSiteCode": 0,
"ClientID": 0,
"CompanyID": 0,
"EBaySellingManagerSalesRecordNumber": "string",
"CompletedOrderID": "string",
"OrderSourceUrl": "string",
"Items": [
{
"ID": 0,
"OrderID": 0,
"ProductID": "string",
"Qty": 0,
"DisplayName": "string",
"AdjustedSitePrice": 0,
"QtyReturned": 0,
"QtyShipped": 0,
"ID1": 0,
"OrderID1": 0,
"ProductID1": "string",
"Qty1": 0,
"DisplayName1": "string",
"OriginalBasePrice": 0,
"SitePrice": 0,
"AdjustedSitePrice1": 0,
"SiteCost": 0,
"TaxExempt": 0,
"TaxClass": 0,
"NonShipping": 0,
"ShipSeparately": 0,
"DropShipMode": 0,
"DropShipAddressID": 0,
"LineTotal": 0,
"LineTaxTotal": 0,
"StatusCode": 0,
"Weight": 0,
"Length": 0,
"Width": 0,
"Height": 0,
"MinimumQty": 0,
"DisplayDescription": "string",
"ImageURL": "string",
"ExtraInformation": "string",
"GiftWrap": 0,
"GiftWrapMessage": "string",
"GiftWrapAllowed": 0,
"InventoryKey": "string",
"ShippingCost": 0,
"QtyShipped1": 0,
"QtyReturned1": 0,
"ParentID": 0,
"ReferenceID": "string",
"eBayTransactionID": "string",
"OriginalOrderSourceID": "string",
"PostingFee": 0,
"FinalValueFee": 0,
"IsBackOrder": true,
"BackOrderAction": 0,
"BackOrderActionDate": "2026-07-17T13:37:35.454Z",
"BackOrderActionBy": 0,
"EstimatedTimeArrival": "2026-07-17T13:37:35.454Z",
"ReplacementSKU": "string",
"ListingError": 0,
"FeedBackID": "string",
"FeedBackReminderSent": "2026-07-17T13:37:35.454Z",
"BackOrderQty": 0,
"BackOrderDate": "2026-07-17T13:37:35.454Z",
"BackOrderBy": 0,
"EstimatedShipDate": "2026-07-17T13:37:35.454Z",
"NotifyCustomerService": true,
"NotifyCustomer": "string",
"DisputeID": "string",
"OriginalSKU": "string",
"IsSKUReplaced": true,
"InsuranceCost": 0,
"FeedbackLeft": true,
"FeedbackLeftOn": "2026-07-17T13:37:35.454Z",
"FeedBackLeftID": "string",
"IsDropShipped": true,
"DropShippedOn": "2026-07-17T13:37:35.454Z",
"DropShippedToVendor": 0,
"Notes": "string",
"ProductIDOriginal": "string",
"SalesRepId": 0,
"ShipFromWareHouseID": 0,
"ShipFromWarehouseName": "string",
"FeedBackFailureCount": 0,
"FeedBackLastFailureOn": "2026-07-17T13:37:35.454Z",
"FeedBackFailureMessage": "string",
"SourceOrderFileName": "string",
"eBayItemIDUnique": "string",
"eBayTransactionIDUnique": "string",
"DontCountInventory": true,
"ShippingTax": 0,
"GiftWrapTax": 0,
"DropShippedVendorOrderID": "string",
"GiftWrapType": "string",
"GiftWrapCharges": 0,
"ShippingCostForAccounting": 0,
"ReturnedToWarehouseID": 0,
"AverageCost": 0,
"LastCost": 0,
"CreditMemoID": 0,
"CreditMemoItemID": 0,
"HasBuyDotCoupon": true,
"BuyDotCouponAmount": 0,
"DiscountType": 0,
"DiscountAmount": 0,
"DiscountTotal": 0,
"QtyRequestedByOrderSource": 0,
"ProductRebateID": 0,
"ProductRebateValue": 0,
"Purchaser": 0,
"ShippingSourceOrderItemID": "string",
"SalesOutlet": "string",
"VariantID": 0,
"ShippingSourceWarehouseID": "string",
"ExportedProductID": "string",
"ExportedDocumentNumber": "string",
"BatchExportedGUID": "string",
"DeliveryDocumentNumber": "string",
"BatchExportDeliveryGUID": "string",
"SrcUpdatedForItemShipping": true,
"SrcUpdatedForItemShippingOn": "2026-07-17T13:37:35.454Z",
"ShipType": "string",
"DropShippedStatus": 0,
"BatchExportedJobID": 0,
"BatchExportedDateTime": "2026-07-17T13:37:35.454Z",
"ItemStatusCode": 0,
"ItemPaymentStatus": 0,
"ItemShippingStatus": 0,
"BatchExportDeliveryJobID": 0,
"BatchExportDeliveryDateTime": "2026-07-17T13:37:35.454Z",
"CancellationRequestSentToInnotrac": true,
"ShippingSourceCancellationQty": 0,
"TotalRefunded": 0,
"ReturnDocumentNumber": "string",
"BatchExportReturnGUID": "string",
"BatchExportReturnJobID": 0,
"BatchExportReturnDateTime": "2026-07-17T13:37:35.454Z",
"ProfitAndLossAdjustmentTotal": 0,
"SalesRecordNumber": "string",
"ShippingSourceOrderItemSKU": "string",
"QtyPerCase": 0,
"TotalCases": 0,
"PricePerCase": 0,
"QtyPicked": 0,
"ProductIDRequested": "string",
"WholesaleConfirmedQty": 0,
"WholesaleConfirmShipDate": "2026-07-17T13:37:35.454Z",
"WholesaleBackOrderQty": 0,
"WholesaleBackOrderShipDate": "2026-07-17T13:37:35.454Z",
"WholesaleRefuseQty": 0,
"KitItemsCount": 0,
"VatRate": 0,
"VATTotal": 0,
"AmazonShipmentID": "string",
"WarehouseBinCartSlotID": 0,
"SettlementID": 0,
"RoundNumber": 0,
"WarehouseBinCartID": 0,
"MainItemID": "string",
"LinkedToPOItemID": 0,
"OrderItemShipDate": "2026-07-17T13:37:35.454Z",
"ProductName": "string",
"InventoryAvailableQty": 0,
"LocationNotes": "string",
"ShadowOf": "string",
"DefaultVendorName": "string",
"BundleItems": [
{
"ID": 0,
"ParentID": 0,
"OrderItemId": 0,
"OrderID": 0,
"ProductID": "string",
"Qty": 0,
"QtyReturned": 0,
"IsPackageGenerated": true,
"IsBackOrder": true,
"BackOrderAction": 0,
"BackOrderActionDate": "2026-07-17T13:37:35.454Z",
"BackOrderActionBy": 0,
"BackOrderQty": 0,
"BackOrderDate": "2026-07-17T13:37:35.454Z",
"BackOrderBy": 0,
"TotalQty": 0,
"ReturnedToWarehouseID": 0,
"SiteCost": 0,
"LastCost": 0,
"AverageCost": 0,
"ProductRebateID": 0,
"ProductRebateValue": 0,
"ShippingSourceOrderItemID": "string",
"ShippingSourceWarehouseID": "string",
"QtyPicked": 0,
"ReplacementSKU": "string",
"IsSKUReplaced": true,
"WarehouseBinCartSlotID": 0,
"RoundNumber": 0,
"WarehouseBinCartID": 0,
"LinkedToPOItemID": 0,
"ProductName": "string"
}
]
}
],
"ShippingTotal": 0,
"ShippingCarrier": "string",
"ShippingService": "string",
"OrderDiscountsTotal": 0,
"ShippingDiscountsTotal": 0,
"Duties": 0,
"InsuranceTotal": 0,
"DeclaredValue": 0,
"HandlingFee": 0,
"PaymentDate": "2026-07-17T13:37:35.454Z",
"OrderCurrencyCode": 0,
"TrackingNumber": "string",
"AllTrackingNumbers": [
"string"
],
"InvoicePrinted": true,
"InvoicePrintedDate": "2026-07-17T13:37:35.454Z",
"CustomerServiceStatus": 0,
"TaxRate": 0,
"TaxTotal": 0,
"ShippingWeightTotalOz": 0,
"CustomerEmail": "string",
"ShippingState": "string",
"ShippingCountry": "string",
"FinalShippingFee": 0,
"FinalValueTotal": 0,
"ProductIDMostExpensiveInOrder": "string",
"EstimatedDeliveryDate": "2026-07-17T13:37:35.454Z",
"RequireSignatureConfirmation": true,
"RelatedOrders": [
{
"RelatedOrderID": 0,
"RelationshipType": 0,
"CreatedOn": "2026-07-17T13:37:35.454Z"
}
],
"RelatedPurchaseOrderID": 0
}
],
"TotalResults": 0
}
}
Demo in c#
string baseUri = "http://{server_id}.api.sellercloud.com/rest";
string url = $"{baseUri}/api/Orders/GetAllByView?request.ViewID=1&request.pageNumber=1&request.pageSize=50";
string username = "{your_username}";
string password = "{your_password}";
IAuthenticationClient authenticationClient = new AuthenticationClient();
string token = authenticationClient.Login(baseUri, new LoginRequest(username, password));
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
var responseMessage = client.GetAsync(url).Result;
var content = responseMessage.Content
.ReadAsStringAsync()
.Result;
return JsonConvert.DeserializeObject<GetAllResponse>(content);
}
public class AuthenticationClient : IAuthenticationClient
{
public string Login(string baseUri, LoginRequest loginRequest)
{
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, $"{baseUri}/api/token"))
{
var json = JsonConvert.SerializeObject(loginRequest);
using (var stringContent = new StringContent(json, Encoding.UTF8, "application/json"))
{
request.Content = stringContent;
var responseMessage = client.SendAsync(request).Result;
var content = responseMessage.Content
.ReadAsStringAsync()
.Result;
var response = JsonConvert.DeserializeObject(content);
return response.access_token;
}
}
}
}
public class LoginResponse
{
public string token_type { get; set; }
public string access_token { get; set; }
public DateTime? validFrom { get; set; }
public DateTime? validTo { get; set; }
}
public interface IAuthenticationClient
{
string Login(string baseUri, LoginRequest request);
}
public class LoginRequest
{
public LoginRequest(string username, string password)
{
this.Username = username;
this.Password = password;
}
public string Username { get; }
public string Password { get; }
}