Skip to content
COMMERCE QUERY
/
Customers
/
/
Enferno.Storm.Query.Api.D...

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://customer-slug.api-se.norce.tech/commerce/query/2.0/

Schemas

Schemas

Enferno.Storm.Query.Api.DataContexts.CustomerModel.Customer

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.

{
  "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": [
    { … }
  ]
}

Enferno.Storm.Query.Api.DataContexts.CustomerModel.Company

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.

{
  "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": [
    { … }
  ]
}

Enferno.Storm.Query.Api.DataContexts.CustomerModel.CustomerOrder

Idstring

Id. Key property.

ClientIdinteger(int32)

ClientId.

ApplicationIdinteger(int32)

ApplicationId.

QuotationIdinteger(int32)

QuotationId. Nullable.

OrderNostring

OrderNo. MaxLength: 50. Nullable.

OrderDatestring(date-time)

OrderDate.

BuyerCompanyCodestring

BuyerCompanyCode. MaxLength: 50. Nullable.

BuyerCompanyIdinteger(int32)

BuyerCompanyId. Nullable.

BuyerCustomerCodestring

BuyerCustomerCode. MaxLength: 50. Nullable.

BuyerCustomerIdinteger(int32)

BuyerCustomerId. Nullable.

PayerCompanyCodestring

PayerCompanyCode. MaxLength: 50. Nullable.

PayerCompanyIdinteger(int32)

PayerCompanyId. Nullable.

PayerCustomerCodestring

PayerCustomerCode. MaxLength: 50. Nullable.

PayerCustomerIdinteger(int32)

PayerCustomerId. Nullable.

ResellerCompanyCodestring

ResellerCompanyCode. MaxLength: 50. Nullable.

ResellerCompanyIdinteger(int32)

ResellerCompanyId. Nullable.

ResellerCustomerCodestring

ResellerCustomerCode. MaxLength: 50. Nullable.

ResellerCustomerIdinteger(int32)

ResellerCustomerId. Nullable.

GroupCodestring

GroupCode. MaxLength: 50. Nullable.

StatusIdinteger(int32)

StatusId.

SalesRepContactIdinteger(int32)

SalesRepContactId. Nullable.

Sourcestring

Source. MaxLength: 255. Nullable.

DeliveryTermsstring

DeliveryTerms. MaxLength: 10. Nullable.

DeliveryModestring

DeliveryMode. MaxLength: 50. Nullable.

DeliveryDatestring(date-time)

DeliveryDate. Nullable.

IsPartDeliveryboolean

IsPartDelivery.

PaymentTermsstring

PaymentTerms. MaxLength: 100. Nullable.

CurrencyIdinteger(int32)

CurrencyId.

VatRatenumber(decimal)

VatRate.

CashDiscountnumber(decimal)

CashDiscount.

LineDiscountnumber(decimal)

LineDiscount.

FreightCostnumber(decimal)

FreightCost.

OrderFeenumber(decimal)

OrderFee.

DeliveryAttentionstring

DeliveryAttention. MaxLength: 100. Nullable.

DeliveryCareOfstring

DeliveryCareOf. MaxLength: 100. Nullable.

DeliveryAddressLine1string

DeliveryAddressLine1. MaxLength: 255. Nullable.

DeliveryAddressLine2string

DeliveryAddressLine2. MaxLength: 255. Nullable.

DeliveryZipCodestring

DeliveryZipCode. MaxLength: 50. Nullable.

DeliveryCitystring

DeliveryCity. MaxLength: 50. Nullable.

DeliveryRegionstring

DeliveryRegion. MaxLength: 100. Nullable.

DeliveryCountryIdinteger(int32)

DeliveryCountryId. Nullable.

LedgerAccountstring

LedgerAccount. MaxLength: 50. Nullable.

Departmentstring

Department. MaxLength: 10. Nullable.

Centrestring

Centre. MaxLength: 10. Nullable.

ExternalPurchaseNostring

ExternalPurchaseNo. MaxLength: 50. Nullable.

SalesCodestring

SalesCode. MaxLength: 50. Nullable.

DeliveryMarkstring

DeliveryMark. MaxLength: 255. Nullable.

InvoiceMarkstring

InvoiceMark. MaxLength: 255. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

PayerCustomerInfoIdstring

PayerCustomerInfoId. Nullable.

EstimatedDeliveryTimestring(date-time)

EstimatedDeliveryTime. Nullable.

DeliveryTimestring(date-time)

DeliveryTime. Nullable.

BuyerCustomerInfoIdstring

BuyerCustomerInfoId. Nullable.

ShipToCustomerInfoIdstring

ShipToCustomerInfoId. Nullable.

ExternalRefstring

ExternalRef. MaxLength: 50. Nullable.

PaymentMethodIdinteger(int32)

PaymentMethodId. Nullable.

DeliveryMethodIdinteger(int32)

DeliveryMethodId. Nullable.

OrderTypeIdinteger(int32)

OrderTypeId. Nullable.

IsForgottenboolean

IsForgotten.

ForgottenByinteger(int32)

ForgottenBy. Nullable.

ForgottenDatestring(date-time)

ForgottenDate. Nullable.

DropPointCustomerInfoIdstring

DropPointCustomerInfoId. Nullable.

DropPointCodestring

DropPointCode. MaxLength: 50. Nullable.

Yearinteger(int32)

Year. Nullable.

Weekinteger(int32)

Week. Nullable.

Companyobject(Enferno.Storm.Query.Api.DataContexts.CustomerModel.Company)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.Company)
Customerobject(Enferno.Storm.Query.Api.DataContexts.CustomerModel.Customer)(Enferno.Storm.Query.Api.DataContexts.CustomerModel.Customer)
{
  "Id": "string",
  "ClientId": 0,
  "ApplicationId": 0,
  "QuotationId": 0,
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "BuyerCompanyCode": "string",
  "BuyerCompanyId": 0,
  "BuyerCustomerCode": "string",
  "BuyerCustomerId": 0,
  "PayerCompanyCode": "string",
  "PayerCompanyId": 0,
  "PayerCustomerCode": "string",
  "PayerCustomerId": 0,
  "ResellerCompanyCode": "string",
  "ResellerCompanyId": 0,
  "ResellerCustomerCode": "string",
  "ResellerCustomerId": 0,
  "GroupCode": "string",
  "StatusId": 0,
  "SalesRepContactId": 0,
  "Source": "string",
  "DeliveryTerms": "string",
  "DeliveryMode": "string",
  "DeliveryDate": "2019-08-24T14:15:22Z",
  "IsPartDelivery": true,
  "PaymentTerms": "string",
  "CurrencyId": 0,
  "VatRate": 0,
  "CashDiscount": 0,
  "LineDiscount": 0,
  "FreightCost": 0,
  "OrderFee": 0,
  "DeliveryAttention": "string",
  "DeliveryCareOf": "string",
  "DeliveryAddressLine1": "string",
  "DeliveryAddressLine2": "string",
  "DeliveryZipCode": "string",
  "DeliveryCity": "string",
  "DeliveryRegion": "string",
  "DeliveryCountryId": 0,
  "LedgerAccount": "string",
  "Department": "string",
  "Centre": "string",
  "ExternalPurchaseNo": "string",
  "SalesCode": "string",
  "DeliveryMark": "string",
  "InvoiceMark": "string",
  "Created": "2019-08-24T14:15:22Z",
  "CreatedBy": 0,
  "Updated": "2019-08-24T14:15:22Z",
  "UpdatedBy": 0,
  "PayerCustomerInfoId": "string",
  "EstimatedDeliveryTime": "2019-08-24T14:15:22Z",
  "DeliveryTime": "2019-08-24T14:15:22Z",
  "BuyerCustomerInfoId": "string",
  "ShipToCustomerInfoId": "string",
  "ExternalRef": "string",
  "PaymentMethodId": 0,
  "DeliveryMethodId": 0,
  "OrderTypeId": 0,
  "IsForgotten": true,
  "ForgottenBy": 0,
  "ForgottenDate": "2019-08-24T14:15:22Z",
  "DropPointCustomerInfoId": "string",
  "DropPointCode": "string",
  "Year": 0,
  "Week": 0,
  "Company": {
    "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": [ … ]
  },
  "Customer": {
    "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": [ … ]
  }
}

Customers

Operations