Appearance

Catalog-Product ​

Merchrocket has a significant catalog of products and variants. A product describes a specific type, model, and manufacturer of an item, while a variant specifies a product's more detailed attributes, such as the exact size and color of a T-shirt or the dimensions of a poster. Additionally, each item in the Merchrocket catalog has a unique variant ID. When managing orders or mockups, you will need to specify the variant ID of the blank item. You can use this API resource to find the necessary variant ID.

What the CatalogProduct Endpoint can do ​

Using the Merchrocket API, you can perform the following actions on the catalog product endpoints:

CatalogProduct-Properties ​

id ​

  • Type: string

The unique identifier of a product.

json
[
  {
    "id": "29872d4a-3a3e-4454-a855-91019d28d261",  
    "name": "Tischuhr",
    "description": "<p>Große Auswahl an Materialien, Designs und Farben. Wählen Sie die brillante Druckqualität auf Holz, hochwertigem Kunststoff oder die Premiumausführung aus Acrylglas mit der besonderen Tiefenwirkung durch das hinterdruckte und weiß hinterlegte Motiv. Angetrieben wir die Uhr von einem präzisen Quarz-Uhrwerk.</p>",
    "brand": "",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7",
    "variantCount": 3,
    "variants": "/api/catalog-products/29872d4a-3a3e-4454-a855-91019d28d261/catalog-variants"
  }
]

name ​

  • Type: string

The name of a product.

json
[
  {
    "id": "29872d4a-3a3e-4454-a855-91019d28d261",  
    "name": "Tischuhr", 
    "description": "<p>Große Auswahl an Materialien, Designs und Farben. Wählen Sie die brillante Druckqualität auf Holz, hochwertigem Kunststoff oder die Premiumausführung aus Acrylglas mit der besonderen Tiefenwirkung durch das hinterdruckte und weiß hinterlegte Motiv. Angetrieben wir die Uhr von einem präzisen Quarz-Uhrwerk.</p>",
    "brand": "",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7",
    "variantCount": 3,
    "variants": "/api/catalog-products/29872d4a-3a3e-4454-a855-91019d28d261/catalog-variants"
  }
]

description ​

  • Type: string

The description of a product.

json
[
  {
    "id": "29872d4a-3a3e-4454-a855-91019d28d261",  
    "name": "Tischuhr",
    "description": "<p>Große Auswahl an Materialien, Designs und Farben. Wählen Sie die brillante Druckqualität auf Holz, hochwertigem Kunststoff oder die Premiumausführung aus Acrylglas mit der besonderen Tiefenwirkung durch das hinterdruckte und weiß hinterlegte Motiv. Angetrieben wir die Uhr von einem präzisen Quarz-Uhrwerk.</p>", 
    "brand": "",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7",
    "variantCount": 3,
    "variants": "/api/catalog-products/29872d4a-3a3e-4454-a855-91019d28d261/catalog-variants"
  }
]

brand ​

  • Type: string

The brand of a product.

json
[
  {
    "id": "29872d4a-3a3e-4454-a855-91019d28d261",  
    "name": "Tischuhr",
    "description": "<p>Große Auswahl an Materialien, Designs und Farben. Wählen Sie die brillante Druckqualität auf Holz, hochwertigem Kunststoff oder die Premiumausführung aus Acrylglas mit der besonderen Tiefenwirkung durch das hinterdruckte und weiß hinterlegte Motiv. Angetrieben wir die Uhr von einem präzisen Quarz-Uhrwerk.</p>",
    "brand": "", 
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7",
    "variantCount": 3,
    "variants": "/api/catalog-products/29872d4a-3a3e-4454-a855-91019d28d261/catalog-variants"
  }
]

image ​

  • Type: string

An image of the product to display it in a product list, for example.

json
[
  {
    "id": "29872d4a-3a3e-4454-a855-91019d28d261",  
    "name": "Tischuhr",
    "description": "<p>Große Auswahl an Materialien, Designs und Farben. Wählen Sie die brillante Druckqualität auf Holz, hochwertigem Kunststoff oder die Premiumausführung aus Acrylglas mit der besonderen Tiefenwirkung durch das hinterdruckte und weiß hinterlegte Motiv. Angetrieben wir die Uhr von einem präzisen Quarz-Uhrwerk.</p>",
    "brand": "",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7", 
    "variantCount": 3,
    "variants": "/api/catalog-products/29872d4a-3a3e-4454-a855-91019d28d261/catalog-variants"
  }
]

variantCount ​

  • Type: integer

How many variants does this product have?

json
[
  {
    "id": "29872d4a-3a3e-4454-a855-91019d28d261",  
    "name": "Tischuhr",
    "description": "<p>Große Auswahl an Materialien, Designs und Farben. Wählen Sie die brillante Druckqualität auf Holz, hochwertigem Kunststoff oder die Premiumausführung aus Acrylglas mit der besonderen Tiefenwirkung durch das hinterdruckte und weiß hinterlegte Motiv. Angetrieben wir die Uhr von einem präzisen Quarz-Uhrwerk.</p>",
    "brand": "",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7",
    "variantCount": 3,  
    "variants": "/api/catalog-products/29872d4a-3a3e-4454-a855-91019d28d261/catalog-variants"
  }
]

variants ​

  • Type: string

The API link to the variants of this product.

json
[
  {
    "id": "29872d4a-3a3e-4454-a855-91019d28d261",  
    "name": "Tischuhr",
    "description": "<p>Große Auswahl an Materialien, Designs und Farben. Wählen Sie die brillante Druckqualität auf Holz, hochwertigem Kunststoff oder die Premiumausführung aus Acrylglas mit der besonderen Tiefenwirkung durch das hinterdruckte und weiß hinterlegte Motiv. Angetrieben wir die Uhr von einem präzisen Quarz-Uhrwerk.</p>",
    "brand": "",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7",
    "variantCount": 3,  
    "variants": "/api/catalog-products/29872d4a-3a3e-4454-a855-91019d28d261/catalog-variants"
  }
]

CatalogProduct-Properties ​

id ​

  • Type: string

The unique identifier of a product.

json
[
  {
    "id": "21052bbc-b7ff-4305-945e-1273d13331b5", 
    "sku": "634752",
    "name": "Tischuhr Holz",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7",
    "placements": [
      {
        ...
      }
    ],
    "inStock": false,
    "options": [
      {
        ...
      }
    ]  
  }
]

sku ​

  • Type: string

The sku of the supplier

json
[
  {
    "id": "21052bbc-b7ff-4305-945e-1273d13331b5", 
    "sku": "634752", 
    "name": "Tischuhr Holz",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7",
    "placements": [
      {
        ...
      }
    ],
    "inStock": false,
    "options": [
      {
        ...
      }
    ]  
  }
]

name ​

  • Type: string

The name variant

json
[
  {
    "id": "21052bbc-b7ff-4305-945e-1273d13331b5", 
    "sku": "634752", 
    "name": "Tischuhr Holz", 
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7",
    "placements": [
      {
        ...
      }
    ],
    "inStock": false,
    "options": [
      {
        ...
      }
    ]  
  }
]

image ​

  • Type: string

The image of the variant

json
[
  {
    "id": "21052bbc-b7ff-4305-945e-1273d13331b5", 
    "sku": "634752", 
    "name": "Tischuhr Holz",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7", 
    "placements": [
      {
        ...
      }
    ],
    "inStock": false,
    "options": [
      {
        ...
      }
    ]  
  }
]

placements ​

  • Type: array

The placement information for this position. Which techniques can be used to produce this variant and what possible surfaces are available that can be printed, engraved, or embroidered.

json
[
  {
    "id": "21052bbc-b7ff-4305-945e-1273d13331b5", 
    "sku": "634752", 
    "name": "Tischuhr Holz",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7",
    "placements": [  
      {  
        "type": "main",  
        "required": true,  
        "technique": "direct_print",  
        "techniques": [ "direct_print" ],  
        "area": {  
          "width": 240,  
          "height": 120,  
          "section": { "top": 5, "right": 5, "bottom": 5, "left": 5 }  
        },  
        "visibleArea": { "top": 0, "left": 0, "width": 240, "height": 120 }  
      }  
    ],  
    "inStock": false,
    "options": [
      {
        ...
      }
    ]  
  }
]

inStock ​

  • Type: boolean

Weather the item is in stock..

json
[
  {
    "id": "21052bbc-b7ff-4305-945e-1273d13331b5", 
    "sku": "634752", 
    "name": "Tischuhr Holz",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7", 
    "placements": [
      {
        ...
      }
    ],
    "inStock": false, 
    "options": [
      {
        ...
      }
    ]  
  }
]

options ​

  • Type: array

Which options are possible with this variant, which must be transferred with an order or when creating mockups. You can display the possible options via one of the variant endpoints or via the product catalog. Here you only have to click on Show list of all options. under Production & Shipping to see all product options of this variant. Here is a small screenshot to visualize the position. An image

json
[
  {
    "id": "21052bbc-b7ff-4305-945e-1273d13331b5", 
    "sku": "634752", 
    "name": "Tischuhr Holz",
    "image": "https://merchrocket-media-live.imgix.net/products/d/2/f/b/d2fbe9cb8d6895051ff6a2bcb12333820b25880e_mockup_table_clock_mockup_1_7f0d5be0ae3bf712b5c4957af717d2d52782b9ea.jpg?w=800&s=a1442eef98f7fcbb195ef0f8a3ccb7a7", 
    "placements": [
      {
        ...
      }
    ],
    "inStock": false,
    "options": [
      {
        "id": "dial_color",
        "type": "string",
        "label": "Ziffernblatt Farbe",
        "required": true,
        "values": [
          {
            "value": "black",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__black.png?auto=format&w=250&s=1bf85972782c2d714273496f97e97d7c",
              "alt": "black"
            }
          },
          {
            "value": "white",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__white.png?auto=format&w=250&s=352ecd60250aeb28d2d21d6b162a12a9",
              "alt": "white"
            }
          },
          {
            "value": "old_lace",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__old_lace.png?auto=format&w=250&s=3397b85e651b998b126db535b974346a",
              "alt": "old_lace"
            }
          },
          {
            "value": "silver",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__silver.png?auto=format&w=250&s=36ac8f2a700849f4e935e62a31ca0352",
              "alt": "silver"
            }
          },
          {
            "value": "light_blue",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__light_blue.png?auto=format&w=250&s=99d6e8a572f1d51209860e9c190d2c26",
              "alt": "light_blue"
            }
          },
          {
            "value": "cadet_blue",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__cadet_blue.png?auto=format&w=250&s=1f2691bfd0dbb49c0d855113b0787e4e",
              "alt": "cadet_blue"
            }
          },
          {
            "value": "golden_rod",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__golden_rod.png?auto=format&w=250&s=1375fd3fb0805869a45f7e5e5a7a8962",
              "alt": "golden_rod"
            }
          },
          {
            "value": "peach_puff",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__peach_puff.png?auto=format&w=250&s=1f564c266e076443afdf0df4cdf42c52",
              "alt": "peach_puff"
            }
          },
          {
            "value": "coral",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__coral.png?auto=format&w=250&s=5efd506974e4fad1642ab3c518bb4167",
              "alt": "coral"
            }
          },
          {
            "value": "crimson",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__crimson.png?auto=format&w=250&s=6ffabd407405cbd2c0103c6f0970d611",
              "alt": "crimson"
            }
          },
          {
            "value": "light_pink",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__light_pink.png?auto=format&w=250&s=a00d48af1eb028f8cde5443da35ad655",
              "alt": "light_pink"
            }
          },
          {
            "value": "rainbow",
            "image": {
              "url": "https://merchrocket-media-live.imgix.net/assets/products/options/dial_color__rainbow.png?auto=format&w=250&s=cda807a881ab3e13d990707782793317",
              "alt": "rainbow"
            }
          }
        ]  
      }
    ]  
  }
]