Create Account User

This API is used to add new user to the Shop.

Note:

• API used for integration case as Partner.

• API_KEY: <shop_key>

• Partner base_url information

CreateAccountUser

POST$BASE_URL.Shop/CreateAccountUser

Body

application/json

full_namestring

passwordstring

Roles []shop_user_role.UserRole json:"roles"

phonestring

Response

200

A successful response

Body

application/json

block_reasonstring

blocked_atstring (date-time)

created_at*string (date-time)

email*string

email_verification_sent_atstring (date-time)

email_verified_atstring (date-time)

full_name*string

id*string (int64)

is_blockedboolean

phone*string

phone_verification_sent_atstring (date-time)

phone_verified_atstring (date-time)

ref_affstring

ref_salestring

short_name*string

sourcedjUserSource (enum)

unknownpsxetoptopshipts_app_androidts_app_iosts_app_webpartneretop_app_iosetop_app_androidtelecom

total_shopinteger

updated_at*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('$BASE_URL.Shop/CreateAccountUser', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "block_reason": "text",
  "blocked_at": "2025-01-09T12:29:13.630Z",
  "created_at": "2025-01-09T12:29:13.630Z",
  "email": "text",
  "email_verification_sent_at": "2025-01-09T12:29:13.630Z",
  "email_verified_at": "2025-01-09T12:29:13.630Z",
  "full_name": "text",
  "id": "text",
  "is_blocked": false,
  "phone": "text",
  "phone_verification_sent_at": "2025-01-09T12:29:13.630Z",
  "phone_verified_at": "2025-01-09T12:29:13.630Z",
  "ref_aff": "text",
  "ref_sale": "text",
  "short_name": "text",
  "source": "unknown",
  "total_shop": 0,
  "updated_at": "2025-01-09T12:29:13.630Z"
}

Request:

curl --location '$BASE_URL.Shop/CreateAccountUser' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API-KEY' \
--data '{
  "full_name": "<string>",
  "password": "<string>",
  "phone": "<string>"
}'

Response:

{
  "block_reason": "string",
  "blocked_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "email": "string",
  "email_verification_sent_at": "2019-08-24T14:15:22Z",
  "email_verified_at": "2019-08-24T14:15:22Z",
  "full_name": "string",
  "id": "string",
  "is_blocked": true,
  "phone": "string",
  "phone_verification_sent_at": "2019-08-24T14:15:22Z",
  "phone_verified_at": "2019-08-24T14:15:22Z",
  "ref_aff": "string",
  "ref_sale": "string",
  "short_name": "string",
  "source": "unknown",
  "total_shop": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}

Request body structure:

Parameters	Data type	Describe
full_name required	string	Employee Name
password required	string	Login Password
phone required	string	Phone number

Return data attribute structure:

Parameters	Data type	Describe
block_reason	string	Reason for Blocking
blocked_at	string<date-time>	Time blocked
created_at	string<date-time>	Initialization time
email	string	Email address
email_verification_sent_at	string<date-time>	Time to send verification email
email_verified_at	string<date-time>	Email verification time
full_name	string	Employee Name
id	string	Employee ID
is_blocked	boolean	Blocked status True False
phone	string	Phone number
phone_verification_sent_at	string<date-time>	Phone number verification sending time
phone_verified_at	string<date-time>	Phone number verification time
short_name	string	Short name
total_shop	int	Total number of shops owned
updated_at	string<date-time>	Update time