COMMERCE SERVICES

Order Service

OrderListItem

Norce Commerce Order v1.1 service (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 is mostly a snapshot view of the orders as they looked when they got created in Norce, unless process integrations exists where DeliveryNotes and Invoices are passed to Norce.

Download OpenAPI description

openapi-v1.json

openapi-v1.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

DeliveryNotes

Contains endpoints for handling package and parcel information from a POS perspective.

Operations

InfoTypes

Contains endpoints for viewing metadata for extended fields on the order and orderitems.

Operations

Invoices

Contains endpoints for viewing invoice information on orders or baskets.

Operations

Orders

Contains endpoints for viewing orders and it`s metadata.

Operations

Schemas

OrderItem

Information about the Items on an Order.

RowNumbernumber or null(decimal)

The row number of the OrderItem.

PartNostring or null[ 0 .. 50 ] characters

The PartNo of the OrderItem. MaxLength: 50

Namestring or null[ 0 .. 255 ] characters

The name of the OrderItem. MaxLength: 255

QtyOrderednumber or null(decimal)

The quantity ordered. This is the total quantity ordered.

UnitPricenumber or null(decimal)

The unit price of the Item, excluding VAT.

UnitDiscountnumber or null(decimal)

The unit discount of the Item, excluding VAT.

RowAmountnumber or null(decimal)

The total amount of the Item, excluding VAT.

VatRatenumber or null(decimal)

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

ImageKeystring or null(uuid)

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 or null(int32)

Sku type internal id for this order item.

Statusstring or null[ 0 .. 50 ] characters

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

InfoArray of objects or null(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 or null(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": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
  "Type": 0,
  "Status": "string",
  "Info": [
    { … }
  ],
  "ParentRowNumber": 0,
  "PriceRecommended": 0,
  "PriceCatalog": 0,
  "PriceStandard": 0,
  "UnitPriceIncVat": 0
}

OrderListItem

Information about an Order used in lists. This is a more light weight representation of the Order than the Order entity.

Idinteger or null(int64)

The internal id of the Order in Norce.

QuotationIdinteger or null(int32)

The internal id of the quotation/basket used to create the Order.

OrderNostring or null

The order number of the Order, usually from an ERP.

OrderDatestring or null(date-time)

The order date of the Order.

Statusstring or null

The status text of the Order. See ListOrderStatuses for information about available statuses.

Sourcestring or null

The source of the Order. 'WEB' is used for all orders created through Norce.

Currencystring or null

The currency code of the Order.

SellToobject or null

Information about the Customers in the Order namespace. It has information about Customer, any Company and addresses.

BillToobject or null

Information about the Customers in the Order namespace. It has information about Customer, any Company and addresses.

ShipToobject or null

Information about the Customers in the Order namespace. It has information about Customer, any Company and addresses.

OrderTotalIncVatnumber or null(decimal)

The total amount on the Order including VAT.

OrderTotalExVatnumber or null(decimal)

The total amount on the Order excluding VAT.

PaymentMethodstring or null

The payment method of the Order.

DeliveryMethodstring or null

The delivery method of the Order.

TypeIdinteger or null(int32)

The type of the order. 1 for normal sales order and 3 for orders from subscriptions. 2 is reserved for purchase orders.

DeliveryMarkstring or null

The delivery mark of the Order. Gets its value from the OrderReference field of the basket.

DropPointobject or null

Information about the Customers in the Order namespace. It has information about Customer, any Company and addresses.

ItemsArray of objects or null(OrderItem)

The items on the Order.

InfoArray of objects or null(Info)

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

{
  "Id": 0,
  "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

Orders in a paged list format. The Items property contains all current orders, depending on paging, and the ItemCount the total number of orders.

ItemCountinteger or null(int32)

The total number of orders. Can be used to manage paging. Use PageSize to calculate number of pages.

ItemsArray of objects or null(Order)

Current list of orders for the current page if paging is used. Otherwise all orders will be in the list.

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