> ## Documentation Index
> Fetch the complete documentation index at: https://docs.depict.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Save the merchant's award notification state

> Replaces the award state with the body (send the full state from GET /collections/award-status, modified). Side effect: appends a new config row authored by the caller. Returns null.



## OpenAPI

````yaml /api-reference/openapi/lite.json put /collections/award-status
openapi: 3.1.0
info:
  title: Search & Merchandising API
  version: 1.0.0
  description: >-
    REST API behind Depict: Search & Merchandising, the native Shopify app:
    onboarding, collections, boost & bury, dashboards, A/B testing and
    multi-store management. Endpoints are served under the /api/lite prefix and
    are authenticated with the Shopify session token that App Bridge issues to
    the embedded app.
servers:
  - url: /api/lite
security:
  - ShopifySessionToken: []
paths:
  /collections/award-status:
    put:
      summary: Save the merchant's award notification state
      description: >-
        Replaces the award state with the body (send the full state from GET
        /collections/award-status, modified). Side effect: appends a new config
        row authored by the caller. Returns null.
      operationId: awardStatusUpdate
      parameters:
        - schema:
            type: string
            description: Lite merchant id, e.g. `shopify-<shop id>`.
          required: true
          description: Lite merchant id, e.g. `shopify-<shop id>`.
          name: merchant_id
          in: query
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwardStatusConfig'
      responses:
        '200':
          description: Saved.
          content:
            application/json:
              schema:
                type: 'null'
        '400':
          description: >-
            The query, path or body failed the schema; `detail` carries zod's
            messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '403':
          description: Authenticated, but this identity may not call the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '404':
          description: Merchant not found for this caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    AwardStatusConfig:
      type: object
      properties:
        awards_dismissed:
          type: array
          items:
            $ref: '#/components/schemas/Award'
        achieved_timestamps:
          type: array
          items:
            type: array
            prefixItems:
              - $ref: '#/components/schemas/Award'
              - type: integer
          description: '[award, timestamp when achieved] pairs.'
      required:
        - awards_dismissed
        - achieved_timestamps
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
    Award:
      type: object
      properties:
        type:
          type: string
          description: Award kind.
        for_num_done:
          type: integer
          description: The milestone count the award is for.
      required:
        - type
        - for_num_done
  securitySchemes:
    ShopifySessionToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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.

````