Skip to content
STORM CONNECT
/
Order Service
/
/
Payment

Documentation Norce [Storm] Connect Order Service (4.0)

The Order Service has Entities and Operations concerned with orders created in Norce [Storm].

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://connect.lab.storm.io/4.0/api

Schemas

Schemas

OrderResponse

Represents successful order registration in receiving system.

HasErpOrderNobooleanrequired

True if ErpOrder number is provided.

StatusCodestringrequired

Order response status. Allowed values are "OK" or "Failed". Max length: 50

Enum"OK""Failed"
Descriptionstring

Use this for a more information if status code is failed. Max length: 255

ErpOrderNostring

Order number from the ERP, if available. Can be sent in with SendOrderStatus as well. Max length: 50

{
  "HasErpOrderNo": true,
  "StatusCode": "OK",
  "Description": "string",
  "ErpOrderNo": "string"
}

Payment

Represents successful payment reservation. Either PaymentCode or PaymentRef must be provided.

PaymentCodeinteger(int32)required

Payment code. Used for payment matching.

PaymentMethodCodestringrequired

Payment method that should be sent in to the ERP, the code is configurable in Norce Commerce.

PaymentRefstringrequired

Transaction identifier from 3rd party, like payment service provider.

AdditionalInfoArray of objects(CodeValue)(CodeValue)

3rd party specific information abount payment (client and PSP decides what this can contain).

Amountnumber

Amount paid or reserved including VAT after rounding rules.

CurrencyCodestring

Currency code in ISO 4217 format, e.g. "SEK", "EUR", "USD". Max length: 3

{
  "PaymentCode": 0,
  "PaymentMethodCode": "string",
  "PaymentRef": "string",
  "AdditionalInfo": [
    { … }
  ],
  "Amount": 0,
  "CurrencyCode": "string"
}

Person

Represents information about person related to an order.

Addressobject(Address)(Address)

Represents person or company address.

CellPhonestring

Mobile phone number. Max length: 50

CompanyCodestring

Always null, deprecated.

CustomerCodestring

Customer code. If exists the person is already in ERP. Max length: 50

Emailstring

Personal email. Max length: 255

FirstNamestring

Person name. Max length: 50

IsActiveboolean

Deprecated

JobTitlestring

Person job title. Max length: 10

LastNamestring

Person surname. Max length: 50

PrivatePhonestring

Private phone number. Max length: 50

SSNstring

Social security number. Max length: 50

WorkPhonestring

Work phone number. Max length: 50

{
  "Address": {
    "Box": "string",
    "CareOf": "string",
    "City": "string",
    "Country": "string",
    "Line1": "string",
    "Line2": "string",
    "Region": "string",
    "Type": "string",
    "ZipCode": "string"
  },
  "CellPhone": "string",
  "CompanyCode": "string",
  "CustomerCode": "string",
  "Email": "string",
  "FirstName": "string",
  "IsActive": true,
  "JobTitle": "string",
  "LastName": "string",
  "PrivatePhone": "string",
  "SSN": "string",
  "WorkPhone": "string"
}

Order Notification

Operations

Order

Operations

Invoice

Operations

POS Shipment

Operations