Overview
Endpoint that is presented in this article is used for creating replacement order.
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
Example for such endpoint for TT server is:
https://tt.api.sellercloud.com/rest/api/Orders/ReplacementOrder
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/Orders/ReplacementOrder
Request
- Method Type: HttpPost
- Authorization: Use Bearer Token + token received from token authentication
- Header info: Content-Type: application/json
Post Body:
Parameter | Data Type | Description | Is Required |
OrderID | Integer | Order ID of the order for which to create replacement order. | Yes |
ReasonID | Integer | ID of replacement reason. List of replacement reasons can be obtained from endpoint GET /Orders/ReplacementOrder/Reasons |
Yes |
AdditionalNote | String | Additional note | No |
DisableInventoryCount | Bool | Indicates whether the inventory cound should be disabled.
Default value is False. |
No |
SecurityPin | String | Security pin. Required if Delta is configured to require security pin for this operation. | No |
Response
- If user is authenticated and the request is successful, then response will be Status Code 200 => OK and the ID of the newly created replacement order will be returned.
- If user is not authenticated, then response will be Status Code 401 => Not Valid Token
- In case of error, response will be Status Code 500 => Internal Server Error
{ "ReplacementOrderID": 0 }