Admin APIReturns
Start Return Receival
Start a return receival process to be later confirmed using the `/admin/returns/:id/receive/confirm` API route.
AuthorizationBearer <token>
In: header
Path Parameters
id*string
The return's ID.
Query Parameters
fields?string
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
Request Body
application/json
internal_note?string
A note viewed only by admin users.
description?string
The return's description.
metadata?object
The return's metadata, can hold custom key-value pairs.
Response Body
application/json
application/json
text/plain
application/json
application/json
application/json
application/json
curl -X POST "https://{tenant}.api.myxclade.com/admin/returns/string/receive" \ -H "Content-Type: application/json" \ -d '{}'{
"order": {
"id": "string",
"version": 0,
"order_change": {},
"status": "canceled",
"region_id": "string",
"customer_id": "string",
"sales_channel_id": "string",
"email": "user@example.com",
"currency_code": "usd",
"shipping_address": {
"id": "string",
"customer_id": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"company": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_code": "us",
"province": "us-ca",
"postal_code": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"billing_address": {
"id": "string",
"customer_id": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"company": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_code": "us",
"province": "us-ca",
"postal_code": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"items": [
{
"id": "string",
"title": "string",
"subtitle": "string",
"thumbnail": "string",
"variant_id": "string",
"product_id": "string",
"product_title": "string",
"product_description": "string",
"product_subtitle": "string",
"product_type": "string",
"product_collection": "string",
"product_handle": "string",
"variant_sku": "string",
"variant_barcode": "string",
"variant_title": "string",
"variant_option_values": {
"Color": "Red"
},
"requires_shipping": true,
"is_discountable": true,
"is_tax_inclusive": true,
"compare_at_unit_price": 0,
"unit_price": 0,
"quantity": 0,
"tax_lines": [
{
"item": {},
"item_id": "string",
"total": 0,
"subtotal": 0,
"id": "string",
"description": "string",
"tax_rate_id": "string",
"code": "string",
"rate": 0,
"provider_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"adjustments": [
{
"item": {},
"item_id": "string",
"id": "string",
"code": "string",
"amount": 0,
"order_id": "string",
"description": "string",
"promotion_id": "string",
"provider_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"detail": {
"id": "string",
"item_id": "string",
"item": {},
"quantity": 0,
"fulfilled_quantity": 0,
"delivered_quantity": 0,
"shipped_quantity": 0,
"return_requested_quantity": 0,
"return_received_quantity": 0,
"return_dismissed_quantity": 0,
"written_off_quantity": 0,
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"metadata": {},
"original_total": 0,
"original_subtotal": 0,
"original_tax_total": 0,
"item_total": 0,
"item_subtotal": 0,
"item_tax_total": 0,
"total": 0,
"subtotal": 0,
"tax_total": 0,
"discount_total": 0,
"discount_tax_total": 0,
"refundable_total": 0,
"refundable_total_per_unit": 0,
"product_type_id": "string",
"is_giftcard": true
}
],
"shipping_methods": [
{
"id": "string",
"order_id": "string",
"name": "string",
"description": "string",
"amount": 0,
"is_tax_inclusive": true,
"shipping_option_id": "string",
"data": {},
"metadata": {},
"tax_lines": [
{
"shipping_method": {},
"shipping_method_id": "string",
"total": 0,
"subtotal": 0,
"id": "string",
"description": "string",
"tax_rate_id": "string",
"code": "string",
"rate": 0,
"provider_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"adjustments": [
{
"shipping_method": {},
"shipping_method_id": "string",
"id": "string",
"code": "string",
"amount": 0,
"order_id": "string",
"description": "string",
"promotion_id": "string",
"provider_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"original_total": 0,
"original_subtotal": 0,
"original_tax_total": 0,
"total": 0,
"subtotal": 0,
"tax_total": 0,
"discount_total": 0,
"discount_tax_total": 0
}
],
"transactions": [
{
"id": "string",
"order_id": "string",
"amount": 0,
"currency_code": "usd",
"reference": "capture",
"reference_id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"order": {},
"version": 0
}
],
"summary": {
"pending_difference": 0,
"current_order_total": 0,
"original_order_total": 0,
"transaction_total": 0,
"paid_total": 0,
"refunded_total": 0,
"credit_line_total": 0,
"accounting_total": 0,
"raw_pending_difference": {},
"raw_current_order_total": {},
"raw_original_order_total": {},
"raw_transaction_total": {},
"raw_paid_total": {},
"raw_refunded_total": {},
"raw_credit_line_total": {},
"raw_accounting_total": {}
},
"metadata": {},
"canceled_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"original_item_total": 0,
"original_item_subtotal": 0,
"original_item_tax_total": 0,
"item_total": 0,
"item_subtotal": 0,
"item_tax_total": 0,
"original_total": 0,
"original_subtotal": 0,
"original_tax_total": 0,
"total": 0,
"subtotal": 0,
"tax_total": 0,
"discount_subtotal": 0,
"discount_total": 0,
"discount_tax_total": 0,
"gift_card_total": 0,
"gift_card_tax_total": 0,
"shipping_total": 0,
"shipping_subtotal": 0,
"shipping_tax_total": 0,
"original_shipping_total": 0,
"original_shipping_subtotal": 0,
"original_shipping_tax_total": 0,
"display_id": 0,
"credit_lines": [
{
"id": "string",
"order_id": "string",
"order": {},
"reference": "string",
"reference_id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"amount": 0
}
],
"is_draft_order": true,
"deleted_at": "2019-08-24T14:15:22Z",
"credit_line_total": 0,
"item_discount_total": 0,
"shipping_discount_total": 0
},
"return": {
"id": "string",
"status": "canceled",
"refund_amount": 0,
"order_id": "string",
"items": [
{
"id": "string",
"quantity": 0,
"received_quantity": 0,
"damaged_quantity": 0,
"reason_id": "string",
"note": "string",
"item_id": "string",
"return_id": "string",
"metadata": {}
}
],
"created_at": "2019-08-24T14:15:22Z",
"canceled_at": "2019-08-24T14:15:22Z",
"exchange_id": "string",
"location_id": "string",
"claim_id": "string",
"order_version": 0,
"display_id": 0,
"no_notification": true,
"received_at": "string"
}
}{
"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"
}Update Damaged Item of Return
Update 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.
Confirm Return Receival
Confirm that a return has been received. This updates the quantity of the items received, if not damaged, and reflects the changes on the order.