Warehouse API Endpoints

Warehouse API Endpoints

Notes
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 system.

1. Introduction

Our API allows external applications to programmatically interact with our warehouse services. This documentation will guide you through the process of making requests and understanding responses.

2. Authentication

All API requests require authentication. We use [HMAC, API Keys] for securing our endpoints.


  • [HMAC]: Please refer to our authentication document

3. Base URL

All API requests should be made to the following base URL:


https://api.apliiq.com/v1

4. Endpoints

The following table lists the available API endpoints and their functionalities.


Endpoint

Method

Description

Request Body (Example)

Response Body (Example)

/WarehouseItem?SavedDesignedId={saveddesignId}

GET

Retrieve a set of warehouse items by saved design id

N/A

[

  {

    "Id": 1487,

    "InventoryId": "PI 1487 10",

    "Name": "Tie Dye Eternity Adult Tee",

    "Description": "m / Tie Dye Cotton Candy",

    "Width": 0,

    "Length": 0,

    "Quantity": 0,

    "Type": "merchandise",

    "PackingType": "NA",

    "UsageRule": "one-per-merch",

    "IsActivated": true,

    "Weight": 16,

    "WeightUnit": "OUNCES",

    "HarmonizationCode": "6110202041",

    "CountryCodeOfOrigin": "US",

    "SKU": "APQ-3110146S7A1",

    "SaveDesignId": "3930290356307",

    "Position": 0

  },

  {

    "Id": 1488,

    "InventoryId": "PI 1488 11",

    "Name": "Tie Dye Eternity Adult Tee",

    "Description": "xxl / Tie Dye Cotton Candy",

    "Width": 0,

    "Length": 0,

    "Quantity": 0,

    "Type": "merchandise",

    "PackingType": "NA",

    "UsageRule": "one-per-merch",

    "IsActivated": true,

    "Weight": 19,

    "WeightUnit": "OUNCES",

    "HarmonizationCode": "6110202041",

    "CountryCodeOfOrigin": "US",

    "SKU": "APQ-3110146S2A1",

    "SaveDesignId": "3930290356307",

    "Position": 0

  }]

/WarehouseItem/?SKU={sku}

GET

Retrieve a specific warehouse item by SKU

N/A

[

  {

    "Id": 1487,

    "InventoryId": "PI 1487 10",

    "Name": "Tie Dye Eternity Adult Tee",

    "Description": "m / Tie Dye Cotton Candy",

    "Width": 0,

    "Length": 0,

    "Quantity": 0,

    "Type": "merchandise",

    "PackingType": "NA",

    "UsageRule": "one-per-merch",

    "IsActivated": true,

    "Weight": 16,

    "WeightUnit": "OUNCES",

    "HarmonizationCode": "6110202041",

    "CountryCodeOfOrigin": "US",

    "SKU": "APQ-3110146S7A1",

    "SaveDesignId": "3930290356307",

    "Position": 0

  }

]

/WarehouseItem/?WarehouseItemIds={comma separated Ids}

GET

Retrieve link to download all the barcode in single html file

NA

https://blob.apliiq.com/content/_release/barcodes/req-133957833515626598-a78da0d6-a8b2-4731-b42f-d81808f2c5dd-1581_itbc.html


/WarehouseItem/{id}

GET

Retrieve a specific warehouse item by Id

NA

[

  {

    "Id": 1487,

    "InventoryId": "PI 1487 10",

    "Name": "Tie Dye Eternity Adult Tee",

    "Description": "m / Tie Dye Cotton Candy",

    "Width": 0,

    "Length": 0,

    "Quantity": 0,

    "Type": "merchandise",

    "PackingType": "NA",

    "UsageRule": "one-per-merch",

    "IsActivated": true,

    "Weight": 16,

    "WeightUnit": "OUNCES",

    "HarmonizationCode": "6110202041",

    "CountryCodeOfOrigin": "US",

    "SKU": "APQ-3110146S7A1",

    "SaveDesignId": "3930290356307",

    "Position": 0,

    "BarcodeDownloadLink": "https://apliiqsc.blob.core.windows.net/content/_release/barcodes/req-133959035439881552-573ac0d1-07d2-4e73-a718-a0bfe4c5bc96-1487_itbc.html"


  }

]


/WarehouseItem

POST

Create a new warehouse item

{

  "Name": "Test WI XYZ 25-57-27 04:57:59",

  "Description": "Description of a XYZ Item",

  "Width": 0,

  "Length": 0,

  "Type": "merchandise",

"ImageURL":"https://blob.apliiq.com/sitestorage/_release/Overrides/ProductImage/5322789_0647be_113.webp",

  "UsageRule": "one-per-merch",

  "IsActivated": true,

  "Weight": 8,

  "WeightUnit": "OZ",

  "HarmonizationCode": "6109.10.00.12",

  "CountryCodeOfOrigin": "US",

  "SKU": "XYZ_M_BlueSky",

  "SaveDesignId": "9999999",

  "Position": 1

}

1501


/WarehouseItem/{id}

DELETE

Deleting a warehouse item

N/A


/WarehouseItem/{id}

PUT

Activate / Deactivate

{"IsActive": true}







/WarehouseShipment

POST

Create a shipment with items

{

  "Items": [

    {

      "Id": 1487,

      "Quantity": 1

    }

  ],

  "Factory": "Los Angeles",

  "Note": "this is a return item"

}


{

  "Id": 1320,

  "Items": [    {

      "Id": 1487,

      "Quantity_Received": 0,

      "InventoryId": "PI 1487 10",

      "Name": "Tie Dye Eternity Adult Tee",

      "Description": "m / Tie Dye Cotton Candy",

      "Quantity": 1,

      "Type": "merchandise",

      "IsActivated": true,

      "Weight": 0,

      "SKU": "APQ-3110146S7A1",

    }

  ],

  "Factory": "Los Angeles",

  "Note": "this is a return item",

  "Status": "",

  "BarcodeDownloadLink": "https://blob.apliiq.com/content/_debug/barcodes/req-133958879070940856-f2eea805-7913-416c-9cc0-c5a4fd39233a-1320_shipmentBarcodes.html",

  "Name": "SH 1320 018"

}



/WarehouseShipment/{id}

GET

Get shipment and its warehouse items

NA

{

  "Id": 1316,

  "Items": [

    {

    "Id": 1497,

      "Quantity_Received": 5,

      "InventoryId": "PI 1497 20",

      "Name": "Tultex Unisex T Shirt",

      "Description": "xs / Peach",

      "Width": 0,

      "Length": 0,

      "Quantity": 5,

      "Type": "merchandise",

      "IsActivated": true,

      "Weight": 0,

      "SKU": "APQ-4551796S5A0"

    }

  ],

  "Factory": "Los Angeles",

  "Status": "",

  "BarcodeDownloadLink": "https://blob.apliiq.com/content/_debug/barcodes/req-133958870160298787-331b88e6-49e4-451a-b83b-0f11e15005d7-1319_shipmentBarcodes.html

",

  "Name": "SH 1316 014"


}









 5.Warehouse Item Fields definition


Field


Description




Name

Required

Name of the warehouse item

Description

Required if Type = merchandise

Description of the warehouse item.  Required if a warehouse item is a merchandise.  Recommend describing the item size and color

Type

Required

Merchandise, pack-in, packaging

SKU

Required

Unique merchandise SKU to your store

PackingType

Required if Type = packaging

Possible values: Interior, Exterior

ImageURL

Required

Image path to where Apliiq can download the asset

UsageRule

Required

Type = merchandise, value is always “one-per-merch”


Type = pack-in, possible values: one-for-every-order

one-contains-these-products

one-for-every-product

One-each-these-products


Type = packaging & PackingType=Interior,

possible values:

one-for-every-product

One-each-these-products


when PackingType=Exterior

Value must always be one-for-every-order

IsActivated

optional

Default is true, specify false will have warehouse item disabled for order fulfillment

Width

Required if Type = packaging

Width describes in inches

Length

Required if Type = packaging

Length describes in inches

Weight

Required if Type = merchandise

Recommend using oz

WeightUnit

Required if Type = merchandise

Possible values are oz, lbs, kg, g

HarmonizationCode

optional

Recommend if item may be used to fulfill for International Orders

SaveDesignId

optional

Define a group for the warehouse item to be linked under.  

Position

optional




6. Data Validation Error Type

ItemIsEmty,

Missing_Type,

NoMatch_ItemType_PackIn_Packaging,

Missing_ItemName,

Duplicate_ItemName,

Missing_ItemDescription,

Missing_Weight,

Missing_Weight_Unit

Missing_UsageRule,

Invalid_UsageRule_PerItemType_PackingType,

Missing_SaveDesignIds,

Missing_ImagePath,

Unsupported_Base64Image,

Invalid_ImagePath,

PNG_JPG_WEBP_OnlyImage, 

SSLTLSConnIssue, 

UnableToGetImageSize,

Max3MBFile,

Missing_PackingType,

NoMatch_PackingType_ExteriorOrInterior,

Missing_ItemWidth,

Missing_ItemLength,

Missing_SKU,

ExceptionCaught



7. Request and Response Formats

All requests and responses use JSON format.


  • Request Headers:

    • Content-Type: application/json

    • Authorization: Refer to authentication document

  • Response Headers:

    • Content-Type: application/json

8. Error Handling

Our API uses standard HTTP status codes to indicate the success or failure of a request. In case of an error, the response body will contain an error object with details.


Status Code

Description

Error Response (Example)

200 OK

Request successful

N/A

201 Created

Resource successfully created

N/A

204 No Content

Request successful, no content to return

N/A

400 Bad Request

Invalid request payload or parameters

{ "error": "Invalid input data" }

401 Unauthorized

Authentication failed or missing

{ "error": "Authentication required" }

403 Forbidden

User does not have permission

{ "error": "Access denied" }

404 Not Found

Resource not found

{ "error": "Resource not found" }

500 Internal Server Error

An unexpected server error occurred

{ "error": "Something went wrong on our end" }

    • Related Articles

    • 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 ...

    • How Shipping Rates & Zones Work With Apliiq Warehouse

      Apliiq Warehouse orders do not use the same shipping profile as Apliiq Print On Demand orders. How you are charged for shipping your warehouse orders Apliiq Warehouse shipping rates are set based on where your products are being stored and where your ...

    • 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 warehouse & fulfill screen printed products

      If you are seeking the benefits of screen printing, but are looking for a fully managed service, you can combine Apliiq's screen printing and warehousing services to purchase products in bulk then fulfill screen print orders from your webstore. ...

    • 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 ...