customerReturnableOrders

Requires a customer (portal or buyer app) session.

Delivered orders still inside PortalConfiguration.returnsWindowDays, with their returnable lines. 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 CustomerReturnableOrders {
  customerReturnableOrders {
    orderNumber
    deliveredDate
    orderId
    windowClosesAt
    lines {
      uomCode
      productName
      orderItemId
      quantityAlreadyReturned
      quantityDelivered
      sku
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CustomerReturnableOrders {\n  customerReturnableOrders {\n    orderNumber\n    deliveredDate\n    orderId\n    windowClosesAt\n    lines {\n      uomCode\n      productName\n      orderItemId\n      quantityAlreadyReturned\n      quantityDelivered\n      sku\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "customerReturnableOrders": [
      {
        "orderNumber": "string",
        "deliveredDate": "2025-01-15T00:00:00Z",
        "orderId": "id",
        "windowClosesAt": "2025-01-15T00:00:00Z",
        "lines": [
          {
            "uomCode": "string",
            "productName": "string",
            "orderItemId": "id",
            "quantityAlreadyReturned": 0,
            "quantityDelivered": 0,
            "sku": "string"
          }
        ]
      }
    ]
  }
}

customerReturnableOrders: [CustomerReturnableOrder!]!

Type

CustomerReturnableOrder object

A delivered order still inside the returns window. screen 15.