> ## Documentation Index > Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # List all marketplace listings > List all marketplace listings ## OpenAPI ````yaml https://openapi.commercengine.io/ce-admin.json get /catalog/marketplace-listings openapi: 3.1.0 info: title: CE Admin APIs version: '1.0' summary: Comprehensive admin interface for managing your e-commerce platform description: >- Complete administrative API suite for Commerce Engine, providing powerful tools to manage products, orders, customers, inventory, analytics, and system configuration. Designed for administrators and backend integrations requiring full platform control. license: name: All Rights Reserved url: https://www.commercengine.io/contact-us contact: email: support@commercengine.io url: https://www.commercengine.io/contact-us name: Support servers: - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin description: Staging Server variables: store_id: default: store_id description: Store ID - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin description: Prod Server variables: store_id: default: store_id description: Store ID security: - Authorization: [] tags: - name: Analytics description: Analytics - name: Catalog description: Catalog - name: Coupons & promotions description: Coupons & promotions - name: Customers description: Customers - name: Filter Options description: Filter Options - name: Inventories description: Inventories - name: Marketplace description: Marketplace - name: Marketplace Catalog description: Marketplace Catalog - name: Media Gallery description: Media Gallery - name: Metrics description: Metrics - name: Orders description: Orders - name: Payments description: Payments - name: Payouts description: Payouts - name: POS description: POS - name: POSAdmin description: Admin endpoints to be used as proxy in pos - name: Segments description: Segments - name: Shipping description: Shipping - name: SSE description: SSE - name: Store description: Store - name: Webhooks description: Webhooks paths: /catalog/marketplace-listings: get: tags: - Catalog summary: List all marketplace listings description: List all marketplace listings operationId: list-marketplace-listings parameters: - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageLimit' - $ref: '#/components/parameters/sortByOptions' - $ref: '#/components/parameters/columnBasedFilters' responses: '200': description: OK content: application/json: schema: type: object properties: message: type: string success: type: boolean content: properties: items: type: array items: $ref: '#/components/schemas/MarketplaceItem' pagination: $ref: '#/components/schemas/Pagination' type: object '401': $ref: '#/components/responses/Unauthorized' security: - Authorization: [] components: parameters: pageNumber: name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: page number of pagination list pageLimit: name: limit in: query required: false schema: type: integer default: 25 minimum: 1 description: no of rows per page sortByOptions: name: sort_by in: query required: false schema: description: >- json string in format {'field_name':'asc', 'other_field_name':'desc', ...} type: string description: 'JSON string format: {"field1":"asc", "field2":"desc"}' columnBasedFilters: name: filters in: query required: false schema: type: string example: >- {"condition":"AND","filters":[{"type":"data","field":"status","operator":"equals","value":"success"}]} description: JSON object schemas: MarketplaceItem: title: MarketplaceItem type: object properties: product_id: type: string product_name: type: string variant_id: type: - string - 'null' variant_name: type: - string - 'null' sku: type: - string - 'null' marketplace_id: type: string marketplace_name: type: string marketplace_slug: type: string status: $ref: '#/components/schemas/MarketplaceListingStatus' marketplace_product_id: type: - string - 'null' marketplace_variant_id: type: - string - 'null' marketplace_item_id: type: - string - 'null' marketplace_item_sku: type: - string - 'null' marketplace_category: description: Marketplace category of the item. Array of category ids. type: array items: type: string marketplace_pricing: type: array items: $ref: '#/components/schemas/ProductPricing' marketplace_attribute: type: array items: type: object properties: attribute_id: type: string attribute_value: type: string required: - attribute_id - attribute_value marketplace_promotion: $ref: '#/components/schemas/ProductPromotion' marketplace_subscription: type: array items: $ref: '#/components/schemas/ProductSubscription' sync_status: oneOf: - $ref: '#/components/schemas/MarketplaceListingSyncStatus' - type: 'null' last_synced_at: type: - string - 'null' format: date-time sync_error_message: description: >- Error message from the last sync. This is only set if the sync status is failed or error. type: - string - 'null' publication_status: $ref: '#/components/schemas/MarketplacePublicationStatus' created_at: type: string format: date-time modified_at: type: string format: date-time Pagination: title: Pagination description: pagination metadata structure type: object properties: total_records: type: integer total_pages: type: integer previous_page: description: Previous page number type: - integer - 'null' limit: type: integer default: 25 next_page: description: Next page number type: - integer - 'null' MarketplaceListingStatus: title: MarketplaceListingStatus type: string enum: - listed - unlisted ProductPricing: title: ProductPricing type: object required: - customer_group_id - cost_price - listing_price - selling_price - tax_rate properties: customer_group_id: description: >- customer group id. for different pricing model in case of multiple customer groups. type: - string - 'null' cost_price: type: - number - 'null' format: double listing_price: type: number format: double selling_price: type: number format: double min_order_quantity: type: integer format: int32 default: 1 max_order_quantity: type: - integer - 'null' format: int32 incremental_quantity: type: integer format: int32 default: 1 tax_type: enum: - GST readOnly: true tax_rate: type: number format: double x-tags: - Catalog ProductPromotion: title: ProductPromotion oneOf: - $ref: '#/components/schemas/DiscountBasedPromotion' - $ref: '#/components/schemas/FixedPricePromotion' - $ref: '#/components/schemas/VolumeBasedPromotion' - $ref: '#/components/schemas/FreeGoodsPromotion' x-tags: - Catalog ProductSubscription: title: ProductSubscription type: object required: - subscription_plan - billing_interval - billing_frequency - billing_limit - billing_trial_days - fulfill_separately - subscription_price properties: subscription_plan_id: type: string readOnly: true subscription_plan: type: string billing_interval: type: integer format: int32 billing_frequency: enum: - monthly billing_limit: type: - integer - 'null' billing_trial_days: type: integer format: int32 default: 0 order_interval: type: - integer - 'null' order_frequency: type: - string - 'null' enum: - monthly order_limit: type: - integer - 'null' fulfill_separately: type: boolean subscription_price: type: array items: type: object required: - suscription_price - minimum_quantity - customer_group_id properties: suscription_price: type: number format: double minimum_quantity: type: integer default: 1 customer_group_id: description: customer group id. type: - string - 'null' x-tags: - Catalog MarketplaceListingSyncStatus: title: MarketplaceListingSyncStatus type: string enum: - success - failed - error MarketplacePublicationStatus: description: Marketplace publication status type: string enum: - published - unpublished DiscountBasedPromotion: title: DiscountBasedPromotion description: promotion_type = discount type: - object - 'null' required: - promotion_type - starts_at - details properties: id: type: string readOnly: true promotion_type: enum: - discount starts_at: type: string expires_at: description: null means never expires. type: - string - 'null' details: type: array items: oneOf: - $ref: '#/components/schemas/PercentageBasedDiscount' - $ref: '#/components/schemas/FixedAmountBasedDiscount' FixedPricePromotion: title: FixedPricePromotion description: promotion_type = fixed-price type: - object - 'null' required: - promotion_type - starts_at - details properties: id: type: string readOnly: true promotion_type: enum: - fixed-price starts_at: type: string expires_at: description: null means never expires. type: - string - 'null' details: type: array items: type: object required: - offer_price - customer_group_id - minimum_quantity - maximum_quantity properties: offer_price: type: number customer_group_id: type: - string - 'null' minimum_quantity: description: >- It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion. type: integer default: 1 maximum_quantity: description: >- It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit. type: - integer - 'null' VolumeBasedPromotion: title: VolumeBasedPromotion description: promotion_type = volume-based type: - object - 'null' required: - promotion_type - starts_at - details properties: id: type: string readOnly: true promotion_type: enum: - volume-based starts_at: type: string expires_at: description: null means never expires. type: - string - 'null' details: type: array items: type: object required: - customer_group_id - slabs properties: customer_group_id: type: - string - 'null' slabs: type: array items: type: object required: - quantity - quantity_condition - discount_percent properties: quantity: type: integer quantity_condition: description: >- This key defines how the system will evaluate the quantity to determine if the promotion should be applied, based on the specified slab. enum: - less - less-or-equal - greater - greater-or-equal discount_percent: type: number FreeGoodsPromotion: title: FreeGoodsPromotion description: promotion_type = free-goods type: - object - 'null' required: - promotion_type - starts_at - details properties: id: type: string readOnly: true promotion_type: enum: - free-goods starts_at: type: string format: date-time expires_at: description: null means never expires. type: - string - 'null' format: date-time details: type: array items: allOf: - required: - customer_group_id properties: customer_group_id: type: - string - 'null' - oneOf: - title: ScaleAutomatically required: - auto_scale - slab properties: auto_scale: description: >- The **auto_scale** key determines whether the promotion should be automatically adjusted based on the ratio between the quantities bought and the quantities received.\n\nIf **true**: The promotion will be applied dynamically according to the ratio of the buy quantity to the get quantity. For example, if the promotion is \"Buy 2, Get 1\" and the customer buys 4 items, they would receive 2 free items (scaling based on the original ratio).\n\nIf **false**: The promotion will be applied strictly according to the predefined conditions. For example, even if the customer buys more items, they will receive the fixed free quantity as defined in the original promotion (e.g., buying 4 would still only get them 1 free item). type: boolean slab: type: object properties: buy_quantity: type: integer get_quantity: type: integer quantity_condition: description: >- Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied. enum: - less - less-or-equal - greater - greater-or-equal required: - buy_quantity - get_quantity - quantity_condition - title: CustomSlabs required: - slabs properties: slabs: type: array items: type: object properties: buy_quantity: type: integer get_quantity: type: integer quantity_condition: description: >- Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied. enum: - less - less-or-equal - greater - greater-or-equal required: - buy_quantity - get_quantity - quantity_condition type: object PercentageBasedDiscount: title: PercentageBasedDiscount description: promotion_type = discount type: - object - 'null' required: - discount_type - discount_percent - customer_group_id - minimum_quantity - maximum_quantity - maximum_discount_amount properties: discount_type: type: string const: percentage discount_percent: type: number customer_group_id: type: - string - 'null' minimum_quantity: description: >- It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion. type: integer default: 1 maximum_quantity: description: >- It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit. type: - integer - 'null' maximum_discount_amount: description: >- When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount. type: - number - 'null' FixedAmountBasedDiscount: title: FixedAmountBasedDiscount description: promotion_type = discount type: - object - 'null' required: - discount_type - discount_fixed_amount - customer_group_id - minimum_quantity - maximum_quantity properties: discount_type: type: string const: fixed-amount discount_fixed_amount: type: integer customer_group_id: type: - string - 'null' minimum_quantity: description: >- It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion. type: integer default: 1 maximum_quantity: description: >- It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit. type: - integer - 'null' responses: Unauthorized: description: Not authorized for given operation on the Resource content: application/json: schema: type: object properties: message: type: string example: Not authorized for given operation on the Resource. success: type: boolean default: false code: type: string example: unauthorized securitySchemes: Authorization: type: http scheme: bearer ````