customerReturns

Requires a customer (portal or buyer app) session.

THIS partner's returns, newest first (Requested | Collected | Credit note issued). 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

query CustomerReturns {
  customerReturns {
    items {
      id
      creditNoteNumber
      orderNumber
      returnNumber
      rmaNumber
      status
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CustomerReturns {\n  customerReturns {\n    items {\n      id\n      creditNoteNumber\n      orderNumber\n      returnNumber\n      rmaNumber\n      status\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "customerReturns": {
      "items": [
        {
          "id": "id",
          "creditNoteNumber": "string",
          "orderNumber": "string",
          "returnNumber": "string",
          "rmaNumber": "string",
          "status": "string"
        }
      ]
    }
  }
}

customerReturns(
  pagination: CustomerPaginationInput
): CustomerReturnConnection!

Arguments

customerReturns.pagination ● CustomerPaginationInput input

Which page to return, and optional search text.

Type

CustomerReturnConnection object

A page of returns.