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

# Listing - Get

> Retrieve product listings with optional filtering by store and linked item status.



## OpenAPI

````yaml get /listing/get
openapi: 3.0.3
info:
  title: SKULabs API
  description: >-
    Most API keys have "platformGeneric" and "platformApi" scopes included.
    Contact us to convert more routes from "platformUser" (only available to
    users) to "platformGeneric" (available to users and api keys) upon request.
  version: 4.5.0
servers:
  - url: https://api.skulabs.com
  - url: https://app.skulabs.com/s
security: []
tags:
  - name: batch
  - name: customer
    description: Manage customers, tags, and notes
  - name: cycle_count
  - name: distributor
  - name: inventory
    description: Query and modify inventory levels across locations
  - name: inventory_table
  - name: item
    description: Manage items, barcodes, serial numbers, and tags
  - name: kit
    description: Manage kits and their component items
  - name: listing
  - name: location
  - name: oauth
  - name: order
    description: Manage orders, shipments, tags, and statuses
  - name: purchase_order
    description: Manage purchase orders and receiving
  - name: run
  - name: shipments
  - name: shipping
  - name: store
  - name: tag
    description: Create, update, and remove tags
  - name: transfer_order
  - name: warehouse
    description: Manage warehouses and view statistics
  - name: webhook
    description: Manage webhook handlers
paths:
  /listing/get:
    get:
      tags:
        - listing
      summary: Listing - Get
      description: >-
        Retrieve product listings with optional filtering by store and linked
        item status.
      operationId: get_listing_get
      parameters:
        - name: selector
          in: query
          required: true
          schema:
            type: object
            properties: {}
            description: Query selector object for filtering results
        - name: limit
          in: query
          required: false
          schema:
            type: number
            description: Max results to return
            example: 50
        - name: skip
          in: query
          required: false
          schema:
            type: number
            description: Number of results to skip
            example: 0
        - name: sort
          in: query
          required: false
          schema:
            type: object
            properties: {}
            description: 'Sort fields object, e.g. { "name": 1 }'
      responses:
        '200':
          description: Array of listings matching the query
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Listing'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '403':
          description: Forbidden. Insufficient permissions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '429':
          description: Too many requests. Rate limit exceeded.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
      security:
        - SKULabsToken: []
      servers:
        - url: https://api.skulabs.com
components:
  schemas:
    Listing:
      type: object
      properties:
        _id:
          type: string
          description: Unique listing identifier
          example: 507f1f77bcf86cd799439011
        store_id:
          type: string
          description: Store ID this listing belongs to
          example: 507f1f77bcf86cd799439011
        id:
          type: string
          description: Listing ID from the sales channel
        active:
          type: boolean
          description: Whether the listing is active for sync
        type:
          type: string
          description: Listing type (e.g. FBA, FBM for Amazon)
        name:
          type: string
          description: Listing name / title
        sku:
          type: string
          description: Listing SKU
        upc:
          type: string
          description: Listing barcode / UPC
        weight:
          type: number
          description: Listing weight
        weight_unit:
          type: string
          description: Weight unit (lb, kg, oz, g)
        length:
          type: number
          description: Package length
        width:
          type: number
          description: Package width
        height:
          type: number
          description: Package height
        dimensions_unit:
          type: string
          description: Dimensions unit (in, cm)
        cost:
          type: number
          description: Listing cost
        retail:
          type: number
          description: Retail price
        location:
          type: string
          description: Warehouse location
        on_hand:
          type: number
          description: On-hand quantity reported by the channel
        image:
          type: string
          description: Listing image URL
        price:
          type: number
          description: Listing price
        variants:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/ListingVariant'
          description: Listing variants
        variant_sets:
          type: array
          items:
            type: object
            properties: {}
          description: Variant option sets (e.g. Size, Color)
        variants_rule:
          type: string
          description: Rule for handling variant sync (e.g. sync_all, sync_none)
        inventory_rule:
          type: string
          description: Inventory sync rule
        price_rule:
          type: string
          description: Price sync rule
        fulfillment_rule:
          type: string
          nullable: true
          description: Fulfillment rule (Amazon only)
        restock_date:
          type: string
          nullable: true
          description: Restock date (Amazon only)
          example: '2025-01-15'
        restock_quantity:
          type: number
          nullable: true
          description: Restock quantity (Amazon only)
        last_pushed:
          type: number
          nullable: true
          description: Last quantity pushed to the channel
        last_pushed_time:
          type: string
          nullable: true
          description: Timestamp of last inventory push
          example: '2025-01-15T12:00:00.000Z'
        last_failed:
          type: number
          nullable: true
          description: Last failed push quantity
        last_failed_time:
          type: string
          nullable: true
          description: Timestamp of last failed push
          example: '2025-01-15T12:00:00.000Z'
        last_price:
          type: number
          nullable: true
          description: Last price pushed to the channel
        custom_fields:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
                description: Custom field name
              value:
                type: string
                description: Custom field value
            required:
              - field
              - value
          description: Custom field key-value pairs
      required:
        - _id
        - store_id
        - id
    ListingVariant:
      type: object
      properties:
        id:
          type: string
          description: Variant ID from the sales channel
        sku:
          type: string
          description: Variant SKU
        name:
          type: string
          description: Variant name or option value
        upc:
          type: string
          description: Variant barcode / UPC
        price:
          type: number
          description: Variant price
        image:
          type: string
          description: Variant image URL
        weight:
          type: number
          description: Variant weight
        weight_unit:
          type: string
          description: Weight unit (lb, kg, oz, g)
        on_hand:
          type: number
          description: On-hand quantity reported by the channel
        inventory_rule:
          type: string
          description: Inventory sync rule for this variant
        price_rule:
          type: string
          description: Price sync rule for this variant
        last_pushed:
          type: number
          nullable: true
          description: Last quantity pushed to the channel
        last_pushed_time:
          type: string
          nullable: true
          description: Timestamp of last inventory push
          example: '2025-01-15T12:00:00.000Z'
        last_failed:
          type: number
          nullable: true
          description: Last failed push quantity
        last_failed_time:
          type: string
          nullable: true
          description: Timestamp of last failed push
          example: '2025-01-15T12:00:00.000Z'
        last_price:
          type: number
          nullable: true
          description: Last price pushed to the channel
        inventory:
          type: array
          items:
            type: object
            properties: {}
          description: Multi-location inventory entries for this variant
  securitySchemes:
    SKULabsToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````