Skip to content

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

Schemas

Schemas

Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderItem

Idstring

Id. Key property.

OrderIdstring

OrderId.

LineNumbernumber(decimal)

LineNumber.

ParentLineNumbernumber(decimal)

ParentLineNumber. Nullable.

StatusIdinteger(int32)

StatusId.

PartNostring

PartNo. MaxLength: 50. Nullable.

ExternalPartNostring

ExternalPartNo. MaxLength: 50. Nullable.

ProductNamestring

ProductName. MaxLength: 255. Nullable.

StockUnitOfMeasurementCountnumber(decimal)

StockUnitOfMeasurementCount.

PriceUnitOfMeasurementCountnumber(decimal)

PriceUnitOfMeasurementCount.

WarehouseIdinteger(int32)

WarehouseId. Nullable.

LocationIdinteger(int32)

LocationId. Nullable.

QtyOrderednumber(decimal)

QtyOrdered.

CurrencyIdinteger(int32)

CurrencyId.

VatRatenumber(decimal)

VatRate.

CostUnitnumber(decimal)

CostUnit.

PriceSalenumber(decimal)

PriceSale.

DiscountPercentagenumber(decimal)

DiscountPercentage.

DiscountAmountnumber(decimal)

DiscountAmount.

LineAmountnumber(decimal)

LineAmount.

DeliveryModestring

DeliveryMode. MaxLength: 50. Nullable.

IsPartDeliveryboolean

IsPartDelivery.

ExpectedDeliveryDatestring(date-time)

ExpectedDeliveryDate. Nullable.

ConfirmedDeliveryDatestring(date-time)

ConfirmedDeliveryDate. Nullable.

SalesRepContactIdinteger(int32)

SalesRepContactId. Nullable.

LedgerAccountstring

LedgerAccount. MaxLength: 50. Nullable.

Departmentstring

Department. MaxLength: 10. Nullable.

Centrestring

Centre. MaxLength: 10. Nullable.

TransIdstring

TransId.

ExternalStatusTextstring

ExternalStatusText. MaxLength: 255. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

LineNumberStringstring

LineNumberString. MaxLength: 50. Nullable.

PriceRecommendednumber(decimal)

PriceRecommended. Nullable.

PriceCatalognumber(decimal)

PriceCatalog. Nullable.

PriceStandardnumber(decimal)

PriceStandard. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

InvoiceItemArray of objects(OrderService.InvoiceItem)(OrderService.InvoiceItem)

InvoiceItem.

InfosArray of objects(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderItemInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderItemInfo)

Infos.

{ "Id": "string", "OrderId": "string", "LineNumber": 0, "ParentLineNumber": 0, "StatusId": 0, "PartNo": "string", "ExternalPartNo": "string", "ProductName": "string", "StockUnitOfMeasurementCount": 0, "PriceUnitOfMeasurementCount": 0, "WarehouseId": 0, "LocationId": 0, "QtyOrdered": 0, "CurrencyId": 0, "VatRate": 0, "CostUnit": 0, "PriceSale": 0, "DiscountPercentage": 0, "DiscountAmount": 0, "LineAmount": 0, "DeliveryMode": "string", "IsPartDelivery": true, "ExpectedDeliveryDate": "2019-08-24T14:15:22Z", "ConfirmedDeliveryDate": "2019-08-24T14:15:22Z", "SalesRepContactId": 0, "LedgerAccount": "string", "Department": "string", "Centre": "string", "TransId": "string", "ExternalStatusText": "string", "Created": "2019-08-24T14:15:22Z", "CreatedBy": 0, "Updated": "2019-08-24T14:15:22Z", "UpdatedBy": 0, "LineNumberString": "string", "PriceRecommended": 0, "PriceCatalog": 0, "PriceStandard": 0, "ClientId": 0, "InvoiceItem": [ {} ], "Infos": [ {} ] }

Enferno.Storm.Query.Api.DataContexts.OrderModel.Order

Idstring

Id. Key property.

ClientIdinteger(int32)

ClientId.

ApplicationIdinteger(int32)

ApplicationId. Nullable.

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.

Quotationobject(Enferno.Storm.Query.Api.DataContexts.OrderModel.Quotation)(Enferno.Storm.Query.Api.DataContexts.OrderModel.Quotation)
ItemsArray of objects(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderItem)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderItem)

Items.

InfosArray of objects(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderInfo)

Infos.

Payerobject(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)
Buyerobject(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)
ShipToobject(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)
DropPointobject(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)
{ "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", "Quotation": { "Id": 0, "ApplicationId": 0, "SalesContactId": 0, "BuyerAccountKey": "string", "BuyerAccountId": 0, "PayerAccountId": 0, "PayerAccountKey": "string", "StatusId": 0, "IsPrimary": true, "Name": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsDeletable": true, "DeleteDate": "2019-08-24T14:15:22Z", "Comment": "string", "RejectionReasonId": 0, "Modified": "2019-08-24T14:15:22Z", "Browsed": "2019-08-24T14:15:22Z", "PaymentMethodId": 0, "DeliveryMethodId": 0, "IpAddress": "string", "PayerFirstName": "string", "PayerMiddleName": "string", "PayerLastName": "string", "PayerCellPhoneNumber": "string", "PayerEmail": "string", "CurrencyId": 0, "ResellerCustomerId": 0, "IsLocked": true, "DiscountCode": "string", "IsActive": true, "ParentQuotationId": 0, "ClientId": 0, "BuyerCompanyId": 0, "PayerCompanyId": 0, "HasPaymentTransaction": true, "BuyerFirstName": "string", "BuyerMiddleName": "string", "BuyerLastName": "string", "BuyerCellPhoneNumber": "string", "BuyerEmail": "string", "CustomerOrderReference": "string", "Created": "2019-08-24T14:15:22Z", "CreatedBy": 0, "ReferId": 0, "ReferUrl": "string", "PayerSocialSecurityNumber": "string", "BuyerCustomerId": 0, "PayerCustomerId": 0, "ShipToCustomerId": 0, "RowId": "string", "PickupCode": "string", "AttestedBy": 0, "ModifiedBy": 0, "TypeId": 0, "DoHold": true, "DeliveryMethodCode": "string", "FreightPrice": 0, "Infos": [], "Items": [], "Addresses": [] }, "Items": [ {} ], "Infos": [ {} ], "Payer": { "Id": "string", "FirstName": "string", "LastName": "string", "EmailAddress": "string", "PhoneNumber": "string", "CellPhoneNumber": "string", "Created": "2019-08-24T14:15:22Z", "CreatedBy": 0, "Rowid": "string", "CompanyName": "string", "CareOf": "string", "AddressLine1": "string", "AddressLine2": "string", "ZipCode": "string", "City": "string", "Region": "string", "CountryId": 0, "ClientId": 0, "ShippingPhoneNumber": "string", "Gln": "string" }, "Buyer": { "Id": "string", "FirstName": "string", "LastName": "string", "EmailAddress": "string", "PhoneNumber": "string", "CellPhoneNumber": "string", "Created": "2019-08-24T14:15:22Z", "CreatedBy": 0, "Rowid": "string", "CompanyName": "string", "CareOf": "string", "AddressLine1": "string", "AddressLine2": "string", "ZipCode": "string", "City": "string", "Region": "string", "CountryId": 0, "ClientId": 0, "ShippingPhoneNumber": "string", "Gln": "string" }, "ShipTo": { "Id": "string", "FirstName": "string", "LastName": "string", "EmailAddress": "string", "PhoneNumber": "string", "CellPhoneNumber": "string", "Created": "2019-08-24T14:15:22Z", "CreatedBy": 0, "Rowid": "string", "CompanyName": "string", "CareOf": "string", "AddressLine1": "string", "AddressLine2": "string", "ZipCode": "string", "City": "string", "Region": "string", "CountryId": 0, "ClientId": 0, "ShippingPhoneNumber": "string", "Gln": "string" }, "DropPoint": { "Id": "string", "FirstName": "string", "LastName": "string", "EmailAddress": "string", "PhoneNumber": "string", "CellPhoneNumber": "string", "Created": "2019-08-24T14:15:22Z", "CreatedBy": 0, "Rowid": "string", "CompanyName": "string", "CareOf": "string", "AddressLine1": "string", "AddressLine2": "string", "ZipCode": "string", "City": "string", "Region": "string", "CountryId": 0, "ClientId": 0, "ShippingPhoneNumber": "string", "Gln": "string" } }

Enferno.Storm.Query.Api.DataContexts.OrderModel.Quotation

Idinteger(int32)

Id. Key property.

ApplicationIdinteger(int32)

ApplicationId.

SalesContactIdinteger(int32)

SalesContactId. Nullable.

BuyerAccountKeystring(guid)

BuyerAccountKey.

BuyerAccountIdinteger(int32)

BuyerAccountId. Nullable.

PayerAccountIdinteger(int32)

PayerAccountId. Nullable.

PayerAccountKeystring(guid)

PayerAccountKey. Nullable.

StatusIdinteger(int32)

StatusId.

IsPrimaryboolean

IsPrimary.

Namestring

Name. MaxLength: 50. Nullable.

ValidTostring(date-time)

ValidTo. Nullable.

IsDeletableboolean

IsDeletable.

DeleteDatestring(date-time)

DeleteDate. Nullable.

Commentstring

Comment. MaxLength: 250. Nullable.

RejectionReasonIdinteger(int32)

RejectionReasonId. Nullable.

Modifiedstring(date-time)

Modified. Nullable.

Browsedstring(date-time)

Browsed. Nullable.

PaymentMethodIdinteger(int32)

PaymentMethodId. Nullable.

DeliveryMethodIdinteger(int32)

DeliveryMethodId. Nullable.

IpAddressstring

IpAddress. MaxLength: 50. Nullable.

PayerFirstNamestring

PayerFirstName. MaxLength: 50. Nullable.

PayerMiddleNamestring

PayerMiddleName. MaxLength: 50. Nullable.

PayerLastNamestring

PayerLastName. MaxLength: 50. Nullable.

PayerCellPhoneNumberstring

PayerCellPhoneNumber. MaxLength: 50. Nullable.

PayerEmailstring

PayerEmail. MaxLength: 255. Nullable.

CurrencyIdinteger(int32)

CurrencyId.

ResellerCustomerIdinteger(int32)

ResellerCustomerId. Nullable.

IsLockedboolean

IsLocked. Nullable.

DiscountCodestring

DiscountCode. Nullable.

IsActiveboolean

IsActive. Nullable.

ParentQuotationIdinteger(int32)

ParentQuotationId. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

BuyerCompanyIdinteger(int32)

BuyerCompanyId. Nullable.

PayerCompanyIdinteger(int32)

PayerCompanyId. Nullable.

HasPaymentTransactionboolean

HasPaymentTransaction. Nullable.

BuyerFirstNamestring

BuyerFirstName. MaxLength: 50. Nullable.

BuyerMiddleNamestring

BuyerMiddleName. MaxLength: 50. Nullable.

BuyerLastNamestring

BuyerLastName. MaxLength: 50. Nullable.

BuyerCellPhoneNumberstring

BuyerCellPhoneNumber. MaxLength: 50. Nullable.

BuyerEmailstring

BuyerEmail. MaxLength: 255. Nullable.

CustomerOrderReferencestring

CustomerOrderReference. MaxLength: 50. Nullable.

Createdstring(date-time)

Created. Nullable.

CreatedByinteger(int32)

CreatedBy. Nullable.

ReferIdinteger(int32)

ReferId. Nullable.

ReferUrlstring

ReferUrl. MaxLength: 255. Nullable.

PayerSocialSecurityNumberstring

PayerSocialSecurityNumber. MaxLength: 50. Nullable.

BuyerCustomerIdinteger(int32)

BuyerCustomerId. Nullable.

PayerCustomerIdinteger(int32)

PayerCustomerId. Nullable.

ShipToCustomerIdinteger(int32)

ShipToCustomerId. Nullable.

RowIdstring

RowId. MaxLength: 8. Nullable.

PickupCodestring

PickupCode. MaxLength: 50. Nullable.

AttestedByinteger(int32)

AttestedBy. Nullable.

ModifiedByinteger(int32)

ModifiedBy. Nullable.

TypeIdinteger(int32)

TypeId. Nullable.

DoHoldboolean

DoHold.

DeliveryMethodCodestring

DeliveryMethodCode. MaxLength: 50. Nullable.

FreightPricenumber(decimal)

FreightPrice. Nullable.

InfosArray of objects(Enferno.Storm.Query.Api.DataContexts.OrderModel.QuotationInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.QuotationInfo)

Infos.

ItemsArray of objects(OrderService.QuotationItem)(OrderService.QuotationItem)

Items.

AddressesArray of objects(OrderService.QuotationCustomerAddress)(OrderService.QuotationCustomerAddress)

Addresses.

{ "Id": 0, "ApplicationId": 0, "SalesContactId": 0, "BuyerAccountKey": "string", "BuyerAccountId": 0, "PayerAccountId": 0, "PayerAccountKey": "string", "StatusId": 0, "IsPrimary": true, "Name": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsDeletable": true, "DeleteDate": "2019-08-24T14:15:22Z", "Comment": "string", "RejectionReasonId": 0, "Modified": "2019-08-24T14:15:22Z", "Browsed": "2019-08-24T14:15:22Z", "PaymentMethodId": 0, "DeliveryMethodId": 0, "IpAddress": "string", "PayerFirstName": "string", "PayerMiddleName": "string", "PayerLastName": "string", "PayerCellPhoneNumber": "string", "PayerEmail": "string", "CurrencyId": 0, "ResellerCustomerId": 0, "IsLocked": true, "DiscountCode": "string", "IsActive": true, "ParentQuotationId": 0, "ClientId": 0, "BuyerCompanyId": 0, "PayerCompanyId": 0, "HasPaymentTransaction": true, "BuyerFirstName": "string", "BuyerMiddleName": "string", "BuyerLastName": "string", "BuyerCellPhoneNumber": "string", "BuyerEmail": "string", "CustomerOrderReference": "string", "Created": "2019-08-24T14:15:22Z", "CreatedBy": 0, "ReferId": 0, "ReferUrl": "string", "PayerSocialSecurityNumber": "string", "BuyerCustomerId": 0, "PayerCustomerId": 0, "ShipToCustomerId": 0, "RowId": "string", "PickupCode": "string", "AttestedBy": 0, "ModifiedBy": 0, "TypeId": 0, "DoHold": true, "DeliveryMethodCode": "string", "FreightPrice": 0, "Infos": [ {} ], "Items": [ {} ], "Addresses": [ {} ] }

Orders

Operations