Version: 1.0.1

Get started

    API Route:

        https://api.teeallover.com/t/Tee/v1/{YourAccCode}/

To use this API, you need an API key. Please login TeeAllover. Then Goto Menu > Edit Account > Settings to get your own API key Account Setting

Authentication

Authorization Type: Basic Auth

Basic base64_encode(AAA:xxxxxxx)

    
# Authen
curl -X GET -H "Authorization: Basic " "https://api.teeallover.com/t/Tee/v1/{YourAccName}/Store"

GET TeeAllover available products.

    
# Get Stores 
curl \
-X GET https://api.teeallover.com/t/Tee/v1/Products/ \

To get products of TeeAllover you need to make a GET call to the following url :
https://api.teeallover.com/t/Tee/v1/Products 



#response
{
    "product_code": {
        "product": "Batwing Pocket Dress-2D",
        "thumb": "webp/267199_300x999.webp",
        "sizeChart": "webp/269197_900x9999.webp",
        "options": [
            {
                "name": "size",
                "values": {
                    "S": "S",
                    "M": "M",
                    "L": "L",
                    "XL": "XL",
                    "2XL": "2XL",
                    "3XL": "3XL",
                    "4XL": "4XL",
                    "5XL": "5XL"
                }
            },
            {
                "name": "type",
                "values": {
                    "Green": "Green",
                    "Black": "Black",
                    "Red": "Red",
                    "Pink": "Pink",
                    "Grey": "Grey",
                    "Blue": "Blue"
                }
            }
        ]
    }
}

GET Stores

    
# Get Stores 
curl \
-X GET https://api.teeallover.com/t/Tee/v1/{YourAccName}/Store/ \

To get stores of your account you need to make a GET call to the following url :
https://api.teeallover.com/t/Tee/v1/{YourAccName}/Store 



    # Result example :
    {
        "stores": [
            {
                "store_name": "ABC1",
                "store_url": "https://storeurl.com",
                "platform": "api",
                "status": "active"
            }
        ],
        "tier": "Standard"
    }

Create new Store

To Create new store you need to make a POST call to the following url :
https://api.teeallover.com/t/Tee/v1/{YourAccCode}/Store 

        
# Create Store 
curl \
-X GET https://api.teeallover.com/t/Tee/v1/{YourAccName}/Store/ \
-H 'Content-Type: application/json'
-d '{"store_url": "https://example.com"}'
        
    
        
# Reponse :
{
    {
        "store": "ABC1"
    }
}

QUERY PARAMETERS

Field Type Description
store_url String Your store url

Create Order

To creat new Order you need to make a POST call to the following url :
https://api.teeallover.com/t/Tee/v1/{YourAccCode}/Order 

        
# Create Order 
curl \
-X POST https://api.teeallover.com/t/Tee/v1/{YourAccCode}/Order/ \
-H 'Content-Type: application/json'
-d '
{
    "store_name": "ABC1",
    "order_id": 234234234,
    "order_name": "364731",
    "email": "customer@gmail.com",
    "phone": "23423545434",
    "financial_status": "Paid",
    "created_at": "2022-03-22 04:50:01",
    "line_items": [
        {
            "item_id": 388412,
            "sku": "ABC-1172-TBD-M-234234",
            "title": "1 Box Moon Stars Nail Art Rivets Stud Multi Mental Decals diy Tips Manicure Charms UV Gel 3D Nail Decorations Perfect Nailart - DR416",
            "quantity": "1",
            "item_status": "hold",
            "map_product": {
                "product_code": "LMS",
                "option1": "m",
                "option2": "",
                "files": {
                    "front_mockup": "http://example/image.png",
                    "front_design": "https://example/image.png",
                    "back_mockup": "https://example/image.png",
                    "back_design": "https://example/image.png",
                    "extra_mockup_1": "https://example/image.png"
                }
            }
        },
        {
            "item_id": 388413,
            "sku": "12324324234234",
            "title": "Product Title - S",
            "quantity": "3",
            "item_status": "order"
        }
    ],
    "shipping_address": {
        "first_name": "John",
        "last_name": "Doe",
        "address1": "32423423",
        "address2": "",
        "city": "23423423423",
        "province": "CA",
        "country": "US",
        "zip": "10000"
    }
}
        
# Reponse :
{
    "success": true,
    "msg": [],
    "order": {
        "store_name": "ABC1",
        "order_name": "364731",
        "check_status": "Ready",
        "line_items": [
            {
                "id": "A-67f14c1edc951",
                "sku": "ABC-A10040846052861-LMS-M",
                "quantity": "1",
                "base_cost": "17.45",
                "design_status": "processing",
                "item_status": null,
                "shipping_fee": "",
                "item_total": "17.45"
            },
            {
                "item_id": "388413",
                "sku": "",
                "quantity": "1",
                "check_status": "Pending"
            }
        ],
	"order_total": "17.45"
    },
    "warning": []
}

QUERY PARAMETERS

Field Type Required Description Limit Length
store_name String Required a store of your account. Ex: ABC1
order_name String Required Order Name 20
email String 50
phone String 50
financial_status string Paid, Processing, Authorized, Completed
Other mark as Pending 		20
created_at string datetime: Y-m-d H:i:s 20
line_items array Required
line_items Required Order must contain line_Items
shipping_address Required Order must contain Shipping Address

Line_Item PARAMETERS

Field Type Required Description Limit Length
item_id String Required 20
sku String A valid Tee sku contain info for Production
Ex: ABC1-DesignNumber-Product-Options 		50
quantity Int Required Must greater than 0
item_status String Valid values: 'order', 'hold', 'trash'.
Default: 'order'
map_product If exist must contain product & files for Production.
product_code string Required Any Product Code available from TeeAllover
option1 string Required product option 1
option2 string Required Empty if product doesn't has option2
files object Required Files For Production
front_mockup String Required Front Mockup Image Url
front_design String Required Front Design Image Url
back_mockup String Required Back Mockup Image Url
back_design String Required Back Design Image Url
extra_mockup_1 String Extra Mockup
extra_designs object Special Printzone or Other Positions follow each Product as below

Get Map Product example Or available Positions ( extra postion )

https://api.teeallover.com/t/Tee/v1/MapFiles/?product=$product_code
example: https://api.teeallover.com/t/Tee/v1/MapFiles/?product=lhd2;

Shipping PARAMETERS

TikTok Label Information

For TikTok Label, please use the following format:

  • address1: Label URL (required)
  • address2: Tracking Number (required)
  • Other fields: Fill with "***"
Field Type Required Description Limit Length
first_name String 50
last_name String Required first_name OR last_name must contain string 50
address1 String Required
address2 String Required
city string Required
province string Required
province_code string
country string Required
country_code string
zip string Required

Get Order

To Get Order you need to make a GET call to the following url:
https://api.teeallover.com/t/Tee/v1/{YourAccCode}/Order 

        
# Get Order 
curl \
-X GET https://api.teeallover.com/t/Tee/v1/{YourAccCode}/Order/?store_name=ABC1&order_name=12345 \'


#response 
{
    "order": {
        "store_name": "ABC1",
        "order_name": "364731",
        "financial_status": "pending",
        "created_at": "2022-03-22 04:50:01",
        "imported_at": "2022-04-10 08:46:05",
        "email": "test@sljfl.com",
        "phone": "23423545434",
        "shipping_address": {
            "phone": "23423545434",
            "first_name": "change first",
            "last_name": "Doe",
            "address1": "32423423",
            "address2": "",
            "province": "CA",
            "country": "US",
            "zip": "10000"
        },
        "line_items": [
            {
                "item_id": "388412",
                "title": "1 Box Moon Stars Nail Art Rivets Stud Multi Mental Decals diy Tips Manicure Charms UV Gel 3D Nail Decorations Perfect Nailart - DR416",
                "sku": "ABC1-A10041526242967-LMS-M",
                "quantity": "10",
                "campaign_status": "uploaded",
                "invoice_date": null
            },
            {
                "item_id": "388413",
                "title": "0.28 Inch DC LED Digital Voltmeter Voltage Meter Auto Car Mobile Power Voltage Tester Detector 12V Red Green Blue Yellow QDH - DC 2.5-30V Blue",
                "sku": "",
                "quantity": "1",
                "campaign_status": "missing",
                "invoice_date": null
            }
        ]
    }
}

PARAMETERS

Field Type Required Description
store_name string Required Store Code
order_name string Required Order Name

Update Order Info

To Update Order you need to make a PUT call to the following url:
https://api.teeallover.com/t/Tee/v1/{YourAccCode}/Order/Info 

        
# Update Order
curl \
-X PUT https://api.teeallover.com/t/Tee/v1/{YourAccCode}/Order/Info/ \
-H 'Content-Type: application/json'
-d '{
    {
        "store_name": "ABC1",
        "order_name": "364731",
        "update": {
            "email": "test@sljfl.com",
            "first_name": "change first name"
        }
    }
  }'
  

#response 
{
    "code": 200,
    "updated": {
        "first_name": "change first",
        "email": "test@sljfl.com"
    }
}

Query PARAMETERS

Field Type Required Description
store_name string Required Store Code
order_name string Required Order Name

Update PARAMETERS

Field Type
email string
phone string
financial_status string
first_name string
last_name string
address1 string
address2 string
city string
province string
country string
zip string

Update Order LineItem

To Update Order you need to make a PUT call to the following url:
https://api.teeallover.com/t/Tee/v1/{YourAccCode}/Order/Item 

        
# Update Order Item 
curl \
-X PUT https://api.teeallover.com/t/Tee/v1/{YourAccCode}/Order/Item/ \
-H 'Content-Type: application/json'
-d '{
    {
        "store_name": "ABC1",
        "order_name": "364731",
        "item_id": "",
        "update": {
            "quantity": 10,
            "item_status": "order",
        }
    }
  }'

#response
{
    "code": 200,
    "updated": {
        "quantity": 10,
        "item_status": "order"
    }
}

Query PARAMETERS

Field Type Required Description
store_name string Required
order_name string Required
item_id string Required

Update PARAMETERS

Field Type
quantity string
sku string
title string
item_status string
map_product Object example: same as post a order.

Get Order's Tracking Numbers

To Get Order Tracking you need to make a GET call to the following url:
https://api.teeallover.com/t/Tee/v1/{YourAccCode}/Tracking 

        
# Get Order's Tracking Numbers
curl \
-X GET https://api.teeallover.com/t/Tee/v1/{YourAccCode}/Tracking/?store_name=ABC1&order_name=1001 \'

#response
{
    "trackings": [
        "Number123456"
    ],
    "detail": {
        "Number123456": {
            "tracking_number": "Number123456",
            "tracking_url": "https://t.17track.net/en#nums=Number123456",
            "line_items": [
                {
                    "id": "388412",
                    "sku": "ABC1-A10040846052861-LMS-M",
                    "quantity": "1",
                    "tracking": "Number123456",
                    "url": "https://t.17track.net/en#nums=Number123456"
                }
            ]
        }
    }
}

PARAMETERS

Field Type Required Description
store_name string Required Store Code
order_name string Required Order Name

Get Webhooks

To Get Webhooks you need to make a GET call to the following url:
https://api.teeallover.com/t/Tee/v1/{YourAccCode}/webhooks 

        
# Get Webhooks
curl \
-X GET https://api.teeallover.com/t/Tee/v1/{YourAccCode}/webhooks \'

#response
{
    "webhooks": [
        {
            "id": 1,
            "url": "https://example.com/webhook",
            "topic": "tracking_updated",
            "created_at": "2022-03-22 04:50:01"
        }
    ]
}



    # exmple traking data
    {
        "store_name": "MPO17",
        "order_name": "576733954269220930",
        "trackings": {
          "94055091060297349124601": {
            "tracking_number": "94055091060297349124601",
            "tracking_url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=94055091060297349124601",
            "line_items": [
              {
                "id": "576733954269352002",
                "sku": "MPO-1269-TXU-RED-XL",
                "quantity": "2",
                "custom_sku": "1729559027793302261",
                "tracking": "94055091060297349124601",
                "url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=94055091060297349124601"
              }
            ]
          },
          "9405509106029734912460": {
            "tracking_number": "9405509106029734912460",
            "tracking_url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9405509106029734912460",
            "line_items": [
              {
                "id": "576733954269483074",
                "sku": "MPO-1269-TXU-GREY-2XL",
                "quantity": "3",
                "custom_sku": "1729559027793367797",
                "tracking": "9405509106029734912460",
                "url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9405509106029734912460"
              }
            ]
          }
        }
      }

Create Webhooks

To Create Webhooks you need to make a POST call to the following url:
https://api.teeallover.com/t/Tee/v1/{YourAccCode}/webhook 


        
# Create Webhooks
curl \
-X POST https://api.teeallover.com/t/Tee/v1/{YourAccCode}/webhook/ \
-H 'Content-Type: application/json'
-d '{
    "url": "https://example.com/webhook",
    "topic": "tracking_updated"
}'


#response
{
    "id": 1234,
    "url": "https://example.com/webhook",
    "topic": "tracking_updated",
    "created_at": "2022-03-22 04:50:01"
}

QUERY PARAMETERS

Field Type Required Description
url string Required Webhook URL
topic string Required Valid values: 'tracking_updated', 'invoice_error'

Update Webhooks

To Update Webhooks you need to make a PUT call to the following url:
https://api.teeallover.com/t/Tee/v1/{YourAccCode}/webhook 


        
# Update Webhooks
curl \
-X PUT https://api.teeallover.com/t/Tee/v1/{YourAccCode}/webhook/ \
-H 'Content-Type: application/json'
-d '{
    "id": 1234,
    "url": "https://new-example.com/webhook",
}'


#response
{
    "id": 1234,
    "url": "https://new-example.com/webhook",
    "topic": "tracking_updated",
    "created_at": "2022-03-22 04:50:01"
}

QUERY PARAMETERS

Field Type Required Description
id string Required Webhook ID
url string Required Webhook URL

Delete Webhooks

To Delete Webhooks you need to make a DELETE call to the following url:
https://api.teeallover.com/t/Tee/v1/{YourAccCode}/webhook 


        
# Delete Webhooks
curl \
-X DELETE https://api.teeallover.com/t/Tee/v1/{YourAccCode}/webhook/ \
-H 'Content-Type: application/json'
-d '{
    "id": 1234
}'


#response
{
    "id": 1234,
}

QUERY PARAMETERS

Field Type Required Description
id string Required Webhook ID

Errors

The TeeAllover API uses the following error codes:

Error Code Meaning
101 Permision Deny.
400 Bad Request.
401 Unauthorized
404 Not Found.