Create Order

Function

Create Order

Endpoint

• /v1/order/create

HTTP Method

• POST

Request Headers

• Authorization: Bearer {token}
• X-App-Key: {appKey}

Request Payload

with receipt

{
    "memberId": "XXXX",
    "transactionId": "XXXX",
    "storeCode": "storeCode",
    "invoiceId": "123456",
    "orderTime": "2024-01-01T10:00:00+08:00",
    "submitTime": "2024-01-01T10:00:00+08:00",
    "approvalTime": "2024-01-01T10:00:00+08:00",
    "originalAmount": "1000.00",
    "discountAmount":"0.00",
    "paymentAmount": "1000.00",
    "paymentMethod": "VS",
    "currency": "HKD",
    "source": "",
    "remark": "",
    "creditCardAuthCode":"",
    "receiptImage": "https://xxxx",
    "paymentImage": "https://xxxx"
}

without receipt

{
    "memberId": "xxx",
    "transactionId": "XXXX",
    "storeCode": "storeCode",
    "invoiceId": "123456",
    "orderTime": "2024-01-01T10:00:00+08:00",
    "submitTime": "2024-01-01T10:00:00+08:00",
    "approvalTime": "2024-01-01T10:00:00+08:00",
    "originalAmount": "1000.00",
    "discountAmount":"200.00",
    "paymentAmount": "800.00",
    "paymentMethod": "VS",
    "currency": "HKD",
    "source": "",
    "remark": "",
    "creditCardAuthCode":"",
    "discounts":{
      "coupons":[
        {
          "discounId":"redemption code",
          "discountAmount":"100.00",
          "couponId":"couponId"
        }
      ],
      "points":{
        "discounId":"burn point unique id",
        "discountAmount":"100.00",
        "points":"2500"
      }
    }
}

Request Parameters

Field	Required	Type	Remark	Sample
memberId	Yes	string	memberId
transactionId	Yes	string	transaction id
storeCode	Yes	string	store Id
invoiceId	Yes	string	receipt number	123456
orderTime	Yes	string	order time, rfc3339 format	2024-01-01T10:00:00+08:00
submitTime	Yes	string	submit time, rfc3339 format	2024-01-01T10:00:00+08:00
approvalTime	Yes	string	approval time, rfc3339 format	2024-01-01T10:00:00+08:00
originalAmount	Yes	string	original order amount	1000.00
discountAmount	Yes	string	discount amount	200.00
paymentAmount	Yes	string	amount of payment	800.00
paymentMethod	Yes	string	method of payment, Definition: PaymentMethod	VS
currency	No	string	currency type, default is HKD	HKD
source	No	string	source: POS/APP
remark	No	string	remark
creditCardAuthCode	No	string	credit card auth code
receiptImage	No	string	receipt image url
paymentImage	No	string	payment image url
discounts	No	json	discount detail list
discounts . coupons	No	object[]	coupons
. coupons . discounId	Yes	string	coupon redemption copon
. coupons . discountAmount	Yes	string	coupon discount amount
. coupons . couponId	Yes	string	couponId
discounts . points	No	object	coupons
. points . discounId	Yes	string	unique id for burn point
. points . discountAmount	Yes	string	amount of points as cash
. points . points	Yes	string	points value

Response Payload

{
  "status": 1,
  "errorCode": 0,
  "message": "success",
  "orderCode": "order unique identifier"
}

Response Parameters

Field	Required	Type	Remark	Sample
status	Yes	string	status code of the api call
message	Yes	string	detail message of the api call
errorCode	No	string
orderCode	Yes	string	order unique identifier

Response Headers

Error Codes

Code	Description
1	Internal Error
3	Missing Parameter
4	Invalid Input
4100	Member not found
10452	Invalid Store
10501	TransactionId already exists