Fulfilment

Overview

SUBPLACE Biz Partner API is used for biz partner system to get the order and subscription related information from SUBPLACE.

Partner will need to initiate a request to SUBPLACE API by passing required information according to authentication and security requirements.

There are 2 level of security for the integration and the 2nd level is the additional which is optional:

Security Signature – as the authentication for client to access to the API
Request Body Encryption – all request body must be encrypted accordingly

Get Fulfilment List

API Suffix: order/fulfillment

Method: POST

The Pre-requisites

The API Input Parameter

{

"key": "97ddc5dc2675bdbba463bd3d11e5ef21",

"signature": "5cb5920101b3352afb07298360f50b45dfd3dca1ab89a57fab7b57a66cfc6b4f",

"page_size": "30",

"current_page": "1",

"search_text": "a",

"fulfillment_type": "delivery",

"delivery_status": "[\"Pending\",\"Completed\"]",

"created_date_from": null,

"created_date_to": null

}

*Please keep delivery -> reference_no provide by us for future API use (use for Get Fulfilment Detail API)

"delivery": {

"reference_no": "DO-MR1614-6254-1",

"sequence": "1/1",

"status": "Pending"

},

The API Output Parameter

"status": {

"code": 1,

"message": "Success"

},

"list": {

"total_item": 180,

"page_size": 20,

"current_page": 1,

"total_page": 9

},

"order": [

{

"no": "SO-7486",

"fulfillment_type": "Delivery",

"status": "Paid",

"created_time": "9-3-2022, 9:46 PM",

"approval_time": "10-3-2022, 1:22 PM",

"shipping_address": "42A,Shineville Villa,Solok Thean tek 1, 11500, Ayer Itam, Pulau Pinang",

"store": {

"name": "LOCKIN Malaysia"

},

"subscriber": {

"name": "LEONG KOK YOONG"

},

"plan": {

"id": 3993,

"name": "2X Pro Rental Plan - 6 month Advance Payment",

"variation_name": "2X Pro Rental Plan - 6 month Advance Payment",

"quantity": 1,

"model": "Rent-to-Own",

"effective_time": null,

"delivery_mode": "One Time",

"cycle": "Upfront",

"status": "Approved"

},

"delivery": {

"reference_no": "DO-MR1907-6487-1",

"sequence": "1/1",

"status": "Pending"

},

"redemption": null

}

]

}

Get Fulfilment Detail

API Suffix: order/fulfillment/detail

Method: POST

The API Input Parameter

The API Output Parameter

{

"status": {

"code": 1,

"message": "Success"

},

"order": {

"no": "SO-7486",

"fulfillment_type": "Delivery",

"status": "Paid",

"created_time": "9-3-2022, 9:46 PM",

"pay_time": "9-3-2022, 9:46 PM",

"approval_time": "10-3-2022, 1:22 PM",

"billing_address": "42A,Shineville Villa,Solok Thean tek 1, 11500, Ayer Itam, Pulau Pinang",

"shipping_address": "42A,Shineville Villa,Solok Thean tek 1, 11500, Ayer Itam, Pulau Pinang",

"store": {

"name": "LOCKIN Malaysia"

},

"subscriber": {

"name": "LEONG KOK YOONG"

},

"plan": {

"id": 3993,

"name": "2X Pro Rental Plan - 6 month Advance Payment",

"variation_name": "2X Pro Rental Plan - 6 month Advance Payment",

"quantity": 1,

"model": "Rent-to-Own",

"effective_time": null,

"delivery_mode": "One Time",

"status": "Approved"

},

"bill": {

"cycle": "Upfront",

"no": "SBL-16865",

"date": null,

"amount": "475.00"

},

"delivery": {

"reference_no": "DO-MR1907-6487-1",

"sequence": "1/1",

"status": "Pending",

"created_time": "10-3-2022, 1:21 PM",

"delivered_time": null,

"confirm_delivered_time": null

},

"redemption": null

}