1. MerchantCatalog
  • Introduction to our API
    • Overview
    • Getting Started
    • Product Catalog
    • Webhooks Overview
    • Notifications Guide
  • User
    • Client
      • Generate Service Client Access Token
    • User
      • Login User by Username and Password
      • Login User with Refresh Token
  • Order
    • OrderItems
      • Search for order items based on various criteria and filters
    • Orders
      • Create a New Order.
      • Search for orders based on various criteria and filters.
      • Create multiple orders
      • Retrieve multiple orders
      • Update multiple orders
      • Retrieve a list of orders
      • Retrieve an order by Order ID.
      • Update order data.
      • Retrieve an order by Safe ID
      • Retrieve order item by Order Item ID
      • Update an item within an order.
      • Cancel Order or order items
      • Change the order status to Customer Care Hold
      • Retrieve audit logs for a specific order.
      • Retrieve audit logs for a specific order.
      • Retrieve audit logs for a specific order item.
      • Add a Refund Request.
  • Note
    • Notes
      • Create a New Note
      • Search All Notes
      • View Note by ID
      • Update Note
      • Delete Note
      • View Note Audit Logs
  • Catalog
    • Categories
      • View all product categories
      • Create a new category
      • Update category
      • Delete category
      • Get audit logs of a category
    • MerchantCatalog
      • Create a merchant catalog
        POST
      • Update a merchant catalog
        PUT
      • Partially update a merchant catalog
        PATCH
      • Get a list of merchant catalogs
        GET
      • Delete a merchant catalog
        DELETE
      • Get a merchant catalog and search variants in it
        GET
      • Get a merchant catalog with variants
        GET
      • Get a list of variants the merchant can use in accordance with their enabled catalog
        GET
      • Search for variants in enabled merchant catalog with fallback to global catalog
        POST
      • Get the variants of the merchant's custom catalog with their stored and live global attributes
        GET
      • Search the variants of the merchant's custom catalog, with their stored and live global attributes
        POST
      • Get audit logs of a merchant catalog
        GET
      • Get the products of the merchant's custom catalog with live global product data
        GET
      • Search the products of the merchant's custom catalog, with live global product data
        POST
    • Products
      • View all products
      • Retrieve product variant details
      • Create a new product
      • Search products
      • Bulk create products
      • Bulk update products
      • Update product
      • Delete product
      • Update variant
      • Get audit logs of a product
    • Variants
      • Delete variant
      • Create a variant
      • Search product variants
      • Get audit logs of a variant
      • Search product variants with cursor pagination
    • MerchantVariants
      • Add new variants to a merchant catalog
      • Update a merchant catalog variants
      • Update a merchant catalog by removing variants
    • Enriched Catalog
      • List the vendors a merchant is connected to.
      • Page through the vendor product data of every vendor a merchant is connected to.
      • Get every variation of one product, per connected vendor able to produce it.
  • Shipment
    • Packing Slip
      • Generates a packing slip for a specific shipment by Shipment ID.
    • Shipments
      • Get details of a specific shipment by Shipment ID.
      • Update details of a specific shipment by Shipment ID.
      • Create packages for a specific shipment.
      • Delete shipment with packages.
      • Get all shipments for an order by Order ID.
      • Create shipment for order, vendor, and order items.
      • Get shipment with packages for order and vendor.
      • Get shipment details by Order Item ID.
      • Update a specific shipment package.
      • Delete a specific shipment package.
      • Cancel shipment.
      • Unassign items to shipment.
      • Shipment resubmission to assigned facility.
      • Retry outbound polling for a shipment by publishing an OutboundShipmentUpdate event.
      • Search shipments.
      • Reroute shipment.
      • Rejects a shipment.
      • Bulk reroute shipments.
      • Get shipment audit logs.
      • Get package audit logs.
      • Get message audit logs for shipment updates.
      • Assign Shipment.
    • VendorShipments
      • Get full vendor details for up to 100 shipments in a single call. Only available for vendor and admin users. Returns a per-id result for each requested shipment: accessible shipments return a 200 detail model, missing ids return 404, and inaccessible ids
  1. MerchantCatalog

Get the variants of the merchant's custom catalog with their stored and live global attributes

GET
/v1/merchantCatalog/effective/variants/enriched
Vendor Access: Forbidden — This endpoint is not accessible to vendor users.
Returns the merchant variants of the merchant's resolved custom catalog, ordered by variant id. In attrs,
opts and extras the entries stored in the catalog (source: CUSTOM) come first, then the live
global variant's entries (source: GLOBAL), read at request time and never merged. The catalog is resolved as
for effective/variants/list; a merchant with no enabled catalog gets an empty page with
merchantHasCustomCatalog: false. A variant whose global variant or product is deleted, hidden or missing keeps
its own data and gets globalResolved: false and a globalResolution instead of GLOBAL entries.
Filters are accepted only in the body of POST merchantCatalog/effective/variants/enriched/search.
With useCursor=true each response's nextCursor fetches the next page until it comes back empty;
page, totalCount and totalPages are then not used, and a cursor is valid only for this endpoint,
the same catalog and the same filters.

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
OK
Body

🟠400
🟠401
🟠403
🟠404
🟠409
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.ordermesh.io/catalog/v1/merchantCatalog/effective/variants/enriched?merchantId=&page=&pageSize=&useCursor=&cursor=' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Page by number
{
    "merchantHasCustomCatalog": true,
    "items": [
        {
            "id": "6710b3f2a1c94e0d2f8b7c31",
            "sku": "MUG-ACC-11OZ-BLUE",
            "merchantSku": "MERCHANT-SKU-001",
            "productId": "1194",
            "merchantPrice": {
                "currencies": [
                    {
                        "amount": 19.99,
                        "currency": "USD"
                    }
                ],
                "amount": 19.99,
                "currency": "USD"
            },
            "decorations": [
                {
                    "area": "Front",
                    "width": 1000,
                    "height": 1000,
                    "dpi": 300,
                    "method": "Sublimation",
                    "price": {
                        "currencies": null,
                        "amount": 0,
                        "currency": "USD"
                    },
                    "printImage": null,
                    "attributes": []
                }
            ],
            "attrs": [
                {
                    "name": "Color",
                    "value": "Blue",
                    "source": "CUSTOM"
                },
                {
                    "name": "Color",
                    "value": "Blue",
                    "source": "GLOBAL"
                },
                {
                    "name": "Size",
                    "value": "11oz",
                    "source": "GLOBAL"
                }
            ],
            "opts": [
                {
                    "name": "Handle Color",
                    "value": "White",
                    "source": "GLOBAL"
                }
            ],
            "extras": [
                {
                    "name": "Gift Wrap",
                    "value": "Available",
                    "source": "GLOBAL"
                }
            ],
            "globalStatus": "ACTIVE",
            "globalResolved": true,
            "globalResolution": null
        },
        {
            "id": "6710b3f2a1c94e0d2f8b7c32",
            "sku": "MUG-ACC-11OZ-RED",
            "merchantSku": null,
            "productId": "1194",
            "merchantPrice": null,
            "decorations": [],
            "attrs": [
                {
                    "name": "Color",
                    "value": "Red",
                    "source": "CUSTOM"
                }
            ],
            "opts": [],
            "extras": [],
            "globalStatus": null,
            "globalResolved": false,
            "globalResolution": "DELETED"
        },
        {
            "id": "6710b3f2a1c94e0d2f8b7c33",
            "sku": "MUG-RETIRED-15OZ",
            "merchantSku": "MERCHANT-SKU-003",
            "productId": "1180",
            "merchantPrice": null,
            "decorations": [],
            "attrs": [],
            "opts": [],
            "extras": [],
            "globalStatus": null,
            "globalResolved": false,
            "globalResolution": "NOT_FOUND"
        }
    ],
    "page": 1,
    "pageSize": 50,
    "totalCount": 3,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false,
    "nextCursor": ""
}
Modified at 2026-10-26 16:22:03
Previous
Search for variants in enabled merchant catalog with fallback to global catalog
Next
Search the variants of the merchant's custom catalog, with their stored and live global attributes
Built with