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! | |
warehouse_id | String! | |
return_reason | String! | |
label_type | ReturnLabelType! | |
label_cost | String! | |
address | AddressInput! | |
dimensions | DimensionsInput! | |
shipping_carrier | String! | |
shipping_method | String! | |
line_items | [CreateReturnLineItemInput]! | |
email_customer_return_label | Boolean | |
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 | |
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": "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"
}