Skip to content
STORM API
/
Customer Service
/
/
Address

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

Account

Idinteger or null(int32)

The internal Id of the Account. This value should be used as updatedBy/createdBy in API-Methods. When creating a new Account on a Customer leave this blank as Storm will generate the Id.

Keystring(guid)

The system wide unique Key for the Account.

LoginNamestring

This is the login name used when logging in. Normally this is the email address. Care must be taken when user updates their emailAddress. Normally this update is just for Customer.Email. It is up to the Application to keep Customer.Email in sync with Account.LoginName if they are the same. MaxLength: 255.

Namestring

This is the full name of the connected Customer's first and last name. MaxLength: 100.

RolesArray of integers(int32)

This is an integer list of Role.Ids. See Application.Roles for available roles for the Application. This can be used to authorize roles to different parts of an Application.

AuthorizationsArray of objects(IdValue)(IdValue)

This is an IdValue list of Authorizations. See Application.Authorizations for available values for the Application. This can be used to authorize users to different parts of an Application.

IsActiveboolean

Indicates if the Account is Active or not. Use UpdateAccountStatus to change this value.

{
  "Id": 0,
  "Key": "string",
  "LoginName": "string",
  "Name": "string",
  "Roles": [
    0
  ],
  "Authorizations": [
    { … }
  ],
  "IsActive": true
}

Address

Idinteger or null(int32)

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

CareOfstring

The CareOf of the Address. MaxLength: 100.

Line1string

The first address line of the Address. MaxLength: 255.

Line2string

The second address line of the Address. MaxLength: 255.

Zipstring

The zip code of the Address. MaxLength: 50.

Citystring

The City of the Address. MaxLength: 50.

CountryIdinteger(int32)

The internal Id for the country associated to the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Id is specified it will be used to resolve the Name. If none is specified the default for the Application will be used.

Countrystring

The country name of the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Name is specified it will be used to resolve the Name and Id. Name should then be specified as Country.Code since Names are culture specific. If none is specified the default for the Application will be used. MaxLength: 50.

Regionstring

The Region of the Address. MaxLength: 50.

IsValidatedboolean

Indicates if the address had been validated. It is up to the Application to validate addresses. Use normal address-methods to update this value.

GlobalLocationNostring

The Global Location Number (GLN) is part of the GS1 systems of standards. It is a simple tool used to identify a location and can identify locations uniquely where required. This is only used for invoice addresses. MaxLength: 50.

ShippingPhoneNumberstring

Phone number for shipping address. Only applicable in shipping addresses. MaxLength: 50.

{
  "Id": 0,
  "CareOf": "string",
  "Line1": "string",
  "Line2": "string",
  "Zip": "string",
  "City": "string",
  "CountryId": 0,
  "Country": "string",
  "Region": "string",
  "IsValidated": true,
  "GlobalLocationNo": "string",
  "ShippingPhoneNumber": "string"
}

AgreementAccount

PricelistIdinteger(int32)

The PriceListId of the PriceList logged in to.

Namestring

The Name of the AgreementAccount/PriceList. MaxLength: 50.

StartDatestring or null(date-time)

The StartDate of the AgreementAccount/PriceList.

EndDatestring or null(date-time)

The EndDate of the AgreementAccount/PriceList.

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.

ShowPricesIncVatboolean or null

Indicates if prices should be shown inc or ex VAT.

{
  "PricelistId": 0,
  "Name": "string",
  "StartDate": "2019-08-24T14:15:22Z",
  "EndDate": "2019-08-24T14:15:22Z",
  "ImageKey": "string",
  "ShowPricesIncVat": true
}

Accounts

Operations

Address

Operations

Companies

Operations

Contacts

Operations

Customers

Operations

Flags

Operations

InfoTypes

Operations

PriceLists

Operations