input CreateReturnInput

Fields

Field	Type	Description
`customer_account_id`	`String`	Use this when you are a 3PL acting on behalf of one of your customers.
`order_id`	`String`!	Public API order ID that identifies the related record.
`warehouse_id`	`String`!	Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.
`return_reason`	`String`!	Return reason for this return.
`label_type`	ReturnLabelType!	Label type for this return.
`label_cost`	`String`!	Monetary amount as a decimal value in the record currency; not cents.
`address`	AddressInput!	Address details for this return.
`dimensions`	DimensionsInput!	Package or item dimensions. Length, width, and height are in inches unless account or carrier configuration specifies another unit.
`shipping_carrier`	`String`!	Carrier name or carrier code used for shipping.
`shipping_method`	`String`!	Carrier service or shipping method code.
`line_items`	[CreateReturnLineItemInput]!	List of line items associated with this return.
`email_customer_return_label`	`Boolean`	Whether to email the generated return label to the customer.
`tracking_number`	`String`	If a label was generated outside of ShipHero, you can send us that tracking number so we can create a generic label with it and assign it to the return.
`create_label`	`Boolean`	If you want us to generate a label for the return.
`partner_id`	`String`	Public API partner ID that identifies the related record.
`display_issue_refund`	`Boolean`	If the user can have access to the refund form.
`return_pickup_datetime`	DateTime	If a scheduled return is needed.

Referenced By

return_create Mutation

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "order_id": "T3JkZXI6MTIzNA==",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "return_reason": "Customer requested expedited handling.",
  "label_type": "PREPAID",
  "label_cost": "19.99",
  "address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "dimensions": {length: 12.5, width: 8.0, height: 4.0},
  "shipping_carrier": "ups",
  "shipping_method": "ups_ground",
  "line_items": [[{sku: "BLUE-TEE-M", quantity: 2}]],
  "email_customer_return_label": true,
  "tracking_number": "1Z999AA10123456784",
  "create_label": true,
  "partner_id": "UmVjb3JkOjEyMzQ=",
  "display_issue_refund": true,
  "return_pickup_datetime": "2026-07-09T15:30:00Z"
}