Get a merchant catalog with variants

GET

/v1/merchantCatalog/variants/list

Vendor Access: Forbidden — This endpoint is not accessible to vendor users.

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Body

🟠400

🟠401

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.dev.ordermesh.io/catalog/v1/merchantCatalog/variants/list?id=&page=&pageSize=&useCursor=&cursor=&currentContext.traceId=&currentContext.clientId=&currentContext.profileEnabled=&currentContext.userId=&currentContext.userName=&currentContext.host=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "catalog": {
        "id": "63f5f1f77dabc3305f462344",
        "ownerMerchantId": "merchant123",
        "name": "Premium Products Catalog",
        "description": "Catalog containing premium products for merchant",
        "isEnabled": true,
        "assignedToSubAccountIds": []
    },
    "variants": [
        {
            "merchantCatalogId": "63f5f1f77dabc3305f462344",
            "id": null,
            "sku": "SKU-12345",
            "merchantSku": "MERCH-SKU-12345",
            "merchantPrice": {
                "currencies": [
                    {
                        "amount": 49.99,
                        "currency": "USD"
                    }
                ],
                "amount": 49.99,
                "currency": "USD"
            },
            "skipImageManipulation": null,
            "productId": null,
            "decorations": [
                {
                    "area": "Front",
                    "width": 200,
                    "height": 300,
                    "dpi": 300,
                    "method": "DirectToGarment",
                    "price": {
                        "currencies": [
                            {
                                "amount": 49.99,
                                "currency": "USD"
                            }
                        ],
                        "amount": 0,
                        "currency": null
                    },
                    "printImage": {
                        "sourcePrintFileUrl": "https://example.com/images/front-print.png",
                        "imageUploadStatus": "Pending",
                        "imageUploadStatusDesc": "Queued for processing",
                        "ourPrintFileId": null,
                        "ourPrintFileUrl": null,
                        "placementX": null,
                        "placementY": null,
                        "placementScale": null,
                        "placementAngle": null
                    },
                    "attributes": [
                        {
                            "name": "Placement",
                            "value": "Center Chest"
                        }
                    ]
                }
            ],
            "attributes": [
                {
                    "name": "Color",
                    "value": "Red"
                },
                {
                    "name": "Size",
                    "value": "Large"
                }
            ],
            "options": [
                {
                    "name": "Packaging",
                    "value": "Gift Box"
                }
            ],
            "extras": [
                {
                    "name": "Care Instructions",
                    "value": "Machine wash cold"
                }
            ],
            "shippingGroupId": null
        },
        {
            "merchantCatalogId": "63f5f1f77dabc3305f462344",
            "id": null,
            "sku": "SKU-67890",
            "merchantSku": "MERCH-SKU-67890",
            "merchantPrice": {
                "currencies": [
                    {
                        "amount": 49.99,
                        "currency": "USD"
                    }
                ],
                "amount": 49.99,
                "currency": "USD"
            },
            "skipImageManipulation": null,
            "productId": null,
            "decorations": [
                {
                    "area": "Back",
                    "width": 150,
                    "height": 200,
                    "dpi": 300,
                    "method": "Embroidery",
                    "price": {
                        "currencies": [
                            {
                                "amount": 49.99,
                                "currency": "USD"
                            }
                        ],
                        "amount": 0,
                        "currency": null
                    },
                    "printImage": {
                        "sourcePrintFileUrl": "https://example.com/images/back-print.png",
                        "imageUploadStatus": "Success",
                        "imageUploadStatusDesc": "File uploaded successfully",
                        "ourPrintFileId": "file-123456",
                        "ourPrintFileUrl": null,
                        "placementX": null,
                        "placementY": null,
                        "placementScale": null,
                        "placementAngle": null
                    },
                    "attributes": [
                        {
                            "name": "Placement",
                            "value": "Left Sleeve"
                        }
                    ]
                }
            ],
            "attributes": null,
            "options": null,
            "extras": null,
            "shippingGroupId": null
        }
    ],
    "totalVariants": 10,
    "nextCursor": ""
}

Modified at 2026-09-08 16:59:39

Get a merchant catalog and search variants in it

Get a list of variants the merchant can use in accordance with their enabled catalog