object RMALabelType

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.
`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.
`created_date`	ISODateTime	Created date in ISO-8601 date or datetime format, returned in UTC when time is included.
`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.
`dimensions`	Dimensions	Package or item dimensions. Length, width, and height are in inches unless account or carrier configuration specifies another unit.
`length`	`Float`	DEPRECATED Use dimensions instead Length as a decimal number in inches unless the account or carrier configuration specifies another unit.
`width`	`Float`	DEPRECATED Use dimensions instead Width as a decimal number in inches unless the account or carrier configuration specifies another unit.
`height`	`Float`	DEPRECATED Use dimensions instead Height as a decimal number in inches unless the account or carrier configuration specifies another unit.
`weight`	`Float`	DEPRECATED Use dimensions instead Weight as a decimal number in ounces unless the account or carrier configuration specifies another unit.
`to_name`	`String`	To name for this RMA label.
`address1`	`String`	Address line 1 for the address or contact.
`address2`	`String`	Address line 2 for the address or contact.
`address_city`	`String`	Address city for this RMA label.
`address_state`	`String`	Address state for this RMA label.
`address_zip`	`String`	Address zip for this RMA label.
`address_country`	`String`	Address country for this RMA label.
`pdf_location`	`String`	URL for the PDF location resource.

Referenced By

Return Type

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "tracking_number": "1Z999AA10123456784",
  "status": "pending",
  "created_date": "2026-07-09T15:30:00Z",
  "carrier": "ups",
  "shipping_method": "ups_ground",
  "cost": "19.99",
  "dimensions": {length: 12.5, width: 8.0, height: 4.0},
  "length": 12.5,
  "width": 8.0,
  "height": 4.0,
  "weight": 1.25,
  "to_name": "Acme Corp",
  "address1": "123 Fulfillment Ave",
  "address2": "Suite 100",
  "address_city": "New York",
  "address_state": "NY",
  "address_zip": "10001",
  "address_country": "US",
  "pdf_location": "https://example.com/labels/SHIP-1001.pdf"
}