Overview
This endpoint is used for getting orders in bulk, using a saved view. A saved view for Orders must be created on the Manage Orders page in the new Sellercloud UI.
The advantages of using this endpoint for getting orders are as follows:
- Ease of use: You can set your filters once, save them as a saved view, and then easily utilize those same filters when getting orders by simply referencing that saved view ID.
- Flexibility: The filters available in the new SellerCloud UI are numerous and extremely flexible.
In order to get information for orders by saved view, you can consume the endpoint presented in this article. However in order to do that, you must:
- Be an authenticated user. For information on how you can authenticate, see: Authentication. As soon as you authenticate and receive a valid token, it needs to be passed on this call for getting orders.
- Have a valid ID of a currently existing saved view. For information on how you can get existing saved views, see Saved Views
Endpoint
The endpoint for the TT server would be:
For your server, the endpoint will be:
Request
Information about expected request parameters can be found on swagger UI https://tt.api.sellercloud.com/rest/swagger.

- Method Type: HttpGet
- Authorization: Use Bearer Token + token received from token authentication
- Header info: Content-Type: application/json
- Parameters:
Parameters | Data Type | Description | Is Required |
pageNumber | integer | Page number | Yes |
pageSize | integer | Number of orders per page.
NOTE: Maximum number of orders that can be pulled with a single call is 50. |
Yes |
viewID | integer | ID of existing saved view | Yes |
Response
- If user is authenticated and provides a valid page number and page size, then response will be Status Code 200 => OK and orders metadata in JSON format
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
{ "Items": [ { "ID": 0, "OrderSourceOrderID": "string", "OrderSource": "Local_Store", "OrderSubType": "None", "bRushOrder": true, "IsGiftOrder": true, "IsBlackListed": true, "ShippingStatus": 0, "PaymentStatus": 0, "StatusCode": 0, "Dropship": "None", "FirstName": "string", "LastName": "string", "TimeOfOrder": "2020-09-09T06:31:01.370Z", "GrandTotal": 0, "CompanyName": "string", "UserID": 0, "ShipDate": "2020-09-09T06:31:01.370Z", "OrderShippingPromiseDate": "2020-09-09T06:31:01.370Z", "HomeCountryCode": 0, "Country": "string", "LastUpdated": "2020-09-09T06:31:01.370Z", "Payments": [ { "TransactionReferenceNumber": "string", "PaidAmount": 0, "PaymentDate": "2020-09-09T06:31:01.370Z", "PaymentType": "Information", "PaymentMethod": "CreditCard" } ], "DestinationState": "string", "DestinationCountry": "string", "ShippingAddress": { "IsShippingAddress": true, "IsBillingAddress": true, "AddressClassification": "None", "Notes": "string", "HomePhone": "string", "EmailAddress": "string", "AddressStatus": "Unknown", "AddressSource": "LocalSite", "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": { "IsShippingAddress": true, "IsBillingAddress": true, "AddressClassification": "None", "Notes": "string", "HomePhone": "string", "EmailAddress": "string", "AddressStatus": "Unknown", "AddressSource": "LocalSite", "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": "US", "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": "2020-09-09T06:31:01.370Z", "BackOrderActionBy": 0, "EstimatedTimeArrival": "2020-09-09T06:31:01.370Z", "ReplacementSKU": "string", "ListingError": 0, "FeedBackID": "string", "FeedBackReminderSent": "2020-09-09T06:31:01.370Z", "BackOrderQty": 0, "BackOrderDate": "2020-09-09T06:31:01.370Z", "BackOrderBy": 0, "EstimatedShipDate": "2020-09-09T06:31:01.370Z", "NotifyCustomerService": true, "NotifyCustomer": "string", "DisputeID": "string", "OriginalSKU": "string", "IsSKUReplaced": true, "InsuranceCost": 0, "FeedbackLeft": true, "FeedbackLeftOn": "2020-09-09T06:31:01.370Z", "FeedBackLeftID": "string", "IsDropShipped": true, "DropShippedOn": "2020-09-09T06:31:01.370Z", "DropShippedToVendor": 0, "Notes": "string", "ProductIDOriginal": "string", "SalesRepId": 0, "ShipFromWareHouseID": 0, "ShipFromWarehouseName": "string", "FeedBackFailureCount": 0, "FeedBackLastFailureOn": "2020-09-09T06:31:01.370Z", "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": "2020-09-09T06:31:01.370Z", "ShipType": "string", "DropShippedStatus": 0, "BatchExportedJobID": 0, "BatchExportedDateTime": "2020-09-09T06:31:01.370Z", "ItemStatusCode": 0, "ItemPaymentStatus": 0, "ItemShippingStatus": 0, "BatchExportDeliveryJobID": 0, "BatchExportDeliveryDateTime": "2020-09-09T06:31:01.370Z", "CancellationRequestSentToInnotrac": true, "ShippingSourceCancellationQty": 0, "TotalRefunded": 0, "ReturnDocumentNumber": "string", "BatchExportReturnGUID": "string", "BatchExportReturnJobID": 0, "BatchExportReturnDateTime": "2020-09-09T06:31:01.370Z", "ProfitAndLossAdjustmentTotal": 0, "SalesRecordNumber": "string", "ShippingSourceOrderItemSKU": "string", "QtyPerCase": 0, "TotalCases": 0, "PricePerCase": 0, "QtyPicked": 0, "ProductIDRequested": "string", "WholesaleConfirmedQty": 0, "WholesaleConfirmShipDate": "2020-09-09T06:31:01.370Z", "WholesaleBackOrderQty": 0, "WholesaleBackOrderShipDate": "2020-09-09T06:31:01.370Z", "WholesaleRefuseQty": 0, "KitItemsCount": 0, "VatRate": 0, "VATTotal": 0, "AmazonShipmentID": "string", "WarehouseBinCartSlotID": 0, "SettlementID": 0, "RoundNumber": 0, "WarehouseBinCartID": 0, "MainItemID": "string", "LinkedToPOItemID": 0, "OrderItemShipDate": "2020-09-09T06:31:01.370Z", "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": "2020-09-09T06:31:01.370Z", "BackOrderActionBy": 0, "BackOrderQty": 0, "BackOrderDate": "2020-09-09T06:31:01.370Z", "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, "InsuranceTotal": 0, "DeclaredValue": 0, "HandlingFee": 0, "PaymentDate": "2020-09-09T06:31:01.370Z", "OrderCurrencyCode": "USD", "TrackingNumber": "string", "AllTrackingNumbers": [ "string" ], "InvoicePrinted": true, "InvoicePrintedDate": "2020-09-09T06:31:01.370Z", "CustomerServiceStatus": 0, "TaxRate": 0, "TaxTotal": 0, "ShippingWeightTotalOz": 0, "CustomerEmail": "string", "ShippingState": "string", "ShippingCountry": "string", "FinalShippingFee": 0, "FinalValueTotal": 0, "ProductIDMostExpensiveInOrder": "string", "EstimatedDeliveryDate": "2020-09-09T06:31:01.370Z", "RequireSignatureConfirmation": true, "RelatedOrders": [ { "RelatedOrderID": 0, "RelationshipType": "Unknown", "CreatedOn": "2020-09-09T06:31:01.370Z" } ] } ], "TotalResults": 0 } |
- If user is not authenticated, then response will be Status Code 401 => Not Valid Token
- On server response => Status Code 500 => Internal Server Error
Different status codes can be found in this section here: https://developer.sellercloud.com/category/pqa1htn09q-resources
Demo in c#
1 2 |
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);
}
1 2 3 4 5 6 7 8 9 10 11 |
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;
}
}
}
}
1 2 3 4 |
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; }
}