customerCreateReturn

Requires a customer (portal or buyer app) session.

Request a return (RMA) against a delivered order. Errors: RETURN_WINDOW_EXPIRED, ITEM_NOT_ON_ORDER. screen 15.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation CustomerCreateReturn($input: CustomerCreateReturnInput!) {
  customerCreateReturn(input: $input) {
    id
    creditNoteNumber
    orderNumber
    returnNumber
    rmaNumber
    status
    pickupShipments {
      id
      shipmentNumber
      trackingNumber
      carrierName
      serviceLevelName
      status
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CustomerCreateReturn($input: CustomerCreateReturnInput!) {\n  customerCreateReturn(input: $input) {\n    id\n    creditNoteNumber\n    orderNumber\n    returnNumber\n    rmaNumber\n    status\n    pickupShipments {\n      id\n      shipmentNumber\n      trackingNumber\n      carrierName\n      serviceLevelName\n      status\n    }\n  }\n}",
  "variables": {
    "input": {
      "items": [
        {
          "orderItemId": "id",
          "quantity": 0
        }
      ],
      "orderId": "id",
      "reason": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "items": [
      {
        "orderItemId": "id",
        "quantity": 0
      }
    ],
    "orderId": "id",
    "reason": "string"
  }
}

Response:

{
  "data": {
    "customerCreateReturn": {
      "id": "id",
      "creditNoteNumber": "string",
      "orderNumber": "string",
      "returnNumber": "string",
      "rmaNumber": "string",
      "status": "string",
      "pickupShipments": [
        {
          "id": "id",
          "shipmentNumber": "string",
          "trackingNumber": "string",
          "carrierName": "string",
          "serviceLevelName": "string",
          "status": "AWAITING_PICKUP"
        }
      ]
    }
  }
}

customerCreateReturn(
  input: CustomerCreateReturnInput!
): CustomerReturnView!

Arguments

customerCreateReturn.input ● CustomerCreateReturnInput! non-null input

The details of the customer create return request.

Type

CustomerReturnView object

Portal-facing return view. Status: Requested | Collected | Credit note issued.