Create Design (coming soon)

Create Design (coming soon)

DESIGN API

Introduction

Create a design

Overview

This API allows you to send a design to Apliiq.

Request Statuses

200 - OK - product created 

400 - Bad request 

401 - Unauthorized

Request Payload

{

  "ProductId": 384,

  "ColorId": 413,

  "Locations": [

    {

      "Artworks": [

        {

          "ServiceTypeId": 3,

          "PrintColors": null,

          "Note": "please center artwork",

          "Id": 1432867

        }

      ],

      "Id": 4537,

      "ImagePath": "https://blob.apliiq.com/sitestorage/resized-products/2170782_4537_577_880.jpg"

    }

  ],

  "Subscriptions": [

    {

      "PlacementId": 1012,

      "SavedDesign": {

        "Id": 1846537

      }

    }

  ],

  "Name": "Anvil camo - ",

  "Description": ""

}

 

Response

{

  "Id": 200012234,

  "ProductId": 384,

  "ColorId": 413,

  "Locations": [

    {

      "Artworks": [

        {

          "ServiceTypeId": 3,

          "PrintColors": null,

          "Note": "please center artwork",

          "Id": 1432867

        }

      ],

      "Id": 4537,

      "ImagePath": "https://blob.apliiq.com/sitestorage/resized-products/2170782_4537_577_880.jpg"

    }

  ],

  "Subscriptions": [

    {

      "PlacementId": 1012,

      "SavedDesign": {

        "Id": 1846537

      }

    }

  ],

  "Name": "Anvil camo - ",

  "Description": ""

}

 

 

Error Codes

DesignCreated_MockImageUploadFailed - possible reasons include bad url format such as missing protocol, include 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_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

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

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



    • Related Articles

    • How To Update A Saved Design

      Please note: If you have already placed an order, changes made to the saved design page will not update orders that are already being produced. It will only update new orders for that product. If you need to make changes on a current order, please ...
    • A Completely New Way To Create Custom Beanies

      Published on Feb 27, 2017 What makes the patch beanie better than just any other embroidered beanie? We are glad you asked. Patch beanies are super "user friendly" from a design standpont. Almost any artwork works and turns out great. Custom patch ...
    • How To Design Fashion Products With Profit In Mind

      Designing great products is indisputably one of the most purely creative experiences around and it's easy to get lost in the creative pursuit.  However, as the owner of your your fashion brand, it's important to ground your designs to ensure they are ...
    • This New Way To Design Custom Hoodies Is Crazy

      Published on Oct 31, 2016 Everyone knows how to make a printed hoodie and everyone has seen a printed hoodie before. Been there done that. The hood lining is a completely untapped opportunity to create custom hoodies. The prints come out super bright ...
    • How To Design And Style A Pocket Tee For Summer

      Published on May 6, 2016 Join sewing icon, sherpa, and savant KenAndrewDaily in his quest to create and style a pocket tee. Join us in downtown Los Angeles to see it all go down! create pocket tees