startImageSourcing

Requires permission catalog:copilot:parse.

Build an ImageSourcingProposal card for variants missing images (or an explicit variant scope).

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

mutation StartImageSourcing($input: StartImageSourcingInput!) {
  startImageSourcing(input: $input) {
    cardId
    matched
    unmatched
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation StartImageSourcing($input: StartImageSourcingInput!) {\n  startImageSourcing(input: $input) {\n    cardId\n    matched\n    unmatched\n  }\n}",
  "variables": {
    "input": {
      "sessionId": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "sessionId": "id"
  }
}

Response:

{
  "data": {
    "startImageSourcing": {
      "cardId": "string",
      "matched": 0,
      "unmatched": 0
    }
  }
}

startImageSourcing(
  input: StartImageSourcingInput!
): ImageSourcingStartResult!

Arguments

startImageSourcing.input ● StartImageSourcingInput! non-null input

The details of the image sourcing to start.

Type

ImageSourcingStartResult object

The result of starting to find images for variants.