object Return

Fields

Field	Type	Description
`id`	`String`	Public API ID for this identifiable.
`legacy_id`	BigInt	Numeric legacy ID for this identifiable; use only where legacy IDs are required.
`account_id`	`String`	Public API account ID that identifies the related record.
`order_id`	`String`	Public API order ID that identifies the related record.
`partner_id`	`String`	Public API partner ID that identifies the related record.
`reason`	`String`	Human-readable reason for this return.
`status`	`String`	Current status; use the API status values returned by this field when filtering or updating.
`label_type`	ReturnLabelType	Label type for this return.
`label_cost`	`String`	Monetary amount as a decimal value in the record currency; not cents.
`labels`	[RMALabelType]	List of labels associated with this return.
`cost_to_customer`	`String`	Cost to customer for this return.
`shipping_carrier`	`String`	Carrier name or carrier code used for shipping.
`shipping_method`	`String`	Carrier service or shipping method code.
`dimensions`	Dimensions	Package or item dimensions. Length, width, and height are in inches unless account or carrier configuration specifies another unit.
`address`	Address	Address details for this return.
`line_items`	[ReturnLineItem]	List of line items associated with this return.
`total_items_expected`	`Int`	Total items expected as a numeric value.
`total_items_received`	`Int`	Total items received as a numeric value.
`total_items_restocked`	`Int`	Total items restocked as a numeric value.
`created_at`	ISODateTime	Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`display_issue_refund`	`Boolean`	Whether the UI should show the issue-refund action for this return.
`order`	Order	Order associated with this return.
`exchanges`	[ReturnExchange]	List of exchanges for this return.
`return_history`	[ReturnHistory]	List of return history for this return.
`attachments`	[ReturnAttachment]	List of attachments associated with this return.

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "QWNjb3VudDoxMjM0",
  "order_id": "UmV0dXJuOjEyMzQ=",
  "partner_id": "UmV0dXJuOjEyMzQ=",
  "reason": "Customer requested expedited handling.",
  "status": "pending",
  "label_type": "{tracking_number: \"1Z999AA10123456784\", carrier: \"ups\"}",
  "label_cost": "19.99",
  "labels": [[{tracking_number: "1Z999AA10123456784", carrier: "ups"}]],
  "cost_to_customer": "19.99",
  "shipping_carrier": "ups",
  "shipping_method": "ups_ground",
  "dimensions": {length: 12.5, width: 8.0, height: 4.0},
  "address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "line_items": [[{sku: "BLUE-TEE-M", quantity: 2}]],
  "total_items_expected": 100,
  "total_items_received": 100,
  "total_items_restocked": 100,
  "created_at": "2026-07-09T15:30:00Z",
  "display_issue_refund": true,
  "order": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"},
  "exchanges": [[{id: "UmV0dXJuRXhjaGFuZ2U6MTIzNA=="}]],
  "return_history": [[{id: "UmV0dXJuSGlzdG9yeToxMjM0"}]],
  "attachments": [[{filename: "damage-photo.jpg", url: "https://example.com/files/damage-photo.jpg"}]]
}