> ## 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.

# Get Listing



## OpenAPI

````yaml /api-reference/openapi/storefront.json get /v3/listings/{listing_id}
openapi: 3.1.0
info:
  title: Depict Platform API
  version: '1.0'
  description: >-
    The Depict platform API at api.depict.ai: storefront-facing search,
    listings, recommendations and event tracking for headless integrations. Not
    to be confused with the storefront search API (runway.depict.ai) used by the
    Search by Depict Shopify app.
servers:
  - url: https://api.depict.ai
security: []
paths:
  /v3/listings/{listing_id}:
    get:
      tags:
        - Listing (v3)
      summary: Get Listing
      operationId: Get_Listing_v3_listings__listing_id__get
      parameters:
        - name: listing_id
          in: path
          required: true
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Listing Id
        - name: merchant
          in: query
          required: true
          schema:
            type: string
            title: Merchant
        - name: market
          in: query
          required: true
          schema:
            type: string
            title: Market
        - name: locale
          in: query
          required: true
          schema:
            type: string
            title: Locale
        - name: session_id
          in: query
          required: false
          schema:
            type: string
            default: ''
            title: Session Id
        - name: external_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: External Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3GetCollectionListingResult'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    V3GetCollectionListingResult:
      properties:
        listing_id:
          type: string
          format: uuid
          title: Listing Id
          description: Depict ID of the listing.
        external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Id
          description: ID of the listing in the merchant PIM, CMS or similar.
        listing_type:
          $ref: '#/components/schemas/CollectionKind'
        show_in_breadcrumbs:
          type: boolean
          title: Show In Breadcrumbs
          description: Show or hide this listing in navigation breadcrumbs.
        show_in_quicklinks:
          type: boolean
          title: Show In Quicklinks
          description: Show or hide this listing in quicklinks.
        image_urls:
          items:
            type: string
          type: array
          title: Image Urls
          description: List of image URLs for the listing.
        title:
          type: string
          title: Title
        slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Slug
        ancestors:
          items:
            $ref: '#/components/schemas/ProductListing'
          type: array
          title: Ancestors
          description: >-
            Ordered list of ancestors of the listing, useful for navigation
            breadcrumbs.
        siblings:
          items:
            $ref: '#/components/schemas/ProductListing'
          type: array
          title: Siblings
          description: >-
            Siblings of the listing, i.e. listings that share the same parent,
            INCLUDING the listing itself.
        children:
          items:
            $ref: '#/components/schemas/ProductListing'
          type: array
          title: Children
          description: >-
            Children of the listing, i.e. listings that have the listing as
            their parent.
        content_blocks:
          items:
            $ref: '#/components/schemas/ContentBlock'
          type: array
          title: Content Blocks
          description: List of content blocks to be displayed on the listing page.
      type: object
      required:
        - listing_id
        - listing_type
        - show_in_breadcrumbs
        - show_in_quicklinks
        - image_urls
        - title
        - ancestors
        - siblings
        - children
        - content_blocks
      title: V3GetCollectionListingResult
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CollectionKind:
      type: string
      enum:
        - long_tail_collection
        - campaign
        - category
        - smart_pick
        - style
        - brand
        - look
      title: CollectionKind
    ProductListing:
      properties:
        listing_id:
          type: string
          format: uuid
          title: Listing Id
          description: Depict ID of the listing.
        external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Id
          description: ID of the listing in the merchant PIM, CMS or similar.
        listing_type:
          $ref: '#/components/schemas/CollectionKind'
        show_in_breadcrumbs:
          type: boolean
          title: Show In Breadcrumbs
          description: Show or hide this listing in navigation breadcrumbs.
        show_in_quicklinks:
          type: boolean
          title: Show In Quicklinks
          description: Show or hide this listing in quicklinks.
        image_urls:
          items:
            type: string
          type: array
          title: Image Urls
          description: List of image URLs for the listing.
        title:
          type: string
          title: Title
        slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Slug
        page_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Page Url
          description: >-
            The listing's own page URL from the merchant's store attributes,
            when ingested. Absent otherwise; a storefront that composes URLs
            from `ancestors` + `slug` keeps doing so.
      type: object
      required:
        - listing_id
        - listing_type
        - show_in_breadcrumbs
        - show_in_quicklinks
        - image_urls
        - title
      title: ProductListing
    ContentBlock:
      properties:
        span_columns:
          type: integer
          title: Span Columns
        span_rows:
          type: integer
          title: Span Rows
        position:
          $ref: '#/components/schemas/ContentPosition'
        row:
          type: integer
          title: Row
        content:
          anyOf:
            - $ref: '#/components/schemas/ImageContent'
            - $ref: '#/components/schemas/VideoContent'
          title: Content
      type: object
      required:
        - span_columns
        - span_rows
        - position
        - row
        - content
      title: ContentBlock
    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
    ContentPosition:
      type: string
      enum:
        - left
        - right
        - center
      title: ContentPosition
    ImageContent:
      properties:
        text:
          anyOf:
            - type: string
              maxLength: 140
            - type: 'null'
          title: Text
        text_position:
          $ref: '#/components/schemas/ContentTextPosition'
          default: bottom-center
        type:
          type: string
          const: image
          title: Type
          default: image
        url:
          type: string
          title: Url
        link:
          anyOf:
            - type: string
            - type: 'null'
          title: Link
      type: object
      required:
        - url
        - link
      title: ImageContent
    VideoContent:
      properties:
        text:
          anyOf:
            - type: string
              maxLength: 140
            - type: 'null'
          title: Text
        text_position:
          $ref: '#/components/schemas/ContentTextPosition'
          default: bottom-center
        type:
          type: string
          const: video
          title: Type
          default: video
        url:
          type: string
          title: Url
        link:
          anyOf:
            - type: string
            - type: 'null'
          title: Link
      type: object
      required:
        - url
        - link
      title: VideoContent
    ContentTextPosition:
      type: string
      enum:
        - top-left
        - top-center
        - top-right
        - middle-left
        - middle-center
        - middle-right
        - bottom-left
        - bottom-center
        - bottom-right
      title: ContentTextPosition

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.