STORM API
/
Order Service
/
Orders

Documentation OrderService (1.1)

The Orders namespace has Entities and Operations used for orders and other related Entities such as DeliveryNotes and Invoices. This namespace has nothing to do with the Checkout process where orders are created, but is more related to order history shown on pages like MyPage and such. The Order history in Storm is mostly a snapshot view of the orders as they looked when they got created in Storm, unless process integrations exists where DeliveryNotes and Invoices are passed to Storm.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://demo.storm.io/api/1.1/

DeliveryNotes

Operations

InfoTypes

Operations

Invoices

Operations

Orders

Operations

Get order by basket

Request

Returns an Order by basket internal id. Returns null if the order does not exist.

Query
basketIdinteger(int32)required

The basket internal id.

cultureCodestring

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

curl -i -X GET \
  'https://demo.storm.io/api/1.1/OrderService.svc/rest/GetOrderByBasket?basketId=0'

Responses

Success

Body
Idstring

The internal id of the Order in Storm.

QuotationIdinteger or null(int32)

The internal id of the quotation/basket used to create the Order.

OrderNostring

The external order number of the Order, usually from an ERP. MaxLength: 50.

OrderDatestring(date-time)

The order date of the Order.

Statusstring

The status text of the Order. See ListOrderStatuses for information about available statuses. MaxLength: 50.

Sourcestring

The source of the Order. 'WEB' is used for all orders created though Storm. MaxLength: 255.

Currencystring

The currency code of the Order. MaxLength: 3.

ItemsArray of objects(OrderItem)(OrderItem)

The items on the Order.

SellToobject(CustomerData)(CustomerData)
BillToobject(CustomerData)(CustomerData)
ShipToobject(CustomerData)(CustomerData)
OrderTotalIncVatnumber(decimal)

The total amount on the Order including VAT.

OrderTotalExVatnumber(decimal)

The total amount on the Order excluding VAT.

PaymentMethodstring

The payment method of the Order. MaxLength: 50.

DeliveryMethodstring

The delivery method of the Order. MaxLength: 50.

DeliveryNotesArray of objects(DeliveryNote)(DeliveryNote)

The delivery notes of the Order.

InfoArray of objects(Info)(Info)

A list of infos used to keep application specific data on the order.

TypeIdinteger(int32)

The type of the order. 1 for normal sales order and 3 for orders from subscriptions. 2 is reserved for purchase orders.

DeliveryMarkstring

The delivery mark of the Order. Gets it's value from the OrderReference field of the basket. MaxLength: 255.

DropPointobject(CustomerData)(CustomerData)
Response
{
  "Id": "string",
  "QuotationId": 0,
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Status": "string",
  "Source": "string",
  "Currency": "string",
  "Items": [
    { … }
  ],
  "SellTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "BillTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "ShipTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "OrderTotalIncVat": 0,
  "OrderTotalExVat": 0,
  "PaymentMethod": "string",
  "DeliveryMethod": "string",
  "DeliveryNotes": [
    { … }
  ],
  "Info": [
    { … }
  ],
  "TypeId": 0,
  "DeliveryMark": "string",
  "DropPoint": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  }
}

Get order by external order number

Request

Returns an Order by external order number. Return null if the Order does not exist.

Query
ordernostringrequired

The external order number.

cultureCodestring

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

curl -i -X GET \
  'https://demo.storm.io/api/1.1/OrderService.svc/rest/GetOrderByNo?orderno=string'

Responses

Success

Body
Idstring

The internal id of the Order in Storm.

QuotationIdinteger or null(int32)

The internal id of the quotation/basket used to create the Order.

OrderNostring

The external order number of the Order, usually from an ERP. MaxLength: 50.

OrderDatestring(date-time)

The order date of the Order.

Statusstring

The status text of the Order. See ListOrderStatuses for information about available statuses. MaxLength: 50.

Sourcestring

The source of the Order. 'WEB' is used for all orders created though Storm. MaxLength: 255.

Currencystring

The currency code of the Order. MaxLength: 3.

ItemsArray of objects(OrderItem)(OrderItem)

The items on the Order.

SellToobject(CustomerData)(CustomerData)
BillToobject(CustomerData)(CustomerData)
ShipToobject(CustomerData)(CustomerData)
OrderTotalIncVatnumber(decimal)

The total amount on the Order including VAT.

OrderTotalExVatnumber(decimal)

The total amount on the Order excluding VAT.

PaymentMethodstring

The payment method of the Order. MaxLength: 50.

DeliveryMethodstring

The delivery method of the Order. MaxLength: 50.

DeliveryNotesArray of objects(DeliveryNote)(DeliveryNote)

The delivery notes of the Order.

InfoArray of objects(Info)(Info)

A list of infos used to keep application specific data on the order.

TypeIdinteger(int32)

The type of the order. 1 for normal sales order and 3 for orders from subscriptions. 2 is reserved for purchase orders.

DeliveryMarkstring

The delivery mark of the Order. Gets it's value from the OrderReference field of the basket. MaxLength: 255.

DropPointobject(CustomerData)(CustomerData)
Response
{
  "Id": "string",
  "QuotationId": 0,
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Status": "string",
  "Source": "string",
  "Currency": "string",
  "Items": [
    { … }
  ],
  "SellTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "BillTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "ShipTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "OrderTotalIncVat": 0,
  "OrderTotalExVat": 0,
  "PaymentMethod": "string",
  "DeliveryMethod": "string",
  "DeliveryNotes": [
    { … }
  ],
  "Info": [
    { … }
  ],
  "TypeId": 0,
  "DeliveryMark": "string",
  "DropPoint": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  }
}

List orders [Obsolete("Use ListOrders2")]

Request

See ListOrders2 for details. ListOrders calls listOrders2 with an empty divisionCode (null). Either of companyId, customerId, fromDate or toDate must be specified.

Query
companyIdstringrequired

The internal company id for which orders are fetched.

customerIdstringrequired

The internal customer id for which orders are fetched.

statusSeedstring

A comma separated string of status ids to filter the orders.

sourcestring

The source of the order as set when created. Used to filter the orders. Usually hardcoded in the web application to WEB.

fromDatestringrequired

A from date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

toDatestringrequired

A to date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of orders to display per page.

cultureCodestring

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

curl -i -X GET \
  'https://demo.storm.io/api/1.1/OrderService.svc/rest/ListOrders?companyId=string&customerId=string&fromDate=string&toDate=string'

Responses

Success

Body
ItemCountinteger(int32)

The total number of orders. Can be used to manage paging. Use PageSize to calculate number of pages.

ItemsArray of objects(Order)(Order)

Current list of orders for the current page if paging is used. Otherwise all orders will be in the list.

Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List orders (v2) [Obsolete("Use ListOrders3")]

Request

Returns a paged order list. Either of companyId, customerId, divisionCode, fromDate or toDate must be specified.

Query
companyIdstringrequired

The internal company id for which orders are fetched.

customerIdstringrequired

The internal customer id for which orders are fetched.

statusSeedstring

A comma separated string of status ids to filter the orders.

sourcestring

The source of the order as set when created. Used to filter the orders. Usually hardcoded in the web application to WEB.

fromDatestringrequired

A from date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

toDatestringrequired

A to date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of orders to display per page.

divisionCodestringrequired

The external division code for which orders are fetched.

cultureCodestring

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

curl -i -X GET \
  'https://demo.storm.io/api/1.1/OrderService.svc/rest/ListOrders2?companyId=string&customerId=string&divisionCode=string&fromDate=string&toDate=string'

Responses

Success

Body
ItemCountinteger(int32)

The total number of orders. Can be used to manage paging. Use PageSize to calculate number of pages.

ItemsArray of objects(Order)(Order)

Current list of orders for the current page if paging is used. Otherwise all orders will be in the list.

Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List orders (v3)

Request

Returns a paged order list. Note that this method returns another entity that ListOrders2. This is a more light weight version. Either of companyId, customerId, divisionCode, fromDate or toDate must be specified.

Query
companyIdstringrequired

The internal company id for which orders are fetched.

customerIdstringrequired

The internal customer id for which orders are fetched.

statusSeedstring

A comma separated string of status ids to filter the orders.

sourcestring

The source of the order as set when created. Used to filter the orders. Usually hardcoded in the web application to WEB.

fromDatestringrequired

A from date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

toDatestringrequired

A to date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of orders to display per page.

divisionCodestringrequired

The external division code for which orders are fetched.

cultureCodestring

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

curl -i -X GET \
  'https://demo.storm.io/api/1.1/OrderService.svc/rest/ListOrders3?companyId=string&customerId=string&divisionCode=string&fromDate=string&toDate=string'

Responses

Success

Body
ItemCountinteger(int32)

The total number of orders. Can be used to manage paging. Use PageSize to calculate number of pages.

ItemsArray of objects(OrderListItem)(OrderListItem)

Current list of orders for the current page if paging is used. Otherwise all orders will be in the list.

Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List order by e-mail address

Request

Returns a paged order list. Note that this method returns another entity that ListOrders2. This is a more light weight version. EmailSeed must be specified.

Query
emailSeedstringrequired

A comma separated list of emails for which orders are fetched.

statusSeedstring

A comma separated string of status ids to filter the orders.

sourcestring

The source of the order as set when created. Used to filter the orders. Usually hardcoded in the web application to WEB.

fromDatestring

A from date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

toDatestring

A to date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of orders to display per page.

cultureCodestring

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

curl -i -X GET \
  'https://demo.storm.io/api/1.1/OrderService.svc/rest/ListOrdersByEmail?emailSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

The total number of orders. Can be used to manage paging. Use PageSize to calculate number of pages.

ItemsArray of objects(OrderListItem)(OrderListItem)

Current list of orders for the current page if paging is used. Otherwise all orders will be in the list.

Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List order statuses

Request

Lists the available order statuses.

Query
cultureCodestring

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

curl -i -X GET \
  https://demo.storm.io/api/1.1/OrderService.svc/rest/ListOrderStatuses

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Entity.

Namestring

The Name of the Entity. MaxLength: 50.

Descriptionstring

The Description of the Entity. MaxLength: 500.

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.

Codestring

The Code of the Entity. MaxLength: 50.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "ImageKey": "string",
    "Code": "string"
  }
]

Search for order

Request

Search for Orders by TrackingId, DeliveryNote or OrderNo.

Query
searchstringrequired

Tracking id, delivery note number or external order number.

cultureCodestring

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

curl -i -X GET \
  'https://demo.storm.io/api/1.1/OrderService.svc/rest/SearchOrder?search=string'

Responses

Success

Body
Idstring

The internal id of the Order in Storm.

QuotationIdinteger or null(int32)

The internal id of the quotation/basket used to create the Order.

OrderNostring

The external order number of the Order, usually from an ERP. MaxLength: 50.

OrderDatestring(date-time)

The order date of the Order.

Statusstring

The status text of the Order. See ListOrderStatuses for information about available statuses. MaxLength: 50.

Sourcestring

The source of the Order. 'WEB' is used for all orders created though Storm. MaxLength: 255.

Currencystring

The currency code of the Order. MaxLength: 3.

ItemsArray of objects(OrderItem)(OrderItem)

The items on the Order.

SellToobject(CustomerData)(CustomerData)
BillToobject(CustomerData)(CustomerData)
ShipToobject(CustomerData)(CustomerData)
OrderTotalIncVatnumber(decimal)

The total amount on the Order including VAT.

OrderTotalExVatnumber(decimal)

The total amount on the Order excluding VAT.

PaymentMethodstring

The payment method of the Order. MaxLength: 50.

DeliveryMethodstring

The delivery method of the Order. MaxLength: 50.

DeliveryNotesArray of objects(DeliveryNote)(DeliveryNote)

The delivery notes of the Order.

InfoArray of objects(Info)(Info)

A list of infos used to keep application specific data on the order.

TypeIdinteger(int32)

The type of the order. 1 for normal sales order and 3 for orders from subscriptions. 2 is reserved for purchase orders.

DeliveryMarkstring

The delivery mark of the Order. Gets it's value from the OrderReference field of the basket. MaxLength: 255.

DropPointobject(CustomerData)(CustomerData)
Response
{
  "Id": "string",
  "QuotationId": 0,
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Status": "string",
  "Source": "string",
  "Currency": "string",
  "Items": [
    { … }
  ],
  "SellTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "BillTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "ShipTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "OrderTotalIncVat": 0,
  "OrderTotalExVat": 0,
  "PaymentMethod": "string",
  "DeliveryMethod": "string",
  "DeliveryNotes": [
    { … }
  ],
  "Info": [
    { … }
  ],
  "TypeId": 0,
  "DeliveryMark": "string",
  "DropPoint": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  }
}