Skip to content
STORM CONNECT
/
Order Service
/
/
SendOrderStatusRequest

Documentation Norce [Storm] Connect Order Service (4.0)

The Order Service has Entities and Operations concerned with orders created in Norce [Storm].

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://connect.lab.storm.io/4.0/api

Schemas

Schemas

Promotion

Represents a promotional discount on an order row.

AppliedAmountnumber

Amount applied to the order item from this promotion.

DiscountCodestring

External code for the promotion (if configured in Norce Commerce). Max length: 50

Idinteger(int32)

Norce Commerce internal id for the promotion.

Namestring

Name of the promotion. Max length: 255

{
  "AppliedAmount": 0,
  "DiscountCode": "string",
  "Id": 0,
  "Name": "string"
}

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"Allocation""Confirmed""BackOrder""Delivered""Invoiced""Cancelled""CreditControl""PartlyDelivered""Acknowledged""ErpConfirmed"
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": "Allocation",
  "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"
  }
}

Order Notification

Operations

Order

Operations

Invoice

Operations

POS Shipment

Operations