object RMALabel

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.
`rma_id`	`String`	Public API RMA ID that identifies the related record.
`shipment_id`	`String`	Public API shipment ID that identifies the related record.
`shipping_name`	`String`	Shipping name for this RMA label.
`tracking_number`	`String`	Carrier tracking number for the shipment or label.
`status`	`String`	Current status; use the API status values returned by this field when filtering or updating.
`carrier`	`String`	Carrier name or carrier code used for shipping.
`shipping_method`	`String`	Carrier service or shipping method code.
`cost`	`String`	Internal cost as a decimal monetary amount; distinct from customer-facing price.
`box_code`	`String`	Box code for this RMA label.
`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 RMA label.
`paper_pdf_location`	`String`	URL for the paper PDF location resource.
`thermal_pdf_location`	`String`	URL for the thermal PDF location resource.
`pdf_location`	`String`	URL for the PDF location resource.
`image_location`	`String`	URL for the image location resource.
`delivered`	`Boolean`	Whether the carrier marked this RMA label as delivered.
`picked_up`	`Boolean`	Whether the carrier picked up this RMA label shipment.
`refunded`	`Boolean`	Whether this RMA label has been refunded.
`needs_refund`	`Boolean`	True when this RMA label needs refund; false otherwise.
`profile`	`String`	Profile for this RMA label.
`full_size_to_print`	`String`	Full size to print for this RMA label.
`partner_fulfillment_id`	`String`	Public API partner fulfillment ID that identifies the related record.
`created_at`	ISODateTime	Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`updated_at`	ISODateTime	Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

Referenced By

MergeableOrder Type
Order Type

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "QWNjb3VudDoxMjM0",
  "order_id": "T3JkZXI6MTIzNA==",
  "rma_id": "UmVjb3JkOjEyMzQ=",
  "shipment_id": "U2hpcG1lbnQ6MTIzNA==",
  "shipping_name": "UPS Ground",
  "tracking_number": "1Z999AA10123456784",
  "status": "pending",
  "carrier": "ups",
  "shipping_method": "ups_ground",
  "cost": "19.99",
  "box_code": "STANDARD",
  "dimensions": {length: 12.5, width: 8.0, height: 4.0},
  "address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "paper_pdf_location": "https://example.com/labels/SHIP-1001.pdf",
  "thermal_pdf_location": "https://example.com/labels/SHIP-1001.pdf",
  "pdf_location": "https://example.com/labels/SHIP-1001.pdf",
  "image_location": "https://example.com/images/blue-tee.jpg",
  "delivered": true,
  "picked_up": true,
  "refunded": true,
  "needs_refund": true,
  "profile": "default",
  "full_size_to_print": "M",
  "partner_fulfillment_id": "UmVjb3JkOjEyMzQ=",
  "created_at": "2026-07-09T15:30:00Z",
  "updated_at": "2026-07-09T15:30:00Z"
}