Skip to main content

Introduction to Catalog

Overview​

API's Catalog system provides a list of products you can order. The Catalog can provide the payload examples you need to use to place orders, and works in two ways: "attributes based" or "SKU based":

Attributes based: The payload contains the entire list of attributes and values you need to specify to order

SKU based: For each single combination we provide a specific SKU you can use to place the order, to avoid passing in the payload the list of all attributes and values

Also, our Catalog gives you the chance to download an Excel sheet containing all the SKUs you are interested in, along with all the related attributes (in case you want to place orders using attributes and not the SKUs), plus the price grid available for different quantity ranges and shipping methods.

Example Payloads​

Attributes Based Orders​

If you place orders attribute based, below is an example payload you will use:

{
    "items": [
        {
            "productConfiguration": "ffdfdf32223",
            "quantity": 1,
            "fileUrls": [
                "https://images.pexels.com/photos/237266/pexels-photo-237266.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=1"
            ],
            "attributes": {
                "Hardcover": "Yes",
                "PaperType": "Glossy",
                "Binding": "Perfect Bound",
                "CoverFinish": "Matte"
            },
            "prioritySet": "PT: 120 h - DO: Fast",
            "userNotes": ""
        }
    ]
}

SKU Based Orders​

If you place orders SKU based (example SKU: SPC-SKU-34343), below is an example payload you will use:

{
    "items": [
        {
            "skuId": "SPC-SKU-34343",
            "quantity": 1,
            "fileUrls": [
                "https://images.pexels.com/photos/237266/pexels-photo-237266.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=1"
            ],
            "prioritySet": "PT: 120 h - DO: Fast",
            "userNotes": ""
        }
    ]
}
info

The items key is part of the create order payload. Click here to check the create order API reference

How to Access the Catalog​

To access the catalog you simply need access to our WebApp (your Account Manager will take care of creating the access for you and share the credentials).

At that point you will be free to:

  • Browse the catalog and explore available products
  • Choose the product you are interested in, along with attributes and values
  • Download the Excel sheet with related prices and product information
  • View pricing grids for different quantity ranges and shipping methods
  • Get payload examples for both attribute-based and SKU-based ordering