Depict.AI Shopify Collection Template API

The Shopify Collection Template API from Depict.AI — 4 operation(s) for shopify collection template.

Operations 4

GET /shopify-collection-template/{merchant_id}/{collection_id}/templates Get Collection Templates #
GET /shopify-collection-template/active/{collection_id} Get Active Collection Template #
POST /shopify-collection-template/{collection_id}/activate Activate Collection Template #
PUT /shopify-collection-template/{merchant_id}/columns-settings Update Columns Settings #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/depictai-shopify-collection-template-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

depictai-shopify-collection-template-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Depict Lite Ab Test Shopify Collection Template 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: Shopify Collection Template
paths:
  /shopify-collection-template/{merchant_id}/{collection_id}/templates:
    get:
      summary: Get Collection Templates
      description: Returns a list of all collection template suffixes for the main theme of the merchant
      operationId: get_collection_templates_shopify_collection_template__merchant_id___collection_id__templates_get
      security:
      - Auth0: []
      parameters:
      - name: merchant_id
        in: path
        required: true
        schema:
          type: string
          title: Merchant Id
      - name: collection_id
        in: path
        required: true
        schema:
          type: string
          title: Collection Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionTemplatesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Shopify Collection Template
  /shopify-collection-template/active/{collection_id}:
    get:
      summary: Get Active Collection Template
      operationId: get_active_collection_template_shopify_collection_template_active__collection_id__get
      security:
      - Auth0: []
      parameters:
      - name: collection_id
        in: path
        required: true
        schema:
          type: string
          title: Collection Id
      - name: merchant_id
        in: query
        required: true
        schema:
          type: string
          title: Merchant Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionTemplate'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Shopify Collection Template
  /shopify-collection-template/{collection_id}/activate:
    post:
      summary: Activate Collection Template
      operationId: activate_collection_template_shopify_collection_template__collection_id__activate_post
      security:
      - Auth0: []
      parameters:
      - name: collection_id
        in: path
        required: true
        schema:
          type: string
          title: Collection Id
      - name: template_suffix
        in: query
        required: true
        schema:
          type: string
          title: Template Suffix
      - name: theme_id
        in: query
        required: true
        schema:
          type: integer
          title: Theme Id
      - name: merchant_id
        in: query
        required: true
        schema:
          type: string
          title: Merchant Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionTemplate'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Shopify Collection Template
  /shopify-collection-template/{merchant_id}/columns-settings:
    put:
      summary: Update Columns Settings
      operationId: update_columns_settings_shopify_collection_template__merchant_id__columns_settings_put
      security:
      - Auth0: []
      parameters:
      - name: merchant_id
        in: path
        required: true
        schema:
          type: string
          title: Merchant Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LiteColumnSettings'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Shopify Collection Template
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CollectionTemplateWithActiveAndWrittenStatus:
      properties:
        template_suffix:
          type: string
          title: Template Suffix
        is_depict_template:
          type: boolean
          title: Is Depict Template
        active:
          type: boolean
          title: Active
        written:
          type: boolean
          title: Written
      type: object
      required:
      - template_suffix
      - is_depict_template
      - active
      - written
      title: CollectionTemplateWithActiveAndWrittenStatus
    GetCollectionTemplatesResponse:
      properties:
        theme_onboarding_status:
          $ref: '#/components/schemas/ThemeOnboardingStatus'
        user_approved:
          type: boolean
          title: User Approved
        templates:
          items:
            $ref: '#/components/schemas/CollectionTemplateWithActiveAndWrittenStatus'
          type: array
          title: Templates
      type: object
      required:
      - theme_onboarding_status
      - user_approved
      - templates
      title: GetCollectionTemplatesResponse
    LiteColumnSettings:
      properties:
        desktop_columns:
          type: integer
          title: Desktop Columns
        mobile_columns:
          type: integer
          title: Mobile Columns
      type: object
      required:
      - desktop_columns
      - mobile_columns
      title: LiteColumnSettings
    ThemeOnboardingStatus:
      type: string
      enum:
      - success
      - warning
      - failure
      - pending
      title: ThemeOnboardingStatus
    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
    CollectionTemplate:
      properties:
        template_suffix:
          type: string
          title: Template Suffix
        is_depict_template:
          type: boolean
          title: Is Depict Template
      type: object
      required:
      - template_suffix
      - is_depict_template
      title: CollectionTemplate
  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