Skip to main content

PrintCart Rest API (1.0.0)

Download OpenAPI specification:Download

Account

Create Account

Request Body schema: application/json
name
string

Customer name.

email
required
string <email>

The email address for the customer.

password
required
string

Customer password.

Responses

Request samples

Content type
application/json
{
  • "name": "example",
  • "email": "example@gamil.com",
  • "password": "Password123@"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Created successfully"
}

Get Account Info

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "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

Content type
application/json
{
  • "name": "example",
  • "email": "example@gamil.com"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Updated successfully"
}

Store

Create Store

Authorizations:
BasicAuth
Request Body schema: application/json
store_name
required
string

Responses

Request samples

Content type
application/json
{
  • "store_name": "store example"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Created successfully"
}

Get Store Info

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Retrieved successfully"
}

Update store details

Authorizations:
BasicStore
Request Body schema: application/json
store_name
string
unsplash
string
pixabay
string
pexels
string
google_font_api
string

Responses

Request samples

Content type
application/json
{
  • "store_name": "store example update",
  • "unsplash": "string",
  • "pixabay": "string",
  • "pexels": "string",
  • "google_font_api": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Updated successfully"
}

Delete a store

Authorizations:
BasicStore

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted successfully"
}

Get Store details

Authorizations:
BasicStoreUnAuthToken

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Retrieved successfully"
}

Renew UnAuth Token

Authorizations:
BasicStore

Responses

Response samples

Content type
application/json
{
  • "unauth_token": "22d23e41e296c45b0c6c9cd722398b90a3cc906301bdebfaac4751cf2dowmar3",
  • "message": "Updated successfully"
}

Product

Create new product

Authorizations:
BasicStore
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" "deleted"

Product status

allowed_file_types
Array of strings
Items Enum: "jpg" "png" "ai" "pdf"
max_file_upload
integer <int64>
Default: 1
min_jpg_dpi
integer <int64>
Default: 0
enable_design
boolean
product_image_id
string

Image ID.

Responses

Request samples

Content type
application/json
{
  • "name": "product example",
  • "dynamic_side": true,
  • "viewport_width": 50.5,
  • "viewport_height": 50.5,
  • "scale": 50.5,
  • "dpi": 100,
  • "dimension_unit": "inch",
  • "status": "publish",
  • "allowed_file_types": [
    ],
  • "max_file_upload": 500,
  • "min_jpg_dpi": 500,
  • "enable_design": false,
  • "product_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Created successfully"
}

Get a list of products

Authorizations:
BasicStoreUnAuthToken
query Parameters
sort
string
Default: "desc"
Enum: "desc" "asc"
limit
string
Default: 20

Limit the number of products

status
string
Default: "publish"
Enum: "publish" "draft" "trashed"

Product status

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Retrieved successfully"
}

Get product details

Authorizations:
BasicStoreUnAuthToken
path Parameters
productId
required
string

Product ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Retrieved successfully"
}

Update product details

Authorizations:
BasicStore
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" "deleted"

Product status

allowed_file_types
Array of strings
Items Enum: "jpg" "png" "ai" "pdf"
max_file_upload
integer <int64>
min_jpg_dpi
integer <int64>
enable_design
boolean
product_image_id
string

Image ID.

Responses

Request samples

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": [
    ],
  • "max_file_upload": 500,
  • "min_jpg_dpi": 500,
  • "enable_design": false,
  • "product_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Updated successfully"
}

Delete a product

Authorizations:
BasicStore
path Parameters
productId
required
string

Product ID

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted successfully"
}

Create batch products

Authorizations:
BasicStore
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" "deleted"

Product status

allowed_file_types
Array of strings
Items Enum: "jpg" "png" "ai" "pdf"
max_file_upload
integer <int64>
Default: 1
min_jpg_dpi
integer <int64>
Default: 0
enable_design
boolean
product_image_id
string

Image ID.

Responses

Request samples

Content type
application/json
{
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Created successfully"
}

Update batch products

Authorizations:
BasicStore
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" "deleted"

Product status

allowed_file_types
Array of strings
Items Enum: "jpg" "png" "ai" "pdf"
max_file_upload
integer <int64>
min_jpg_dpi
integer <int64>
enable_design
boolean
product_image_id
string

Image ID

Responses

Request samples

Content type
application/json
{
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Updated successfully"
}

Delete batch products

Authorizations:
BasicStore
Request Body schema: application/json
Array of objects
Array
id
required
string

Product ID

Responses

Request samples

Content type
application/json
{
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Deleted successfully"
}

Get a list of designs by product

Authorizations:
BasicStore
path Parameters
productId
required
string

Product ID

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "message": "Retrieved successfully"
}

Get a list of sides by product

Authorizations:
BasicStoreUnAuthToken
path Parameters
productId
required
string

Product ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Retrieved successfully"
}

Get a count of designs by product

Authorizations:
BasicStore
path Parameters
productId
required
string

Product ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Retrieved successfully"
}

Get a count of sides by product

Authorizations:
BasicStore
path Parameters
productId
required
string

Product ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Retrieved successfully"
}

Get a count of products

Authorizations:
BasicStore

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Retrieved successfully"
}

Side

Create new product side

Authorizations:
BasicStore
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

Image ID

ratio
number <double>
background_included
boolean
show_overlay
boolean
include_overlay
boolean
object
object
object
show_bleed
boolean
object
show_safe_zone
boolean
object
bg_img_id
string

Image ID

object
object
object
object
ratio_image
number <double>

Responses

Request samples

Content type
application/json
{
  • "product_id": "962af342-a2c9-4665-bb5d-cb208258d958",
  • "name": "printcart",
  • "bg_type": "image",
  • "bg_color_value": "red",
  • "img_overlay_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
  • "ratio": 100,
  • "background_included": true,
  • "show_overlay": true,
  • "include_overlay": true,
  • "product_size": {
    },
  • "design_size": {
    },
  • "design_position": {
    },
  • "show_bleed": true,
  • "bleed_size": {
    },
  • "show_safe_zone": true,
  • "margin_size": {
    },
  • "bg_img_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
  • "background_size": {
    },
  • "bleed_position": {
    },
  • "margin_position": {
    },
  • "measure_size": {
    },
  • "ratio_image": 100
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Created successfully"
}

Get a list of product sides

Authorizations:
BasicStoreUnAuthToken
query Parameters
sort
string
Default: "desc"
Enum: "desc" "asc"
limit
string
Default: 20

Limit the number of sides

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Retrieved successfully"
}

Get product side details

Authorizations:
BasicStoreUnAuthToken
path Parameters
sideId
required
string

Side ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Retrieved successfully"
}

Update a product side details

Authorizations:
BasicStore
path Parameters
sideId
required
string

Side ID

Request Body schema: application/json
product_id
string

Product ID

name
string

Updated name of the side

bg_type
string
Enum: "color" "image" "transparent"
bg_color_value
string
img_overlay_id
string

Image ID

ratio
number <double>
background_included
boolean
show_overlay
boolean
include_overlay
boolean
object
object
object
show_bleed
boolean
object
show_safe_zone
boolean
object
bg_img_id
string

Image ID

object
object
object
object
ratio_image
number <double>

Responses

Request samples

Content type
application/json
{
  • "product_id": "962af342-a2c9-4665-bb5d-cb208258d958",
  • "name": "printcart",
  • "bg_type": "image",
  • "bg_color_value": "red",
  • "img_overlay_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
  • "ratio": 100,
  • "background_included": true,
  • "show_overlay": true,
  • "include_overlay": true,
  • "product_size": {
    },
  • "design_size": {
    },
  • "design_position": {
    },
  • "show_bleed": true,
  • "bleed_size": {
    },
  • "show_safe_zone": true,
  • "margin_size": {
    },
  • "bg_img_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
  • "background_size": {
    },
  • "bleed_position": {
    },
  • "margin_position": {
    },
  • "measure_size": {
    },
  • "ratio_image": 100
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Updated successfully"
}

Delete a product side

Authorizations:
BasicStore
path Parameters
sideId
required
string

Side ID

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted successfully"
}

Create batch sides

Authorizations:
BasicStore
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

Image ID

ratio
number <double>
background_included
boolean
show_overlay
boolean
include_overlay
boolean
object
object
object
show_bleed
boolean
object
show_safe_zone
boolean
object
bg_img_id
string

Image ID

object
object
object
object
ratio_image
number <double>

Responses

Request samples

Content type
application/json
{
  • "sides": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Created successfully"
}

Update batch sides

Authorizations:
BasicStore
Request Body schema: application/json
Array of objects
Array
id
required
string

Side ID

product_id
string

Product ID

name
string

Updated name of the side

bg_type
string
Enum: "color" "image" "transparent"
bg_color_value
string
img_overlay_id
string

Image ID

ratio
number <double>
background_included
boolean
show_overlay
boolean
include_overlay
boolean
object
object
object
show_bleed
boolean
object
show_safe_zone
boolean
object
bg_img_id
string

Image ID

object
object
object
object
ratio_image
number <double>

Responses

Request samples

Content type
application/json
{
  • "sides": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Updated successfully"
}

Delete batch sides

Authorizations:
BasicStore
Request Body schema: application/json
Array of objects
Array
id
required
string

Side ID

Responses

Request samples

Content type
application/json
{
  • "sides": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Deleted successfully"
}

Get a list of templates by side

Authorizations:
BasicStoreUnAuthToken
path Parameters
sideId
required
string

Side ID

query Parameters
sort
string
Default: "desc"
Enum: "desc" "asc"
limit
string
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "message": "Retrieved successfully"
}

Get a count of product sides

Authorizations:
BasicStore

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Retrieved successfully"
}

Image

Add new image

Authorizations:
BasicStoreUnAuthToken
Request Body schema: multipart/form-data
file
string <binary>

Image to upload

type
string
Default: null
Enum: "null" "cliparts" "designs"

Responses

Response samples

Content type
application/json
{}

Get a list of images

Authorizations:
BasicStoreUnAuthToken
query Parameters
sort
string
Default: "desc"
Enum: "desc" "asc"
limit
string
Default: 20

Limit the number of images

Responses

Response samples

Content type
application/json
{}

Get image details

Authorizations:
BasicStore
path Parameters
imageId
required
string

Image ID

Responses

Response samples

Content type
application/json
{}

Delete a image

Authorizations:
BasicStore
path Parameters
imageId
required
string

Image Id

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted successfully"
}

Add new batch images

Authorizations:
BasicStoreUnAuthToken
Request Body schema: multipart/form-data
files[]
string <binary>

Image to upload

type
string
Default: null
Enum: "null" "cliparts" "designs"

Responses

Response samples

Content type
application/json
{}

Get a count of images

Authorizations:
BasicStore

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Retrieved successfully"
}

Clipart

Add new Clipart

Authorizations:
BasicStore
Request Body schema: multipart/form-data
file
string <binary>

Clipart to upload

Responses

Response samples

Content type
application/json
{}

Get a list of cliparts

Authorizations:
BasicStoreUnAuthToken
query Parameters
sort
string
Default: "desc"
Enum: "desc" "asc"
limit
string
Default: 20

Limit the number of cliparts

Responses

Response samples

Content type
application/json
{}

Get a list of cliparts default

Authorizations:
BasicStoreUnAuthToken
query Parameters
sort
string
Default: "desc"
Enum: "desc" "asc"
limit
string
Default: 20

Limit the number of cliparts default

Responses

Response samples

Content type
application/json
{}

Get clipart details

Authorizations:
BasicStoreUnAuthToken
path Parameters
clipartId
required
string

Clipart ID

Responses

Response samples

Content type
application/json
{}

Update clipart details

Authorizations:
BasicStore
path Parameters
clipartId
required
string

Clipart ID

Request Body schema: application/json
storages
Array of arrays

Uuid Storage

Responses

Request samples

Content type
application/json
{
  • "storages": [
    ]
}

Response samples

Content type
application/json
{}

Delete a clipart

Authorizations:
BasicStore
path Parameters
clipartId
required
string

Clipart Id

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted successfully"
}

Add new batch clipart

Authorizations:
BasicStore
Request Body schema: multipart/form-data
files[]
string <binary>

Clipart to upload

Responses

Response samples

Content type
application/json
{}

Get a count of cliparts

Authorizations:
BasicStoreUnAuthToken

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Retrieved successfully"
}

Font

Add new font

Authorizations:
BasicStore
Request Body schema: application/json
name
required
string

The name given to a font

alias
required
string
url
required
string <url>
type
required
string
subset
required
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Created successfully"
}

Get a list of fonts

Authorizations:
BasicStoreUnAuthToken
query Parameters
sort
string
Default: "desc"
Enum: "desc" "asc"
limit
string
Default: 20

Limit the number of fonts

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Retrieved successfully"
}

Get a list of fonts default

Authorizations:
BasicStoreUnAuthToken
query Parameters
sort
string
Default: "desc"
Enum: "desc" "asc"
limit
string
Default: 20

Limit the number of fonts

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Retrieved successfully"
}

Get font details

Authorizations:
BasicStoreUnAuthToken
path Parameters
fontId
required
string

Font ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Retrieved successfully"
}

Update font details

Authorizations:
BasicStore
path Parameters
fontId
required
string

Font ID

Request Body schema: application/json
name
string

Updated name of the font

alias
string
url
string <url>
type
string
subset
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Update successfully"
}

Delete font

Authorizations:
BasicStore
path Parameters
fontId
required
string

Font ID

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted successfully"
}

Get a count of fonts

Authorizations:
BasicStore

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Retrieved successfully"
}

Design

Create new design

Authorizations:
BasicStoreUnAuthToken
Request Body schema: application/json
project_id
string

Project ID

side_id
required
string

Side ID

design_ratio
number <float>
pdf_url
string
preview_image_id
string

Image ID

design_image_id
string

Image ID

quantity
integer <int64>
Default: 1
note
string
template_id
string
Default: null
layers
json

Lorem ipsum...

status
string
Default: "processing"
Enum: "accepted" "processing" "declined" "trashed" "deleted"

Design status

viewport_width
number <float>
viewport_height
number <float>

Responses

Request samples

Content type
application/json
{
  • "project_id": "4419934f-8e1b-4cf0-b432-01ef9258a812",
  • "side_id": "c5661a1e-8147-4dc3-8600-00fdc81ed14b",
  • "design_ratio": 50.5,
  • "pdf_url": "string",
  • "preview_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
  • "design_image_id": "e8304b84-a015-3bd4-a7d3-7a978f465df2",
  • "quantity": 50,
  • "note": "printcart",
  • "template_id": null,
  • "layers": [
    ],
  • "status": "accepted",
  • "viewport_width": 50.5,
  • "viewport_height": 50.5
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Created successfully"
}

Get a list of designs

Authorizations:
BasicStore
query Parameters
sort
string
Default: "desc"
Enum: "desc" "asc"
limit
string
Default: 20

Limit the number of designs

status
string
Enum: "accepted" "processing" "declined" "trashed"

Design status

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "message": "Retrieved successfully"
}

Get design details

Authorizations:
BasicStoreUnAuthToken
path Parameters
designId
required
string

Design ID

Responses

Response samples

Content type
application/json
{
  • "data": {