create_return
Initiate return requests for e-commerce orders by specifying order ID, return items, and return address details, streamlining the process within ShipBob API MCP Server.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | Items to return | |
| orderId | Yes | The ID of the order to create a return for | |
| returnAddress | No | Return address information |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"items": {
"description": "Items to return",
"items": {
"additionalProperties": false,
"properties": {
"orderItemId": {
"description": "Order item ID to return",
"type": "string"
},
"quantity": {
"description": "Quantity to return",
"type": "number"
},
"reason": {
"description": "Reason for return",
"type": "string"
}
},
"required": [
"orderItemId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"orderId": {
"description": "The ID of the order to create a return for",
"type": "string"
},
"returnAddress": {
"additionalProperties": false,
"description": "Return address information",
"properties": {
"address1": {
"description": "Address line 1",
"type": "string"
},
"address2": {
"description": "Address line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country code (e.g., US)",
"type": "string"
},
"name": {
"description": "Return address name",
"type": "string"
},
"state": {
"description": "State/Province",
"type": "string"
},
"zipCode": {
"description": "Zip/Postal code",
"type": "string"
}
},
"required": [
"name",
"address1",
"city",
"state",
"zipCode",
"country"
],
"type": "object"
}
},
"required": [
"orderId",
"items"
],
"type": "object"
}