Last updated

Event schemas

Customer

Customer and company notifications and events.

CompanyChangedNotification

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)

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

CompanyIdinteger(int32)required

Norce internal id for the organization

EntityChangedstringrequired

Describes what triggered the event.<br/>Read about the different entities <a href='/eventsettings/#companychangednotification'>here</a>.

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

CustomerChangedNotification

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)

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

CustomerIdinteger(int32)required

Norce internal id for the person or contact

EntityChangedstringrequired

Describes what triggered the event.<br/>Read about the different entities <a href='/eventsettings/#customerchangednotification'>here</a>.

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

Order

Order and transaction related events.

InvoiceCaptureCompletedEvent

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)required

Application identifier

CapturedInvoiceIdinteger(int32)required

Norce internal id for the invoice

Statestringrequired

This is the state of the captured invoice.

Enum"Captured""Error"

OrderCancelledEvent

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)required

Application identifier

OrderIdinteger(int64)required

Norce internal id for the order

OrderNostringrequired

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

ClientOrderRefstringrequired

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

CellPhonestring

This is the phone number of the buyer.

FirstNamestring

This is the first name of the buyer.

LastNamestring

This is the last name of the buyer.

Sourcestringrequired

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

OrderConfirmedEvent

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)required

Application identifier

OrderIdinteger(int64)required

Norce internal id for the order

OrderNostringrequired

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

ClientOrderRefstringrequired

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

CellPhonestring

This is the phone number of the buyer.

FirstNamestring

This is the first name of the buyer.

LastNamestring

This is the last name of the buyer.

Sourcestringrequired

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

OrderDeliveredEvent

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)required

Application identifier

OrderIdinteger(int64)required

Norce internal id for the order

OrderNostringrequired

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

ClientOrderRefstringrequired

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

CellPhonestring

This is the phone number of the buyer.

FirstNamestring

This is the first name of the buyer.

LastNamestring

This is the last name of the buyer.

Sourcestringrequired

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

OrderPartlyDeliveredEvent

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)required

Application identifier

OrderIdinteger(int64)required

Norce internal id for the order

OrderNostringrequired

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

ClientOrderRefstringrequired

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

CellPhonestring

This is the phone number of the buyer.

FirstNamestring

This is the first name of the buyer.

LastNamestring

This is the last name of the buyer.

Sourcestringrequired

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

OrderReadyForPickupEvent

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)required

Application identifier

OrderIdinteger(int64)required

Norce internal id for the order

OrderNostringrequired

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

ClientOrderRefstringrequired

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

CellPhonestring

This is the phone number of the buyer.

FirstNamestring

This is the first name of the buyer.

LastNamestring

This is the last name of the buyer.

Sourcestringrequired

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

DropPointCodestring

This is the drop point reference.

OrderPaymentReceivedEvent

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)required

Application identifier

ClientOrderRefstringrequired

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

ErpOrderNostringrequired

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

PaymentCodestringrequired

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

PaymentMethodCodestring

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

PaymentRefstring

This is the payment reference from the Payment Service Provider.

Amountnumber(double)

This is the amount paid.

CurrencyCodestring

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

OrderReceivedEvent

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)required

Application identifier

ClientOrderRefstringrequired

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

Emailstring

This is the email address of the buyer.

CellPhonestring

This is the phone number of the buyer.

FirstNamestring

This is the first name of the buyer.

LastNamestring

This is the last name of the buyer.

Sourcestringrequired

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

SubscriptionFailedEvent

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)required

Application identifier

SubscriptionIdinteger(int32)

Norce subscription id

RecurringOrderIdinteger(int32)

This is the Norce recurring order id.

RecurringOrderScheduleIdinteger(int32)

This is the Norce recurring order schedule id.

BasketIdinteger(int32)

This is the current basket.

Emailstring

This is the email address of the buyer.

CellPhonestring

This is the phone number of the buyer.

FirstNamestring

This is the first name of the buyer.

LastNamestring

This is the last name of the buyer.

ErrorMessagestring

This is the error message.

System

Notifications related to internal jobs and processes in Norce.

JobCompletedEvent

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)

Application identifier

JobIdinteger(int32)required

This is the JobId of the job in Norce

StatusIdinteger(int32)required

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)

Enum123456

Product

Product price and availability related events and notifications.

SkuPriceChangedNotification

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)

Application identifier

PartNostringrequired

This is the product that has a changed price.

PricelistIdinteger(int32)required

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

PricelistCodestring

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

PriceSaleValuenumber(double)required

This is the actual changed price.

QuantityBreaknumber(double)

This is the quantity break on the price.

SkuOnHandBreakPointNotification

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)

Application identifier

PartNostringrequired

This is the product that has a changed price.

WarehouseIdinteger(int32)required

This is internal id in Norce for the Warehouse.

WarehouseCodestring

This is the external code for the Warehouse.

LocationIdinteger(int32)required

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

LocationCodestring

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

OnHandValuenumber(double)required

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

MinimumValuenumber(double)required

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

SkuChangedNotification

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)

Application identifier

PartNostringrequired

This is the part number of the product changed.

EntityChangedstringrequired

Describes what triggered the event.<br/>Read about the different entities <a href='/eventsettings/#skuchangednotification'>here</a>.

Enum"tApplicationPriceList""tCategory""tCategoryCulture""tCategorySalesArea""tClientManufacturer""tClientProductSku""tClientProductSkuCulture""tClientProductSkuOnHand""tClientProductSkuPriceList""tClientProductSkuSalesArea"

TranslationRequestedNotification

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)

Application identifier

PartNostringrequired

This is the part number of the product needing translation.

EntityChangedstringrequired

Describes what triggered the event.<br/>Read about the different entities <a href='/eventsettings/#translationrequestednotification'>here</a>.

Value"tProduct"

Supplier

Supplier product related events and notifications.

SupplierSkuChangedNotification

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)

Application identifier

SupplierIdinteger(int32)required

Internal id in Norce for the Supplier.

PartNostringrequired

This is the part number of the supplier product.

EntityChangedstringrequired

Describes what triggered the event.<br/>Read about the different entities <a href='/eventsettings/#supplierskuchangednotification'>here</a>.

Enum"tSupplierProductSku""tSupplierProductSkuClient"

SupplierSkuOnHandChangedNotification

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)

Application identifier

SupplierIdinteger(int32)required

Internal id in Norce for the Supplier.

PartNostringrequired

This is the part number of the supplier product.

EntityChangedstringrequired

Describes what triggered the event.<br/>Read about the different entities <a href='/eventsettings/#supplierskuonhandchangednotification'>here</a>.

Value"tSupplierProductSkuOnHand"

SupplierSkuPriceChangedNotification

ClientIdinteger(int32)required

Client identifier

ApplicationIdinteger(int32)

Application identifier

SupplierIdinteger(int32)required

Internal id in Norce for the Supplier.

PartNostringrequired

This is the part number of the supplier product.

PricelistIdinteger(int32)

Internal id in Norce for the Supplier price list.

PricelistCodestring

External code for the Supplier price list.

PriceSaleValuenumber(double)

The supplier price sale that has changed.

QuantityBreaknumber(double)

The supplier quantity break for the price that is changed.