itemProfile

Requires permission biddesk:assembly:read.

A product's item profile, or null when it has none. Requires Bid Desk and permission to read assemblies.

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 ItemProfile($productId: ID!) {
  itemProfile(productId: $productId) {
    id
    createdAt
    attributes
    productId
    roles
    serviceFlags
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ItemProfile($productId: ID!) {\n  itemProfile(productId: $productId) {\n    id\n    createdAt\n    attributes\n    productId\n    roles\n    serviceFlags\n  }\n}",
  "variables": {
    "productId": "id"
  }
}
EOF

Variables:

{
  "productId": "id"
}

Response:

{
  "data": {
    "itemProfile": {
      "id": "id",
      "createdAt": "2025-01-15T00:00:00Z",
      "attributes": {},
      "productId": "id",
      "roles": [
        "ASSEMBLED"
      ],
      "serviceFlags": [
        "CRITICAL"
      ]
    }
  }
}

itemProfile(
  productId: ID!
): ItemProfile

Arguments

itemProfile.productId ● ID! non-null scalar

The product whose profile to read.

Type

ItemProfile object

A product's Bid Desk item profile, kept beside the product: its roles, sourcing, service flags and technical attribute values.