DESIGN API Introduction

Designs are end products sold to customers and are created by specifying a single product and a set of artwork or subscriptions.

For example, Bella Canvas 3001 is a product, and your design would be adding a print and a private label to that product, for the purpose of selling it to end customers.

Overview

This API allows you to send a design to Apliiq.

POST https://api.apliiq.com/v1/Design

Authorization Header: x-apliiq-auth  RTS:SIG:APPID:STATE   

Accept application/json

Request Statuses

200 - OK - product created 

400 - Bad request 

401 - Unauthorized

Request Fields

ProductId	Optional	The Id of the product to create design from
ProductCode	required	Product code associated with product
Name	Optional	Product name
Description	Optional	Product description
ColorId	required	Product color
MockupTemplateId	optional	Saved design Id - Use this saved design placement to generate mock up image
Locations	optional	Product views -  front, back, left, right, details, etc..
Locations.Id	Optional *	* required only if ImagePath is specified
Locations.ImagePath	Optional *	Mock image url that represents the finished product.  * required only if artwork is specified *https url for download Ideal image dimension 944 x 1440
Locations.Artworks	Optional	Contain a list of artworks for a given product view
Locations.Artworks.BoxId	Optional*	* required if mock-up template Id is provided and mock-up view has more than 1 artworks in different design locations
Locations.Artworks.Service	Optional	Available values :  print, applique, dtgprint, sublimation, embroidery, transfer_print depending on product selected and service available for that product. Description: print - screen printing dtgprint - digital printing sublimation - custom fabric print such as pocket, kangaroo pocket, hood liner embroidery - embroidery Transfer_print - heat transfer print
Locations.Artworks.PrintColors	Optional	Must provide HexCodeColor if Service = print or Service =  embroidery - max color = 6
Locations.Artworks.Note	Optional	Specific notes about the artwork for the production team
Locations.Artworks.Id	Optional	Apliiq Artwork Id
Subscriptions	Optional	A list of subscriptions to use in making the product
Subscriptions.Placement.Id	Optional *	* required if Name is provided
Subscriptions.Placement.Name	Optional *	* required if Id is provided
Subscriptions.Label.Id	Optional *	* required only if placement is provided

Request Payload Example

{

    "ProductCode": "mens_Comfort-Colors-Heavyweight-T-Shirt",

    "ColorId": 521,

    "MockupTemplateId": 3455677, /* this is the saved design you want to use placement from**/

    "Locations": [

        {

            "Artworks": [

                {

                    "Service": "dtgprint",

                    "Note": "created through api",

                    "Id": 3699695

                }

            ],

            "Id": 4587,

            "ImagePath": "https://cloud-image.com/test/dfhebns.jpg",

            "BoxId": 1

        }

    ],

    "Subscriptions": [

        {

            "Placement": {

                "Id": 1012,

                "Name": "outside neck"

            },

            "Label": {

                "Id": 2921386

            },

            "Id": 0

        }

    ],

    "Name": "coolest comfort color shirt",

    "Description": "the coolest shirt you will ever own"

}

Response Example

{

    "ProductId": 409,

    "ProductCode": "mens_Comfort-Colors-Heavyweight-T-Shirt",

    "ColorId": 521,

    "MockupTemplateId": 3455677,

    "Locations": [

        {

            "Artworks": [

                {

                    "Service": "dtgprint",

                    "Note": "created through api",

                    "Id": 3699695

                }

            ],

            "Id": 4587,

            "ImagePath": "//blob.apliiq.com/sitestorage/_debug/Overrides/ProductImage/3110428_45872023-07-31-23-32-51Z2170782_4537_577_880.jpg"

        }

    ],

    "Subscriptions": [

        {

            "Placement": {

                "Id": 1012,

                "Name": "outside neck"

            },

            "Label": {

                "Id": 2921386

            },

            "Id": 0

        }

    ],

    "Variants": [

        {

            "SKU": "APQ-3110428S6A1",

            "Id": 0,

            "Name": "s"

        },

        {

            "SKU": "APQ-3110428S7A1",

            "Id": 0,

            "Name": "m"

        },

        {

            "SKU": "APQ-3110428S8A1",

            "Id": 0,

            "Name": "l"

        },

        {

            "SKU": "APQ-3110428S1A1",

            "Id": 0,

            "Name": "xl"

        },

        {

            "SKU": "APQ-3110428S2A1",

            "Id": 0,

            "Name": "xxl"

        },

        {

            "SKU": "APQ-3110428S21A1",

            "Id": 0,

            "Name": "xxxl"

        }

    ],

    "Id": 3110428,

    "Name": "designAPI_WithMockandArtworkandWLSubscription"

}

Error Codes

• DesignCreated

• DesignCreated_MockImageUploadFailed - possible reasons include bad url format such as missing protocol, including query parameters.

• DesignCreate_Failed

• ProductNotFound - invalid product id or non existence product id

• NotSupported_Color - Color id is not available for given product

• NotSupported_Service - Service id is not available for given product

• NotSupported_ServiceColor - Selected hex color is not available for selected service (embroidery or Screen)

• NotSupported_Location - specified location id is not available for given product

• NotSupported_Subscription - subscription is not found or not available for given product

• NotSupported_SubscriptionPlacement - subscription found but specified placement option is not available for given subscription

• Missing_ProductCode - missing product code in the request

• Missing_ProductId - missing product id in the request

• Missing_ColorId - missing product color id in the request

• Missing_ColorForSelectedService - only when service is embroidery or screen and no color is specified in the request

• Missing_MockUrl - missing image url for location - only when artwork is specified

• Missing_ArtworkId - missing artwork id in request - only when service is specified

• Missing_SubscriptionSavedDesignId - missing subscription saved design id

• Missing_Placement - missing subscription placement

• Data_MaxServiceColorsSelected - too many colors selected for service embroidery or screen - max 6 colors

• Data_DuplicateArtworkIdUsed - when same artwork id provided more than once in a request - reuse artwork is encourage but not within same request

• Data_DuplicateSubscriptionIdUsed -

• Data_MaxPrivateLabelSubscription - only 1 private label subscription can be used in each request

• Data_ProductCodeNotMatchWithProductId - product code and product id do not match

• Data_MaxFileSize - maximum file size of 6MB.

• SetupIssue_PlacementConfig - no placement found on a given subscription - contact customer service.