Apliiq Artwork API: Integration Guide & Key Features

Artwork API

Artwork API

Introduction

Upload an artwork

Overview

This API allows you to send a file to Apliiq, which will be used to create your finished designs.


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

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

Name

required

Artwork name

ImagePath

required

Image URL - url must be https://




Request Payload Example

{

  "Name": "artwork 1",

  "ImagePath": "https://cloud-image.com/test/artwork1.png"

}


Response Example

{

  "WtoHRatio": 0.87,

  "DateCreated": "2023-08-03T04:54:15.0391237Z",

  "Id": 5623808,

  "Name": "flower api artwork"

}



Error Codes

  • Success

  • MissingName

  • Max50CharName - Name cannot exceed 50 characters

  • MissingImageURL

  • InvalidImageURL - 

  • base64UnSupported

  • Max12MBFile

  • SaveIncomplete - issue uploading the artwork -

  • ExceptionCaught - additional message 


    • Related Articles

    • Get Order Endpoints

      Get Order Use the Get Order endpoint get a list of your Apliiq orders or the details of a specific order. Get List Of Orders Provide a month or year filter to retrieve a list of orders from the specified time period. GET ...

    • How to generate product mockups via Apliiq API with mock up templates

      Product mockups are helpful in setting good customer expectations when selling made to order products online. The Apliiq API can help you generate mockups for your custom or personalized products that you are sending to Apliiq via the createDesign. ...

    • Product API

      Product API Introduction Get a list of products or a single product available in Apliiq. Products are the garments and accessories that are available to customize on the Apliiq website. Overview This API endpoints allow you to get the list of ...

    • Artwork Requirements - Your Responsibilities

      In making custom apparel, great results start with great artwork and well thought out designs. Specific requirements for each type of production service we offer can be found here. It is solely your responsibility to review, understand, and provide ...

    • Warehouse API Endpoints

      These endpoints are currently in development. This document outlines the Warehouse API for our application, providing details on endpoints, authentication, request formats, and response structures. It is intended for developers integrating with our ...