Create New Customer

Updated 5 months ago ​by nussi

Overview

In order to create a new customer from the API you can consume the endpoint presented in this article. In order to consume it, you must:

  • Be authenticated user

For information on how you can authenticate, see: Authentication

Endpoint

Example for such endpoint for TT server is:

https://tt.api.sellercloud.com/rest/api/Customers/

For your server endpoint will be:

​https://{your_server_id}.api.sellercloud.com/rest/api/Customers/

Request

  • Method Type: HttpPost
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json

Parameter

Data Type

Description

Is Required

CompanyID

integer

ID of the company of the customer

yes

FirstName

string

First name of the customer

yes

LastName

string

Last name of customer

*Required for customer of type 'Retail'

no

Email

string

Email of the customer

yes

BusinessName

string

Name of business

*Required for customer of type 'WholeSale' only if client setting 'Enable Required Fields for WholeSale Customers' is enabled.

no

CustomerType

Enumeration

Wholesale or Retails.

For more into check at the bottom of the article.

yes

Response

  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • On server response => Status Code 500 => Internal Server Error

Enumerations

Customer Type

WholeSale = 0

Retails = 1


How did we do?