COMMERCE SERVICES
/
Order Service
/
Orders
/
List orders (v3)

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
Languages
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

Get order by external order number

Request

Returns an Order by external order number. Return null if the Order does not exist.

Query
ordernostring

The external order number.

cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/order/1.1/GetOrderByNo \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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[ 0 .. 50 ] characters

The external order number of the Order, usually from an ERP. MaxLength: 50

OrderDatestring or null(date-time)

The order date of the Order.

Statusstring or null[ 0 .. 50 ] characters

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

Sourcestring or null[ 0 .. 255 ] characters

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

Currencystring or null[ 0 .. 3 ] characters

The currency code of the Order. MaxLength: 3

ItemsArray of objects or null(OrderItem)

The items on 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[ 0 .. 50 ] characters

The payment method of the Order. MaxLength: 50

DeliveryMethodstring or null[ 0 .. 50 ] characters

The delivery method of the Order. MaxLength: 50

DeliveryNotesArray of objects or null(DeliveryNote)

The delivery notes of the Order.

InfoArray of objects or null(Info)

A list of infos used to keep application specific data on 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[ 0 .. 255 ] characters

The delivery mark of the Order. Gets it's value from the OrderReference field of the basket. MaxLength: 255

DropPointobject or null

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

Response
application/json
{
  "Id": 0,
  "QuotationId": 0,
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Status": "string",
  "Source": "string",
  "Currency": "str",
  "Items": [
    { … }
  ],
  "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",
  "DeliveryNotes": [
    { … }
  ],
  "Info": [
    { … }
  ],
  "TypeId": 0,
  "DeliveryMark": "string",
  "DropPoint": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  }
}

Get order by basket

Request

Returns an Order by basket internal id. Returns null if the order does not exist.

Query
basketIdinteger(int32)

The basket internal id.

cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/order/1.1/GetOrderByBasket \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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[ 0 .. 50 ] characters

The external order number of the Order, usually from an ERP. MaxLength: 50

OrderDatestring or null(date-time)

The order date of the Order.

Statusstring or null[ 0 .. 50 ] characters

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

Sourcestring or null[ 0 .. 255 ] characters

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

Currencystring or null[ 0 .. 3 ] characters

The currency code of the Order. MaxLength: 3

ItemsArray of objects or null(OrderItem)

The items on 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[ 0 .. 50 ] characters

The payment method of the Order. MaxLength: 50

DeliveryMethodstring or null[ 0 .. 50 ] characters

The delivery method of the Order. MaxLength: 50

DeliveryNotesArray of objects or null(DeliveryNote)

The delivery notes of the Order.

InfoArray of objects or null(Info)

A list of infos used to keep application specific data on 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[ 0 .. 255 ] characters

The delivery mark of the Order. Gets it's value from the OrderReference field of the basket. MaxLength: 255

DropPointobject or null

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

Response
application/json
{
  "Id": 0,
  "QuotationId": 0,
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Status": "string",
  "Source": "string",
  "Currency": "str",
  "Items": [
    { … }
  ],
  "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",
  "DeliveryNotes": [
    { … }
  ],
  "Info": [
    { … }
  ],
  "TypeId": 0,
  "DeliveryMark": "string",
  "DropPoint": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  }
}

List orders (v3)

Request

Returns a paged order list. Note that this method returns another entity that ListOrders2. This is a more light weight version. Either of companyId, customerId, divisionCode, fromDate or toDate must be specified.

Query
companyIdstring

The internal company id for which orders are fetched.

customerIdstring

The internal customer id for which orders are fetched.

statusSeedstring

(Optional) A comma separated string of status ids to filter the orders.

sourcestring

(Optional) The source of the order as set when created. Used to filter the orders. Usually hardcoded in the web application to WEB.

fromDatestring

A from date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

toDatestring

A to date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

pageNostring

(Optional) Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

(Optional) Number of orders to display per page.

divisionCodestring

The external division code for which orders are fetched.

cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/order/1.1/ListOrders3 \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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(OrderListItem)

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

Response
application/json
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List order by e-mail address

Request

Returns a paged order list. Note that this method returns another entity that ListOrders2. This is a more light weight version. EmailSeed must be specified.

Query
emailSeedstring

A comma separated list of emails for which orders are fetched.

statusSeedstring

(Optional) A comma separated string of status ids to filter the orders.

sourcestring

(Optional) The source of the order as set when created. Used to filter the orders. Usually hardcoded in the web application to WEB.

fromDatestring

(Optional) A from date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

toDatestring

(Optional) A to date used to filter orders. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

pageNostring

(Optional) Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

(Optional) Number of orders to display per page.

cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/order/1.1/ListOrdersByEmail \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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(OrderListItem)

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

Response
application/json
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

Search for order

Request

Search for Orders by TrackingId, DeliveryNote or OrderNo.

Query
searchstring

Tracking id, delivery note number or external order number.

cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/order/1.1/SearchOrder \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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[ 0 .. 50 ] characters

The external order number of the Order, usually from an ERP. MaxLength: 50

OrderDatestring or null(date-time)

The order date of the Order.

Statusstring or null[ 0 .. 50 ] characters

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

Sourcestring or null[ 0 .. 255 ] characters

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

Currencystring or null[ 0 .. 3 ] characters

The currency code of the Order. MaxLength: 3

ItemsArray of objects or null(OrderItem)

The items on 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[ 0 .. 50 ] characters

The payment method of the Order. MaxLength: 50

DeliveryMethodstring or null[ 0 .. 50 ] characters

The delivery method of the Order. MaxLength: 50

DeliveryNotesArray of objects or null(DeliveryNote)

The delivery notes of the Order.

InfoArray of objects or null(Info)

A list of infos used to keep application specific data on 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[ 0 .. 255 ] characters

The delivery mark of the Order. Gets it's value from the OrderReference field of the basket. MaxLength: 255

DropPointobject or null

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

Response
application/json
{
  "Id": 0,
  "QuotationId": 0,
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Status": "string",
  "Source": "string",
  "Currency": "str",
  "Items": [
    { … }
  ],
  "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",
  "DeliveryNotes": [
    { … }
  ],
  "Info": [
    { … }
  ],
  "TypeId": 0,
  "DeliveryMark": "string",
  "DropPoint": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  }
}

List order statuses

Request

Lists the available order statuses.

Query
cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/order/1.1/ListOrderStatuses \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
Idinteger or null(int32)

The internal Id of the Entity.

Namestring or null

The Name of the Entity.

Descriptionstring or null

The Description of the Entity.

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.

Codestring or null

The Code of the Entity.

]
Response
application/json
[
  {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
    "Code": "string"
  }
]

Schemas