COMMERCE SERVICES

Order Service

DeliveryNote

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

CustomerData

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

Companyobject or null

Information about Companies in the Order namespace.

Customerobject or null

Information about Customers in the Order namespace.

Addressobject or null

Information about Addresses in the Order namespace.

DropPointCodestring or null

The external drop point code, if any. Only set for drop points.

{
  "Company": {
    "Id": 0,
    "No": "string",
    "Name": "string",
    "OrgNo": "string"
  },
  "Customer": {
    "Id": 0,
    "No": "string",
    "FirstName": "string",
    "LastName": "string",
    "Ssn": "string",
    "Email": "string",
    "Phone": "string",
    "CellPhone": "string"
  },
  "Address": {
    "Line1": "string",
    "Line2": "string",
    "CareOf": "string",
    "City": "string",
    "ZipCode": "string",
    "Country": "string",
    "CountryCode": "string",
    "Region": "string",
    "ShippingPhoneNumber": "string",
    "GlobalLocationNo": "string"
  },
  "DropPointCode": "string"
}

DeliveryNote

Information about a DeliveryNote. DeliveryNotes are not created though the API and must be imported to Norce through Norce Connect API.

Idinteger or null(int32)

The internal Id of the DeliveryNote.

NoteNostring or null[ 0 .. 50 ] characters

The external number of the DeliveryNote. Usually a number from the ERP system. MaxLength: 50

DeliveryDatestring or null(date-time)

The delivery date of the DeliveryNote.

NoteTextstring or null[ 0 .. 255 ] characters

Free text field of the DeliveryNote. MaxLength: 255

DeliveryModestring or null[ 0 .. 50 ] characters

The delivery mode of the items for the DeliveryNote. MaxLength: 50

OrderNostring or null[ 0 .. 50 ] characters

The external order number of the Order related to the DeliveryNote. This usually comes from an ERP. MaxLength: 50

OrderDatestring or null(date-time)

The order date of the Order related to the DeliveryNote.

Culturestring or null[ 0 .. 16 ] characters

The culture code of the DeliveryNote. This is the culture code used when asking for DeliveryNotes, not the original. MaxLength: 16

YourReferencestring or null[ 0 .. 255 ] characters

Not used. MaxLength: 255

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.

SmsNotificationNumberstring or null[ 0 .. 50 ] characters

Not used. MaxLength: 50

ItemsArray of objects or null(DeliveryNoteItem)

The items delivered.

PackagesArray of objects or null(DeliveryNotePackage)

Package information for the DeliveryNote.

DivisionCodestring or null[ 0 .. 50 ] characters

The external store code for the delivering Store. MaxLength: 50

Statusstring or null[ 0 .. 50 ] characters

The status text of the DeliveryNote. 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 deliveryNote.

{
  "Id": 0,
  "NoteNo": "string",
  "DeliveryDate": "2019-08-24T14:15:22Z",
  "NoteText": "string",
  "DeliveryMode": "string",
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Culture": "string",
  "YourReference": "string",
  "SellTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "BillTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "ShipTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "SmsNotificationNumber": "string",
  "Items": [
    { … }
  ],
  "Packages": [
    { … }
  ],
  "DivisionCode": "string",
  "Status": "string",
  "Info": [
    { … }
  ]
}

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