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.

 

Revise order

HTTP Request:

POST /orders/:order_id/revise

Submit a revision request for a specific order when it is in "reviewing" status

 

Query Parameters:

Name Type Description

instructions

json
required

The revision instructions are image-bound. For each edited image, a unique image ID is set and can be retrieved via the /orders/:order_id API. You must specify the image ID as the key and revison instructions as the value.

example:

Assuming syd3ue2 and xbsh9sk are the IDs for 2 example edited images
{
   "syd3ue2":"slim waist more; tan skin more",
   "xbsh9sk":"make eyes bigger"
}

Example successful response:


{
    "errors": [],
    "data": {
      "order_id": "UVWXYZ123",
      "project_name": "John's wedding",
      "customer_id": 1234,
      "price": 3,
      "status": "revising",
      "revision": 2,
      "ordered_at": "2017-12-02T16:00:00+04:00",
      "revision_requested_at": "2017-12-03T16:00:00+04:00",
      "estimated_delivery": "2017-12-05T12:00:00+04:00"
    }
}

Example error response:


{
    "errors": [
      "invalid order status",
      "image ID not found: sh38nsk"
    ]
}

 

Next: Approve order