Skip to content

Order

Jump to bottom
Karick Tung edited this page May 6, 2018 · 2 revisions

Order available fields

url /order/fields

output

{
    "message":"处理成功",
    "data": {
        "queryFields":"orderID|membershipType|orderDateR|acctType|orderAmt|loginID|shipTitle|discount|shipFirstName|shipLastName|shipAddr1|shipAddr2|shipAddr3|shipDistID|shipDistName|shipPhoneNo|shipFaxNo|shipMobileNo|billTitle|billFirstName|billLastName|billCompany|billAddr1|billAddr2|billAddr3|billDistID|billDistName|billPhoneNo|billFaxNo|billMobileNo|billEmail|payment|drawerName|cardNo|cardExpire|deliverDate|deliverTime|deliverStoreID|specialInstruction|orderStatus|deliveryCharge|umiCardNo|saveBy|pickupStore"
    },
    "error_code":"2000",
    "is_success":true
}

Order item available fields

url /order/item/fields

output

{
    "message":"处理成功",
    "data":{
        "queryFields":"orderID|prdID|prdPrice|promPrice|normalPrice|orderQty|orderItm|orderRemark|prdBrandEnu|prdBrandZht|prdNameEnu|prdNameZht|prdCode|prdSequence|promotionStatus"
    },
    "error_code":"2000",
    "is_success":true
}

Create order

url /order/add

input

(不能附帶 orderID, items 一定要有)

{
    "refundOrderID":163100000000337,
    "mbCardNo":"1229099890912",
    "billAddr1":"pBillAddr1",
    "billAddr2":"pBillAddr2",
    "billAddr3":"pBillAddr3",
    "billCompany":"pBillCompany",
    "billDistID":"1002",
    "billDistName":"Admiralty",
    "billEmail":"pBillEmail",
    "billFirstName":"BillFirstName",
    "billLastName":"pBillLastName",
    "billFaxNo":"pBillFaxNo",
    "billTitle":"Mr",
    "cardExpire":"2018-08",
    "deliverDate":"20180227",
    "deliverStoreID":"530",
    "deliverTime":"10:00AM - 02:00PM",
    "drawerName":"pDrawerName",
    "orderAmt":60,
    "payment":"americanExpress",
    "shipAddr1":"pShipAddr1",
    "shipAddr2":"pShipAddr2",
    "shipAddr3":"pShipAddr3",
    "shipDistID":"1001",
    "shipDistName":"Aberdeen",
    "shipFirstName":"pShipFirstName",
    "shipLastName":"pShipLastName",
    "shipPhoneNo":"shipPhoneNo",
    "shipMobileNo":"shipMobileNo",
    "billPhoneNo":"billPhoneNo",
    "billMobileNo":"billMobileNo",
    "cardNo":"311111111111111",
    "shipFaxNo":"pShipFaxNo",
    "shipTitle":"Mr",
    "specialInstruction":"for test",
    "acctType":"Individual",
    "discount":10,
    "deliveryCharge":true,
    "umiCardNo":"010100003283",
    "membershipType":"Gold",
    "loginID":1,
    "orderItems":[
        {
            "prdID":180868,
            "prdPrice":10,
            "promPrice":12,
            "normalPrice":10,
            "orderQty":5,
            "orderItm":"Y",
            "orderRemark":"test",
            "prdBrandEnu":"DULUC",
            "prdBrandZht":"DULUC ZHT",
            "prdNameEnu":"DULUC DUCRU",
            "prdNameZht":"DULUC DUCRU ZHT",
            "prdCode":"",
            "prdSequence":1,
            "promotionStatus":false
        }
    ],
    "saveBy":"WebSite",
    "pickupStore":"512"
}

output

{
    "message":"处理成功",
    "data": {
        "orderID":163100000000012
    },
    "error_code":"2000",
    "is_success":true
}

Artiasan CLI

$ php artisan mpos-ws:order:create

Query for orders

(測試一下有無 currentPage, pageSize 等參數)

url /order/query

input

{
    "keywords":"163100000000012",
    "queryFields":"orderID",
    "displayFields":`
        refundOrderID;
        mbCardNo;
        orderID;
        membershipType;
        orderDate;acctType;
        orderAmt;
        loginID;
        shipTitle;
        discount;
        shipFirstName;
        shipLastName;
        shipAddr1;
        shipAddr2;
        shipAddr3;
        shipDistID;
        shipDistName;
        shipPhoneNo;
        shipFaxNo;
        shipMobileNo;
        billTitle;
        billFirstName;
        billLastName;
        billCompany;
        billAddr1;
        billAddr2;
        billAddr3;
        billDistID;
        billDistName;
        billPhoneNo;
        billFaxNo;
        billMobileNo;
        billEmail;
        payment;
        drawerName;
        cardNo;
        cardExpire;
        deliverDate;
        deliverTime;
        deliverStoreID;
        specialInstruction;
        orderStatus;
        deliveryCharge;
        umiCardNo;
        saveBy;
        pickupStore`
}

output

{
    "message":"处理成功",
    "data": {
        "orderHeaders":[
            {
                "refundOrderID":163100000000337,
                "mbCardNo":"1229099890912"
                "saveBy":"WebSite",
                "orderItems":null,
                "orderID":163100000000012,
                "billAddr1":"pBillAddr1",
                "billAddr2":"pBillAddr2",
                "billAddr3":"pBillAddr3",
                "billCompany":"pBillCompany",
                "billDistID":"1002",
                "billDistName":"Admiralty",
                "billEmail":"pBillEmail",
                "billFirstName":"BillFirstName",
                "billLastName":"pBillLastName",
                "billFaxNo":"pBillFaxNo",
                "billTitle":"Mr",
                "cardExpire":"2018-08",
                "deliverDate":"20180227",
                "deliverStoreID":"530",
                "deliverTime":"10:00AM - 02:00PM",
                "drawerName":"pDrawerName",
                "orderAmt":60,
                "orderDate":"20180228",
                "orderStatus":"Ordered",
                "payment":"americanExpress",
                "shipAddr1":"pShipAddr1",
                "shipAddr2":"pShipAddr2",
                "shipAddr3":"pShipAddr3",
                "shipDistID":"1001",
                "shipDistName":"Aberdeen",
                "shipFirstName":"pShipFirstName",
                "shipLastName":"pShipLastName",
                "shipPhoneNo":"shipPhoneNo",
                "shipMobileNo":"shipMobileNo",
                "billPhoneNo":"billPhoneNo",
                "billMobileNo":"billMobileNo",
                "cardNo":"311111111111111",
                "shipFaxNo":"pShipFaxNo",
                "shipTitle":"Mr",
                "specialInstruction":"for test",
                "acctType":"Individual",
                "discount":10,
                "deliveryCharge":true,
                "umiCardNo":"010100003283",
                "membershipType":"Gold",
                "loginID":1,
                "pickupStore":"512"
            }
        ]
    },
    "error_code":"2000",
    "is_success":true
}

Artiasan CLI

$ php artisan mpos-ws:order:query

Order count

url /order/count

input

{
    "keywords":"163100000000012",
    "queryFields":"orderID"
}

output

{
    "message":"处理成功",
    "data": {
        "noOfOrderHeaders":1
    },
    "error_code":"2000",
    "is_success":true
}

Get specific order item

url /order/item/query

input

{
    "keywords":"163100000000012",
    "queryFields":"orderID",
    "displayFields":"orderID;prdID;prdPrice;promPrice;normalPrice;orderQty;orderItm;orderRemark;prdBrandEnu;prdBrandZht;prdNameEnu;prdNameZht;prdCode;prdSequence;promotionStatus"
}

output

{
    "message":"处理成功",
    "data":{
        "orderItems":[
            {
                "prdID":180868,
                "orderID":163100000000012,
                "prdBrandEnu":"DULUC",
                "prdBrandZht":"DULUC ZHT",
                "prdNameEnu":"DULUC DUCRU",
                "prdNameZht":"DULUC DUCRU ZHT",
                "prdPrice":10,
                "promPrice":12,
                "normalPrice":10,
                "orderQty":5,
                "orderItm":"Y",
                "orderRemark":"test",
                "prdCode":null,
                "prdSequence":1,
                "promotionStatus":false
            }
        ]
    },
    "error_code":"2000",
    "is_success":true
}

Artiasan CLI

$ php artisan mpos-ws:order:item

Order time slots (確定是送貨時間? 那 input 是?)

url /order/timeslots

input output

{
    "message":"处理成功",
    "data":{
        "timeslots":["10:00AM - 02:00PM"]
    },
    "error_code":"2000",
    "is_success":true
}

Order delivery methods

url /order/deliverymethods

input

output

{
    "message":"处理成功",
    "data": {
        "deliverymethods":[
            {
                deliverymethodCode:"VISAMasterCard",
                deliverymethodValue:"VISA / MasterCard"
            },

            {
                deliverymethodCode:"UnionPay",
                deliverymethodValue:"UnionPay"
            },

            {
                deliverymethodCode:"americanExpress",
                deliverymethodValue:"American Express"
            }
        ]
    },
    "error_code":"2000",
    "is_success":true
}

Stock

url /stock/query

input

{
    storeID: 530,
    prdID: 361396,
}

output

{
    message:"处理成功",
    data: {
        "prdID":361396,
        "storeID":"530",
        "minStockLevel":0,
        "actualStock":200,
        "saleStock":2,
        "cardStock":198
    },
    "error_code": "2000",
    "is_success": true
}

Artisan CLI

$ php artisan mpos-ws:product:stock
Clone this wiki locally