Overview
This endpoint can be used to get the order snapshot.
In order to consume the endpoint, you must:
- Be 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 to the call.
Endpoint
An example of such an endpoint for XX server is https://xx.api.sellercloud.com/rest/api/Orders/{id}/Snapshot
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/Orders/{id}/Snapshot
Request
Method Type: HttpGet
Authorization: Use Bearer Token + token received from token authentication
Response
- If the user is authenticated and the request is successful, then the response will be Status Code 200 => OK with the order snapshot in the response. If the order does not have a snapshot then null will be returned for “OrderSnapshot” property.
- 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
- In case of an incorrect request, the response will be with status code 400 Bad Request
Response Body
{
"OrderSnapshot": {
"OrderID": 0,
"OrderDate": "2023-12-05T09:04:02.860Z",
"OrderSource": "string",
"OrderSourceOrderID": "string",
"SubTotal": 0,
"DiscountsTotal": 0,
"ShippingDiscountsTotal": 0,
"TaxTotal": 0,
"ShippingTotal": 0,
"HandlingTotal": 0,
"InsuranceTotal": 0,
"GiftWrapCharge": 0,
"GrandTotal": 0,
"PaymentMethod": "string",
"PaymentReference": "string",
"PaymentReferenceNumber": "string",
"PaymentDate": "2023-12-05T09:04:02.860Z",
"PaymentTotal": 0,
"PaymentReceived": 0,
"PaymentUnCleared": 0,
"PaymentRefunded": 0,
"PaymentRemaining": 0,
"Items": [
{
"SKU": "string",
"Quantity": 0,
"SitePrice": 0,
"UnitPrice": 0,
"LineTax": 0,
"ShippingTax": 0,
"GiftWrapTax": 0,
"Discount": 0,
"Total": 0,
"Kits": [
{
"KitSku": "string",
"TotalQty": 0
}
]
}
]
}
}