STORM API

Order Service

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/

DeliveryNotes

Operations

Insert a delivery note [Obsolete("Not used. Delivery notes are inserted through integrations.")]

Request

Not implemented.

Body

required

The DeliveryNote to insert.

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.

curl -i -X POST \
  https://demo.storm.io/api/1.1/OrderService.svc/rest/InsertDeliveryNote \
  -H 'Content-Type: application/json' \
  -d '{
    "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": {
        "Id": 0,
        "No": "string",
        "Name": "string",
        "OrgNo": "string"
      },
      "Customer": {
        "Id": 0,
        "No": "string",
        "FirstName": "string",
        "LastName": "string",
        "SSN": "string",
        "Email": "string",
        "Phone": "string",
        "CellPhone": "string"
      },
      "Address": {
        "Line1": "string",
        "Line2": "string",
        "CareOf": "string",
        "City": "string",
        "ZipCode": "string",
        "Country": "string",
        "CountryCode": "string",
        "Region": "string",
        "ShippingPhoneNumber": "string",
        "GlobalLocationNo": "string"
      },
      "DropPointCode": "string"
    },
    "BillTo": {
      "Company": {
        "Id": 0,
        "No": "string",
        "Name": "string",
        "OrgNo": "string"
      },
      "Customer": {
        "Id": 0,
        "No": "string",
        "FirstName": "string",
        "LastName": "string",
        "SSN": "string",
        "Email": "string",
        "Phone": "string",
        "CellPhone": "string"
      },
      "Address": {
        "Line1": "string",
        "Line2": "string",
        "CareOf": "string",
        "City": "string",
        "ZipCode": "string",
        "Country": "string",
        "CountryCode": "string",
        "Region": "string",
        "ShippingPhoneNumber": "string",
        "GlobalLocationNo": "string"
      },
      "DropPointCode": "string"
    },
    "ShipTo": {
      "Company": {
        "Id": 0,
        "No": "string",
        "Name": "string",
        "OrgNo": "string"
      },
      "Customer": {
        "Id": 0,
        "No": "string",
        "FirstName": "string",
        "LastName": "string",
        "SSN": "string",
        "Email": "string",
        "Phone": "string",
        "CellPhone": "string"
      },
      "Address": {
        "Line1": "string",
        "Line2": "string",
        "CareOf": "string",
        "City": "string",
        "ZipCode": "string",
        "Country": "string",
        "CountryCode": "string",
        "Region": "string",
        "ShippingPhoneNumber": "string",
        "GlobalLocationNo": "string"
      },
      "DropPointCode": "string"
    },
    "SMSNotificationNumber": "string",
    "Items": [
      {
        "Id": 0,
        "RowNumber": 0,
        "ItemNo": "string",
        "ItemDescription": "string",
        "QtyOrdered": 0,
        "QtyDelivered": 0,
        "QtyBackordered": 0,
        "Comment": "string",
        "TrackingCodes": [
          {
            "Id": 0,
            "FreightForwarder": "string",
            "TrackingCode": "string"
          }
        ],
        "Status": "string"
      }
    ],
    "Packages": [
      {
        "Id": 0,
        "ParcelNumber": "string",
        "Status": "string"
      }
    ],
    "DivisionCode": "string",
    "Status": "string",
    "Info": [
      {
        "Code": "string",
        "Name": "string",
        "Description": "string",
        "Value": "string"
      }
    ]
  }'

Responses

Success

Body

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.

Response

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

Update a delivery note package status

Request

Updates a DeliveryNotePackage.

Query

cultureCodestring

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

Body

required

The DeliveryNotePackage to update. The DeliveryNotePackage must have and Id and Status defined or an exception will be raised.

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.

curl -i -X POST \
  https://demo.storm.io/api/1.1/OrderService.svc/rest/UpdateDeliveryNotePackage \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "ParcelNumber": "string",
    "Status": "string"
  }'

Responses

Success

Body

InfoTypes

Operations

Invoices

Operations

Orders

Operations

Documentation OrderService (1.1)

DeliveryNotes

Insert a delivery note [Obsolete("Not used. Delivery notes are inserted through integrations.")]

Request

Responses

Did the information on the page help you?

Update a delivery note package status

Request

Responses

Did the information on the page help you?

InfoTypes

Invoices

Orders

Documentation OrderService (1.1)

DeliveryNotes

Insert a delivery note [Obsolete("Not used. Delivery notes are inserted through integrations.")]

RequestExpand all

Responses

Did the information on the page help you?

Update a delivery note package status

Request

Responses

Did the information on the page help you?

InfoTypes

Invoices

Orders

Request