ASL API Docs
  • Get Started
  • Process Flow
  • API Specifications
    • Authentication
    • Order Submit
    • Get Submitted Order
    • Cancel Order
    • Get Inventory
    • Appendix
  • Third party Integration
    • Shoplify Order Automation
      • Custom App Setup
Powered by GitBook
On this page
  • Body
  • Example JSON
  • Error
  1. API Specifications

Order Submit

POST - Submitting order to ASL System

POST - https://portal.asl-asia.cloud:4000/api/order/submit

Body

Field
Type
Optional

order_id

String

description

String

note

String

service_type

String

Optional. Required service enabled from ASL Admin

tracking_no

String

Optional

is_cod

Boolean

payment_amount

Float (e.g 200.5)

Optional

payment_currency

3-letter (e.g HKD)

Optional

buyer

Object

-- name

String

-- address

String

(Max 35 character)

-- address2

String

Optional

-- zip

String

-- country

-- state

String

-- phone

String

-- city

String

-- email

String

item_lines

Array

-- description

String

Required if auto-fulfilled

-- sku

String

-- qty

Integer

-- price

Object

Required if auto-fulfilled

---- currency

3 Digit Currency Code

---- amount

Integer

dimension

Object

Optional

-- weight

-- height

-- width

-- length

Example JSON

{
    "order_id": "testing_order_id_002",
    "is_cod": true,
    "payment_amount": 12000,
    "reference": "test",
    "payment_currency": "HKD",
    "buyer": {
        "name": "David",
        "address": "testing address",
        "city": "Hong Kong",
        "zip": "000852",
        "country": "HK",
        "state": "NA"
    },
    "note": "testing",
    "dimension": {
        "weight": { "unit": "kg", "value": 12 },
        "height": { "unit": "cm", "value": 100 },
        "width": { "unit": "cm", "value": 100 },
        "length": { "unit": "cm", "value": 100 }
    },
    "item_lines": [
        { 
            "sku": "TEST-01",
            "qty": 1
        }
    ]
}

Error

Code
Reason

ORDER_ALREADY_EXISTS

order_id already used

BODY_MISSING_FIELDS

The required fields from body is missing

BUYER_MISSING_FIELDS

The required fields from body.buyer is missing

COUNTRY_NOT_CORRECT

body.buyer.country is not correct

ITEM_LINES_NOT_CORRECT

item_lines is missing correct fields

PreviousAuthenticationNextGet Submitted Order

Last updated 11 months ago

2-digit de

Object

Object

Object

Object

Country Co
UnitValue
UnitValue
UnitValue
UnitValue