return_create

Arguments

ArgumentTypeRequiredDefaultDescription
dataCreateReturnInput!Yes

Return Type

CreateReturnOutput

Mutation

mutation return_create(
  $data: CreateReturnInput!
) {
  return_create(
    data: $data
  ) {
    request_id
    complexity
    return {
      ...ReturnFragment
    }
  }
}

Variables

{
  "data": {
    "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"
  }
}

Response

{
  "data": {
    "return_create": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "return": {id: "UmV0dXJuOjEyMzQ="}
    }
  }
}