Colors

GET {domain}/colors
Get a list of colors
id

Color identifier
code

Color code
description

Color description
hex

Hex code of the color

 
{
    "colors": [
        {
            "id": 2,
            "code": "Arctic Blue",
            "description": null,
            "hex": "#5ea3b3"
        },
        {
            "id": 3,
            "code": "Army Green",
            "description": null,
            "hex": "#4b5320"
        }
    ]
}
GET {domain}/colors/2
Get color by identifier
id

Color identifier
code

Color code
description

Color description
hex

Hex code of the color

 
{
    "color": {
        "id": 2,
        "code": "Arctic Blue",
        "description": null,
        "hex": "#5ea3b3"
    }
}

Sizes

GET {domain}/sizes
Get a list of sizes
id

Size identifier
code

Size code
description

Size description

 
{
    "sizes": [
        {
            "id": 5,
            "code": "X-Large",
            "description": null
        },
        {
            "id": 6,
            "code": "2XL",
            "description": null
        }
    ]
}
GET {domain}/sizes/5
Get size by identifier
id

Size identifier
code

Size code
description

Size description

 
{
    "size": {
        "id": 5,
        "code": "X-Large",
        "description": null
    }
}

Print areas

GET {domain}/printareas
Get a list of print areas
id

Print area identifier
code

Print area code
description

Print area description
width

Print area width
height

Print area height

 
{
    "print_areas": [
        {
            "id": 1,
            "code": "Front",
            "description": null,
            "width": 4200,
            "height": 4800
        },
        {
            "id": 2,
            "code": "Back",
            "description": "ss",
            "width": 4200,
            "height": 4800
        }
    ]
}
GET {domain}/printareas/1
Get print area by identifier
id

Print area identifier
code

Print area code
description

Print area description
width

Print area width
height

Print area height

 
{
    "print_area": {
        "id": 1,
        "code": "Front",
        "description": null,
        "width": 4200,
        "height": 4800
    }
}

Base SKUs

GET {domain}/baseskus
Get a list of base SKUs
id

Base SKU identifier
code

Base SKU code
title

Base SKU title
description

Base SKU description
enabled

Is sase SKU enabled

 
{
    "base_skus": [
        {
            "id": 2,
            "code": "AS_3001",
            "title": "AS Colour - Wee Tee (Ribbed, not in use)",
            "description": "AS Colour - Wee Tee (Ribbed, not in use)",
            "enabled": false
        },
        {
            "id": 3,
            "code": "AS_3003",
            "title": "AS Colour - Mini Me - Baby Onesie",
            "description": "AS Colour - Mini Me - Baby Onesie",
            "enabled": false
        }
    ]
}
GET {domain}/baseskus/2
Get base SKU by identifier
id

Base SKU identifier
code

Base SKU code
title

Base SKU title
description

Base SKU description
enabled

Is sase SKU enabled

 
{
    "base_sku": {
        "id": 2,
        "code": "AS_3001",
        "title": "AS Colour - Wee Tee (Ribbed, not in use)",
        "description": "AS Colour - Wee Tee (Ribbed, not in use)",
        "enabled": false
    }
}

Orders

POST {domain}/orders
Add order
order_reference

Order reference number
email

Email
requested_shipping

Requested shipping method
billing_address
first_name

First name
last_name

Last name
company_name

Company name
address1

Address 1
address2

Address 2
phone

Phone number
city

City
state

State
country

Country
postcode

Post code
shipping_address
first_name

First name
last_name

Last name
company_name

Company name
address1

Address 1
address2

Address 2
phone

Phone number
city

City
state

State
country

Country
postcode

Post code
line_items
size

Size code
colour

Color code
base_sku

Base SKU code
quantity

Quantity
prints
print_area

Print area code
print_image_url

URL of the print image
mockup_image_url

URL of the mockup image

 
{
    "order_reference": "#1001",
    "email": "jane@example.com",
    "requested_shipping": "express",
    "billing_address": {
        "first_name": "John",
        "last_name": "Smith",
        "company_name": "Ogo Pty Ltd",
        "address1": "Unit 1",
        "address2": "123 Fake Street",
        "phone": "(03) 9999-9999",
        "city": "Ferntree Gully",
        "state": "Victoria",
        "country": "Australia",
        "postcode": "3156"
    },
    "shipping_address": {
        "first_name": "Jane",
        "last_name": "Smith",
        "company_name": "Ogo Pty Ltd",
        "address1": "123 Fake Street",
        "address2": "123 Fake Street",
        "phone": "777-777-7777",
        "city": "Ferntree Gully",
        "state": "Victoria",
        "country": "Australia",
        "postcode": "3156"
    },
    "line_items": [
        {
            "size": "Extra Small",
            "colour": "Red",
            "base_sku": "AS_5001",
            "quantity": 1,
            "prints": [
                {
                    "print_area": "Front",
                    "print_image_url": "http://example.com/print.png",
                    "mockup_image_url": "http://example.com/mockup.png"
                },
                {
                    "print_area": "Back",
                    "print_image_url": "http://example.com/backprint.png",
                    "mockup_image_url": "http://example.com/backmockup.png"
                }
            ]
        }
    ]
}
                                
{
    "id": 1003
}
GET {domain}/orders/1
Get order by identifier
id

Order identifier
user_id

User who added the order
order_reference

Order reference number
email

Email
requested_shipping

Requested shipping method
created_at

Create time
updated_at

Last update time
billing_address
first_name

First name
last_name

Last name
company_name

Company name
address1

Address 1
address2

Address 2
phone

Phone number
city

City
state

State
country

Country
postcode

Post code
shipping_address
first_name

First name
last_name

Last name
company_name

Company name
address1

Address 1
address2

Address 2
phone

Phone number
city

City
state

State
country

Country
postcode

Post code
line_items
id

Line item identifier
size

Size code
colour

Color code
base_sku

Base SKU code
quantity

Quantity
prints
print_area

Print area code
print_image_url

URL of the print image
mockup_image_url

URL of the mockup image

 
{
    "order": {
        "id": 1,
        "user_id": "61c88d4e-3135-4c0b-98c9-ccc718bf4ee8",
        "order_reference": "#1001",
        "email": "jane@example.com",
        "requested_shipping": "express",
        "created_at": "2017-08-05T12:12:35.083",
        "updated_at": "2017-08-05T12:12:35.083",
        "billing_address": {
            "first_name": "John",
            "last_name": "Smith",
            "company_name": "Ogo Pty Ltd",
            "address1": "Unit 1",
            "address2": "123 Fake Street",
            "phone": "(03) 9999-9999",
            "city": "Ferntree Gully",
            "state": "Victoria",
            "country": "Australia",
            "postcode": "3156"
        },
        "shipping_address": {
            "first_name": "Jane",
            "last_name": "Smith",
            "company_name": "Ogo Pty Ltd",
            "address1": "123 Fake Street",
            "address2": "123 Fake Street",
            "phone": "777-777-7777",
            "city": "Ferntree Gully",
            "state": "Victoria",
            "country": "Australia",
            "postcode": "3156"
        },
        "line_items": [
            {
                "id": 1,
                "size": "Extra Small",
                "colour": "Red",
                "base_sku": "AS_5001",
                "quantity": 1,
                "prints": [
                    {
                        "print_area": "Front",
                        "print_image_url": "http://example.com/print.png",
                        "mockup_image_url": "http://example.com/mockup.png"
                    },
                    {
                        "print_area": "Back",
                        "print_image_url": "http://example.com/backprint.png",
                        "mockup_image_url": "http://example.com/backmockup.png"
                    }
                ]
            }
        ]
    }
}