STORM QUERY
/
Customers
/
Customers

Storm Query API Documentation (2.0)

Storm Query API is an API based on OData V4. It is an API to fill the need for data from Storm in integration services that do not have direct access to Storm’s data and data models.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://query.storm.io/Query/2.0/

Customers

Operations

Get CustomerCompany

Request

Get CustomerCompany

curl -i -X GET \
  https://query.storm.io/Query/2.0/Customers/CustomerCompanies

Responses

Success

Bodyapplication/jsonArray [
CustomerIdinteger(int32)

CustomerId. Nullable. Key property.

CompanyIdinteger(int32)

CompanyId. Nullable. Key property.

RoleIdinteger(int32)

RoleId. Nullable.

CustomerCodePrefixstring

CustomerCodePrefix. MaxLength: 10. Nullable.

CustomerCodestring

CustomerCode. MaxLength: 50. Nullable.

Departmentstring

Department. MaxLength: 255. Nullable.

OrganizationTitlestring

OrganizationTitle. MaxLength: 50. Nullable.

IsPrimaryboolean

IsPrimary.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

Customerobject(Enferno.Storm.Query.Api.DataContexts.CustomerModel.Customer)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.Customer)
Companyobject(Enferno.Storm.Query.Api.DataContexts.CustomerModel.Company)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.Company)
]
Response
application/json
[
  {
    "CustomerId": 0,
    "CompanyId": 0,
    "RoleId": 0,
    "CustomerCodePrefix": "string",
    "CustomerCode": "string",
    "Department": "string",
    "OrganizationTitle": "string",
    "IsPrimary": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "ClientId": 0,
    "Customer": { … },
    "Company": { … }
  }
]

Get Customer

Request

Get Customer

curl -i -X GET \
  https://query.storm.io/Query/2.0/Customers/Customers

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

Keystring(guid)

Key.

ClientIdinteger(int32)

ClientId.

CustomerCodePrefixstring

CustomerCodePrefix. MaxLength: 10. Nullable.

CustomerCodestring

CustomerCode. MaxLength: 50. Nullable.

TypeIdinteger(int32)

TypeId.

EmailAddressstring

EmailAddress. MaxLength: 255. Nullable.

SocialSecurityNumberstring

SocialSecurityNumber. MaxLength: 50. Nullable.

Titlestring

Title. MaxLength: 10. Nullable.

FirstNamestring

FirstName. MaxLength: 50. Nullable.

MiddleNamestring

MiddleName. MaxLength: 50. Nullable.

LastNamestring

LastName. MaxLength: 50. Nullable.

Suffixstring

Suffix. MaxLength: 10. Nullable.

PhoneNumberstring

PhoneNumber. MaxLength: 50. Nullable.

CellPhoneNumberstring

CellPhoneNumber. MaxLength: 50. Nullable.

ReferIdinteger(int32)

ReferId. Nullable.

ReferUrlstring

ReferUrl. MaxLength: 255. Nullable.

UseBillingAddressAsShippingAddressboolean

UseBillingAddressAsShippingAddress.

OldCustomerNoPrefixstring

OldCustomerNoPrefix. MaxLength: 10. Nullable.

OldCustomerNostring

OldCustomerNo. MaxLength: 50. Nullable.

ReplacementCustomerIdinteger(int32)

ReplacementCustomerId. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

LastOrderDatestring(date-time)

LastOrderDate. Nullable.

NormalizedSocialSecurityNumberstring

NormalizedSocialSecurityNumber. MaxLength: 50. Nullable.

ApplicationIdinteger(int32)

ApplicationId. Nullable.

IsForgottenboolean

IsForgotten.

ForgottenByinteger(int32)

ForgottenBy. Nullable.

ForgottenDatestring(date-time)

ForgottenDate. Nullable.

StoppedDatestring(date-time)

StoppedDate. Nullable.

StoppedByinteger(int32)

StoppedBy. Nullable.

CrmIdstring

CrmId. MaxLength: 50. Nullable.

AccountArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.Account)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.Account)

Account.

CompaniesArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerCompany)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerCompany)

Companies.

AddressesArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerAddress)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerAddress)

Addresses.

OrdersArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerOrder)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerOrder)

Orders.

InfosArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerInfo)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerInfo)

Infos.

FlagsArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerFlag)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerFlag)

Flags.

]
Response
application/json
[
  {
    "Id": 0,
    "Key": "string",
    "ClientId": 0,
    "CustomerCodePrefix": "string",
    "CustomerCode": "string",
    "TypeId": 0,
    "EmailAddress": "string",
    "SocialSecurityNumber": "string",
    "Title": "string",
    "FirstName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Suffix": "string",
    "PhoneNumber": "string",
    "CellPhoneNumber": "string",
    "ReferId": 0,
    "ReferUrl": "string",
    "UseBillingAddressAsShippingAddress": true,
    "OldCustomerNoPrefix": "string",
    "OldCustomerNo": "string",
    "ReplacementCustomerId": 0,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "LastOrderDate": "2019-08-24T14:15:22Z",
    "NormalizedSocialSecurityNumber": "string",
    "ApplicationId": 0,
    "IsForgotten": true,
    "ForgottenBy": 0,
    "ForgottenDate": "2019-08-24T14:15:22Z",
    "StoppedDate": "2019-08-24T14:15:22Z",
    "StoppedBy": 0,
    "CrmId": "string",
    "Account": [ … ],
    "Companies": [ … ],
    "Addresses": [ … ],
    "Orders": [ … ],
    "Infos": [ … ],
    "Flags": [ … ]
  }
]

Get Company

Request

Get Company

curl -i -X GET \
  https://query.storm.io/Query/2.0/Customers/Companies

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

Keystring(guid)

Key.

ClientIdinteger(int32)

ClientId.

CompanyCodePrefixstring

CompanyCodePrefix. MaxLength: 10. Nullable.

CompanyCodestring

CompanyCode. MaxLength: 50. Nullable.

TypeIdinteger(int32)

TypeId.

LogoPathstring

LogoPath. MaxLength: 255. Nullable.

OrganizationNostring

OrganizationNo. MaxLength: 50. Nullable.

Namestring

Name. MaxLength: 100. Nullable.

EmailAddressstring

EmailAddress. MaxLength: 255. Nullable.

PhoneNumberstring

PhoneNumber. MaxLength: 50. Nullable.

FaxNumberstring

FaxNumber. MaxLength: 50. Nullable.

ParentCompanyIdinteger(int32)

ParentCompanyId. Nullable.

ReferIdinteger(int32)

ReferId. Nullable.

ReferUrlstring

ReferUrl. MaxLength: 255. Nullable.

UseBillingAddressAsShippingAddressboolean

UseBillingAddressAsShippingAddress.

OldCompanyCodePrefixstring

OldCompanyCodePrefix. MaxLength: 10. Nullable.

OldCompanyCodestring

OldCompanyCode. MaxLength: 50. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

LogoKeystring(guid)

LogoKey. Nullable.

NormalizedOrganizationNostring

NormalizedOrganizationNo. MaxLength: 50. Nullable.

ApplicationIdinteger(int32)

ApplicationId. Nullable.

VatNostring

VatNo. MaxLength: 50. Nullable.

CustomersArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerCompany)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerCompany)

Customers.

OrdersArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerOrder)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerOrder)

Orders.

InfosArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyInfo)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyInfo)

Infos.

AddressesArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyAddress)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyAddress)

Addresses.

FlagsArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyFlag)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyFlag)

Flags.

PriceListsArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyPriceList)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyPriceList)

PriceLists.

DiscountsArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyDiscount)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyDiscount)

Discounts.

DeliveryMethodsArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyDeliveryMethod)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyDeliveryMethod)

DeliveryMethods.

PaymentMethodsArray of objects(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyPaymentMethod)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.CompanyPaymentMethod)

PaymentMethods.

]
Response
application/json
[
  {
    "Id": 0,
    "Key": "string",
    "ClientId": 0,
    "CompanyCodePrefix": "string",
    "CompanyCode": "string",
    "TypeId": 0,
    "LogoPath": "string",
    "OrganizationNo": "string",
    "Name": "string",
    "EmailAddress": "string",
    "PhoneNumber": "string",
    "FaxNumber": "string",
    "ParentCompanyId": 0,
    "ReferId": 0,
    "ReferUrl": "string",
    "UseBillingAddressAsShippingAddress": true,
    "OldCompanyCodePrefix": "string",
    "OldCompanyCode": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "LogoKey": "string",
    "NormalizedOrganizationNo": "string",
    "ApplicationId": 0,
    "VatNo": "string",
    "Customers": [ … ],
    "Orders": [ … ],
    "Infos": [ … ],
    "Addresses": [ … ],
    "Flags": [ … ],
    "PriceLists": [ … ],
    "Discounts": [ … ],
    "DeliveryMethods": [ … ],
    "PaymentMethods": [ … ]
  }
]