GET /orders/id

Get a list of order ids per customer/partner.

Resource URL

https://www.easel.ly/orders/id

Parameters

Name Type Required Description Value
partner_email String
varchar(250)		 Yes Official email address of Easely partner hello@design.com (Sample only)
name String
varchar(250)		 No Company or Customer name John Doe
order_type String No Specify if the order is Test or Official. Available values : test-order, official-order
Default value : test-order

Example request

curl -X GET "https://easel.ly/orders/id?partner_email="hello@design.com" -H "accept: application/json"
-H "apiKey: mqcM1mdeDMx3M22QCf3423MX7BXYUbsNcn9DzWFV9Tz" /span>

Example response

Response headers

connection: keep-alive content-encoding: gzip content-type: application/json date:
Wed, 07 Jul 2021 06:48:42 GMT server: nginx transfer-encoding: chunked vary:           
Accept-Encoding

Response body

[
    {
        "id": 1920
    },
    {
        "id": 1912
    },      
    {
        "id": 1886
    },           
    {   
        "id": 1855
    },           
    {   
        "id": 1846
    }
]

Response Code: 200


GET /orders/list

Return list of orders per customer name / company.

Resource URL

https://www.easel.ly/orders/list

Parameters

Name Type Required Description Value
partner_email String
varchar(250)		 Yes Official email address of Easely partner hello@design.com (Sample only)
name String
varchar(250)		 No Company or Customer name John Doe
order_type String No Specify if the order is Test or Official. Available values : test-order, official-order
Default value : test-order

Example request

curl -X GET "https://easel.ly/orders/list?partner_email=hello@design.com" -H "accept: application/json"
-H "apiKey: mqcM1mdeDMx3M22QCf3423MX7BXYUbsNcn9DzWFV9Tz"

Example response

Response headers

{
    access-control-allow-origin: *          
    connection: keep-alive          
    content-type: application/json
    date: Wed, 10 Feb 2021 11:01:26 GMT
    server: nginx/1.16.0
    transfer-encoding: chunked
    x-powered-by: PHP/7.0.33
}

Response body

{
    "records": 2,
    "data": [
        {
            "order_id": 53,
            "order_status": "new_order",
            "partner_email": "hello@design.com",
            "name": "John Doe",
            "email": "partner@easel.ly",
            "infographic_title": "Blog Infographics",
            "version": null,
            "design_url": null,
            "order_date": "2021-02-10 11:00:57"
        },
        {
            "order_id": 52,
            "order_status": "new_order",
            "partner_email": "hello@design.com",
            "name": "John Doe",
            "email": "partner@easel.ly",
            "infographic_title": "Top 10 Tech Trends 2021",
            "version": null,
            "design_url": null,
            "order_date": "2021-02-10 10:29:26"
        }
    ]
}

Response Code: 200


GET /orders/getOrderStatus

A customer can return the status of a particular order within Easelly by passing the Easelly API the order ID.

Resource URL

https://www.easel.ly/orders/getOrderStatus

Parameters

Name Type Required Description Value
order_id Int Yes Your unique infographic order ID number 1527 (Sample only)
order_type String No Specify if the order is Test or Official. Available values : test-order, official-order
Default value : test-order

Example request

curl -X GET "https://easel.ly/orders/getOrderStatus?order_id=1527" -H "accept: application/json"
-H "apiKey: mqcM1mdeDMx3M22QCf3423MX7BXYUbsNcn9DzWFV9Tz"

Example response

Response headers

connection: keep-alive content-encoding: gzip content-type: application/json date:
Wed, 26 May 2021 06:23:27 GMT server: nginx transfer-encoding: chunked vary:          
Accept-Encoding

Response body

{
    "order_id": 1527,
    "order_status": "new_order",
    "partner_email": "hello@design.com",
    "name": "Semrush",
    "email": "partner@easel.ly",
    "infographic_title": "My Infographic Order",
    "version": null,
    "design_url": null,
    "order_date": "2021-05-26 06:20:35",
    "message": null
}

Response body

{
    "order_id": 1527,
    "order_status": "paused",
    "partner_email": "hello@design.com",
    "name": "John Doe",
    "email": "partner@easel.ly",
    "infographic_title": "My Infographic Order",
    "version": null,
    "design_url": null,
    "order_date": "2021-05-26 06:20:35",
    "message": "need more details"
}

Response Code: 200


The order_status possible return values are: “new_order”, “paused”, “progress”, “review”, “revision”, “complete”


GET /orders/getDesignFiles

Return Design URL, PDF and PNG/JPEG files created by Easily designers.

Resource URL

https://www.easel.ly/getDesignFiles

Parameters

Name Type Required Description Value
order_id Int Yes Your unique infographic order ID number 52 (Sample only)
order_type String No Specify if the order is Test or Official. Available values : test-order, official-order
Default value : test-order

Example request

curl -X GET "https://easel.ly/orders/getDesignFiles?order_id=52" -H "accept: application/json"
-H "apiKey: mqcM1mdeDMx3M22QCf3423MX7BXYUbsNcn9DzWFV9Tz"

Example response

Response headers

{
    access-control-allow-origin: *          
    connection: keep-alive          
    content-type: application/json          
    date: Wed, 10 Feb 2021 11:14:05 GMT          
    server: nginx/1.16.0          
    transfer-encoding: chunked          
    x-powered-by: PHP/7.0.33          
}

Response body

{
    "order_id": 52,
    "infographic_title": "Top 10 Tech Trends 2021",
    "partner_email": "hello@design.com",
    "version": 2,
    "pdf_url": "https://easel.ly/components/pdf_annotation/php/files/844459506Top-10-Tech-Trends-2021.pdf",
    "image_url": "https://easel.ly/components/image_annotation/php/files/1751590875Top-10-Tech-Trends-2021.png",
    "design_url": "https://easel.ly/infographicdesign/design/r7X9SfYD9ebozTyGpLAJ26BGouKHZiGmTdm",
    "design_file": "https://drive.google.com/uc?export=download&id=1My76zA9keS64zM29YPaJ_hQaJfT3v1f_"
}

Response Code: 200


POST /orders/createOrder

Creates an infographic design job within the Easelly job queue.

Resource URL

https://www.easel.ly/orders/createOrder

Parameters

Name Type Required Description Value
name String
varchar(250)		 Yes Company or Customer name John Doe
email String
varchar(250)		 Yes Email address used to order your infographic.
If you are whitelabelling this service and wish not to send email any direct updates to your customer, please use the default value of “partner@easel.ly”. Otherwise, input any email address you intend to use for receiving updates		 partner@easel.ly (Sample only)
partner_email String
varchar(250)		 Yes Official email address of Easely partner hello@design.com (Sample only)
phone_number String
varchar(250)		 No Company or Customer Phone 092812323881
infographic_title String
varchar(250)		 Yes Title of your infographic Top 5 Appliance Brands of 2020
website_url String
varchar(250)		 No Your Website URL https://albertlee.com
infographic_description Text Yes Text for your infographic Top 5 Appliance Brands of 2020"infographic_description”,\"1 Whirlpool 2 LG 3 Samsung 4 Frigidaire 5 KitchenAid
infographic_reference Text No Style/Branding Guide, Logo, Colo Use website logo color
infographic_Instructions Text No Instructions you’d like to inform our designer about. Use minimal design
attach[] Int No Supporting materials for your infographic that you can attach in the order e.g. .doc, .xls, .jpeg, .png, .psd, .eps, gif Attachment
Max Upload Size Per Attachment: 40000 bytes
print_size Tinyint No Specify if you need an infographic for a particular size. 0 - no “extra file versions is needed”
1 - yes, extra file versions is needed
order_type String No Specify if the order is Test or Official. Available values : test-order, official-order
Default value : test-order

Example request

curl -X POST "https://easel.ly/orders/createOrder" -H "accept: application/json"
-H "apiKey: mqcM1mdeDMx3M22QCf3423MX7BXYUbsNcn9DzWFV9Tz" -H "Content-Type: multipart/form-data" 
-F "name=John Doe" -F "email=partner@easel.ly" -F "partner_email=hello@design.com " -F "phone_number=123456"
-F "infographic_title=My Infographic Order" -F "website_url=https://hello.com"
-F "infographic_description=My Infographic Order" -F "infographic_reference=Minimalist" 
-F "infographic_instructions=Please use My Infographic Order" -F "attach[]=@online.jpg;type=image/jpeg" -F "print_size=1"

Example response

Response headers

connection: keep-alive content-encoding: gzip content-type: application/json date:
Wed, 26 May 2021 06:20:35 GMT server: nginx transfer-encoding: chunked vary:          
Accept-Encoding

Response body

{
    "order_id": 1527,
    "name": "John Doe",
    "email": "partner@easel.ly",,
    "partner_email": "hello@design.com ",
    "phone_number": 123456,
    "infographic_title": "My Infographic Order",
    "website_url": "https://hello.com",
    "infographic_description": "My Infographic Order",
    "infographic_reference": "Minimalist",
    "infographic_instructions": "Please use My Infographic Order",
    "print_size": 1,
    "due_date": "2021-05-27",
    "orderdate": "2021-05-25 23:20:35"
}

Response Code: 200


POST /orders/updateorder

"Updating" an order allows a customer to edit and add more details for our designers' reference.

Simply enter the OrderID of an infographic order and Easelly will reopen the OrderID where the customer can add/edit their job details. Depending on the order details, you may pass these parameters to get an order updated.

Note that this endpoint will only be successful on orders in “new_order” status.

Resource URL

https://www.easel.ly/orders/updateorder

Parameters

Name Type Required Description Value
order_id Int Yes Your unique infographic order ID number 1527 (Sample only)
infographic_title String
varchar(250)		 No Title of your infographic Top 10 Tech Trends 2021
infographic_description Text No Text for your infographic This design should show the Top 10 Tech Trends 2021
infographic_reference Text No Style/Branding Guide, Logo, Colo Follow the website branding test.com
infographic_Instructions Text No Instructions you’d like to inform our designer about. Design should be be minimalist and trendy and colorful
attach[] Int No Supporting materials for your infographic that you can attach in the order e.g. .doc, .xls, .jpeg, .png, .psd, .eps, gif Attachment
Max Upload Size Per Attachment: 40000 bytes
print_size Tinyint No Specify if you need an infographic for a particular size. 0 - no “extra file versions is needed”
1 - yes, extra file versions is needed
order_type String No Specify if the order is Test or Official. Available values : test-order, official-order
Default value : test-order

Example request

curl -X POST "https://easel.ly/orders/updateOrder" -H  "accept: application/json"
-H "apiKey: mqcM1mdeDMx3M22QCf3423MX7BXYUbsNcn9DzWFV9Tz" -H "Content-Type: multipart/form-data" 
-F "order_id=1527" -F "infographic_title=My Infographic Order" -F "infographic_description=My Infographic Order"
-F "infographic_reference=Please use My Infographic Order 01" -F "infographic_instructions=Please use My Infographic Order 01" 
-F "attach[]=@online.jpg;type=image/jpeg" -F "print_size=1"

Example response

Response headers

connection: keep-alive content-encoding: gzip content-type: application/json date:
application/json date: Wed, 26 May 2021 06:31:02 GMT server: nginx          
transfer-encoding: chunked vary: Accept-Encoding

Response body

{
    "order_id": 1527,
    "partner_email": "hello@design.com ",
    "infographic_title": "My Infographic Order",
    "infographic_description": "My Infographic Order",
    "infographic_reference": "Please use My Infographic Order 01",
    "infographic_instructions": "Please use My Infographic Order 01",
    "print_size": 1,
    "updated": "2021-05-25 23:31:02"
}

Response Code: 200


If an order is not on “new_order” status, the response will be:

Response body

{
    "success": false,
    "errorCode": 400,
    "message": "Cannot update order if status is not new."
}

Response Code: 400


POST /orders/requestRevision

Request revision of design work and provide comments/changes to Easelly designers

Resource URL

https://www.easel.ly/orders/requestRevision

Parameters

Name Type Required Description Value
order_id Int Yes Your unique infographic order ID number 52 (Sample only)
version Tinyint Yes Version you intend to revise 2
annotation_url String
varchar(250)		 Yes A whitelink where points of comments will be provided Sample https://share.getcloudapp.com/DOuqPbJ7
revision_comments String
varchar(250)		 Yes List of comments or any additional instructions to Easelly designers to apply the revision requests Sample: Please apply the changes and use the attached file document as additional reference. (no mark-up required)
attach[] Int No Supporting materials for your infographic that you can attach in the order e.g. .doc, .xls, .jpeg, .png, .psd, .eps, gif Attachment
Max Upload Size Per Attachment: 40000 bytes
order_type String No Specify if the order is Test or Official. Available values : test-order, official-order
Default value : test-order

Example request

curl -X GET "https://easel.ly/orders/requestRevision?order_id=52" -H "accept: application/json"
-H "apiKey: mqcM1mdeDMx3M22QCf3423MX7BXYUbsNcn9DzWFV9Tz", "order_id: 52", "version: 2",
"annotation_url": "https://share.getcloudapp.com/DOuqPbJ7",
"revision_comments: please apply the changes and use the attached file document as additional reference",
"attach[]=@top tech trends 2021.png;type=image/png"

Example response

Response headers

{
    access-control-allow-origin: *          
    connection: keep-alive          
    content-type: application/json          
    date: Wed, 10 Feb 2021 10:04:26 GMT          
    server: nginx/1.16.0          
    transfer-encoding: chunked          
    x-powered-by: PHP/7.0.33
}

Response body

{
    "order_id": 52,
    "order_status": "revision",
    "version": 2,
    "design_url": "https://easel.ly/infographicdesign/design/r7X9SfYD9ebozTyGpLAJ26BGouKHZiGmTdm",
    "annotation_url": "https://share.getcloudapp.com/DOuqPbJ7",
    "revision_comments": "Please apply the changes and use the attached file document as additional reference.",
}

Response Code: 200


If an order is not on “review” status, the response will be:

Response body

{
    "success": false,
    "errorCode": 400,
    "message": "Cannot request revision if order status is not review."
}

Response Code: 400


POST /orders/approveOrder

Marking an order as “complete” which means the design is approved.

Resource URL

https://www.easel.ly/orders/approveOrder

Parameters

Name Type Required Description Value
order_id Int Yes Your unique infographic order ID number 52 (Sample only)
order_type String No Specify if the order is Test or Official. Available values : test-order, official-order
Default value : test-order

Example request

curl -X GET "https://easel.ly/orders/approveOrder?order_id=52" -H "accept: application/json"
-H "apiKey: mqcM1mdeDMx3M22QCf3423MX7BXYUbsNcn9DzWFV9Tz", "order_id: 52"

Example response

Response headers

{
    access-control-allow-origin: *          
    connection: keep-alive          
    content-type: application/json          
    date: Wed, 10 Feb 2021 10:04:26 GMT          
    server: nginx/1.16.0          
    transfer-encoding: chunked          
    x-powered-by: PHP/7.0.33
}

Response body

{
    "order_id": 52,
    "order_status": "complete",
    "infographic_title": "Top 10 Tech Trends 2021",
    "partner_email": "hello@design.com",
    "version": 2,
    "pdf_url": "https://easel.ly/components/pdf_annotation/php/files/844459506Top-10-Tech-Trends-2021.pdf",
    "image_url": "https://easel.ly/components/image_annotation/php/files/1751590875Top-10-Tech-Trends-2021.png",
    "design_url": "https://easel.ly/infographicdesign/design/r7X9SfYD9ebozTyGpLAJ26BGouKHZiGmTdm"
}

Response Code: 200


If an order is not on “review” status, the response will be:

Response body

{
    "success": false,
    "errorCode": 400,
    "message": "Cannot approve order if status is not review."
}

Response Code: 400


Easel.ly © Copyright 2021