API document

1. Mobile APIs

1.1 User login

(v1.user.generalLogin)

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

phoneNumberstringRequired

passwordstringRequired

positionstring · enumRequiredDefault: userPossible values:

Responses

200Success

application/json

Responseone of

or

object[]Optional

or

objectOptional

401

Need auth

application/json

422

Fields invalid

application/json

default

Server errors: 500, 501, 400, 404 and etc...

application/json

post

/api/public/device/user/login

HTTPcURLJavaScriptPython

POST /api/public/device/user/login HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "phoneNumber": "",
  "password": "",
  "position": "user"
}

{
  "rows": [
    {}
  ],
  "totalCount": 1
}

1.2 Verify user's phone

• Kiểm tra một số điện thoại đã tồn tại trên hệ thống hay chưa

• Tạo contact mới nếu số điện thoại chưa đăng ký trên hệ thống

(v1.user.verifyPhoneNumber)

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

phoneNumberstring · min: 6 · max: 6Optional

deviceIdstringOptional

Responses

200Success

application/json

Responseone of

or

object[]Optional

or

objectOptional

401

Need auth

application/json

422

Fields invalid

application/json

default

Server errors: 500, 501, 400, 404 and etc...

application/json

get

/api/public/user/verifyPhone

HTTPcURLJavaScriptPython

GET /api/public/user/verifyPhone HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "rows": [
    {}
  ],
  "totalCount": 1
}

1.3 Add user to an organization

(v1.user.addToOrg)

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

orgIdstringRequired

Responses

200Success

application/json

Responseone of

or

object[]Optional

or

objectOptional

401

Need auth

application/json

422

Fields invalid

application/json

default

Server errors: 500, 501, 400, 404 and etc...

application/json

post

/api/private/user/org

HTTPcURLJavaScriptPython

POST /api/private/user/org HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "orgId": ""
}

{
  "rows": [
    {}
  ],
  "totalCount": 1
}

1.4 Reset user's password

(v1.user.resetPassword)

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

phoneNumberstringRequired

otpstringRequired

newPasswordstringRequired

Responses

200Success

application/json

Responseone of

or

object[]Optional

or

objectOptional

401

Need auth

application/json

422

Fields invalid

application/json

default

Server errors: 500, 501, 400, 404 and etc...

application/json

post

/api/public/user/reset-password

HTTPcURLJavaScriptPython

POST /api/public/user/reset-password HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "phoneNumber": "",
  "otp": "",
  "newPassword": ""
}

{
  "rows": [
    {}
  ],
  "totalCount": 1
}

1.5 Register fcm token

(v1.user.registerNotification)

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

fcmTokenstringRequired

tokenTypestring · enumOptionalDefault: userPossible values:

Responses

200Success

application/json

Responseone of

or

object[]Optional

or

objectOptional

401

Need auth

application/json

422

Fields invalid

application/json

default

Server errors: 500, 501, 400, 404 and etc...

application/json

post

/api/private/user/fcmToken

HTTPcURLJavaScriptPython

POST /api/private/user/fcmToken HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "fcmToken": "",
  "tokenType": "user"
}

{
  "rows": [
    {}
  ],
  "totalCount": 1
}

1.6 Deregister fcm token

(v1.user.deregisterNotification)

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

fcmTokenstringOptional

tokenTypestring · enumOptionalDefault: userPossible values:

Responses

200Success

application/json

Responseone of

or

object[]Optional

or

objectOptional

401

Need auth

application/json

422

Fields invalid

application/json

default

Server errors: 500, 501, 400, 404 and etc...

application/json

delete

/api/private/user/fcmToken

HTTPcURLJavaScriptPython

DELETE /api/private/user/fcmToken HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "rows": [
    {}
  ],
  "totalCount": 1
}

1.7 List user's orders

(v1.order.userListOrder)

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startTimestring · date-timeOptionalExample: 1998-01-10T13:00:00.000Z

indexnumberOptional

pagenumber · min: 10OptionalDefault: 10

isPaidbooleanOptionalExample: false

isDeliveriedbooleanOptionalExample: false

orderStatusstring · enumOptionalExample: successPossible values:

orderTypestring · enumOptionalExample: pudoPossible values:

isDeliveridbooleanOptionalExample: false

Responses

200Success

application/json

Responseone of

or

object[]Optional

or

objectOptional

401

Need auth

application/json

422

Fields invalid

application/json

default

Server errors: 500, 501, 400, 404 and etc...

application/json

get

/api/private/user/order

HTTPcURLJavaScriptPython

GET /api/private/user/order HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "rows": [
    {}
  ],
  "totalCount": 1
}

1.8 Get user's order

(v1.order.userGetOrder)

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orderIdstringRequired

Responses

200Success

application/json

Responseone of

or

object[]Optional

or

objectOptional

401

Need auth

application/json

422

Fields invalid

application/json

default

Server errors: 500, 501, 400, 404 and etc...

application/json

get

/api/private/user/order/{orderId}

HTTPcURLJavaScriptPython

GET /api/private/user/order/{orderId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "rows": [
    {}
  ],
  "totalCount": 1
}