POST api/UserLogin/Login

用户登录

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
LoginID	Login ID	string	None.
Password	Login Password	string	None.

Request Formats

application/json, text/json

Sample:

{
  "LoginID": "sample string 1",
  "Password": "sample string 2"
}

Response Information

Resource Description

CustomerLoginResultModel

Name	Description	Type	Additional information
id_Customer	Main Customer account ID	integer	None.
LoginID	Login ID	string	None.
Name	Name	string	None.
Token	API Token	string	None.
TokenExpireTime	API Token Expire Time	date	None.
CNYToAUDRate	CNY to AUD exchange rate	decimal number	None.
id_AcctType	Account Type	integer	None.
Email	Email	string	None.
verifiedEmail	Email verified	boolean	None.
avatar	Avatar	string	None.
isAgent	Indicate if a user is an angent	boolean	None.
lang	Language	string	None.
sharecode	Share code	string	None.
FreshchatRestoreId	Freshchat restore Id	string	None.
UserProfile		CustomerInfoDetailModel	None.
settings		UserSettings	None.
ErrorCode	Detailed Error code (Variable definition by specific API)	integer	None.
ErrDetail	错误原因	ErrorCodeModel	None.
Code	Return code	APIReturnResult	None.
Reference	Optional, typically used for refering Unique ID in batch operation result;	string	None.
Message	Returned message.	string	None.
ReturnResult	Return result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "id_Customer": 1,
  "LoginID": "sample string 2",
  "Name": "sample string 3",
  "Token": "sample string 4",
  "TokenExpireTime": "2026-05-31T02:49:46.1301615+10:00",
  "CNYToAUDRate": 6.0,
  "id_AcctType": 7,
  "Email": "sample string 8",
  "verifiedEmail": true,
  "avatar": "sample string 10",
  "isAgent": true,
  "lang": "sample string 12",
  "sharecode": "sample string 13",
  "FreshchatRestoreId": "sample string 14",
  "UserProfile": {
    "ReceiverName": "sample string 1",
    "ReceiverPhone": "sample string 2",
    "InvoiceTo": "sample string 3",
    "InvoiceAddr": "sample string 4",
    "id_InvoiceTitleOption": 5,
    "FullAddress": "sample string 6 sample string 7 sample string 8 sample string 9 sample string 10",
    "Address": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "PostCode": "sample string 9",
    "Country": "sample string 10",
    "IsEnterprise": true,
    "Company": "sample string 12",
    "BusinessEmail": "sample string 13",
    "BusinessPhone": "sample string 14",
    "BusinessAddress": "sample string 15",
    "BusinessCity": "sample string 16",
    "BusinessState": "sample string 17",
    "BusinessPostCode": "sample string 18",
    "BusinessCountry": "sample string 19",
    "BusinessFullAddress": "sample string 15 sample string 7 sample string 8 sample string 9 sample string 10",
    "BusinessSector": "sample string 21",
    "Website": "sample string 22",
    "DeliveryLocation": "sample string 23",
    "ABN": "sample string 24",
    "ACN": "sample string 25",
    "LastLoginTime": "2026-05-31T02:49:46.1301615+10:00",
    "QLineEnable": true,
    "Sender": "sample string 27",
    "SenderPhone": "sample string 28",
    "SenderAddress": "sample string 29",
    "SenderCity": "sample string 30",
    "SenderState": "sample string 31",
    "SenderPostCode": "sample string 32",
    "SenderCountry": "sample string 33",
    "SenderEmail": "sample string 34",
    "id": 40,
    "Name": "sample string 41",
    "Phone": "sample string 42",
    "Email": "sample string 43",
    "LoginID": "sample string 44",
    "AccessToken": "sample string 45",
    "TokenExpireTime": "2026-05-31T02:49:46.1301615+10:00",
    "id_UserTier": 47,
    "Notes": "sample string 48",
    "id_Role": 49,
    "IsMainAcct": true,
    "id_Parent": 51,
    "avatar": "sample string 52",
    "lang": "sample string 53",
    "CreditAUD": 54.0,
    "CreditLimit": 55.0,
    "PaymentTerm": 56,
    "id_Type": 57,
    "UserPrefix": "sample string 59",
    "AgentPrefix": "sample string 60",
    "IsAgent": false,
    "verifiedPhone": true,
    "verifiedEmail": true,
    "id_SalesStaff": 68,
    "id_SalesStaffGZ": 69
  },
  "settings": {
    "id_User": 1,
    "column_shipment": [
      "sample string 1",
      "sample string 2"
    ],
    "column_notice": [
      "sample string 1",
      "sample string 2"
    ],
    "column_cargo": [
      "sample string 1",
      "sample string 2"
    ],
    "column_combine": [
      "sample string 1",
      "sample string 2"
    ],
    "column_inspection": [
      "sample string 1",
      "sample string 2"
    ],
    "column_return": [
      "sample string 1",
      "sample string 2"
    ],
    "column_claim": [
      "sample string 1",
      "sample string 2"
    ],
    "column_address": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "ErrorCode": 15,
  "ErrDetail": {
    "Code": 1,
    "ErrMsg": "sample string 2",
    "ErrMsgEn": "sample string 3"
  },
  "Code": 0,
  "Reference": "sample string 16",
  "Message": "sample string 17",
  "ReturnResult": {}
}