vendorProducts

Requires at least one of the permissions purchase:grn:read, purchase:purchase_order:read or suppliers:supplier:read.

Lists vendor products: which supplier sells which product, with their costs and lead times, optionally filtered. Needs the suppliers read, purchase order read or GRN read permission.

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 VendorProducts {
  vendorProducts {
    id
    vendorName
    createdAt
    averageCost
    averageLeadTime
    averageOrderValue
    product {
      id
      name
      barcode
      sku
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query VendorProducts {\n  vendorProducts {\n    id\n    vendorName\n    createdAt\n    averageCost\n    averageLeadTime\n    averageOrderValue\n    product {\n      id\n      name\n      barcode\n      sku\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "vendorProducts": [
      {
        "id": "id",
        "vendorName": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "averageCost": 0,
        "averageLeadTime": 0,
        "averageOrderValue": 0,
        "product": {
          "id": "id",
          "name": "string",
          "barcode": "string",
          "sku": "string"
        }
      }
    ]
  }
}

vendorProducts(
  filter: VendorProductFilterInput
): [VendorProduct!]!

Arguments

vendorProducts.filter ● VendorProductFilterInput input

Optional filters: supplier, product, variant, supplier SKU, search text, preferred and active flags, cost range, maximum lead time and minimum quality rating.

Type

VendorProduct object

A product variant a vendor supplies, with the vendor's own code, terms, costs and delivery record. Costs and lead times are updated from goods receipts.