STORM API

Order Service

OrderListItem

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

Servers

https://demo.storm.io/api/1.1/

Schemas

OrderItem

RowNumbernumber(decimal)

The row number of the OrderItem.

PartNostring

The PartNo of the OrderItem. MaxLength: 50.

Namestring

The name of the OrderItem. MaxLength: 255.

QtyOrderednumber(decimal)

The quantity ordered. This is the total quantity ordered.

UnitPricenumber(decimal)

The unit price of the Item, excluding VAT.

UnitDiscountnumber(decimal)

The unit discount of the Item, excluding VAT.

RowAmountnumber(decimal)

The total amount of the Item, excluding VAT.

VatRatenumber(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

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.

Typeinteger(int32)

Sku type internal id for this order item.

Statusstring

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

InfoArray of objects(Info)(Info)

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

ParentRowNumbernumber or null(decimal)

The parent row number of the OrderItem, if any.

PriceRecommendednumber or null(decimal)

This is the recommended price of the item when the order was created.

PriceCatalognumber or null(decimal)

This is the catalog price of the item when the order was created.

PriceStandardnumber or null(decimal)

This is the standard price of the item when the order was created.

UnitPriceIncVatnumber(decimal)

The unit price of the item, including VAT.

{
  "RowNumber": 0,
  "PartNo": "string",
  "Name": "string",
  "QtyOrdered": 0,
  "UnitPrice": 0,
  "UnitDiscount": 0,
  "RowAmount": 0,
  "VatRate": 0,
  "ImageKey": "string",
  "Type": 0,
  "Status": "string",
  "Info": [
    { … }
  ],
  "ParentRowNumber": 0,
  "PriceRecommended": 0,
  "PriceCatalog": 0,
  "PriceStandard": 0,
  "UnitPriceIncVat": 0
}

OrderListItem

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 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.

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.

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 its value from the OrderReference field of the basket. MaxLength: 255.

DropPointobject(CustomerData)(CustomerData)

ItemsArray of objects(OrderItem)(OrderItem)

The items on the Order.

InfoArray of objects(Info)(Info)

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

{
  "Id": "string",
  "QuotationId": 0,
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Status": "string",
  "Source": "string",
  "Currency": "string",
  "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",
  "TypeId": 0,
  "DeliveryMark": "string",
  "DropPoint": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "Items": [
    { … }
  ],
  "Info": [
    { … }
  ]
}

OrderPagedList

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.

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

DeliveryNotes

Operations

InfoTypes

Operations

Invoices

Operations

Orders

Operations