Event schemas

Customer

Customer and company notifications and events.

CompanyChangedNotification

ClientId
required
integer <int32>

Client identifier

ApplicationId
integer <int32>

Application identifier, if company is application unique, see client settings

CompanyId
required
integer <int32>

Norce internal id for the organization

EntityChanged
required
string

Describes what triggered the event.
Read about the different entities here.

Enum: "tClientCompany" "tClientCompanyAddress" "tClientCompanyDeliveryMethod" "tClientCompanyDiscount" "tClientCompanyDivision" "tClientCompanyFlag" "tClientCompanyInfo" "tClientCompanyPaymentMethod" "tClientCompanyPriceList" "tClientCustomer" "tClientCustomerCompany"

CustomerChangedNotification

ClientId
required
integer <int32>

Client identifier

ApplicationId
integer <int32>

Application identifier, if company is application unique, see client settings

CustomerId
required
integer <int32>

Norce internal id for the person or contact

EntityChanged
required
string

Describes what triggered the event.
Read about the different entities here.

Enum: "tApplicationAccount" "tClientCustomer" "tClientCustomerAddress" "tClientCustomerDivision" "tClientCustomerFlag" "tClientCustomerInfo" "tClientCustomerPriceList"

Order

Order and transaction related events.

InvoiceCaptureCompletedEvent

ClientId
required
integer <int32>

Client identifier

ApplicationId
required
integer <int32>

Application identifier

CapturedInvoiceId
required
integer <int32>

Norce internal id for the invoice

State
required
string

This is the state of the captured invoice.

Enum: "Captured" "Error"

OrderCancelledEvent

ClientId
required
integer <int32>

Client identifier

ApplicationId
required
integer <int32>

Application identifier

OrderId
required
integer <int64>

Norce internal id for the order

OrderNo
required
string

This is the order identifier usually from the erp-system.

ClientOrderRef
required
string

This is the quotation/basket id from Norce or any external order reference (when an external order).

CellPhone
string

This is the phone number of the buyer.

FirstName
string

This is the first name of the buyer.

LastName
string

This is the last name of the buyer.

Source
required
string

This is the source of the order. 'WEB' for Norce orders, name of marketplace or POS system is also possible.

OrderConfirmedEvent

ClientId
required
integer <int32>

Client identifier

ApplicationId
required
integer <int32>

Application identifier

OrderId
required
integer <int64>

Norce internal id for the order

OrderNo
required
string

This is the order identifier usually from the erp-system.

ClientOrderRef
required
string

This is the quotation/basket id from Norce or any external order reference (when an external order).

CellPhone
string

This is the phone number of the buyer.

FirstName
string

This is the first name of the buyer.

LastName
string

This is the last name of the buyer.

Source
required
string

This is the source of the order. 'WEB' for Norce orders, name of marketplace or POS system is also possible.

OrderDeliveredEvent

ClientId
required
integer <int32>

Client identifier

ApplicationId
required
integer <int32>

Application identifier

OrderId
required
integer <int64>

Norce internal id for the order

OrderNo
required
string

This is the order identifier usually from the erp-system.

ClientOrderRef
required
string

This is the quotation/basket id from Norce or any external order reference (when an external order).

CellPhone
string

This is the phone number of the buyer.

FirstName
string

This is the first name of the buyer.

LastName
string

This is the last name of the buyer.

Source
required
string

This is the source of the order. 'WEB' for Norce orders, name of marketplace or POS system is also possible.

OrderPartlyDeliveredEvent

ClientId
required
integer <int32>

Client identifier

ApplicationId
required
integer <int32>

Application identifier

OrderId
required
integer <int64>

Norce internal id for the order

OrderNo
required
string

This is the order identifier usually from the erp-system.

ClientOrderRef
required
string

This is the quotation/basket id from Norce or any external order reference (when an external order).

CellPhone
string

This is the phone number of the buyer.

FirstName
string

This is the first name of the buyer.

LastName
string

This is the last name of the buyer.

Source
required
string

This is the source of the order. 'WEB' for Norce orders, name of marketplace or POS system is also possible.

OrderReadyForPickupEvent

ClientId
required
integer <int32>

Client identifier

ApplicationId
required
integer <int32>

Application identifier

OrderId
required
integer <int64>

Norce internal id for the order

OrderNo
required
string

This is the order identifier usually from the erp-system.

ClientOrderRef
required
string

This is the quotation/basket id from Norce or any external order reference (when an external order).

CellPhone
string

This is the phone number of the buyer.

FirstName
string

This is the first name of the buyer.

LastName
string

This is the last name of the buyer.

Source
required
string

This is the source of the order. 'WEB' for Norce orders, name of marketplace or POS system is also possible.

DropPointCode
string

This is the drop point reference.

OrderPaymentReceivedEvent

ClientId
required
integer <int32>

Client identifier

ApplicationId
required
integer <int32>

Application identifier

ClientOrderRef
required
string

This is the quotation/basket id from Norce or any external order reference (when an external order).

ErpOrderNo
required
string

This is the order identifier usually from the erp-system.

PaymentCode
required
string

This is the payment code of the payment. Unique identifier from Norce.

PaymentMethodCode
string

This is the payment method code of the payment, the code configured on the payment method in Norce.

PaymentRef
string

This is the payment reference from the Payment Service Provider.

Amount
number <double>

This is the amount paid.

CurrencyCode
string

This is the currency code of the payment. In a three letter ISO standard format. Like 'USD', 'EUR', or 'SEK' for example.

OrderReceivedEvent

ClientId
required
integer <int32>

Client identifier

ApplicationId
required
integer <int32>

Application identifier

ClientOrderRef
required
string

This is the quotation/basket id from Norce or any external order reference (when an external order).

Email
string

This is the email address of the buyer.

CellPhone
string

This is the phone number of the buyer.

FirstName
string

This is the first name of the buyer.

LastName
string

This is the last name of the buyer.

Source
required
string

This is the source of the order. 'WEB' for Norce orders, name of marketplace or POS system is also possible.

SubscriptionFailedEvent

ClientId
required
integer <int32>

Client identifier

ApplicationId
required
integer <int32>

Application identifier

SubscriptionId
integer <int32>

Norce subscription id

RecurringOrderId
integer <int32>

This is the Norce recurring order id.

RecurringOrderScheduleId
integer <int32>

This is the Norce recurring order schedule id.

BasketId
integer <int32>

This is the current basket.

Email
string

This is the email address of the buyer.

CellPhone
string

This is the phone number of the buyer.

FirstName
string

This is the first name of the buyer.

LastName
string

This is the last name of the buyer.

ErrorMessage
string

This is the error message.

System

Notifications related to internal jobs and processes in Norce.

JobCompletedEvent

ClientId
required
integer <int32>

Client identifier

ApplicationId
integer <int32>

Application identifier

JobId
required
integer <int32>

This is the JobId of the job in Norce

StatusId
required
integer <int32>

This is the status of the outcome of the job, should be 2, 3 or 4. (1=Initialized, 2=Succeeded, 3=Failed, 4=Validation failed, 5=Validating, 6=Queued)

Enum: 1 2 3 4 5 6

Product

Product price and availability related events and notifications.

SkuPriceChangedNotification

ClientId
required
integer <int32>

Client identifier

ApplicationId
integer <int32>

Application identifier

PartNo
required
string

This is the product that has a changed price.

PricelistId
required
integer <int32>

This is the internal id in Norce for the price list that has a changed price on the product.

PricelistCode
string

This is the external codde for the price list that has a changed price on the product.

PriceSaleValue
required
number <double>

This is the actual changed price.

QuantityBreak
number <double>

This is the quantity break on the price.

SkuOnHandBreakPointNotification

ClientId
required
integer <int32>

Client identifier

ApplicationId
integer <int32>

Application identifier

PartNo
required
string

This is the product that has a changed price.

WarehouseId
required
integer <int32>

This is internal id in Norce for the Warehouse.

WarehouseCode
string

This is the external code for the Warehouse.

LocationId
required
integer <int32>

This is internal id in Norce for the Location of the Warehouse.

LocationCode
string

This is the external code for the Location of the Warehouse.

OnHandValue
required
number <double>

This is the current on hand value that triggered the event.

MinimumValue
required
number <double>

This is the configured min value for the warehouse/location for the product.

SkuChangedNotification

ClientId
required
integer <int32>

Client identifier

ApplicationId
integer <int32>

Application identifier

PartNo
required
string

This is the part number of the product changed.

EntityChanged
required
string

Describes what triggered the event.
Read about the different entities here.

Enum: "tApplicationPriceList" "tCategory" "tCategoryCulture" "tCategorySalesArea" "tClientManufacturer" "tClientProductSku" "tClientProductSkuCulture" "tClientProductSkuOnHand" "tClientProductSkuPriceList" "tClientProductSkuSalesArea" "tClientProductSkuStructureItem" "tClientProductSkuStructureItemPriceList" "tParametric" "tParametricCulture" "tParametricList" "tParametricListCulture" "tParametricMultiple" "tParametricMultipleCulture" "tPriceListClientPricing" "tProduct" "tProductAccessory" "tProductCategory" "tProductCrossell" "tProductCulture" "tProductFile" "tProductFlag" "tProductParametric" "tProductParametricCulture" "tProductParametricMultiple" "tProductPopularity" "tProductRelation" "tProductUpsell" "tVariant" "tVariantCulture"

TranslationRequestedNotification

ClientId
required
integer <int32>

Client identifier

ApplicationId
integer <int32>

Application identifier

PartNo
required
string

This is the part number of the product needing translation.

EntityChanged
required
string

Describes what triggered the event.
Read about the different entities here.

Value: "tProduct"

Supplier

Supplier product related events and notifications.

SupplierSkuChangedNotification

ClientId
required
integer <int32>

Client identifier

ApplicationId
integer <int32>

Application identifier

SupplierId
required
integer <int32>

Internal id in Norce for the Supplier.

PartNo
required
string

This is the part number of the supplier product.

EntityChanged
required
string

Describes what triggered the event.
Read about the different entities here.

Enum: "tSupplierProductSku" "tSupplierProductSkuClient"

SupplierSkuOnHandChangedNotification

ClientId
required
integer <int32>

Client identifier

ApplicationId
integer <int32>

Application identifier

SupplierId
required
integer <int32>

Internal id in Norce for the Supplier.

PartNo
required
string

This is the part number of the supplier product.

EntityChanged
required
string

Describes what triggered the event.
Read about the different entities here.

Value: "tSupplierProductSkuOnHand"

SupplierSkuPriceChangedNotification

ClientId
required
integer <int32>

Client identifier

ApplicationId
integer <int32>

Application identifier

SupplierId
required
integer <int32>

Internal id in Norce for the Supplier.

PartNo
required
string

This is the part number of the supplier product.

PricelistId
integer <int32>

Internal id in Norce for the Supplier price list.

PricelistCode
string

External code for the Supplier price list.

PriceSaleValue
number <double>

The supplier price sale that has changed.

QuantityBreak
number <double>

The supplier quantity break for the price that is changed.