St. Hee women's Shoes API design (i)

Women's Shoes APIdata structure Definition

//Product//产品数据对象解构{    id:101,    name:‘产品名‘,    summary:‘产品简介‘,    image:‘imageURL‘,    code:‘产品编码，例如3014‘,    price:‘价格‘,    colors:[        color,        ...    ],    sizes:[        size,        ...    ]}

//Color对象//颜色描述对象{    id:‘颜色id，唯一标识‘,    name:‘颜色名称，例如红色‘}

//Size对象//尺码描述对象{    id:‘尺码id，唯一标识‘,    name:‘尺码名称，例如43号‘}

//PreOrder//预定信息{    id:101,    date:‘时间‘,    productID:    name:‘产品名‘,    code:‘产品编码，例如3014‘,    image:‘图片链接‘,    price:‘价格‘,    count:‘数量,}

//Order//订单对象{    id:订单id,    date:订单时间,    totalPrice:总价,    type:‘0为确认订单，1已确认订单，2已发货订单‘}

//OrderDetail//订单明细对象{    id:订单明细id,    productID:商品类型ID,    productName:商品名称,    productCode:商品编码,    productColorID:    productColorName:    productSizeID:    productSizeName:    count:    price:    totalPrice:    type:‘订单明细类型，0正常，1退货申请中，2退货成功，3退货失败，4换货申请中，5换货成功,6退货失败‘}

//BillDetail//账单明细对象{    id:    date:    totalPrice:    orderID:}

//Bill//对账单对象{    id:    date:    orderTotalPrice:订单总金额    backTotalPrice:退货总金额    money:应付账款    type:‘0为确认，1已确认，2已付款‘}

//notice//通知对象{    id:    title:    content:    date:    type:‘0为公共，1为个人‘,}

API Interface Definition1, Login

Request Address: Http://host:port/api/login

Request Method: POST

Request Parameters:

Name of parameter	Parameter Description
Name	Login Name
Pwd	Password

return value:

{    success:true,    data:{        uid:1001        token:xxxx    }}

2. Get the product

Request Address: Http://host:port/api/getProducts

Request Method: GET

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens
Type	0 for all items, 1 for new, default to 0

return value:

{    success:true,    data:[        Product对象,        ...    ]}

3, submit booking information

Request Address: Http://host:port/api/postPreOrider

Request Method: POST

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens
ProductID	Product ID
Count	Number of bookings

return value:

{    success:true,}

4, get the reservation record

Request Address: Http://host:port/api/getPerOrders

Request Method: GET

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens

return value:

{    success:true,    data:[        PreOrder对象,        ...    ]}

5. Get Order list

Request Address: Http://host:port/api/getOrders

Request Method: GET

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens

return value:

{    success:true,    data:[        Order对象，        ...    ]}

6. Get Order Details

Request Address: Http://host:port/api/getOrderDetails

Request Method: GET

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens
OrderID	Order ID

return value:

{    success:true,    data:[        OrderDetail对象，        ...    ]}

7, confirm the order

Request Address: Http://host:port/api/confirmOrder

Request Method: POST

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens
OrderID	Confirm Order ID

return value:

{    success:true,}

8, return

Request Address: Http://host:port/api/backProduct

Request Method: POST

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens
OrderID	Order ID
Orderdetailid	Order Detail ID
Count	Return quantity

return value:

{    success:true,}

9, Exchange

Request Address: Http://host:port/api/changeProduct

Request Method: POST

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens
OrderID	Order ID
Orderdetailid	Order Detail ID
Count	Replacement quantity
Colorid	Exchange Color ID
Sizeid	Replacement size ID

return value:

{    success:true,}

10. Get Billing Details

Request Address: Http://host:port/api/getBillDetails

Request Method: GET

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens

return value:

{    success:true,    data:[        账单明细对象,        ...    ]}

11, get the statement

Request Address: Http://host:port/api/getBill

Request Method: GET

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens

return value:

{    success:true,    data:对账单对象,}

12, confirm the statement

Request Address: Http://host:port/api/confirmBill

Request Method: POST

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens
billID	The statement ID

return value:

{    success:true,}

13, get the history statement

Request Address: Http://host:port/api/getHistoryBills

Request Method: GET

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens

return value:

{    success:true,    data:[        对账单对象，        ...    ],}

14, get notifications

Request Address: Http://host:port/api/getNotices

Request Method: GET

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens

return value:

{    success:true,    data:[        通知对象，        ...    ],}

15, Change password

Request Address: Http://host:port/api/user/setPassword

Request Method: POST

Request Parameters:

Name of parameter	Parameter Description
Token	Login Tokens
Currentpwd	Current password
Newpwd	New password

return value:

{    success:true,}

St. Hee women's Shoes API design (i)