COMMERCE SERVICES

Order Service

DeliveryNotePackage

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

DeliveryNoteItem

Information about the items on a DeliveryNote.

Idinteger or null(int32)

The internal id of the DeliveryNoteItem.

RowNumbernumber or null(decimal)

The row number of the DeliveryNoteItem.

ItemNostring or null[ 0 .. 50 ] characters

The PartNo of the DeliveryNoteItem. MaxLength: 50

ItemDescriptionstring or null[ 0 .. 255 ] characters

The name of the DeliveryNoteItem. MaxLength: 255

QtyOrderednumber or null(decimal)

The 1uantity ordered. This is the total quantity ordered.

QtyDeliverednumber or null(decimal)

The quantity delivered. This is the quantity delivered on this DeliverNoteItem.

QtyBackorderednumber or null(decimal)

The quantity not delivered. This is the quantity still missing on this DeliverNoteItem.

Commentstring or null[ 0 .. 255 ] characters

Free text comment on the DeliverNoteItem. MaxLength: 255

Statusstring or null[ 0 .. 50 ] characters

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

TrackingCodesArray of objects or null(Tracking)Deprecated

The external tracking code of the DeliveryNoteItem.

{
  "Id": 0,
  "RowNumber": 0,
  "ItemNo": "string",
  "ItemDescription": "string",
  "QtyOrdered": 0,
  "QtyDelivered": 0,
  "QtyBackordered": 0,
  "Comment": "string",
  "TrackingCodes": [
    { … }
  ],
  "Status": "string"
}

DeliveryNotePackage

Information about each package associated with a DeliveryNote.

Idinteger or null(int32)

The internal id of the DeliveryNotePackage.

ParcelNumberstring or null

The external parcel number of the DeliveryNotePackage from the Speditor. Used to track parcels online.

Statusstring or null

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

{
  "Id": 0,
  "ParcelNumber": "string",
  "Status": "string"
}

IdNameDescription

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.

{
  "Id": 0,
  "Name": "string",
  "Description": "string",
  "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
  "Code": "string"
}