HEhelcim
Customer

Create customer

Changed on
post/customers

Request

  • Base URL
    https://api.helcim.com/v2
  • URL
    https://api.helcim.com/v2/customers
  • Auth
    API key in header api-token

Request body

customerCodestring

The unique customer code. If blank, it will be automatically generated.

contactNamestring

The primary contact name (full name) of the customer.

businessNamestring

The business name of the customer. There must be either a contact name or business name present.

cellPhonestring

The cell phone number of the customer.

Example request

{
  "customerCode": "CST1000",
  "contactName": "John Smith",
  "businessName": "Best Company",
  "cellPhone": "908-295-4902",
  "billingAddress": {
    "name": "John Smith / Helcim",
    "street1": "21 Jump Street",
    "street2": "Suite 400",
    "city": "Calgary",
    "province": "AB",
    "country": "CAN",
    "postalCode": "H0H0H0",
    "email": "john@example.com"
  },
  "shippingAddress": {
    "name": "John Smith / Helcim",
    "street1": "21 Jump Street",
    "street2": "Suite 400",
    "city": "Calgary",
    "province": "AB",
    "country": "CAN",
    "postalCode": "H0H0H0",
    "email": "john@example.com"
  }
}

Response

Successful

idinteger

Id of Customer

customerCodestring

Customer code of the customer

businessNamestring

Name of the business

contactNamestring

Contact Name

cellPhonestring

Cell phone number of customer

Example response

{
  "id": 2488717,
  "customerCode": "CST1200",
  "businessName": "Best company",
  "contactName": "John Smith",
  "cellPhone": "908-295-4902",
  "billingAddress": {
    "name": "John Smith / Helcim",
    "street1": "21 Jump Street",
    "street2": "Suite 400",
    "city": "Calgary",
    "province": "AB",
    "country": "CAN",
    "postalCode": "H0H0H0",
    "email": "john@example.com"
  },
  "shippingAddress": {
    "name": "John Smith / Helcim",
    "street1": "21 Jump Street",
    "street2": "Suite 400",
    "city": "Calgary",
    "province": "AB",
    "country": "CAN",
    "postalCode": "H0H0H0",
    "email": "john@example.com"
  },
  "cards": [
    {
      "cardHolderName": "John Smith",
      "cardToken": "a1b2c3d4e5f6"
    }
  ]
}

Changes