Whether the merchant's recommendations are computed yet

Error

A valid request URL is required to generate request examples

{
  "running": {
    "instanceId": "<string>",
    "heldForMs": 123
  },
  "lastRun": {
    "instanceId": "<string>",
    "startedAtMs": 123,
    "status": "<string>",
    "error": "<string>",
    "marketsTotal": 123,
    "marketsComplete": 123,
    "skipped": true
  },
  "ready": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

GET

recommendations

precompute-status

Error

A valid request URL is required to generate request examples

{
  "running": {
    "instanceId": "<string>",
    "heldForMs": 123
  },
  "lastRun": {
    "instanceId": "<string>",
    "startedAtMs": 123,
    "status": "<string>",
    "error": "<string>",
    "marketsTotal": 123,
    "marketsComplete": 123,
    "skipped": true
  },
  "ready": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.

Query Parameters

merchant_id

string

required

Lite merchant id, e.g. shopify-<shop id>.

Response

The running and last runs, and the verdict.

running

object | null

required

The run in flight, if any.

Show child attributes

lastRun

object | null

required

Show child attributes

ready

boolean

required

The last finished run completed with at least one complete market.