MX Retail lets you manage your product catalog — products, variants, collections, images, and suppliers — programmatically instead of logging in to the merchant portal. Build your inventory once, keep it in sync from your own systems, and reuse it across orders, invoices, and in-person sales.

Common use cases

• Sync a product catalog from your ERP or e-commerce platform
• Add products with variants (size, color) and per-variant pricing
• Group products into collections for merchandising
• Track suppliers and link them to the products they provide

Make your first product

Everything in MX Retail hangs off your catalog. Get your catalog ID first, then create a product under it.

Step 1: Get your catalog ID

GET /v3/catalog

{
  "records": [
    { "id": 114160, "name": "Default", "autoCreateSku": true }
  ],
  "recordCount": 1
}

Retrieved via GET /v3/catalog. Use the returned id as the catalog id in the next call.

Step 2: Create a product

POST /v3/catalogproduct?id=114160

{
  "clientNumber": 1,
  "name": "Test Product",
  "description": "Test Product Description",
  "taxCode": "Tax Code",
  "taxable": true,
  "active": true
}

{
  "id": 886652,
  "name": "Test Product",
  "clientNumber": "1",
  "active": true,
  "taxable": true,
  "availableCount": 0,
  "quantitySold": 0,
  "created": "2020-10-06T14:31:03.49Z"
}

Created via POST /v3/catalogproduct. clientNumber and name are required; the catalog id query parameter is required. Store the returned product id.

Scenarios

Each scenario builds on the catalog and product you created above. Pick the one that matches your job.

Scenario 1: Sell a product with size and color options

(Add variants so each option has its own SKU and price)

Use this when a product comes in more than one variation. Create the product once, then add a variant per option.

You'll also need: the product id from "Make your first product".

POST /v3/productvariant

{
  "productId": 886652,
  "name": "Test Product - Large / Red",
  "price": 19.99
}

Created via POST /v3/productvariant. List a product's variants with GET /v3/productvariant and update one with PUT /v3/variant.

Scenario 2: Merchandise products into a collection

(Group related products so they can be browsed or discounted together)

Use this to organize products — for example, a "Summer Sale" collection.

POST /v3/catalogcollection

{
  "name": "Summer Sale",
  "active": true
}

Created via POST /v3/catalogcollection. List collections with GET /v3/catalogcollection.

Scenario 3: Track a supplier and the products they provide

(Keep supplier records and link them to products for purchasing/reorder)

Use this when you buy stock from vendors and want supplier data alongside your catalog.

POST /v3/supplier

{
  "name": "Acme Wholesale",
  "active": true
}

Created via POST /v3/supplier. Then link a product to the supplier with POST /v3/productsupplier.

Add product images

Attach an image to a product so it displays on receipts and hosted pages.

POST /v3/productimage

Uploaded via POST /v3/productimage.

Operations reference

The full MX Retail surface lives in the MX Retail API Reference. Common operations:

Best practices

General API practices are in Getting Started. Specific to MX Retail:

Next steps

See also

• MX Orders: manage orders built from your catalog
• Invoicing: itemized billing for products
• Sales Tax: how taxCode / taxable drive tax on line items