Get Manual Reserves - Sellercloud API Docs
Overview
This endpoint can be used to get the manual reserves for an existing product.
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 endpoint for server XX is: https://xx.api.sellercloud.com/rest/api/Inventory/ManualReserves/Get
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/Inventory/ManualReserves/Get
Request
- Method Type: HttpPost
- Authorization: Use Bearer Token + token received from token authentication
- Header info: Content-Type: application/json
- Parameters:
| Parameter | Data Type | Description | Required |
|---|---|---|---|
| ProductId | String | ID of existing product | Yes |
| PageNumber | Integer | Page number Records are returned in pages. This is the requested page number. Optional. Default is 1. |
No |
| PageSize | Integer | Page size Records are returned in pages. This is the requested page size. Minimum page size is 10. Maximum page size is 50. Optional. Default is 10. |
No |
Response
- If the user is authenticated and the request is successful, then the response will be Status Code 200 => OK with the manual reserves returned in the response body.
- If the user is not authenticated, then the response will be Status Code 401 => Not Valid Token.
- In case of 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
{
“ProductId”: “string”,
“ManualReserves”: [
{
“ReserveId”: 0,
“ProductId”: “string”,
“Channel”: 0,
“WarehouseId”: 0,
“WarehouseName”: “string”,
“Quantity”: 0,
“TotalOrders”: 0,
“StartDate”: “2023-07-17T17:40:56.700Z”,
“EndDate”: “2023-07-17T17:40:56.700Z”,
“ReserveType”: 0,
“CreatedOn”: “2023-07-17T17:40:56.700Z”,
“CustomerId”: 0,
“CustomerName”: “string”,
“CreatedById”: 0,
“CreatedByName”: “string”,
“IsActive”: true
}
],
“TotalManualReserves”: 0
}