Skip to content
STORM API
/
Customer Service
/
/
Customer

Documentation CustomerService (1.1)

The Customers namespace has Entities and Operations concerned with Customer and Company management.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://demo.storm.io/api/1.1/

Schemas

Schemas

Contact

Idinteger or null(int32)

The internal Id of the Contact.

Keystring(guid)

The system wide unique Key for the Contact.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

ResponsibilityIdinteger(int32)

The ResponsibilityId of the Contact.

Emailstring

The Email of the Contact. MaxLength: 255.

FirstNamestring

The FirstName of the Contact. MaxLength: 50.

LastNamestring

The LastName of the Contact. MaxLength: 50.

Phonestring

The Phone number of the Contact. MaxLength: 50.

CellPhonestring

The CellPhone number of the Contact. MaxLength: 50.

ImagePathstring

MaxLength: 255. Obsolete! - Use ImageKey

ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

{
  "Id": 0,
  "Key": "string",
  "Code": "string",
  "ResponsibilityId": 0,
  "Email": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ImagePath": "string",
  "ImageKey": "string"
}

Customer

Idinteger or null(int32)

The internal Storm Id of the Customer. When creating a new Customer leave this blank as Storm will generate the Id.

Keystring(guid)

The system wide unique Key of the Customer.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

Emailstring

The Email address of the Customer. MaxLength: 255.

SSNstring

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50.

FirstNamestring

The FirstName of the Customer. MaxLength: 50.

LastNamestring

The LastName of the Customer. MaxLength: 50.

Phonestring

The PhoneNumber of the Customer. MaxLength: 50.

CellPhonestring

The CellPhone number of the Customer. MaxLength: 50.

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring

Used to tag a Customer with an incoming URL. MaxLength: 255.

Accountobject(Account)(Account)
CompaniesArray of objects(Company)(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects(Address)(Address)

A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.

InvoiceAddressobject(Address)(Address)
FlagsArray of objects(Flag)(Flag)

A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.

UseInvoiceAddressAsDeliveryAddressboolean

Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.

InfoArray of objects(IdValue)(IdValue)

Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.

CrmIdstring

Used to save the Customers external id from a crm-system MaxLength: 50.

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

{
  "Id": 0,
  "Key": "string",
  "Code": "string",
  "Email": "string",
  "SSN": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "string",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true
  },
  "Companies": [
    { … }
  ],
  "DeliveryAddresses": [
    { … }
  ],
  "InvoiceAddress": {
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

CustomerFlag

Idinteger(int32)

The internal Id of the CustomerFlag.

Namestring

The name of the CustomerFlag. MaxLength: 50.

Descriptionstring

The description of the CustomerFlag. MaxLength: max.

SortOrderinteger(int32)

The sort order of the CustomerFlag.

Groupobject(IdNameDescription)(IdNameDescription)
{
  "Id": 0,
  "Name": "string",
  "Description": "string",
  "SortOrder": 0,
  "Group": {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "ImageKey": "string",
    "Code": "string"
  }
}

Accounts

Operations

Address

Operations

Companies

Operations

Contacts

Operations

Customers

Operations

Flags

Operations

InfoTypes

Operations

PriceLists

Operations