LOGO
LOGO
 

API Documentation

Current Version: 2.0

This API allows you to create and manage your orders with Tucia in a simple, programmatic way using conventional HTTP requests. The endpoints are intuitive and powerful, allowing you to easily make calls to retrieve information or to execute actions.

With this API, you are able to add Tucia's human-powered photo editing functionality to any application. This is especially useful for resellers who have their own websites or apps, and outsource the real editing service to Tucia.

 

List orders

HTTP Request:

GET /orders

Retrieves a list of your orders, ordered by create time descending.

 

Query Parameters:

Name Type Description

filter_status

string
optional

Filter orders by order status. Default value: all

Can be one of: all editing revising paused reviewing closed

example:

revising

filter_customer_id

string
optional

Filter orders by your own customer id.

example:

1234

filter_keywords

json
optional

Filter orders by 1 or more keywords.

Each keyword should be in string type with minimum length of 6 characters

example:

["wedding","portrait"]

page

integer
optional

For pagination. Default: 1

example:

5

Example successful response:


{
    "errors": [],
    "per_page": 20,
    "current_page": 5,
    "total_pages": 27,
    "total_results": 538,
    "filter_status": "all",
    "filter_keywords": "",
    "filter_customer_id": "",
    "sort_by": "ordered_at",
    "data": [
       {
          "order_id": "UVWXYZ123",
          "project_name": "John's wedding",
          "customer_id": 1234,
          "price": 3,
          "status": "editing",
          "revision": 0,
          "ordered_at": "2017-12-02T16:00:00+04:00"
       },
       {
          "order_id": "UVWXYZ456",
          "project_name": "Chloe's portrait",
          "customer_id": 4567,
          "price": 1,
          "status": "revising",
          "revision": 1,
          "ordered_at": "2017-12-02T16:00:00+04:00"
       }
       ... ...
    ]
}

 

Next: Fetch order