Read the merchant's award notification state - Depict Documentation

Error

A valid request URL is required to generate request examples

{
  "awards_dismissed": [
    {
      "type": "<string>",
      "for_num_done": 123
    }
  ],
  "achieved_timestamps": [
    [
      123
    ]
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

GET

/

collections

/

award-status

Error

A valid request URL is required to generate request examples

{
  "awards_dismissed": [
    {
      "type": "<string>",
      "for_num_done": 123
    }
  ],
  "achieved_timestamps": [
    [
      123
    ]
  ]
}

{
  "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 award state.

awards_dismissed

object[]

required

Show child attributes

achieved_timestamps

tuple[]

required

[award, timestamp when achieved] pairs.

Show child attributes