Create Manual Reserve - Sellercloud API Docs
Create Manual Reserve
Overview
This endpoint can be used to create a manual reserve for a 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 for such an endpoint for server XX is https://xx.api.sellercloud.com/rest/api/Inventory/ManualReserves/Create
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/Inventory/ManualReserves/Create
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 | Product id of the product for which to create a manual reserve | Yes |
| Quantity | Integer | Reserve quantity | Yes |
| Channel | Enum | Channel Required when ReserveType is ‘Channel’ |
No |
| ReserveType | Enum | Reserve type. Possible values: 0 – Customer 1- Channel |
Yes |
| CustomerId | Integer | ID of a customer. Required when ReserveType is ‘Customer’ |
No |
| WarehouseId | Integer | ID of a warehouse | Yes |
| StartDate | DateTime | Start date | Yes |
| EndDate | DateTime | End date Must be greater than start date |
Yes |
Response
- If the user is authenticated and the request is successful, then the response will be Status Code 200 => OK.
- 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 incorrect request, the response will be with Status Code 400 Bad Request.