OMS DOCUMENTATIONRESOURCE CENTER

These guides provide examples for many tasks that a developer will need to be familiar with during implementation.

KIBO OMS DEVELOPMENT

Documentation

Create Customer

The Create Customer API allows a new customer to be created and their information saved when they place an order. Their basic account and contact information is assigned on this initial creation, and custom data can be added when applicable.

Version2.0
Callhttps://integration.shopatron.com/api/v2/customer
Supported FormatsJSON
HTTP MethodPOST
Schemahttps://integration.shopatron.com/api/v2/schema/createCustomer.json

The .json address above can be used to access the schema within Postman. An example use of the Customer API follows below, or view the schema or the sample Postman collection.

Example

In this example, the customer details includes these particular properties:

  • Customer named TEST CUSTOMER
  • Being set up with the email “test@shopatron.com” and the password “password”

Required Parameters

These parameters are necessary for the Create Customer API to return a successful response:

ParameterTypeDescription
firstNamestringThe first name of the customer. The minimum length is 1 and the maximum length is 300.
lastNamestringThe last name of the customer. The minimum length is 1 and the maximum length is 300.
emailstringThe email address of the customer. The minimum length is 1 and the maximum length is 250.
phone1stringThe phone number of the customer. The minimum length is 1 and the maximum length is 20.
passwordstringA unique password for the customer. The minimum length is 5 and the maximum length is 48.

Optional Parameters

This additional information can also be provided during customer creation:

ParameterTypeDescription
phone2stringA secondary phone number for the customer. The maximum length is 20.
customDataarrayA set of custom data for the customer. See the schema for more details.

The Full Request

This is the complete request that will create a new customer.

{
 "firstName":"TEST",
 "lastName":"CUSTOMER",
 "email":"test@shopatron.com", 
 "phone1":"0000000000",
 "password":"password"
}

The Full Response

This is the full response returned by the API, detailing the information about the newly created customer.

{
 "customerID": "000000",
 "firstName": "TEST",
 "lastName": "CUSTOMER",
 "email": "test@shopatron.com",
 "password": "*****",
 "phone1": "0000000000",
 "active": "ACTIVE",
 "accountCreated": "2007-11-20T02:50:15+00:00"
}