Skip to main content

Create Seller

Path

  • URL: /cb-core/api/v1/seller/create
  • Method: POST
  • Description: This API allows registering new seller information into the Baokim system

Request

Request table

ParamsData TypeRequiredDescription
request_idstring(50)YesRequest ID from merchant.
Format: MerchantCode + YYYYMMDDHHMMSS + UniqueId
request_timestring(19)YesRequest timestamp. Format: YYYY-MM-DD HH:MM:SS
merchant_codestring(20)YesMerchant code provided by Baokim
sub_merchant_codestring(20)YesSub-merchant code. If seller belongs to merchant directly, fill in merchant_code
seller_idstring(50)YesSeller ID in merchant system
seller_namestring(255)YesFull name of seller
platformarrayYesPlatform information
- typestringYesPlatform type:
1: Website
2: E-commerce Platform
3: B2B
4: Service
5: Other
- linksstring(255)Yes*Platform URL (*Required if type is 1 or 2)
- platform_seller_idstring(255)Yes*Seller ID on platform (*Required if type is 2)
filesarrayYesDocument files (maximum 15 files)
- typestringYesFile type:
1: Business License
2: ID Card/Passport/Visa
3: Contract
4: Bank Statement
5: Other
- filefileYesFile upload (jpg, jpeg, png, pdf, max: 2MB)
representative_DOBstringYesRepresentative's date of birth (Format: YYYY-MM-DD)
representative_ID_numberstring(255)YesRepresentative's ID number
representative_namestring(255)YesRepresentative's full name
representative_nationalitystring(255)YesRepresentative's nationality
representative_addressstring(255)NoRepresentative's address
seller_business_typestringYesBusiness type:
1: Enterprise
2: Household
3: Individual
seller_business_registration_nostring(255)Yes*Business registration number (*Required if business_type is 1 or 2)
seller_phonestringNoContact phone number
seller_emailstringNoContact email (must be valid email format)
seller_business_descriptionstring(255)YesBusiness description
seller_risk_levelstringYesRisk level:
1: Low
2: Medium
3: High
gc_codestring(10)YesGroup Category code (must exist in system) Dowload excel
mcc_codestring(10)YesMerchant Category Code (must exist in system) Dowload excel

Request Example

{
"request_id": "MERCHANT12345678901234510281",
"request_time": "2024-11-15 14:36:00",
"merchant_code": "MERCHANT001",
"sub_merchant_code": "MERCHANT001",
"seller_id": "SELLER123456",
"seller_name": "Nguyễn Văn A",
"platform": [
{
"type": "2",
"links": "https://shopee.vn/seller123",
"platform_seller_id": "SHOPEE123456"
}
],
"files": [
{
"type": "1",
"file": "[binary file data]"
},
{
"type": "2",
"file": "[binary file data]"
}
],
"representative_DOB": "1990-01-01",
"representative_ID_number": "001099012345",
"representative_name": "Nguyen Van A",
"representative_nationality": "Vietnam",
"representative_address": "1 Dai Co Viet Street, Hai Ba Trung District, Ha Noi",
"seller_business_type": "2",
"seller_business_registration_no": "0123456789",
"seller_phone": "0912345678",
"seller_email": "[email protected]",
"seller_business_description": "Online retail store selling electronics",
"seller_risk_level": "1",
"gc_code": "5045",
"mcc_code": "5399"
}

Response

Response table

ParamsData TypeDescription
response_codeintResponse code from Baokim
response_messagestring(255)Response description
merchant_codestring(20)Merchant code
seller_idstring(50)Seller ID
statusintSeller status:
1: Processing

Response Example

{
"response_code": 200,
"response_message": "Success",
"merchant_code" :"MERCHANT001",
"seller_id": "SELLER123456",
"status": 1
}

Error Codes

Response CodeResponse MessageDescription
200SuccessCreate seller successfully
101System ErrorSystem error
422Validation ErrorValidation Error
130Seller ID existSeller's ID is duplicated or existing