Create Customer

POST /locations/{location_id}/customers

Create a new customer.

Roles

Users with the following roles may access this endoint:

Dispatcher

Breaking Changes

2021/04/07

200 Response Body
- DispatchCustomerLocationModel
  - customer_id was renamed to id.

Request

Sample Request
Sample Response

POST /locations/{location_id}/customers/max_address_edit_distance=0
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}
{
"account_number_1": "TestACCT#1",
"account_number_2": "TestACCT#2",
"addresses": [
  {
    "country": "US",
    "is_billing": true,
    "is_shipping": true,
    "latitude": 48.076273,
    "line_1": "123 A Street",
    "line_2": "Suite 34",
    "line_3": "2nd Door on Left",
    "line_4": "Blue slot",
    "locality": "Sequim",
    "longitude": -123.117185,
    "postcode": "98368",
    "region": "WA"
  }
],
"contacts": [],
"is_commercial": true,
"name": "Test 1",
"note": "",
"parent_id": null,
"renewal_date": "2100-02-18T15:53:55.8510000",
"suspension_id": null
}

Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: GET,POST
Access-Control-Allow-Origin: *
Allow: GET,POST
Content-Length: 1040
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:38:51 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: 2e370b25-de46-4f17-ad24-365eff09c677

{
"account_number_1": "TestACCT#1",
"account_number_2": "TestACCT#2",
"addresses": [
  {
    "country": "US",
    "id": 107604,
    "is_active": true,
    "is_billing": true,
    "is_physical": true,
    "is_shipping": true,
    "latitude": 48.076273,
    "line_1": "123 A Street",
    "line_2": "Suite 34",
    "line_3": "2nd Door on Left",
    "line_4": "Blue slot",
    "locality": "Sequim",
    "longitude": -123.117185,
    "postcode": "98368",
    "region": "WA"
  }
],
"contacts": [
  {
    "email": null,
    "fax": null,
    "id": 107589,
    "name": null,
    "notify_on_acknowledged_request": false,
    "notify_on_completed_request": false,
    "notify_on_dispatched_request": false,
    "notify_on_failed_request": false,
    "notify_on_new_request": false,
    "number": null
  }
],
"created_on": "2022-08-20T01:38:51.013000",
"customer_id": 151049,
"is_active": true,
"is_commercial": true,
"last_updated_on": "2022-08-20T01:38:51.003000",
"location_id": 1,
"name": "Test 1",
"note": "",
"parent_id": null,
"reference_number": null,
"renewal_date": "2100-02-18T15:53:55.850000",
"sales_rep": null,
"sales_rep_id": null,
"suspension_id": null
}

Path Parameters

location_id Integer, Required

Location identifier.

Query Parameters

max_address_edit_distance Integer, Optional

Maximum address edit distance (levenshtein).

Less than or equal to 999.
Greater than or equal to 0.

Request Headers

Refer to StandardRequestHeadersModel for more details.

authorization String, Required

Authorization header (bearer with access token). See the Authentication Guide to get started.

Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
No longer than 256 characters.
At least 1 characters long.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

"application/json" Refer to the JSON Spec.

x-api-version String, Optional

Request identifier.

At least 1 and no more than 64 characters.
Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

x-tenant-id Integer, Required

Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.

Request Body

Refer to CreateCustomerModel for more details.

account_number_1 String, Optional

Customer account number.

At least 0 and no more than 128 characters.

account_number_2 String, Optional

Customer account number.

At least 0 and no more than 128 characters.

addresses Array[CreateCustomerAddressModel], Required

Refer to CreateCustomerAddressModel.

contacts Array[CreateCustomerContactModel], Required

Refer to CreateCustomerContactModel.

is_commercial Boolean, Optional

Commercial address if true, private if false.

One of 0, 1, True, False (case insensitive).

name String, Required

Name (free text).

At least 1 and no more than 64 characters.

note String, Optional

Notes (free text).

At least 0 and no more than 2048 characters.

parent_id Integer, Optional

Parent record identifier.

reference_number String, Optional

Reference number (free text).

At least 1 and no more than 256 characters.

renewal_date String, Optional

Renewal date.

Date in an ISO 8601 compatible format.

sales_rep String, Optional

Name of sales representative.

At least 1 and no more than 64 characters.

sales_rep_id String, Optional

Sales rep identifier. May be an integer provider id, the sales user UUID, or the username.

At least 0 and no more than 64 characters.

suspension_id Integer, Optional

Suspension identifier.

Response

Response Headers

Refer to StandardResponseHeadersModel for more details.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

"application/json" Refer to the JSON Spec.

x-api-version String

Request identifier.

At least 1 and no more than 64 characters.
Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

x-request-id String

Request identifier.

Valid UUID.

Response Body

Refer to DispatchCustomerLocationModel for more details.

account_number_1 String

Customer account number.

At least 0 and no more than 128 characters.

account_number_2 String

Customer account number.

At least 0 and no more than 128 characters.

addresses Array[CustomerAddressModel]

Refer to CustomerAddressModel.

contacts Array[CustomerContactModel]

Refer to CustomerContactModel.

created_on String

Timestamp of creation (must be in past).

Date occurring in the past in an ISO 8601 compatible format.

customer_id Integer

Customer identifier.

is_active Boolean

Records marked inactive are treated as deleted (soft delete).

One of 0, 1, True, False (case insensitive).

is_commercial Boolean, Conditional

Commercial address if true, private if false.

One of 0, 1, True, False (case insensitive).

last_updated_on String

Date occurring in the past in an ISO 8601 compatible format.

location_id Integer

Location identifier.

name String

Name (free text).

At least 1 and no more than 64 characters.

note String, Conditional

Notes (free text).

At least 0 and no more than 2048 characters.

parent_id Integer

Parent record identifier.

reference_number String, Conditional

Reference number (free text).

At least 1 and no more than 256 characters.

renewal_date String

Renewal date.

Date in an ISO 8601 format.

sales_rep String, Conditional

Name of sales representative.

At least 1 and no more than 64 characters.

sales_rep_id String, Conditional

Sales rep identifier.

suspension_id Integer, Conditional

Suspension identifier.

Code Samples

cURL
Python
CSharp 2.0

curl --request POST --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
--data '{"account_number_1": "TestACCT#1", "account_number_2": "TestACCT#2", "addresses": [{"country": "US", "is_billing": true, "is_shipping": true, "latitude": 48.076273, "line_1": "123 A Street", "line_2": "Suite 34", "line_3": "2nd Door on Left", "line_4": "Blue slot", "locality": "Sequim", "longitude": -123.117185, "postcode": "98368", "region": "WA"}], "contacts": [], "is_commercial": true, "name": "Test 1", "note": "", "parent_id": null, "renewal_date": "2100-02-18T15:53:55.8510000", "suspension_id": null}' \
127.0.0.1:8003/locations/{location_id}/customers?max_address_edit_distance=0

import requests, json

body = '''
    {
"account_number_1": "TestACCT#1",
"account_number_2": "TestACCT#2",
"addresses": [
  {
    "country": "US",
    "is_billing": true,
    "is_shipping": true,
    "latitude": 48.076273,
    "line_1": "123 A Street",
    "line_2": "Suite 34",
    "line_3": "2nd Door on Left",
    "line_4": "Blue slot",
    "locality": "Sequim",
    "longitude": -123.117185,
    "postcode": "98368",
    "region": "WA"
  }
],
"contacts": [],
"is_commercial": true,
"name": "Test 1",
"note": "",
"parent_id": null,
"renewal_date": "2100-02-18T15:53:55.8510000",
"suspension_id": null
}
    '''
response = requests.post(
        'http://localhost:8003/locations/{location_id}/customers',
        headers={
            'Authorization': 'Bearer {your-auth-token}',
            'Content-Type': 'application/json',
            'x-tenant-id': '{your-tenant-id}'
        },
        params={
            'max_address_edit_distance': '0'
        },
        data=body
    )
results = json.loads(response.text)
print(results)

using System;
using System.Net;
using System.Collections.Specialized;

namespace CROSoftware
{
public class DemoClient
{
    static public void Main ()
    {
        WebClient client = new WebClient();

        // URL    
        String url = "/locations/{location_id}/customers?max_address_edit_distance=0";

        // Headers
        client.Headers.Add("Authorization", "Bearer {your-auth-token}");
        client.Headers.Add("Content-Type", "application/json");
        client.Headers.Add("x-tenant-id", "{your-tenant-id}");

        // Body
        String body = "{\"account_number_1\": \"TestACCT#1\", \"account_number_2\": \"TestACCT#2\", \"addresses\": [{\"country\": \"US\", \"is_billing\": true, \"is_shipping\": true, \"latitude\": 48.076273, \"line_1\": \"123 A Street\", \"line_2\": \"Suite 34\", \"line_3\": \"2nd Door on Left\", \"line_4\": \"Blue slot\", \"locality\": \"Sequim\", \"longitude\": -123.117185, \"postcode\": \"98368\", \"region\": \"WA\"}], \"contacts\": [], \"is_commercial\": true, \"name\": \"Test 1\", \"note\": \"\", \"parent_id\": null, \"renewal_date\": \"2100-02-18T15:53:55.8510000\", \"suspension_id\": null}";

        String json = client.UploadString(url, "post", body);
        Console.WriteLine(json);
    }
}
}

Create Customer

Roles​

Breaking Changes​

Request​

Path Parameters​

Query Parameters​

Request Headers​

Request Body​

Response​

Response Headers​

Response Body​

Code Samples​

Roles

Breaking Changes

Request

Path Parameters

Query Parameters

Request Headers

Request Body

Response

Response Headers

Response Body

Code Samples