Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Inventory__seed Job Status

Progress for a background seed job started via inventory__startSeedJob. Requires a signed-in staff user. Needs the `inventory__Product` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYinventory__seedJobStatus(jobId: String!): SeedJobStatus

Progress for a background seed job started via inventory__startSeedJob. Requires a signed-in staff user. Needs the inventory__Product read permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

jobId*String!

Returns

  1. inventory__seedJobStatus
categories*
error?String
jobId*String!
result?
status*String!
Example Request
query Inventory__seedJobStatus($jobId: String!) {  inventory__seedJobStatus(jobId: $jobId) {    categories {      done      key      label      total    }    error    jobId    result {      created      datasetId      failed      items {        handle        message        status        title      }      skipped    }    status  }}
Variables
{  "jobId": "string"}
Example Response
{  "data": {    "inventory__seedJobStatus": {      "categories": [        {          "done": 10,          "key": "string",          "label": "string",          "total": 10        }      ],      "error": "string",      "jobId": "string",      "result": {        "created": 10,        "datasetId": "string",        "failed": 10,        "items": [          {            "handle": "string",            "message": "string",            "status": "string",            "title": "string"          }        ],        "skipped": 10      },      "status": "string"    }  }}

Inventory__seed Datasets QUERY

Lists curated demo datasets that can be applied to the current store. Requires a signed-in staff user. Needs the `inventory__Product` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

Inventory__stock Groups QUERY

Requires a signed-in staff user. Needs the `inventory__Stock` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).