Skip to content
STORM CONNECT
/
Order Service
/
/
OrderRequest

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

OrderItem

Represents order row

Discountnumberrequired

Discount

LineNointeger(int32)required

Norce Commerce generated row identifier. Unique within the order.

PartNostringrequired

Article number (Part No) in Norce Commerce.

Quantityinteger(int32)required

Number of items ordered.

Quantity2numberrequired

Item quantity for non-integer values.

Typestringrequired

Type of product.

Enum"Undefined""ErpStandard""Refurbished""Freight""Insurance""GiftCertificate""Bid""Download""Structure""Invoice"
TypeGroupstringrequired

Product type group.

Enum"Undefined""Physical""Virtual""Fee""Service""AddedFee"
UnitPricenumberrequired

Sale price for one item only excluding VAT (to get the row amount you multiply with quantity).

UnitPriceOriginalnumberrequired

Sale price before discounts.

UnitVatnumberrequired

VAT amount for one item (to get the row VAT multiply with quantity).

VatRatenumberrequired

VAT in percent

AdditionalInfoArray of objects(CodeValue)(CodeValue)

Client specific information on order item.

Commentstring

Row comment.

Descriptionstring

Product description (ERP name in Norce Commerce).

ErpPartNostring

Article number in ERP (usually same as PartNo, different for SKU type 13 'Accumulation').

InternalProductIdinteger(int32)

Internal product id in Norce Commerce.

ParentLineNointeger(int32)

Exists if the row is a child to another row, e.g. in case of service articles or items in a package/bundle.

PriceListNointeger(int32)

Price list from which the price is derived.

PriceListsArray of objects(PriceListItem)(PriceListItem)

All price lists that the unit price original is based on. This is a list of all pricelists in the hierarchy.

PromotionsArray of objects(Promotion)(Promotion)

List of all promotions applied to the order item.

UnitOfMeasurestring

Unit of measurement, e.g. pieces, mm, g.

{
  "Discount": 0,
  "LineNo": 0,
  "PartNo": "string",
  "Quantity": 0,
  "Quantity2": 0,
  "Type": "Undefined",
  "TypeGroup": "Undefined",
  "UnitPrice": 0,
  "UnitPriceOriginal": 0,
  "UnitVat": 0,
  "VatRate": 0,
  "AdditionalInfo": [
    { … }
  ],
  "Comment": "string",
  "Description": "string",
  "ErpPartNo": "string",
  "InternalProductId": 0,
  "ParentLineNo": 0,
  "PriceListNo": 0,
  "PriceLists": [
    { … }
  ],
  "Promotions": [
    { … }
  ],
  "UnitOfMeasure": "string"
}

OrderRequest

Represents a new order from Norce Commerce

AdditionalInfoArray of objects(CodeValue)(CodeValue)

Client specific information on the order

BillToobject(ClientCustomer)(ClientCustomer)

Represents customer, either a person or a company.

ClientOrderRefstring

Usually weborder number (basket id in Norce Commerce). For orders from external source this is their number. Max length: 50

CurrencyCodestring

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

CustomerOrderCommentstring

Comment field

CustomerOrderRefstring

Buyers reference, usually added in the checkout for B2B orders. Max length: 50

DiscountsArray of objects(Discount)(Discount)

List of order discounts that are not represented on order lines. Not commonly used.

DoHoldboolean

True if web solution thinks that this order should be manually validated before processed

ErpOrderNostring

Usually empty. If exists this is a suggestion from web solution which order number the order should have in ERP. Max length: 50

FeesArray of objects(Fee)(Fee)

Collection of fees on the order. Not commonly used, the fees are mostly implemented as order items with TypeGroup "Fee".

Headerobject(Header)(Header)

Header information about order.

ItemsArray of objects(OrderItem)(OrderItem)

Collection of order rows. Other than the articles this collection can also contain fees such as freight.

OrderTypeinteger(int32)

Order type:
1 = Order
3 = Subscription/Recurring order
5 = External order

PaymentsArray of objects(Payment)(Payment)

An order can have several payments. Usually this is only one, but sometime there are an additional payment method like giftcard or a voucher.

ReferIdinteger(int32)

If order is created from a referral like an ad

SalesContactCodestring

Code of sales contact if a sales rep should be marked as seller. Max length: 50

SalesContactDivisionstring

Code of sales department if a sales dep should be marked as seller. Max length: 50

SellToobject(ClientCustomer)(ClientCustomer)

Represents customer, either a person or a company.

ShipToobject(ClientCustomer)(ClientCustomer)

Represents customer, either a person or a company.

ShippingAdviceobject(ShippingAdvice)(ShippingAdvice)

Represents order shipping information

Sourcestring

Order source. Should be WEB for all orders created from client web sites.

SubmitDatestring(DateTime)

Timestamp when order was created in Norce Commerce.

{
  "AdditionalInfo": [
    { … }
  ],
  "BillTo": {
    "Company": { … },
    "Person": { … }
  },
  "ClientOrderRef": "string",
  "CurrencyCode": "string",
  "CustomerOrderComment": "string",
  "CustomerOrderRef": "string",
  "Discounts": [
    { … }
  ],
  "DoHold": true,
  "ErpOrderNo": "string",
  "Fees": [
    { … }
  ],
  "Header": {
    "ApplicationKey": "string"
  },
  "Items": [
    { … }
  ],
  "OrderType": 0,
  "Payments": [
    { … }
  ],
  "ReferId": 0,
  "SalesContactCode": "string",
  "SalesContactDivision": "string",
  "SellTo": {
    "Company": { … },
    "Person": { … }
  },
  "ShipTo": {
    "Company": { … },
    "Person": { … }
  },
  "ShippingAdvice": {
    "DeliveryMethodCode": "string",
    "DoSMSNotify": true,
    "IsComplete": true,
    "IsFeeChargedOnce": true,
    "PickupStore": { … },
    "ShipAdvisorOrderCode": "string"
  },
  "Source": "string",
  "SubmitDate": "string"
}

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"
}

Order Notification

Operations

Order

Operations

Invoice

Operations

POS Shipment

Operations