xclade
Admin APIReturns

Cancel Return Receival

Cancel the receival process previously started, and hasn't been confirmed, of a return.

DELETE
/admin/returns/{id}/receive

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

The return's ID.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X DELETE "https://{tenant}.api.myxclade.com/admin/returns/string/receive"
{
  "id": "string",
  "object": "return",
  "deleted": true
}

{
  "message": "Discount must be set to dynamic",
  "type": "not_allowed"
}

"Unauthorized"
{
  "message": "Entity with id 1 was not found",
  "type": "not_found"
}
{
  "code": "unknown_error",
  "message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
  "type": "QueryRunnerAlreadyReleasedError"
}
{
  "code": "invalid_request_error",
  "message": "Discount with code TEST already exists.",
  "type": "duplicate_error"
}

{
  "code": "api_error",
  "message": "An error occured while hashing password",
  "type": "database_error"
}

Remove Damaged Item from Return

Remove a damaged item, whose quantity is to be dismissed, in the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return.

Remove a Received Item from Return

Remove a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return.