Get Order Endpoints

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  https://api.apliiq.com/v1/Order?yearOrlastNoMonth=

Parameter:

yearOrlastNoMonth 

optional

Default value = 1 (last 1 month)

If (value = year), the result returns top 500 in year


Request Example

 https://api.apliiq.com/v1/Order?yearOrlastNoMonth=2023 (get top 500 orders in year 2023)


Response Example

[

  {

    "OrderId": 436200,

    "OrderDate": "09/14/2023",

    "ExpectedDate": "09/29/2023",

    "DeliveryPromiseMsg": "estimated",

    "TotalQty": 1,

    "SN": [

      {

        "Helptext": "",

        "Carrier": "",

        "Service": "",

        "TrackingNumber": "",

        "Items": [

          {

            "SKU": "APQ-4259945S7A1",

            "Name": "Gildan - Cotton T-Shirt",

            "Quantity": 1

          }

        ]

      }

    ],

    "StoreName": "your-storename",

    "StoreOrderId": "903",

    "StoreSystemOrderId": "2p2TJmGoviKHy",

    "Status": "Preparing to release",

    "AwaitingGarment": true,

    "AwaitingArtwork": true,

    "AwaitingSupplies": false,

    "CanChangeShipAddress": false

  },

  {

    "OrderId": 431954,

    "OrderDate": "08/30/2023",

    "ExpectedDate": "09/14/2023",

    "DeliveryPromiseMsg": "estimated",

    "TotalQty": 1,

    "SN": [

      {       

        "Helptext": "This order has been cancelled and your payment is refunded.",

        "Carrier": "",

        "Service": "",

        "TrackingNumber": "",

        "Items": [

          {

            "SKU": "APQ-3999473S7A1",

            "Name": "Embroidery - gold Comfort Colors Heavyweight T Shi",

            "Quantity": 1

          }

        ]

      }

    ],

    "StoreName": "store-name",

    "StoreOrderId": "1148",

    "StoreSystemOrderId": "5528514920535",

    "Status": "Cancelled",

    "AwaitingGarment": false,

    "AwaitingArtwork": false,

    "AwaitingSupplies": false,

    "CanChangeShipAddress": false

  }

]


Get Order Details

Provide an Apliiq order id to get the details of a specific order.


GET  https://api.apliiq.com/v1/Order/:OrderId

OrderId: Apliiq Order Id

Request Example

https://api.apliiq.com/v1/Order/426090

Response Example

[

  {

    "OrderId": 426090,

    "OrderDate": "08/11/2023",

    "ExpectedDate": "08/28/2023",

    "DeliveryPromiseMsg": "estimated",

    "TotalQty": 1,

    "SN": [

      {

         "Helptext": "your package shipped on 08/18/2023",

        "Carrier": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=",

        "Service": "USPS First Class Mail",

        "TrackingNumber": "9400111206215113456864",

          "Items": [

          {            

            "SKU": APQ-4157168S34A0",

            "Name": "custom Class Cord Cap",

            "Quantity": 1

          },

          {

             "SKU": "APQ-4159723S34A0",

            "Name": "Black Class Cord Cap",

            "Quantity": 1

          }

        ]

      }

    ],

    "StoreName": "your-store-name",

    "StoreOrderId": "your-friendly-store-orderid",

    "StoreSystemOrderId": "your-system-store-orderid",

    "Status": "Shipped",

     "AwaitingGarment": false,

    "AwaitingArtwork": false,

    "AwaitingSupplies": false,

    "CanChangeShipAddress": false

  }

]


Fields definition

OrderId

int

Apliiq OrderId

OrderDate

date

Order date

ExpectedDate

date

Expected arrival date

DeliveryPromiseMsg

string

Estimated OR guarantee depends on shipping selection

TotalQty

int

Total order quantity

SN

Array of ship notice if the order has shipped





>>Helptext

string

Order status in detail if any

>>Carrier

string

Carrier tracking URL

>>Service

string

Carrier service

>>TrackingNumber

string

Package tracking number(s)

>>Items

Array of items in a shipnotice


>>>>SKU

string

Item sku

>>>>Name

string

Name of the saved design

>>>>Quantity

string

Item quantity

StoreName

string

Store that this order was placed

StoreOrderId

string

Store friendly order id

StoreSystemOrderId

string

Store system order id

Status

string

In Production

Shipped

Canceled

Ready To Ship

New

Preparing to Release

Ready to Release

AwaitingGarment

boolean

When order in progress, is this order waiting on garment

AwaitingArtwork

boolean

When order in progress, is this order waiting on artwork 

AwaitingSupplies

boolean

When order in progress, is this order waiting on labels

CanChangeShipAddress

boolean





    • 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 Long Does It Take To Get My Order?

      As your dropshipping partner, we understand how important it is to get your customers your products as quickly as possible.  In fact, we have designed our entire production process with this in mind. Standard drop shipping orders are produced in ...

    • When Will My Campaign Orders Ship?

      Apliiq plans to discontinue support of its Campaigns feature in 2023.  In December of 2022, Apliiq.com will be updated so that no new campaigns can be started.  All active campaigns will still be supported.  When all campaigns are concluded, campaign ...

    • How Can I Cancel A Dropshipping Order?

      You are able to cancel a dropshipping order once it has been placed, if we haven’t started working on it yet. To cancel an order simply email cs@apliiq.com once you cancel your order we will refund your credit card. In cases that we have already ...

    • How To Manually Enter A Dropshipping Order

      Here are a few reasons why you may need to enter a dropshipping order As you are building your clothing line, you may find that from time to time you need to enter a dropshipping transaction manually. For example, maybe your friend saw you wearing a ...