Ecommerce
  1. Profile
Ecommerce
  • Start your Apidog journey
  • Sample APIs
    • Find pet by ID
    • Add a new pet to the store
    • Update an existing pet
    • Deletes a pet
    • Finds Pets by status
  • Users
    • profile
      • me
    • auth
      • login
      • login google by using firebase auth
      • login google
      • callback google
      • forgotPasswordByCode
      • verify Code
      • profile
      • forgotPassword
      • register
      • send-otp
      • verify otp
      • guard
    • Roles
      • get all roles
      • get roles
    • Capabilities
      • get all capabilities
  • Ecommerce
    • Profile
      • Web Create guest profile
        POST
      • Web Update my Profile
        PUT
      • Web Get my Profile
        GET
    • Features Group
      • Get all feature groups
      • Get feature groups with pagination
      • Get feature group by id
      • Add feature group
      • Delete feature group
      • Update feature group
    • Features
      • Get all features
      • Get features with pagination
      • Get feature by id
      • Add feature
      • Delete feature
      • Update feature
    • Order
      • Get orders with pagination
      • Get upcoming shipping
      • Get recent activity
      • Get buyer recent activity
      • Get order by id
      • Add order
      • Update order
      • Update order status
      • Refend order
      • Cancel order
      • Delete order
      • Export orders
    • Order web
      • Get my orders
      • Pay order
    • Appointment
      • Request Translation
      • Reschedule Appointment
      • Create Appointment
      • Update Partial
      • Get Appointments With Pagination
      • Get appointment by id
    • Quotation
      • Summary
        • Get quick summary
        • Get recent activity
        • Get most requested products
        • Get expiring quotations
        • Get buyer quotations reply insights
      • Shipping
        • Submit To Agent
        • Upsert Cost By From Agent
        • Upsert Cost By To Agent
        • Submit To Vendor
      • Create general quotation
      • Create quotation response
      • Create quotation request
      • Update quotation status
      • Add comment to quotation
      • Get quotation by id
      • Get open request quotations
      • Get my replies quotations
      • Get my requests
      • Get replies of a request quotation
      • Get general quotations
    • Plan
      • Get plans with pagination
      • Get Web All
      • Get All plans
      • Get plan by id
      • Add plan
      • Delete plan
      • Update plan
    • Addresses
      • Get Web Address All
      • Get Web addresses
      • Get Web address by id
      • Add Web Address
      • Delete Web Address
      • Bulk Web Delete Addresses
      • Update Web Address
    • Watch list Web
      • Get watch lists
      • Add to watch list
      • Delete from watch list
    • Dashboard Carts
      • Get Cart
      • Get cart by id
      • Create Cart
      • Delete cart
      • Update cart
    • Capabilities
      • Create Capabilities
    • Product
      • Production Line
        • Create Production Line
        • Get Production Line By Id
        • Get Production Line By Criteria
        • Update Production Line By Id
        • Delete Production Line By Id
        • Bulk Delete Production Lines
      • Attribute
        • Create Attribute
        • Get Attribute By Id
        • Get Attribute All
        • Get Attribute By Criteria
        • Update Attribute By Id
        • Delete Attribute By Id
        • Bulk Delete Attributes
      • Group
        • Create Group
        • Get Group By Id
        • Get Group All
        • Get Group By Criteria
        • Update Group By Id
        • Delete Group By Id
        • Bulk Delete Group
      • Review
        • Create Review
        • Get Review By Criteria
        • Update Review By product Id
        • Delete Review By Product Id
      • Branch
        • Create Branch
        • Update Branch By Id
        • Get Branch By Id
        • Get Branch All
        • Get Branchs with pagination
        • Delete Branch By Id
        • Bulk Delete Branches
        • Get Web Branch By Coordinates
        • Get All Web Branch With Pagination
        • Get All Web Branch
        • Import Branch Zones
        • Get Import Branch Zones Example
        • Get Branch Zones File
        • Import Branch Products
        • Get Import Branch Products Example
        • Get Branch Products File
      • Link To Branches
        • Get Link By Branch Id and Product Id
      • Addons
        • Get addons
        • Get addon by id
        • Add Addons
        • Delete addon
        • Bulk Delete addons
        • Update addon
        • Get Web addons
        • Get Web addons all
      • Get Web Product By Id
      • Get Web Product By Criteria
      • Create Product
      • Get Product By Id
      • Get Product By Criteria
      • Link Product By Id to Branches
      • Update Product By Id
      • Link Product By Id to Production Line
      • Delete Product By Id
      • Delete Duplicated Products
    • Category
      • Get Web Category All
      • Create Category
      • Get Category By Id
      • Get Category All
      • Get Category By Criteria
      • Update Category By Id
      • Delete Category By Id
      • Bulk Delete Category
    • Unit
      • Create Unit
      • Get Unit By Id
      • Get Unit All
      • Get Unit By Criteria
      • Update Unit By Id
      • Delete Unit By Id
      • Bulk Unit Category
    • Contact
      • Shipping
        • Create Shipping
        • Get Shipping By Id
        • Get Shipping By Criteria
        • Update Shipping By Id
        • Delete Shipping By Id
        • Bulk Delete Shippings
      • Broker
        • Create Broker
        • Get Broker By Id
        • Get Broker By Criteria
        • Update Broker By Id
        • Delete Broker By Id
        • Bulk Delete Brokers
      • Agent
        • Create Agent
        • Get Agent By Id
        • Get Agent By Criteria
        • Update Agent By Id
        • Delete Agent By Id
        • Bulk Delete Agent
      • Customer
        • Create Customer
        • Get Customer By Id
        • Get Customer By Criteria
        • Update Customer By Id
        • Delete Customer By Id
        • Bulk Delete Customer
    • Payment
      • Invoice
        • Create Invoice
        • Get Invoice By Id
        • Get Invoice By Criteria
        • Update Invoice By Id
        • Delete Invoice By Id
        • Bulk Delete Invoice
      • Payout
        • Create Payout
        • Get Payout By Id
        • Get Payout By Criteria
        • Update Payout By Id
        • Delete Payout By Id
        • Bulk Delete Payout
      • Transaction
        • Create Transaction
        • Get Transaction By Id
        • Get Transaction By Criteria
        • Update Transaction By Id
        • Delete Transaction By Id
        • Bulk Delete Transaction
      • Create Payment
      • Get Payment By Id
      • Get Payment By Criteria
      • Update Payment By Id
      • Delete Payment By Id
      • Bulk Delete Payment
    • Setup
      • Create Capabilities
      • Upsert Seed
      • Upsert System Seed
      • Truncate Seed
    • Config
      • Currency
        • Get All currencies
        • Get currencies with pagination
        • Get currency by id
      • Location
        • Country
          • Get All Seed Countries
          • Get All Countries
          • Get All locations
          • Get Countries with pagination
          • Get Country by id
          • Create country
          • Update country
          • Delete country
        • City
          • Get All Seed Cities
          • Get All Cities
          • Get Cities with pagination
          • Get City by id
          • Create city
          • Update city
          • Delete cityId
        • Area
          • Get All Seed Areas
          • Get All Areas
          • Get Areas with pagination
          • Get Area by id
          • Create Area
          • Update Area
          • Delete Area
        • Zone
          • Get All Zones
          • Get Zones with pagination
          • Get Zone by id
          • Create Zone
          • Update zone
          • Delete Zone
          • Find Zones Containing Location
          • Find Zones Containing Point
        • Location Web
          • Get All Web Countries
          • Get All Web Cities
          • Get All Web Areas
      • Ticket type
        • Get All Ticket Types
        • Get Ticket Types with pagination
        • Get Ticket Type by id
        • Create Ticket Type
        • Update Ticket Type
        • Delete Ticket Type
    • Settings
      • Sales Inventory
        • Get inventory settings
        • Update inventory settings
      • Sales Settings
        • Get sales settings
        • Update sales settings
      • General Settings
        • Get general settings
        • Update general settings
    • Cart
      • Clear Web Cart Item
      • Upsert Web Cart Item
      • Get Web Cart Item Mine
    • Ticket
      • Get My Tickets
      • Get Ticket by Id
      • Get Ticket Summary
      • Create Ticket
      • Add comment
      • Update ticket
    • Coupon
      • Create Coupon
      • Get Coupons with Pagination
      • Get Coupon by Id
      • Update Coupon
      • Delete Coupon
      • Bulk Delete Coupon
      • Get Web Coupon Mine
      • Check Web Coupon Redeemption
    • Checkout
      • Try Checkout
      • Checkout
    • Survey
      • Question
        • Create Question
        • Update Question
        • Get Questions with Pagination
        • Get Question by Id
        • Delete Question
        • Get Web Questions with Pagination
        • Get Web Questions All
      • Waiters
        • Get Web Waiters with Pagination
        • Get Web Waiters All
        • Create Waiter
        • Update Waiter
        • Get Waiters with Pagination
        • Delete Waiter
        • Get Waiter by Id
      • FeedBack
        • Create Web FeedBack
        • Get Feedbacks with Pagination
        • Delete Feedback
        • Get Feedback by Id
        • Export Feedback
    • Truncate Collection List
      DELETE
    • Fix Product Attributes
      PUT
  • Files
    • Upload File
  1. Profile

Web Create guest profile

POST
{{web_ecommercev2_url}}/profiles/guest
for Vendor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST '{{web_ecommercev2_url}}/profiles/guest' \
--header 'x-client: {{client}}' \
--header 'accept-language: {{acceptLanguage}}' \
--header 'Content-Type: application/json' \
--header 'x-access-token;' \
--data-raw '{
    "companyName": "string",
    "companyWebsite": "https://kareem.com",
    "industry": [
        "string"
    ],
    "country": "string",
    "city": "string",
    "area": "string",
    "address": "string",
    "phone": "string",
    "email": "string@hbd.com",
    "responsiblePerson": "string",
    "responsibleRole": "string",
    "interestedInAgents": true,
    "interestedInExports": true,
    "interestedInSeekAgents": true,
    "additionalInfo": "string"
}'
Response Response Example
Profile Buyer
{
    "id": "667917cabd1516884a1af8fe",
    "companyName": "string",
    "companyWebsite": "https://kareem.com",
    "industry": [
        "string"
    ],
    "country": "string",
    "city": "string",
    "area": "string",
    "address": "string",
    "phone": "string",
    "email": "string@hbd.com",
    "responsiblePerson": "string",
    "responsibleRole": "string",
    "interestedInAgents": true,
    "interestedInExports": true,
    "interestedInSeekAgents": true,
    "additionalInfo": "string",
    "profileType": "Buyer",
    "userType": "Member",
    "createdAt": "2025-04-03T15:12:09.906Z",
    "updatedAt": "2025-04-03T15:15:49.585Z",
    "createdBy": "667917cabd1516884a1af8fe",
    "updatedBy": "667917cabd1516884a1af8fe"
}

Request

Authorization
API Key
Add parameter in header
x-access-token
Example:
x-access-token: ********************
or
Header Params
x-access-token
string 
required
Example:
{{admin-token}}
x-client
string 
required
Example:
{{client}}
accept-language
string 
required
Example:
{{acceptLanguage}}
Body Params application/json
optional
Any of
companyName
string 
required
companyWebsite
string 
required
industry
array[string]
required
country
string 
required
city
string 
required
area
string 
required
address
string 
required
phone
string 
required
email
string 
required
responsiblePerson
string 
required
responsibleRole
string 
required
interestedInAgents
boolean 
required
interestedInExports
boolean 
required
interestedInSeekAgents
boolean 
required
additionalInfo
string 
required
registrationCertifications
array [object {13}] 
required
qualityCertifications
array [object {17}] 
required
licenses
array [object {12}] 
required
Examples

Responses

🟢200OK
application/json
Body
optional
Any of
id
string 
required
companyName
string 
required
companyWebsite
string 
required
industry
array[string]
required
country
string 
required
city
string 
required
area
string 
required
address
string 
required
phone
string 
required
email
string 
required
responsiblePerson
string 
required
responsibleRole
string 
required
interestedInAgents
boolean 
required
interestedInExports
boolean 
required
interestedInSeekAgents
boolean 
required
additionalInfo
string 
required
profileType
string 
required
userType
string 
required
createdAt
string 
required
updatedAt
string 
required
createdBy
string 
required
updatedBy
string 
required
Modified at 2025-05-13 10:50:04
Previous
get all capabilities
Next
Web Update my Profile
Built with