GET Orders/Get?orderId={orderId}
Get an order by order Id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
OrderName | Description | Type | Additional information |
---|---|---|---|
OrderId |
Unique identifier for the order |
string |
None. |
AccountId |
Id for Marketplace account |
string |
None. |
MarketplaceId |
Id for the market place origin of the order |
integer |
None. |
MarketplaceName |
name of the marketplace the order |
string |
None. |
EmailOptIn |
has the user opted into allow notification via email |
boolean |
None. |
Discount |
Total discount amount on order |
decimal number |
None. |
PaymentMethod |
The method used to pay for the order |
string |
None. |
PaymentRef |
reference number for the payment |
string |
None. |
Notes |
notes for order could be customer messages, delivery instructions ect |
string |
None. |
InternalNotes |
Internal notes |
string |
None. |
LastUpdated |
Date and time of the last update to the order |
date |
None. |
ExpectedShipDate |
(UTC) Date and time the order must be fulfilled by |
date |
None. |
Quantity |
Number of units that the user has purchased |
string |
None. |
Color |
The color of the item that was ordered (if applicable) |
string |
None. |
Price |
The price of the item when the user purchases one |
string |
None. |
VariantId |
Unique identifier for the Product Variation that was ordered |
string |
None. |
ShippingDetail |
Shipping information container for the order |
Shippingdetail |
None. |
IsWishExpress |
Is a wish express order |
string |
None. |
Cost |
The amount of money paid for the product (per unit) |
string |
None. |
ShippingCost |
The amount of money paid for shipping the product (per unit) |
string |
None. |
HoursToFulfill |
hours left to fulfill order. |
string |
None. |
RequiresDeliveryConfirmation |
Order must be shipped using a carrier that has last mile tracking functionality |
string |
None. |
ProductImageUrl |
The product image |
string |
None. |
Size |
Ordered item size (if applicable) |
string |
None. |
Sku |
Unique item identifier for your system |
string |
None. |
TrackingConfirmed |
Tracking confirmation |
string |
None. |
OrderTotal |
Total value of the order |
string |
None. |
ProductId |
Unique identifier for the Product being ordered |
string |
None. |
Shipping |
Amount of money user pays for shipping for the product(per unit) |
string |
None. |
State |
The status of the order: APPROVED, SHIPPED, REFUNDED, REQUIRE_REVIEW |
string |
None. |
OrderTime |
Date and time of when the order was placed |
date |
None. |
DaysToFulfill |
Number of days left to fulfill this order |
string |
None. |
ProductName |
Name of the product |
string |
None. |
TransactionId |
Orders unique grouping identifier to highlight if the user makes several purchases at once |
string |
None. |
BuyerId |
Identification of the buyer for this order. |
string |
None. |
Response Formats
application/json, text/json
{ "OrderId": "sample string 1", "AccountId": "sample string 2", "MarketplaceId": 3, "MarketplaceName": "sample string 4", "EmailOptIn": true, "Discount": 6.0, "PaymentMethod": "sample string 7", "PaymentRef": "sample string 8", "Notes": "sample string 9", "InternalNotes": "sample string 10", "LastUpdated": "2024-05-06T02:21:46.6964253Z", "ExpectedShipDate": "2024-05-06T02:21:46.6964253Z", "Quantity": "sample string 13", "Color": "sample string 14", "Price": "sample string 15", "VariantId": "sample string 16", "ShippingDetail": { "PhoneNumber": "sample string 1", "MobileNumber": "sample string 2", "City": "sample string 3", "State": "sample string 4", "Name": "sample string 5", "Forename": "sample string 6", "Surname": "sample string 7", "Country": "sample string 8", "StreetAddress2": "sample string 9", "StreetAddress1": "sample string 10", "Zipcode": "sample string 11" }, "IsWishExpress": "sample string 17", "Cost": "sample string 18", "ShippingCost": "sample string 19", "HoursToFulfill": "sample string 20", "RequiresDeliveryConfirmation": "sample string 21", "ProductImageUrl": "sample string 22", "Size": "sample string 23", "Sku": "sample string 24", "TrackingConfirmed": "sample string 25", "OrderTotal": "sample string 26", "ProductId": "sample string 27", "Shipping": "sample string 28", "State": "sample string 29", "OrderTime": "2024-05-06T02:21:46.7120569Z", "DaysToFulfill": "sample string 31", "ProductName": "sample string 32", "TransactionId": "sample string 33", "BuyerId": "sample string 34" }