Catalogs

Endpoints for listing and retrieving catalogs

List catalogs

get

Returns a paginated list of catalogs.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptionalDefault: 1

per_pageintegerOptionalDefault: 50

searchstringOptional

Search by catalog name.

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

get

/catalogs

HTTPcURLJavaScriptPython

GET /v1/catalogs HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": 7,
      "name": "Unisex Standard T-Shirt",
      "mockups": [
        {
          "url": "https://example.com/original.jpg"
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 1234
  }
}

Catalog detail

get

Returns full catalog details for a given ID.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Responses

200

OK

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

/catalogs/{id}

HTTPcURLJavaScriptPython

GET /v1/catalogs/{id} HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 7,
  "name": "Unisex Standard T-Shirt",
  "description": "<p>HTML description...</p>",
  "mockups": [
    {
      "url": "https://example.com/original.jpg"
    }
  ],
  "print_areas": [
    {
      "name": "front",
      "width": 4050,
      "height": 4650,
      "dpi": 300
    },
    {
      "name": "back",
      "width": 4050,
      "height": 4650,
      "dpi": 300
    }
  ],
  "variants": [
    {
      "variant_sku": 1,
      "size": "S",
      "color": "Black",
      "base_cost": "6.99",
      "availability": "in_stock",
      "weight": null
    },
    {
      "variant_sku": 2,
      "size": "S",
      "color": "Safety Pink",
      "base_cost": "6.99",
      "availability": "in_stock",
      "weight": null
    },
    {
      "variant_sku": 3,
      "size": "5XL",
      "color": "Ice Grey",
      "base_cost": "12.49",
      "availability": "out_of_stock",
      "weight": null
    }
  ]
}