Skip to content
COMMERCE CONNECT
/
Order Service
/
/
Shipment

Documentation Norce Commerce Connect Order Service (4.0)

The Order Service has Entities and Operations concerned with orders created in Norce Commerce.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/connect/4.0/

Schemas

Schemas

SendOrderStatusRequest

Order update request. Either ClientOrderRef or ErpOrderNo must be provided.

ClientOrderRefinteger(int32)required

Quotation/basket id. Used for order matching as reference.

ErpOrderNostringrequired

ERP order number. Used for order matching.

OrderStatusstringrequired

Order status.

Enum"Created""Allocation""Confirmed""BackOrder""Delivered""Invoiced""Cancelled""CreditControl""PartlyDelivered""Acknowledged"
AccountIdinteger(int32)

Norce Commerce account used for order update.

InfosArray of objects(OrderInfo)(OrderInfo)

List of additional order information fields.

{
  "ClientOrderRef": 0,
  "ErpOrderNo": "string",
  "OrderStatus": "Created",
  "AccountId": 0,
  "Infos": [
    { … }
  ]
}

Shipment

Information about shipment to POS system. Either DeliveryNoteNo or InvoiceNo and Items must be provided.

ApplicationKeystring(uuid)required

Application identifier

DeliveryNoteNostringrequired

External identifier for the delivery note.

InvoiceNostringrequired

External identifier for related invoice.

ShipmentNostringrequired

External identifier for shipment.

SourceWarehouseCodestringrequired

External identifier for the warehouse to ship items from.

TargetWarehouseCodestringrequired

External identifier for the warehouse to receive the items.

Barcodestring

Barcode for whole shipment (individual shipment packages may have individual barcodes)

CarrierNamestring

Carrier service name

CarrierReferencestring

Carrier service shipment reference

CarrierTrackingUrlstring(uri)

Carrier service tracking url.

Commentstring

User comment.

ItemsArray of objects(ShipmentItem)(ShipmentItem)

Items in the shipment

ReceiverNamestring

Name of receiver

SenderNamestring

Name of sender

ShipmentPackagesArray of objects(ShipmentPackage)(ShipmentPackage)

List of shipment parts.

ShipmentWarehouseobject(Address)(Address)

Represents person or company address.

TargetWarehouseAddressobject(Address)(Address)

Represents person or company address.

{
  "ApplicationKey": "15d62d1f-3a4e-4111-845a-4db40bf08e87",
  "DeliveryNoteNo": "string",
  "InvoiceNo": "string",
  "ShipmentNo": "string",
  "SourceWarehouseCode": "string",
  "TargetWarehouseCode": "string",
  "Barcode": "string",
  "CarrierName": "string",
  "CarrierReference": "string",
  "CarrierTrackingUrl": "http://example.com",
  "Comment": "string",
  "Items": [
    { … }
  ],
  "ReceiverName": "string",
  "SenderName": "string",
  "ShipmentPackages": [
    { … }
  ],
  "ShipmentWarehouse": {
    "Box": "string",
    "CareOf": "string",
    "City": "string",
    "Country": "string",
    "Line1": "string",
    "Line2": "string",
    "Region": "string",
    "Type": "string",
    "ZipCode": "string"
  },
  "TargetWarehouseAddress": {
    "Box": "string",
    "CareOf": "string",
    "City": "string",
    "Country": "string",
    "Line1": "string",
    "Line2": "string",
    "Region": "string",
    "Type": "string",
    "ZipCode": "string"
  }
}

ShipmentItem

Items in a POS shipment

LineNointeger(int32)required

Line number

PartNostringrequired

The item's part number

Quantityinteger(int32)required

Quantity of the item

Namestring

Name of the item.

PackageNostring

External reference to which shipment package that includes this item.

Pricenumber

Deprecated. Use PurchaseCost.

PurchaseCostnumber

Purchase cost of the item.

UnitCostnumber

Unit cost of the item.

{
  "LineNo": 0,
  "PartNo": "string",
  "Quantity": 0,
  "Name": "string",
  "PackageNo": "string",
  "Price": 0,
  "PurchaseCost": 0,
  "UnitCost": 0
}

Order Notification

Operations

Order

Operations

Invoice

Operations

POS Shipment

Operations