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": "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": DateTime
  }
}

Response

{
  "data": {
    "return_create": {
      "request_id": "abc123",
      "complexity": 987,
      "return": Return
    }
  }
}