input CreateReturnInput

Fields

FieldTypeDescription
customer_account_idString

Use this when you are a 3PL acting on behalf of one of your customers

order_idString!
warehouse_idString!
return_reasonString!
label_typeReturnLabelType!
label_costString!
addressAddressInput!
dimensionsDimensionsInput!
shipping_carrierString!
shipping_methodString!
line_items[CreateReturnLineItemInput]!
email_customer_return_labelBoolean
tracking_numberString

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_labelBoolean

If you want us to generate a label for the return

partner_idString
display_issue_refundBoolean

If the user can have access to the refund form

return_pickup_datetimeDateTime

If a scheduled return is needed

Referenced By

Example

{
  "customer_account_id": "abc123",
  "order_id": "abc123",
  "warehouse_id": "abc123",
  "return_reason": "abc123",
  "label_type": "FREE",
  "label_cost": "abc123",
  "address": AddressInput,
  "dimensions": DimensionsInput,
  "shipping_carrier": "abc123",
  "shipping_method": "abc123",
  "line_items": CreateReturnLineItemInput,
  "email_customer_return_label": true,
  "tracking_number": "abc123",
  "create_label": true,
  "partner_id": "abc123",
  "display_issue_refund": true,
  "return_pickup_datetime": "abc123"
}