Documentation CustomerService (1.1)

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

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://demo.storm.io/api/1.1/

Schemas

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"
  }
}

Flag

Idinteger(int32)

The internal Id of the Flag.

Namestring

The Name of the Flag. MaxLength: 50.

Groupinteger(int32)

The GroupId of the Flag.

IsSelectedboolean

Indicates if the Flag is selected or not.

{
  "Id": 0,
  "Name": "string",
  "Group": 0,
  "IsSelected": true
}

Login

LoginNamestring

User login name MaxLength: 255.

Passwordstring

User's password MaxLength: 4000.

CultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application. MaxLength: 16.

IncludeCompaniesstring

Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true. MaxLength: bool.

{
  "LoginName": "string",
  "Password": "string",
  "CultureCode": "string",
  "IncludeCompanies": "string"
}

Accounts

Operations

Address

Operations

Companies

Operations

Contacts

Operations

Customers

Operations

Flags

Operations

InfoTypes

Operations

PriceLists

Operations