getReturnsByCustomer

Requires permission sales:credit_note:list.

Lists the returns of one customer. Needs the credit notes list permission; a rep sees only their own customers' returns.

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 GetReturnsByCustomer($customerId: String!) {
  getReturnsByCustomer(customerId: $customerId) {
    id
    returnNumber
    status
    type
    createdAt
    baseTotalAmount
    creditNotes {
      id
      creditNoteNumber
      status
      type
      amount
      issueDate
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query GetReturnsByCustomer($customerId: String!) {\n  getReturnsByCustomer(customerId: $customerId) {\n    id\n    returnNumber\n    status\n    type\n    createdAt\n    baseTotalAmount\n    creditNotes {\n      id\n      creditNoteNumber\n      status\n      type\n      amount\n      issueDate\n    }\n  }\n}",
  "variables": {
    "customerId": "string"
  }
}
EOF

Variables:

{
  "customerId": "string"
}

Response:

{
  "data": {
    "getReturnsByCustomer": [
      {
        "id": "id",
        "returnNumber": "string",
        "status": "APPROVED",
        "type": "DEFECTIVE_RETURN",
        "createdAt": "2025-01-15T00:00:00Z",
        "baseTotalAmount": 0,
        "creditNotes": [
          {
            "id": "id",
            "creditNoteNumber": "string",
            "status": "string",
            "type": "string",
            "amount": 0,
            "issueDate": "2025-01-15T00:00:00Z"
          }
        ]
      }
    ]
  }
}

getReturnsByCustomer(
  customerId: String!
): [ProductReturn!]!

Arguments

getReturnsByCustomer.customerId ● String! non-null scalar

The ID of the customer.

Type

ProductReturn object

A return of goods, sales or purchase side, with its lines and the notes raised from it.