Depict.AI Other (v3) API

openapi: 3.1.0
info:
  title: Depict Lite Ab Test Other (v3) API
  version: 1.0.0
  description: 'REST API behind Depict Lite, 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 require an Auth0-issued bearer token.'
servers:
- url: /api/lite
tags:
- name: Other (v3)
paths:
  /v3/get-displays:
    post:
      tags:
      - Other (v3)
      summary: Get Displays
      operationId: get_displays_v3_get_displays_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDisplaysRequestV3'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyQuery: []
      - APIKeyHeader: []
      - APIKeyCookie: []
  /v3/markets:
    get:
      tags:
      - Other (v3)
      summary: Get Markets
      operationId: get_markets_v3_markets_get
      security:
      - APIKeyQuery: []
      - APIKeyHeader: []
      - APIKeyCookie: []
      parameters:
      - name: merchant
        in: query
        required: true
        schema:
          type: string
          title: Merchant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v3/locales:
    get:
      tags:
      - Other (v3)
      summary: Get Locales
      operationId: get_locales_v3_locales_get
      security:
      - APIKeyQuery: []
      - APIKeyHeader: []
      - APIKeyCookie: []
      parameters:
      - name: merchant
        in: query
        required: true
        schema:
          type: string
          title: Merchant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    GetDisplaysRequestV3:
      properties:
        market:
          type: string
          minLength: 1
          title: Market
          description: Market identifier
        product_ids:
          items:
            type: string
          type: array
          maxItems: 50
          minItems: 1
          title: Product Ids
        merchant:
          type: string
          minLength: 1
          title: Merchant
          description: Identifier associated with the API integration
        locale:
          type: string
          minLength: 1
          title: Locale
          description: Locale identifier
      additionalProperties: false
      type: object
      required:
      - market
      - product_ids
      - merchant
      - locale
      title: GetDisplaysRequestV3
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    Auth0:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            openid: OpenID Connect
            profile: User profile
            email: User email
          authorizationUrl: https://depict.eu.auth0.com/oauth/authorize
          tokenUrl: https://depict.eu.auth0.com/oauth/token
      x-tokenName: id_token