Order Notifications

Lifecycle

Order Lifecycle

Event list

The following list represents all notifications which could be sent during the purchase workflow. They are linked to the order resource.

  • Order creation
  • Transaction call
  • Fraud call
  • Order creation
  • Subscription call
  • Subscription
  • Fulfillment call
  • Fulfillment
  • Activation code
  • Update subscription with fulfillment
  • Update end user with subscription
  • Order confirmation
  • Invoice creation
  • End user creation
  • End user retrieved by email
  • Informative event
  • Order cancellation
  • Cancellation
  • Partial cancellation
  • Fulfillment cancellation
  • Subscription cancellation
  • Credit note creation

List of fields

This structure represents the body which will be sent by email and/or by webhook.

Name Description
id Order's unique identifier
status Functional status
creationDate Creation date
currency Order's Currency
totalPriceIncVAT Order's total price including sales tax
totalPriceExclVAT Order's total price excluding sales tax
payment.method Payment Method (Visa, Mastercard, Paypal, SEPA, ...)
payment.automaticBilling Specify if the payment could be renewed (true/false)
user.email Buyer's email
user.firstName Buyer's first name
user.lastName Buyer's last name
user.language Buyer's language
user.country Buyer's country
user.street Buyer's street address
user.zipcode Buyer's zipcode
user.city Buyer's city
items[] List of sold items (products, services, ...)
items[].id Order line's unique id
items[].product.name Product's name
items[].product.uniqueReference A unique identifier for the product. This id is the one that identify the product in the Nexawy Monetize Platform
items[].product.publisherReference A unique identifier for the product. This id is the one that identify your product in your information system
items[].quantity Product's quantity
items[].unitPriceIncVAT Product's unit price including sale taxes
items[].unitPriceExclVAT Product's unit price excluding sale taxes
items[].externalContext Product's external context
items[].VATRate Sold product's sale taxes amount
items[].discountRate Discount rate applied to the product

Example

{
	"subject": "order",
	"type": "orderConfirmation",
	"objectId": "17101797d2bb",
	"eventDate": "2017-08-17T11:25:33.606Z",
	"order": {
		"id": "17101797d2bb",
		"status": "COMPLETED",
		"creationDate": "2017-08-17T11:25:31Z",
		"payment": {
			"method": "visa",
			"automaticBilling": false
		},
		"totalPriceIncVAT": 357,
		"totalPriceExclVAT": 297.5,
		"currency": "USD",
		"user": {
			"email": "jdoe@com2us.com",
			"firstName": "John",
			"lastName": "Doe",
			"language": "en",
			"country": "USA",
			"street": "587 Main Street",
			"zipcode": "20005",
			"city": "Washington"
		},
		"items": [
			{
				"id": "fd58a2e5-548c-44a7-b78d-5b246c1a25cd",
				"product": {
					"name": "My product name",
					"uniqueReference": "82165493-486f-54fa-a454-65458da64c53",
					"publisherReference": "SKU-0001",
				},
				"quantity": 1,
				"externalContext": "what the customer want"
				"unitPriceIncVAT": 178.5,
				"unitPriceExclVAT": 148.75,
				"VATRate": 0.2
			}
		]
	}
}