COMMERCE SERVICES

Order Service

Invoice

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

Info

Information carrier entity. It is used on Orders, DeliveryNotes and Invoices. When setting up InfoTypes on Order use the same Code for Order/OrderItem as for Basket/BasketItem if you want them to be mapped. When creating orders, info-fields will be transferred from basket to order when there is a map with the same code.

Codestring or null

The external code of the Info.

Namestring or null

The name of the Info.

Descriptionstring or null

The description of the Info.

Valuestring or null

The value of the Info.

{
  "Code": "string",
  "Name": "string",
  "Description": "string",
  "Value": "string"
}

Invoice

Information about an Invoice. Invoices are not created through the API and must be imported to Norce through Norce Connect API.

Idinteger or null(int64)

The internal id of the Invoice.

InvoiceNostring or null[ 0 .. 50 ] characters

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

InvoiceDatestring or null(date-time)

The invoice date of the Invoice.

InvoiceDueDatestring or null(date-time)

The invoice due date of the Invoice.

InvoiceTextstring or null[ 0 .. 255 ] characters

InvoiceText is taken from InvoiceMark in Norce. MaxLength: 255

OrderIdinteger or null(int64)

The internal id of the Order related to the Invoice.

OrderNostring or null[ 0 .. 50 ] characters

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

OrderDatestring or null(date-time)

The order date of the Order related to the Invoice.

Sourcestring or null[ 0 .. 255 ] characters

The Source of the Invoice. 'WEB' is used for all invoices created through Norce. MaxLength: 255

DeliveryDatestring or null(date-time)

The delivery date of the DeliveryNote related to the Invoice.

DeliveryMethodstring or null[ 0 .. 50 ] characters

The delivery method of the Order. MaxLength: 50

PaymentMethodstring or null[ 0 .. 50 ] characters

The payment method of the Order. MaxLength: 50

BillToobject or null

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

OrderFreightnumber or null(decimal)

The total amount for freight on the Invoice.

InvoiceChargenumber or null(decimal)

The total amount for invoice charge on the Invoice.

InvoiceAmountExVatnumber or null(decimal)

The total amount invoiced ex VAT.

VatAmountnumber or null(decimal)

The total VAT amount invoiced.

ItemsArray of objects or null(InvoiceItem)

The invoiced items.

InfoArray of objects or null(Info)

A list of infos used to keep application specific data on the invoice. Not used for credit invoices.

InvoiceNoPspstring or null[ 0 .. 50 ] characters

The invoice number from the PSP. This is only used when the PSP issues invoices. MaxLength: 50

CreditedInvoiceNostring or null[ 0 .. 50 ] characters

The credited invoice number. This is only used for credit invoices and this is the number of the original invoice being credited. MaxLength: 50

IsDebitboolean or null

Indicates if this is a debit invoice (true) or a credit invoice (false).

GroupByKeystring or null[ 0 .. 50 ] characters

GroupByKey can be used to group invoices. All individual invoices on one summary invoice will have this set to the same value. Normal non-summary invoices will have this value set to null. MaxLength: 50

Commentstring or null[ 0 .. 250 ] characters

Free text comment on the Invoice. MaxLength: 250

InvoiceAmountIncVatnumber or null(decimal)

The total amount invoiced inc VAT.

{
  "Id": 0,
  "InvoiceNo": "string",
  "InvoiceDate": "2019-08-24T14:15:22Z",
  "InvoiceDueDate": "2019-08-24T14:15:22Z",
  "InvoiceText": "string",
  "OrderId": 0,
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Source": "string",
  "DeliveryDate": "2019-08-24T14:15:22Z",
  "DeliveryMethod": "string",
  "PaymentMethod": "string",
  "BillTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "OrderFreight": 0,
  "InvoiceCharge": 0,
  "InvoiceAmountExVat": 0,
  "VatAmount": 0,
  "Items": [
    { … }
  ],
  "Info": [
    { … }
  ],
  "InvoiceNoPsp": "string",
  "CreditedInvoiceNo": "string",
  "IsDebit": true,
  "GroupByKey": "string",
  "Comment": "string",
  "InvoiceAmountIncVat": 0
}

InvoiceItem

Information about each item on an Invoice.

RowNumbernumber or null(decimal)

The row number of the item.

ItemNostring or null[ 0 .. 50 ] characters

The PartNo of the item. MaxLength: 50

ItemDescriptionstring or null[ 0 .. 255 ] characters

The mame of the item. MaxLength: 255

Quantitynumber or null(decimal)

The quantity invoiced. This is the quantity invoiced on this InvoiceItem.

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.

RowAmountVatnumber or null(decimal)

The total VAT of the item.

DeliveryDatestring or null(date-time)

The delivery date of the item.

VatRatenumber or null(decimal)

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

UnitPriceIncVatnumber or null(decimal)

The unit price of the item, including VAT.

{
  "RowNumber": 0,
  "ItemNo": "string",
  "ItemDescription": "string",
  "Quantity": 0,
  "UnitPrice": 0,
  "UnitDiscount": 0,
  "RowAmount": 0,
  "RowAmountVat": 0,
  "DeliveryDate": "2019-08-24T14:15:22Z",
  "VatRate": 0,
  "UnitPriceIncVat": 0
}