Create Order - Apliiq API

Create Order

Introduction

Create an order

Overview

This API enable you to send order to Apliiq.

Authentication

using API Key and Shared_SECRET provided to create hmac signature authentication header

authorization schema x-apliiq-auth

header authorization value RTS:SIG:APPID:STATE

RTS - Request time stamp is calculated using UNIX time (number of seconds since Jan. 1st 1970)

SIG - Signature is calculated with following algorithm : base64_encode(HMACSHA265([APPId][RTS][STATE][Base64_ReqContentIFanyOREmptyString], Shared_SECRET))

APPID - app key

STATE - Random unique string (nonce)

* DO NOT INCLUDE YOUR SHARED SECRET IN ANY REQUESTS *

Error Codes

200 - OK - order processed

202 - Accepted - order received but not process due to reason in response message

401 - Unauthorized

Rate Limit

TBD

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

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

Accept application/json

Payload example

{

"id": 1324325406,

"number": 1006,

"name": "#1006",

"order_number": 1006,

"line_items": [

{

"id": "1511138222",

"title": "cotton heritage polly pocket",

"quantity": 1,

"price": "45.50",

"grams": 0,

"sku": "APQ-1998244S7A1",

"name": "cotton heritage polly pocket - M / denim"

}

],

"billing_address": {

"first_name": "john",

"address1": "1692 Avenue du Mont-Royal Est",

"phone": "2135558976",

"city": "los angeles",

"zip": "90013",

"province": "California",

"country": "United States",

"last_name": "smith",

"address2": "unit 142",

"name": "john smith",

"country_code": "US",

"province_code": "CA"

},

"shipping_address": {

"first_name": "john",

"address1": "1692 Avenue du Mont-Royal Est",

"phone": "2135558976",

"city": "los angeles",

"zip": "90013",

"province": "California",

"country": "United States",

"last_name": "smith",

"address2": "unit 142",

"name": "john smith",

"country_code": "US",

"province_code": "CA"

},

"shipping_lines": : [{

"code": "upgraded"

}]

}

RESPONSE EXAMPLE

{

"id": 567890

}

Fields

id	required	Store system order id - generally a system generated Id that is unique to the platform as a whole - Apliiq will use this id as part of the fulfillment
number	required	Store alternative order id
name	required	Order friendly name
order_number	required	Order friendly name - Apliiq use this
line_items	required	Array of line items
>>> id	required	Store system line item id
>>> title	optional/required*	line item name is required if title is not provided
>>> name	optional/required*	line item title is required if name is not provided
>>> quantity	required	Quantity of given product
>>> price	required	Sold price
>>> sku	required	Apliiq product SKU: APQ-########S#A#
>>> gram	optional	Can be set to zero
billing_address	Optional
>>> first_name	Optional
>>> last_Name	Optional
>>> address1	Optional
>>> address2	Optional
>>> phone	Optional
>>> city	Optional
>>> zip	Optional
>>> province	Optional
>>> province_code	Optional
>>> country	Optional
>>> country_code	Optional
shipping_address	required	Customer’s shipping address
>>> company	optional
>>> first_name	required	Customer first name
>>> last_Name	required	Customer last name
>>> address1	required	Customer address line 1
>>> address2	Optional
>>> phone	Optional
>>> city	required	Customer address city
>>> zip	required	Customer address zip
>>> province	required	Customer address state
>>> province_code	required*	* requires if country is US - 2 letters state code if country is US
>>> country	required	Country name
>>> country_code	required	2 letters country code
shipping_lines	optional	Array of shipping lines
>>>code	optional	Default is standard if no shipping_lines is provided. Only 1 shipping line is needed. Values: standard \| upgraded \| rush