Overview
To get information for a single existing order, you can use the endpoint presented in this article. To consume it, you must:
- Be an authenticated user.
For information on how you can authenticate, see: Authentication
As soon as you do authentication and receive a valid token, it needs to be passed on the call for receiving a single order.
- Have a valid ID of an existing order.
Endpoint
An example of such endpoint for XX server is:
https://xx.api.sellercloud.com/rest/api/Orders/{id}
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/Orders/{id}
Request
- Method Type: HttpGet
- Authorization: Use Bearer Token + token received from token authentication
- Header info: Content-Type: application/json
- Parameters: ID of the order
| Parameter | Data Type | Description | Is Required |
| id | integer | The ID of the existing sales order. | Yes |
Example: https://tt.api.sellercloud.com/rest/api/orders/581
Response
- If user is authenticated and provides a valid ID of an order, then response will be Status Code 200 => OK and order metadata in JSON format
- If user is not authenticated, then response will be Status Code 401 => Not Valid Token
- On server response => Status Code 500 => Internal Server Error
Response Body
Note: The currency of international orders is automatically converted to USD upon their creation. In the response body, you will see the conversion rate used by Sellercloud for each individual order. See CurrencyRateFromUSD and CurrencyRateToUSD.
{
"OrderID": 0,
"OrderDetails": {
"CompanyId": 0,
"ClientId": 0,
"SiteCode": 0,
"OrderSource": 0,
"OrderSourceOrderId": "string",
"OrderSourceOrderIdUrl": "string",
"EbaySellingManagerSalesRecordNumber": "string",
"EbayUserId": "string",
"EbayUserUrl": "string",
"CustomerEmail": "string",
"CustomerID": 0,
"SalesRep1": 0,
"SalesRep2": 0,
"SalesRep3": 0,
"PromiseDate": "2024-09-10T13:38:28.339Z",
"DisplayPromiseDate": true,
"EstimatedOrderDeliveryDate": "2024-09-10T13:38:28.339Z",
"CurrencyCode": 0,
"CurrencyRateFromUSD": 0,
"CurrencyRateToUSD": 0,
"OrderDate": "2024-09-10T13:38:28.339Z",
"CreatedOn": "2024-09-10T13:38:28.339Z",
"OrderSubType": 0,
"MarkettingSourceID": 0,
"MarketingSourceEnabled": true,
"EbayOrdersSource3": "string",
"EbayOrdersSource3Url": "string",
"DisableOrderSourceOrderID": true,
"IsOrderLocked": true,
"LockedByUser": "string",
"LockedTimeLeft": 0,
"AllowEditChannelAndChannelOrder": true,
"AllowEditPinnedOrder": true,
"IsModified": true
},
"Statuses": {
"OrderStatus": 1,
"ShippingStatus": 0,
"PaymentStatus": 10,
"RushOrder": true,
"DropshipStatus": 0,
"CustomerServiceStatus": 0,
"IsDelivered": true,
"BackorderStatus": 0,
"IsInvoicePrinted": true,
"IsExported": true,
"InventoryDisabled": true,
"OkToProcess": 0,
"OkToShip": 0,
"QBExported": true,
"Confirmed": true,
"FeedbackReceived": true,
"ShippingVerified": true,
"ChannelNotifiedOfShipping": true,
"FinalSale": true,
"PickingStatus": 0,
"InPicklist": "string",
"IsInvoiced": "string",
"IsInGroup": "string",
"IsBlackListed": true,
"SkubloxStatus": "string",
"AddressVerifiedStatus": 0
},
"OrderItems": [
{
"ID": 0,
"OrderID": 0,
"ProductID": "string",
"_ProductIDInitial": "string",
"ProductIDOriginal": "string",
"ProductIDRequested": "string",
"ItemProductIdExists": true,
"DisplayName": "string",
"DisplayDescription": "string",
"ImageURL": "string",
"Qty": 0,
"TaxExempt": true,
"SitePrice": 0,
"PricePerCase": 0,
"TotalCases": 0,
"QtyPerCase": 0,
"EBayItemID": "string",
"EBayItemUrl": "string",
"InventoryAvailableQty": 0,
"WarehouseID": 0,
"BundleItems": [
{
"ProductID": "string",
"ImageURL": "string",
"ProductName": "string",
"QtyPerKit": 0,
"TotalQty": 0,
"BackOrderQty": 0,
"Picked": 0,
"OrderItemID": 0
}
],
"BackOrderQty": 0,
"QtyReturned": 0,
"QtyPicked": 0,
"IgnoreQtyPickedOnSaving": true,
"QtyShipped": 0,
"Notes": "string",
"LineTotal": 0,
"DiscountValue": 0,
"DiscountType": 0,
"CanBeDeleted": true,
"CanBePicked": true,
"AdjustedSitePrice": 0,
"ShadowOf": "string",
"LineTaxTotal": 0,
"ShippingCost": 0,
"ShippingTax": 0,
"DoNotAllowToEditQtyOnOrderIfAlreadyPicked": true,
"RowStatus": 0,
"IsModified": true
}
],
"RelatedOrders": [
{
"RelatedOrderID": 0,
"RelationshipType": 0,
"CreatedOn": "2024-09-10T13:38:28.340Z"
}
],
"TotalInfo": {
"SubTotal": 0,
"Discount": 0,
"OrderLevelDiscount": 0,
"OrderItemLevelDiscount": 0,
"OriginalCalculatedDiscount": 0,
"PromoCode": "string",
"ShippingDiscount": 0,
"Tax": 0,
"TaxRate": 0,
"TaxType": 0,
"IncludeTaxInGrandTotal": true,
"Duties": 0,
"CustomTaxRate": 0,
"Shipping": 0,
"Handling": 0,
"Insurance": 0,
"GiftWrap": 0,
"ShouldDisplayWrapFee": true,
"GrandTotal": 0,
"ForceUseFixedTaxAmount": true,
"TaxRateDecimalPoints": 0,
"IsModified": true
},
"PaymentOptions": {
"PaymentTerm": 0,
"Total": 0,
"Received": 0,
"Uncleared": 0,
"Refunded": 0,
"RemainingDues": 0
},
"ShippingDetails": {
"ShippingStatus": 0,
"Carrier": "string",
"Service": "string",
"RushOrder": true,
"RequirePINToShip": true,
"OrderShippingPromiseDate": "2024-09-10T13:38:28.340Z",
"ShipDate": "2024-09-10T13:38:28.340Z",
"ShippingTotal": 0,
"ShippingDiscountsTotal": 0,
"CostOfShipping": 0,
"EstShipWeight": {
"Pounds": 0,
"Ounces": 0
},
"ShippedBy": 0,
"ShippedByUser": "string",
"ShippingLocation": 0,
"ShippingStation": 0,
"ShippingDeviceFormattedCrc": "string",
"DisplayShippingDevice": true,
"LockShippingMethod": true,
"AllowShippingWithoutPaymentValue": true,
"AllowShippingWithoutPaymentVisible": true,
"OtherCarrier": "string",
"OtherMethed": "string",
"RequestedShippingBy": "string",
"MaximumOrderItemsToDisplaySetting": true,
"OrderItemCount": "string",
"ShippingSourceOrderID": "string",
"DisplayShippingSourceOrderID": "string",
"BatchNumber": "string",
"RequireSignatureConfirmation": true,
"IsShowOrderShippingLabel": true,
"ValidateAddressEnabled": true,
"ValidateAddressToolTip": "string",
"AddressClassification": "string",
"IsModified": true
},
"OrderPackages": [
{
"ShippingWeight": {
"Pounds": 0,
"Ounces": 0
},
"ID": 0,
"TrackingNumber": "string",
"TrackingNumberUrl": "string",
"TrackingNumberText": "string",
"Length": 0,
"Width": 0,
"Height": 0,
"Weight": 0,
"ShippingCost": 0,
"FinalShippingFee": 0,
"EstimatedDeliveryDate": "2024-09-10T13:38:28.340Z",
"DeliveryDate": "2024-09-10T13:38:28.340Z",
"DeliveryStatus": 0,
"DeclaredValue": 0,
"Items": [
{
"PackageID": 0,
"OrderItemID": 0,
"OrderItemBundleItemID": 0,
"IsKitParent": true,
"ProductID": "string",
"Qty": 0,
"ItemName": "string"
}
],
"EnableOrderShipmentTrackingAPI": true,
"CWAPackagingType": "string"
}
],
"LastUpdated": "2024-09-10T13:38:28.340Z",
"OrderSiteCode": "string",
"OrderItemDiscountAllowed": true,
"EnableCaseQty": true,
"ShowProductImageOnOrderDetailPage": true,
"HideBackOrdersColumnInManageOrders": true,
"DisplayLocationNotesOnOrderItemsGrid": true,
"EnableWarehouseBins": true,
"EnableSecondSalesRep": true,
"RmaID": 0,
"RelatedPurchaseOrderID": 0,
"IsWholeSaleOrder": true,
"MostExpensiveSKU": "string",
"RequirePinToSetCancelledOrdersToInProcess": true,
"ForceEnterCommentsWhenSettingOrderToOnHoldOrProblem": true,
"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"
},
"StoreType": 0,
"Payments": [
{
"ID": 0,
"TransactionReferenceNumber": "string",
"PaidAmount": 0,
"PaymentDate": "2024-09-10T13:38:28.340Z",
"PaymentType": 1,
"PaymentMethod": 1,
"PaymentStatus": 0
}
],
"ProfitAndLoss": {
"ItemCost": "string",
"ItemCostUsd": "string",
"PostingFee": "string",
"PostingFeeUsd": "string",
"Comission": "string",
"ComissionUsd": "string",
"TransactionFee": "string",
"TransactionFeeUsd": "string",
"ShippingCost": "string",
"ShippingCostUsd": "string",
"ShippingCostTooltip": "string",
"Tax": "string",
"TaxUsd": "string",
"Promotion": "string",
"PromotionUsd": "string",
"Rebates": "string",
"RebatesUsd": "string",
"OrderCost": "string",
"OrderCostUsd": "string",
"Payments": "string",
"PaymentsVisible": true,
"PaymentsUsd": "string",
"Adjustments": "string",
"AdjustmentsUsd": "string",
"DropShipFee": "string",
"DropShipFeeUsd": "string",
"ShippingClaim": "string",
"ProfitLoss": "string",
"ProfitLossUsd": "string",
"ProfitLossForParentOrder": "string",
"ProfitForParentOrderTooltip": "string",
"QbeExported": "string",
"CurrencyCode": 0,
"MiscFees": "string"
},
"CustomColumns": [
{
"ColumnName": "string",
"DisplayName": "string",
"Value": {}
}
],
"GiftDetails": {
"IsGiftOrder": true,
"IsWholeSaleOrder": true,
"HasOrderItems": true,
"GiftDetails": {
"UseGiftWrap": true,
"GiftWrapFee": 0,
"GiftMessage": "string",
"GiftWrapType": "string"
}
},
"RequireSignatureConfirmation": true
}