STORM API

Order Service

DeliveryNoteItem

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

DeliveryNote

Idinteger or null(int32)

The internal Id of the DeliveryNote.

NoteNostring

The external number of the DeliveryNote. Usually a number from the ERP system. MaxLength: 50.

DeliveryDatestring(date-time)

The delivery date of the DeliveryNote.

NoteTextstring

Free text field of the DeliveryNote. MaxLength: 255.

DeliveryModestring

The delivery mode of the items for the DeliveryNote. MaxLength: 50.

OrderNostring

The external order number of the Order related to the DeliveryNote. This usually comes from an ERP. MaxLength: 50.

OrderDatestring(date-time)

The order date of the Order related to the DeliveryNote.

Culturestring

The culture code of the DeliveryNote. This is the culture code used when asking for DeliveryNotes, not the original. MaxLength: 16.

YourReferencestring

Not used. MaxLength: 255.

SellToobject(CustomerData)(CustomerData)

BillToobject(CustomerData)(CustomerData)

ShipToobject(CustomerData)(CustomerData)

SMSNotificationNumberstring

Not used. MaxLength: 50.

ItemsArray of objects(DeliveryNoteItem)(DeliveryNoteItem)

The items delivered.

PackagesArray of objects(DeliveryNotePackage)(DeliveryNotePackage)

Package information for the DeliveryNote.

DivisionCodestring

The external store code for the delivering Store. MaxLength: 50.

Statusstring

The status text of the DeliveryNote. 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 deliveryNote.

{
  "Id": 0,
  "NoteNo": "string",
  "DeliveryDate": "2019-08-24T14:15:22Z",
  "NoteText": "string",
  "DeliveryMode": "string",
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Culture": "string",
  "YourReference": "string",
  "SellTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "BillTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "ShipTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "SMSNotificationNumber": "string",
  "Items": [
    { … }
  ],
  "Packages": [
    { … }
  ],
  "DivisionCode": "string",
  "Status": "string",
  "Info": [
    { … }
  ]
}

DeliveryNoteItem

Idinteger or null(int32)

The internal id of the DeliveryNoteItem.

RowNumbernumber(decimal)

The row number of the DeliveryNoteItem.

ItemNostring

The PartNo of the DeliveryNoteItem. MaxLength: 50.

ItemDescriptionstring

The name of the DeliveryNoteItem. MaxLength: 255.

QtyOrderednumber(decimal)

The 1uantity ordered. This is the total quantity ordered.

QtyDeliverednumber(decimal)

The quantity delivered. This is the quantity delivered on this DeliverNoteItem.

QtyBackorderednumber(decimal)

The quantity not delivered. This is the quantity still missing on this DeliverNoteItem.

Commentstring

Free text comment on the DeliverNoteItem. MaxLength: 255.

TrackingCodesArray of objects(Tracking)(Tracking)

The external tracking code of the DeliveryNoteItem. Obsolete! - Not used. Tracking info is in DeliveryNotePackage.

Statusstring

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

{
  "Id": 0,
  "RowNumber": 0,
  "ItemNo": "string",
  "ItemDescription": "string",
  "QtyOrdered": 0,
  "QtyDelivered": 0,
  "QtyBackordered": 0,
  "Comment": "string",
  "TrackingCodes": [
    { … }
  ],
  "Status": "string"
}

DeliveryNotePackage

Idinteger or null(int32)

The internal id of the DeliveryNotePackage.

ParcelNumberstring

The external parcel number of the DeliveryNotePackage from the Speditor. Used to track parcels online. MaxLength: 50.

Statusstring

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

{
  "Id": 0,
  "ParcelNumber": "string",
  "Status": "string"
}

DeliveryNotes

Operations

InfoTypes

Operations

Invoices

Operations

Orders

Operations