PrintCart Rest API (1.0.0)

Download OpenAPI specification:Download

Support: support@printcart.com

PrintCart REST API Doc.

Authentication

PrintCart offers two forms of authentication:

Basic Auth
UnAuthToken

BasicAuth

The client sends HTTP requests with the Authorization header that contains the word Basic word followed by a space and a base64-encoded string

Security Scheme Type: HTTP

HTTP Authorization Scheme:

UnAuthToken

Some Printcart API endpoints don't need your username and password to authenticate. Those endpoints only interact with your public data so the code can be shared publicly.
To request to those endpoints, you only need to send UnAuthToken in the X-PrintCart-Unauth-Token header

Security Scheme Type: API Key

Header parameter name: X-PrintCart-Unauth-Token

Account

Create Account

Request Body schema: application/json

name required	string Customer name
email required	string <email> The email address for the customer.
password required	string Require at least 8 characters Require at least one number Require at least one symbol Require at least one uppercase and one lowercase letter

Responses

Request samples

Payload

Content type

application/json

{"name": "admin",
"email": "admin@example.com",
"password": "Password1234@"
}

Response samples

201
400
500

Content type

application/json

{"data": {"user": {"id": "013f00061-edacd12-455e-b407-aa6aa80ec862",
"name": "admin",
"email": "admin@example.com",
"email_verified_at": "2022-11-23T03:33:58.000000Z",
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"token_type": "bearer",
"access_token": "eyJ0eXiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwMDEvdjEvYWNjb3VudCIsImlhdCI6MTY2MTMzMDk0OSwibmJmIjoxNjYxMzMwOTQ5LCJqdGkiOiJkbFI4ZG1iMnNqMlpLUjlwIiwic3ViIjoiMSIsInBydiI6IjIzYmQ1Yzg5NDlmNjAwYWRiMzllNzAxYzQwMDg3MmRiN2E1OTc2ZjcifQ.ev6XeAuuQ8wz0pSyWcoqP71pzpWEp8rjZ11FyxdyPEk"
},
"message": "Created successfully"
}

Get Account Info

Authorizations:

BasicAuth

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"id": "013f00061-edacd12-455e-b407-aa6aa80ec862",
"name": "admin",
"email": "admin@example.com",
"email_verified_at": "2022-11-23T03:33:58.000000Z",
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "Retrieved successfully"
}

Update Account Details

Authorizations:

BasicAuth

Request Body schema: application/json

name	string Customer name.
email	string <email> The email address for the customer.

Responses

Request samples

Payload

Content type

application/json

{"name": "admin",
"email": "admin@example.com"
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"id": "013f00061-edacd12-455e-b407-aa6aa80ec862",
"name": "admin",
"email": "admin@gmail.com",
"email_verified_at": "2022-11-23T03:33:58.000000Z",
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-18T08:26:30.000000Z"
},
"message": "Updated successfully"
}

Store

Create Store

Authorizations:

BasicAuth

Request Body schema: application/json

store_name required	string Customer store name
google_font_api	string API Key Google Font
unsplash	string API Key Unsplash
pixabay	string API Key Pixabay
pexels	string API Key Pexels

Responses

Request samples

Payload

Content type

application/json

{"store_name": "Store Example",
"google_font_api": "string",
"unsplash": "string",
"pixabay": "string",
"pexels": "string"
}

Response samples

201
400
401
500

Content type

application/json

{"data": {"id": "a2ba0785-7f53-3eea-a020-bac895d31234",
"name": "printcart store",
"sid": "pcsia_xxxxx6fa332b74bdd0exxxxx3b361aca0c2f7b9bbfe68343xxxx",
"secret": "pcsup_xxxxx225e8ddb1ff446c6xxxxx94902ab2f193fcd5bfc2xxxx",
"unauth_token": "xxxxx13e142d5202aedaxxxxx5ce0a82bbf6c05711af3a2xxxx",
"google_font_api": "string",
"shop_url": "string",
"view_store_url": "string",
"integration_type": "null",
"is_integrated": false,
"unsplash_key": "string",
"pixabay_key": "string",
"pexels_key": "string",
"timezone": "string",
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "Created successfully"
}

Get Store Info

Authorizations:

BasicAuth

query Parameters

limit	integer Default: 20 The numbers of items to return
sort	string Default: "desc" Enum: "desc" "asc"
sortBy	string Default: "id"

Responses

Response samples

200
401
404
413
500

Content type

application/json

{"data": [{"id": "a2ba0785-7f53-3eea-a020-bac895d31234",
"name": "printcart store",
"sid": "pcsia_xxxxx6fa332b74bdd0exxxxx3b361aca0c2f7b9bbfe68343xxxx",
"secret": "pcsup_xxxxx225e8ddb1ff446c6xxxxx94902ab2f193fcd5bfc2xxxx",
"unauth_token": "xxxxx13e142d5202aedaxxxxx5ce0a82bbf6c05711af3a2xxxx",
"google_font_api": "string",
"shop_url": "string",
"view_store_url": "string",
"integration_type": "null",
"is_integrated": false,
"unsplash_key": "string",
"pixabay_key": "string",
"pexels_key": "string",
"timezone": "string",
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"links": {"first": null,
"last": null,
"prev": "https://api.printcart.com/v1/stores?cursor=byJpZCI6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ",
"next": "https://api.printcart.com/v1/stores?cursor=byJpOAM6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ"
},
"meta": {"path": "https://api.printcart.com/v1/stores",
"per_page": 20
},
"message": "Retrieved successfully"
}

Update Store Details

Authorizations:

BasicAuth

Request Body schema: application/json

store_name	string Customer store name
google_font_api	string API Key Google Font
unsplash	string API Key Unsplash
pixabay	string API Key Pixabay
pexels	string API Key Pexels

Responses

Request samples

Payload

Content type

application/json

{"store_name": "Store Example",
"google_font_api": "string",
"unsplash": "string",
"pixabay": "string",
"pexels": "string"
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"id": "a2ba0785-7f53-3eea-a020-bac895d31234",
"name": "printcart store",
"sid": "pcsia_xxxxx6fa332b74bdd0exxxxx3b361aca0c2f7b9bbfe68343xxxx",
"secret": "pcsup_xxxxx225e8ddb1ff446c6xxxxx94902ab2f193fcd5bfc2xxxx",
"unauth_token": "xxxxx13e142d5202aedaxxxxx5ce0a82bbf6c05711af3a2xxxx",
"google_font_api": "string",
"shop_url": "string",
"view_store_url": "string",
"integration_type": "null",
"is_integrated": false,
"unsplash_key": "string",
"pixabay_key": "string",
"pexels_key": "string",
"timezone": "string",
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "Updated successfully"
}

Delete a store

Authorizations:

BasicAuth

Responses

Response samples

200
401
404
500

Content type

application/json

{"message": "Deleted successfully"
}

Get Store Details

Authorizations:

BasicAuthUnAuthToken

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"id": "a2ba0785-7f53-3eea-a020-bac895d31234",
"name": "printcart store",
"sid": "pcsia_xxxxx6fa332b74bdd0exxxxx3b361aca0c2f7b9bbfe68343xxxx",
"secret": "pcsup_xxxxx225e8ddb1ff446c6xxxxx94902ab2f193fcd5bfc2xxxx",
"unauth_token": "xxxxx13e142d5202aedaxxxxx5ce0a82bbf6c05711af3a2xxxx",
"google_font_api": "string",
"shop_url": "string",
"view_store_url": "string",
"integration_type": "null",
"is_integrated": false,
"unsplash_key": "string",
"pixabay_key": "string",
"pexels_key": "string",
"timezone": "string",
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "Retrieved successfully"
}

Renew UnAuth Token

Authorizations:

BasicAuth

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"unauth_token": "22d23e41e296c45b0c6c9cd722398b90a3cc906301bdebfaac4751cf2dowmar3"
},
"message": "Updated successfully"
}

Product

Create Product

Authorizations:

BasicAuth

Request Body schema: application/json

name required	string The name given to a product
dynamic_side	boolean
viewport_width	number <float>
viewport_height	number <float>
scale	number <float>
dpi	integer <int64> Default: 72
dimension_unit	string Default: "cm" Enum: "inch" "cm"
status	string Default: "publish" Enum: "publish" "draft" "trashed" Product status
allowed_file_types	Array of strings Items Enum: "jpg" "png" "ai" "pdf" "svg" "ps"
enable_design	boolean
enable_upload	boolean
enable_pod	boolean Default: false True if you want the product to be published on our POD page
product_image_id	string Image ID.
max_file_upload	integer <int64> Default: 1
min_jpg_dpi	integer <int64> Default: 0
type_id	string Enum: "simple" "variant" "variant_option"
description	string Product description
category_ids	Array of strings Category ID (Storage ID)
parent_id	string Product ID
upload_max_filesize	integer Limit file upload size
metadata	Array of arrays

Responses

Request samples

Payload

Content type

application/json

{"name": "Product Example",
"dynamic_side": true,
"viewport_width": 50.5,
"viewport_height": 50.5,
"scale": 50.5,
"dpi": 72,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"enable_design": false,
"enable_upload": false,
"enable_pod": false,
"product_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"max_file_upload": 500,
"min_jpg_dpi": 500,
"type_id": "simple",
"description": null,
"category_ids": ["string"
],
"parent_id": null,
"upload_max_filesize": null,
"metadata": [null
]
}

Response samples

201
400
401
404
500

Content type

application/json

{"data": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"message": "Created successfully"
}

Get a list of products

Authorizations:

BasicAuthUnAuthToken

query Parameters

limit	integer Default: 20 The numbers of items to return
sort	string Default: "desc" Enum: "desc" "asc"
sortBy	string Default: "id"
status	string Default: "publish" Enum: "publish" "draft" "trashed" Product status

Responses

Response samples

200
401
404
413
500

Content type

application/json

{"data": [{"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
}
],
"links": {"first": null,
"last": null,
"prev": "https://api.printcart.com/v1/products?cursor=byJpZCI6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ",
"next": "https://api.printcart.com/v1/products?cursor=byJpOAM6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ"
},
"meta": {"path": "https://api.printcart.com/v1/products",
"per_page": 20
},
"message": "Retrieved successfully"
}

Get Product Details

Authorizations:

BasicAuthUnAuthToken

path Parameters

productId

required

string

Product ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"message": "Retrieved successfully"
}

Update Product Details

Authorizations:

BasicAuth

path Parameters

productId

required

string

Product ID

Request Body schema: application/json

name	string Updated name of the product
dynamic_side	boolean
viewport_width	number <float>
viewport_height	number <float>
scale	number <float>
dpi	integer <int64>
dimension_unit	string Enum: "inch" "cm"
status	string Enum: "publish" "draft" "trashed" Product status
allowed_file_types	Array of strings Items Enum: "jpg" "png" "ai" "pdf" "ps"
max_file_upload	integer <int64>
min_jpg_dpi	integer <int64>
enable_design	boolean
enable_upload	boolean
enable_pod	boolean True if you want the product to be published on our POD page
product_image_id	string Image ID.
description	string Product description
category_ids	Array of strings Category ID (Storage ID)
upload_max_filesize	integer Limit file upload size
metadata	Array of arrays

Responses

Request samples

Payload

Content type

application/json

{"name": "product example update",
"dynamic_side": true,
"viewport_width": 50.5,
"viewport_height": 50.5,
"scale": 50.5,
"dpi": 100,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": false,
"enable_pod": false,
"product_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"description": null,
"category_ids": ["string"
],
"upload_max_filesize": null,
"metadata": [null
]
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"message": "Updated successfully"
}

Delete a product

Authorizations:

BasicAuth

path Parameters

productId

required

string

Product ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"message": "Deleted successfully"
}

Create batch products

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects (Product)

Array

name required	string The name given to a product
dynamic_side	boolean
viewport_width	number <float>
viewport_height	number <float>
scale	number <float>
dpi	integer <int64> Default: 72
dimension_unit	string Default: "cm" Enum: "inch" "cm"
status	string Default: "publish" Enum: "publish" "draft" "trashed" Product status
allowed_file_types	Array of strings Items Enum: "jpg" "png" "ai" "pdf" "svg" "ps"
enable_design	boolean
enable_upload	boolean
enable_pod	boolean Default: false True if you want the product to be published on our POD page
product_image_id	string Image ID.
max_file_upload	integer <int64> Default: 1
min_jpg_dpi	integer <int64> Default: 0
type_id	string Enum: "simple" "variant" "variant_option"
description	string Product description
category_ids	Array of strings Category ID (Storage ID)
parent_id	string Product ID
upload_max_filesize	integer Limit file upload size
metadata	Array of arrays

Responses

Request samples

Payload

Content type

application/json

{"products": [{"name": "Product Example",
"dynamic_side": true,
"viewport_width": 50.5,
"viewport_height": 50.5,
"scale": 50.5,
"dpi": 72,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"enable_design": false,
"enable_upload": false,
"enable_pod": false,
"product_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"max_file_upload": 500,
"min_jpg_dpi": 500,
"type_id": "simple",
"description": null,
"category_ids": ["string"
],
"parent_id": null,
"upload_max_filesize": null,
"metadata": [null
]
}
]
}

Response samples

Content type

application/json

{"data": [{"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
}
],
"message": "Created successfully"
}

Update batch products

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects

Array

id required	string Product ID.
name	string Updated name of the product
dynamic_side	boolean
viewport_width	number <float>
viewport_height	number <float>
scale	number <float>
dpi	integer <int64>
dimension_unit	string Enum: "inch" "cm"
status	string Enum: "publish" "draft" "trashed" Product status
allowed_file_types	Array of strings Items Enum: "jpg" "png" "ai" "pdf" "ps"
max_file_upload	integer <int64>
min_jpg_dpi	integer <int64>
enable_design	boolean
enable_upload	boolean
enable_pod	boolean True if you want the product to be published on our POD page
product_image_id	string Image ID
description	string Product description
upload_max_filesize	integer Limit file upload size
metadata	Array of arrays

Responses

Request samples

Payload

Content type

application/json

{"products": [{"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example update",
"dynamic_side": true,
"viewport_width": 50.5,
"viewport_height": 50.5,
"scale": 50.5,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": false,
"enable_pod": false,
"product_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"description": null,
"upload_max_filesize": null,
"metadata": [null
]
}
]
}

Response samples

Content type

application/json

{"data": [{"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
}
],
"message": "Updated successfully"
}

Delete batch products

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects

Array

id

required

string

Product ID

Responses

Request samples

Payload

Content type

application/json

{"products": [{"id": "962af342-a2c9-4665-bb5d-cb208258d958"
}
]
}

Response samples

Content type

application/json

{"message": "Deleted successfully"
}

Get a count of products

Authorizations:

BasicAuth

Responses

Response samples

200
401
500

Content type

application/json

{"data": {"count": 10
},
"message": "Retrieved successfully"
}

Get a list of designs by product

Authorizations:

BasicAuth

path Parameters

productId

required

string

Product ID

query Parameters

limit	integer Default: 20 The numbers of items to return
sort	string Default: "desc" Enum: "desc" "asc"
sortBy	string Default: "id"
status	string Default: "publish" Enum: "publish" "draft" "trashed" Product status

Responses

Response samples

200
401
404
413
500

Content type

application/json

{"data": [{"id": "cce4dc71-6757-4a1c-a259-6b66a4304c14",
"note": "Design example note",
"status": "processing",
"side": {"type": null,
"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"ratio": 72,
"dimension_unit": "cm",
"status": "publish",
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50.5,
"y": 50.5
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50.5,
"y": 50.5
},
"side_image_size": {"width": 50,
"height": 50
},
"side_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"bg_type": "image",
"bg_color_value": "red",
"img_overlay": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"product": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"project": {"id": "4419934f-8e1b-4cf0-b432-01ef9258a812",
"name": "project example",
"status": "processing",
"note": "project example note",
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"preview_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"design_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"original_side": {"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"scale": 72,
"dimension_unit": "cm",
"status": "publish",
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50.5,
"y": 50.5
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50.5,
"y": 50.5
},
"side_image_size": {"width": 50,
"height": 50
},
"side_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"product": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"bg_type": "image",
"bg_color_value": "red",
"img_overlay": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"original_output_options": {"dpi": 500,
"dimension_unit": "inch"
},
"viewport": {"width": 50.5,
"height": 50.5
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"links": {"first": null,
"last": null,
"prev": "https://api.printcart.com/v1/designs?cursor=byJpZCI6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ",
"next": "https://api.printcart.com/v1/designs?cursor=byJpOAM6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ"
},
"meta": {"path": "https://api.printcart.com/v1/designs",
"per_page": 20
},
"message": "Retrieved successfully"
}

Get a list of sides by product

Authorizations:

BasicAuthUnAuthToken

path Parameters

productId

required

string

Product ID

query Parameters

limit	integer The numbers of items to return
sort	string Default: "desc" Enum: "desc" "asc"
sortBy	string Default: "id"

Responses

Response samples

200
401
404
413
500

Content type

application/json

{"data": [{"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"scale": 72,
"dimension_unit": "cm",
"status": "publish",
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50.5,
"y": 50.5
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50.5,
"y": 50.5
},
"side_image_size": {"width": 50,
"height": 50
},
"side_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"product": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"bg_type": "image",
"bg_color_value": "red",
"img_overlay": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"links": {"first": null,
"last": null,
"prev": "https://api.printcart.com/v1/sides?cursor=byJpZCI6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ",
"next": "https://api.printcart.com/v1/sides?cursor=byJpOAM6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ"
},
"meta": {"path": "https://api.printcart.com/v1/sides",
"per_page": 20
},
"message": "Retrieved successfully"
}

Get a count of designs by product

Authorizations:

BasicAuth

path Parameters

productId

required

string

Product ID

Responses

Response samples

200
401
500

Content type

application/json

{"data": {"count": 10
},
"message": "Retrieved successfully"
}

Get a count of sides by product

Authorizations:

BasicAuth

path Parameters

productId

required

string

Product ID

Responses

Response samples

200
401
500

Content type

application/json

{"data": {"count": 10
},
"message": "Retrieved successfully"
}

Side

Create new product side

Authorizations:

BasicAuth

Request Body schema: application/json

product_id required	string Product ID
name required	string The name given to a side
bg_type	string Default: "image" Enum: "color" "image" "transparent"
bg_color_value	string
img_overlay_id	string
scale required	number <double>
background_included	boolean
show_overlay	boolean
include_overlay	boolean
	object
	object
show_cut_line	boolean
	object
show_safe_zone	boolean
	object
side_image_id required	string
status	string Default: "publish" Enum: "publish" "draft" "trashed" Side status

Responses

Request samples

Payload

Content type

application/json

{"product_id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "Side Example",
"bg_type": "image",
"bg_color_value": "red",
"img_overlay_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"scale": 100,
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"side_image_size": {"width": 50,
"height": 50
},
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50,
"y": 50
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50,
"y": 50
},
"side_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"status": "publish"
}

Response samples

201
400
401
404
500

Content type

application/json

{"data": {"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"scale": 72,
"dimension_unit": "cm",
"status": "publish",
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50.5,
"y": 50.5
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50.5,
"y": 50.5
},
"side_image_size": {"width": 50,
"height": 50
},
"side_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"product": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"bg_type": "image",
"bg_color_value": "red",
"img_overlay": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "Created successfully"
}

Get a list of product sides

Authorizations:

BasicAuthUnAuthToken

query Parameters

limit	integer Default: 20 The numbers of items to return
sort	string Default: "desc" Enum: "desc" "asc"
sortBy	string Default: "id"
status	string Default: "publish" Enum: "publish" "draft" "trashed" Side status

Responses

Response samples

200
401
404
413
500

Content type

application/json

{"data": [{"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"scale": 72,
"dimension_unit": "cm",
"status": "publish",
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50.5,
"y": 50.5
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50.5,
"y": 50.5
},
"side_image_size": {"width": 50,
"height": 50
},
"side_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"product": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"bg_type": "image",
"bg_color_value": "red",
"img_overlay": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"links": {"first": null,
"last": null,
"prev": "https://api.printcart.com/v1/sides?cursor=byJpZCI6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ",
"next": "https://api.printcart.com/v1/sides?cursor=byJpOAM6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ"
},
"meta": {"path": "https://api.printcart.com/v1/sides",
"per_page": 20
},
"message": "Retrieved successfully"
}

Get product side details

Authorizations:

BasicAuthUnAuthToken

path Parameters

sideId

required

string

Side ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"scale": 72,
"dimension_unit": "cm",
"status": "publish",
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50.5,
"y": 50.5
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50.5,
"y": 50.5
},
"side_image_size": {"width": 50,
"height": 50
},
"side_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"product": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"bg_type": "image",
"bg_color_value": "red",
"img_overlay": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "Retrieved successfully"
}

Update a product side details

Authorizations:

BasicAuth

path Parameters

sideId

required

string

Side ID

Request Body schema: application/json

product_id	string Product ID
name	string The name given to a side
bg_type	string Default: "image" Enum: "color" "image" "transparent"
bg_color_value	string
img_overlay_id	string
scale	number <double>
background_included	boolean
show_overlay	boolean
include_overlay	boolean
	object
	object
show_cut_line	boolean
	object
show_safe_zone	boolean
	object
side_image_id	string
status	string Default: "publish" Enum: "publish" "draft" "trashed" Side status

Responses

Request samples

Payload

Content type

application/json

{"product_id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "Side Example",
"bg_type": "image",
"bg_color_value": "red",
"img_overlay_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"scale": 100,
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"side_image_size": {"width": 50,
"height": 50
},
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50,
"y": 50
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50,
"y": 50
},
"side_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"status": "publish"
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"scale": 72,
"dimension_unit": "cm",
"status": "publish",
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50.5,
"y": 50.5
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50.5,
"y": 50.5
},
"side_image_size": {"width": 50,
"height": 50
},
"side_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"product": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"bg_type": "image",
"bg_color_value": "red",
"img_overlay": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "Updated successfully"
}

Delete a product side

Authorizations:

BasicAuth

path Parameters

sideId

required

string

Side ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"message": "Deleted successfully"
}

Create batch sides

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects (Side)

Array

product_id required	string Product ID
name required	string The name given to a side
bg_type	string Default: "image" Enum: "color" "image" "transparent"
bg_color_value	string
img_overlay_id	string
scale required	number <double>
background_included	boolean
show_overlay	boolean
include_overlay	boolean
	object
	object
show_cut_line	boolean
	object
show_safe_zone	boolean
	object
side_image_id required	string
status	string Default: "publish" Enum: "publish" "draft" "trashed" Side status

Responses

Request samples

Payload

Content type

application/json

{"sides": [{"product_id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "Side Example",
"bg_type": "image",
"bg_color_value": "red",
"img_overlay_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"scale": 100,
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"side_image_size": {"width": 50,
"height": 50
},
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50,
"y": 50
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50,
"y": 50
},
"side_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"status": "publish"
}
]
}

Response samples

Content type

application/json

{"data": [{"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"scale": 72,
"dimension_unit": "cm",
"status": "publish",
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50.5,
"y": 50.5
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50.5,
"y": 50.5
},
"side_image_size": {"width": 50,
"height": 50
},
"side_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"product": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"bg_type": "image",
"bg_color_value": "red",
"img_overlay": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"message": "Created successfully"
}

Update batch sides

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects

Array

id required	string Side ID
name	string The name given to a side
bg_type	string Default: "image" Enum: "color" "image" "transparent"
bg_color_value	string
img_overlay_id	string
scale	number <double>
background_included	boolean
show_overlay	boolean
include_overlay	boolean
	object
	object
show_cut_line	boolean
	object
show_safe_zone	boolean
	object
side_image_id	string
status	string Default: "publish" Enum: "publish" "draft" "trashed" Side status

Responses

Request samples

Payload

Content type

application/json

{"sides": [{"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"bg_type": "image",
"bg_color_value": "red",
"img_overlay_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"scale": 100,
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"side_image_size": {"width": 50,
"height": 50
},
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50,
"y": 50
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50,
"y": 50
},
"side_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"status": "publish"
}
]
}

Response samples

Content type

application/json

{"data": [{"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"scale": 72,
"dimension_unit": "cm",
"status": "publish",
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50.5,
"y": 50.5
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50.5,
"y": 50.5
},
"side_image_size": {"width": 50,
"height": 50
},
"side_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"product": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"bg_type": "image",
"bg_color_value": "red",
"img_overlay": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"message": "Updated successfully"
}

Delete batch sides

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects

Array

id

required

string

Side ID

Responses

Request samples

Payload

Content type

application/json

{"sides": [{"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b"
}
]
}

Response samples

Content type

application/json

{"message": "Deleted successfully"
}

Get a list of templates by side

Authorizations:

BasicAuthUnAuthToken

path Parameters

sideId

required

string

Side ID

query Parameters

limit	integer Default: 20 The numbers of items to return
sort	string Default: "desc" Enum: "desc" "asc"
sortBy	string Default: "id"

Responses

Response samples

200
401
404
413
500

Content type

application/json

{"data": [{"id": "cce4dc71-6757-4a1c-a259-6b66a4304c14",
"note": "Template example note",
"side": {"type": null,
"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"ratio": 72,
"dimension_unit": "cm",
"status": "publish",
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50.5,
"y": 50.5
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50.5,
"y": 50.5
},
"side_image_size": {"width": 50,
"height": 50
},
"side_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"bg_type": "image",
"bg_color_value": "red",
"img_overlay": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"product": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"project": {"id": "4419934f-8e1b-4cf0-b432-01ef9258a812",
"name": "project example",
"status": "processing",
"note": "project example note",
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"preview_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"template_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"original_side": {"id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
"name": "Side Example",
"scale": 72,
"dimension_unit": "cm",
"status": "publish",
"design_area": {"width": 50,
"height": 50,
"top": 50,
"left": 50
},
"show_cut_line": true,
"cut_line_margin": {"x": 50.5,
"y": 50.5
},
"show_safe_zone": true,
"safe_zone_margin": {"x": 50.5,
"y": 50.5
},
"side_image_size": {"width": 50,
"height": 50
},
"side_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"product": {"id": "962af342-a2c9-4665-bb5d-cb208258d958",
"name": "product example",
"dynamic_side": 500,
"viewport_width": 500,
"viewport_height": 500,
"scale": 500,
"dpi": 500,
"dimension_unit": "inch",
"status": "publish",
"allowed_file_types": ["jpg",
"png",
"ai",
"pdf"
],
"max_file_upload": 500,
"min_jpg_dpi": 500,
"enable_design": false,
"enable_upload": true,
"enable_pod": false,
"upload_max_filesize": null,
"integration_product_id": null,
"product_image": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z",
"metadata": null
},
"bg_type": "image",
"bg_color_value": "red",
"img_overlay": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"background_included": true,
"show_overlay": true,
"include_overlay": true,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"original_output_options": {"dpi": 500,
"dimension_unit": "inch"
},
"viewport": {"width": 50.5,
"height": 50.5
},
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"links": {"first": null,
"last": null,
"prev": "https://api.printcart.com/v1/templates?cursor=byJpZCI6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ",
"next": "https://api.printcart.com/v1/templates?cursor=byJpOAM6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ"
},
"meta": {"path": "https://api.printcart.com/v1/templates",
"per_page": 20
},
"message": "Retrieved successfully"
}

Get a count of product sides

Authorizations:

BasicAuth

Responses

Response samples

200
401
500

Content type

application/json

{"data": {"count": 10
},
"message": "Retrieved successfully"
}

Image

Add new image

Authorizations:

BasicAuthUnAuthToken

Request Body schema: multipart/form-data

file	string <binary> Image to upload
type	string Default: null Enum: null "cliparts" "designs"
custom_width	integer <int64> Custom width thumbnail image

Responses

Response samples

201
400
401
415
500

Content type

application/json

{"data": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "File successfully uploaded"
}

Get a list of images

Authorizations:

BasicAuthUnAuthToken

query Parameters

limit	integer The numbers of items to return
sort	string Default: "desc" Enum: "desc" "asc"
sortBy	string Default: "id"

Responses

Response samples

200
401
404
413
500

Content type

application/json

{"data": [{"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"links": {"first": null,
"last": null,
"prev": "https://api.printcart.com/v1/images?cursor=byJpZCI6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ",
"next": "https://api.printcart.com/v1/images?cursor=byJpOAM6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ"
},
"meta": {"path": "https://api.printcart.com/v1/images",
"per_page": 20
},
"message": "Retrieved successfully"
}

Get image details

Authorizations:

BasicAuth

path Parameters

imageId

required

string

Image ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "Retrieved successfully"
}

Delete a image

Authorizations:

BasicAuth

path Parameters

imageId

required

string

Image Id

Responses

Response samples

200
401
404
500

Content type

application/json

{"message": "Deleted successfully"
}

Add new batch images

Authorizations:

BasicAuthUnAuthToken

Request Body schema: multipart/form-data

files[]	string <binary> Multiple File Images Upload
type	string Default: null Enum: null "cliparts" "designs"

Responses

Response samples

201
400
401
415
500

Content type

application/json

{"data": [{"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Image example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Image example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"message": "File successfully uploaded"
}

Get a count of images

Authorizations:

BasicAuth

Responses

Response samples

200
401

Content type

application/json

{"data": {"count": 10
},
"message": "Retrieved successfully"
}

Clipart

Add new Clipart

Authorizations:

BasicAuth

Request Body schema: multipart/form-data

file	string <binary> Clipart to upload

Responses

Response samples

201
400
401
415
500

Content type

application/json

{"data": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Clipart example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Clipart example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "File successfully uploaded"
}

Get a list of cliparts

Authorizations:

BasicAuthUnAuthToken

query Parameters

limit	integer The numbers of items to return
sort	string Default: "desc" Enum: "desc" "asc"
sortBy	string Default: "id"

Responses

Response samples

200
401
404
413
500

Content type

application/json

{"data": [{"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Clipart example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Clipart example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"links": {"first": null,
"last": null,
"prev": "https://api.printcart.com/v1/cliparts?cursor=byJpZCI6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ",
"next": "https://api.printcart.com/v1/cliparts?cursor=byJpOAM6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ"
},
"meta": {"path": "https://api.printcart.com/v1/cliparts",
"per_page": 20
},
"message": "Retrieved successfully"
}

Get a list of cliparts default

Authorizations:

BasicAuthUnAuthToken

query Parameters

limit	integer The numbers of items to return
sort	string Default: "desc" Enum: "desc" "asc"
sortBy	string Default: "id"

Responses

Response samples

200
401
404
413
500

Content type

application/json

{"data": [{"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Clipart example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Clipart example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"links": {"first": null,
"last": null,
"prev": "https://api.printcart.com/v1/cliparts?cursor=byJpZCI6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ",
"next": "https://api.printcart.com/v1/cliparts?cursor=byJpOAM6MTE4MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cncavQ"
},
"meta": {"path": "https://api.printcart.com/v1/cliparts",
"per_page": 20
},
"message": "Retrieved successfully"
}

Get clipart details

Authorizations:

BasicAuthUnAuthToken

path Parameters

clipartId

required

string

Clipart ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Clipart example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Clipart example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "Retrieved successfully"
}

Update clipart details

Authorizations:

BasicAuth

path Parameters

clipartId

required

string

Clipart ID

Request Body schema: application/json

storages

Array of arrays

Storage ID

Responses

Request samples

Payload

Content type

application/json

{"storages": ["e8304b84-a015-3bd4-a7d3-7a978f463a6v",
"e5610b84-a015-3bd4-a7d3-7a978f465df2"
]
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Clipart example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Clipart example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
},
"message": "Update successfully"
}

Delete a clipart

Authorizations:

BasicAuth

path Parameters

clipartId

required

string

Clipart Id

Responses

Response samples

200
401
404
500

Content type

application/json

{"message": "Deleted successfully"
}

Add new batch clipart

Authorizations:

BasicAuth

Request Body schema: multipart/form-data

files[]

string <binary>

ultiple File Cliparts Upload

Responses

Response samples

201
400
401
415
500

Content type

application/json

{"data": [{"id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
"name": "Clipart example",
"url": "https://files.printcart.com/images/19f99961-edac-455e-b407-aa6aa80ec862/0V34SX2YcE31B3zZ0xcm5dFbN1fGUdZc9GRIlxvP.jpg",
"thumbnails": {"small": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_small.webp",
"medium": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_medium.webp",
"custom": "https://files.printcart.com/image-thumbnail/e24d-dezj-408a-a247-4012a09b3/G0Ujj8ICRFDacEL0zj6Zq983Q818Z1X_custom.webp"
},
"alt": "Clipart example",
"width": 500,
"height": 500,
"created_at": "2021-11-16T08:26:30.000000Z",
"updated_at": "2021-11-16T08:26:30.000000Z"
}
],
"message": "File successfully uploaded"
}

Get a count of cliparts

Authorizations:

BasicAuthUnAuthToken

Responses

Response samples

200
401
500

Content type

application/json

{"data": {"count": 10
},
"message": "Retrieved successfully"
}

Get a count of cliparts default

Authorizations:

BasicAuthUnAuthToken

Responses

Response samples

200
401
500

Content type

application/json

{"data": {"count": 10
},
"message": "Retrieved successfully"
}

Design

Create new design

Authorizations:

BasicAuthUnAuthToken

Request Body schema: application/json

project_id	string Project ID
side_id required	string Side ID
preview_image_id	string Image ID
design_image_id	string Image ID
note	string
is_uploader	boolean Default: false
layers	Array of objects Lorem ipsum...
status	string Default: "processing" Enum: "accepted" "processing" "declined" "trashed" Design status
viewport_width	number <float>
viewport_height	number <float> </