Sending notifications to third-party services

30 March 2019 Integrations Leave a comment 543 Views Leave review

Rating 5 (3 Votes)

NotificationOrder

Name	Type	Format	Mandatory	Description
orderId	int		+	Unique order identifier
orderDate	string	yyyyMMddHHmmss	+	Date and time of order initialization
payDate	string	yyyyMMddHHmmss	-	This field is present only for orders in statuses: Commited = 6, CommitedManually = 7, Failed = 10, Cancelled = 15. Contains the date and time of the relevant transaction (for example, payment or cancellation)
orderStatus	int	See description of OrderStatus	+	Order status
paySystem	int	See description of PaySystem	-	Payment system chosen by the user to pay for the order
clientName	string		-	Name of the client
clientPhone	string		-	Customer phone
clientEmail	string		+	Customer Email Address
clientComment	string		-	Customer's comment on the order (in the case of order processing via manual payment - this also includes information about manual payment)
orderSum	decimal		+	Order amount (all discounts are included, summed up the cost of all goods in the case when several copies of the product are purchased)
currency	int	See description of Сurrency	-	Order currency
additionalData	object	See description of NotificationOrderLine	-	Additional ordering information
orderLines	object	See description of NotificationAdditionalOrderData	+	Information about the goods included in the order

NotificationOrderLine

Name	Type	Format	Mandatory	Description
lineId	int		+	Order Line ID
productId	int		+	Item ID
promoactionId	int		-	Promotion ID
productName	string		+	Product Name
productPrice	decimal		+	Product price (discounts and other are not taken into account here)
count	int		+	Number of goods
sum	decimal		+	Amount with discounts and quantity of goods
currency	int	See description of Сurrency	+	Item Currency
discountType	int	See description of DiscountType	-	Discount type - can be either a percentage of the amount or an absolute value in the commodity currency
discountValue	decimal		-	Discount Type
promoCode	string		-	Promo code

NotificationAdditionalOrderData

Name	Type	Format	Mandatory	Description
payPhone	string		-	Payment phone number (to which the payment system is registered) is used only if it is mandatory for the payment system (for example, as in Qiwi)
pin	string		-	PIN code (if it was issued for this order)
manualInfo	object	See description of ManualOrderData	-	Order information if this order was made through a manual payment system

ManualOrderData

Name	Type	Format	Mandatory	Description
keeperNumber	string		-	Payment Wallet Number
protectionCode	string	-	Patron code
provider	string		-	Name of payment method

Сurrency:
USD = 840,
UAH = 980,
RUB = 643,
EUR = 978

OrderStatus:
Init = 0 – order created
Waiting = 3 – order is awaiting payment
Commited = 6 – order has been paid
CommitedManually = 7 – order is manually confirmed
Granted = 8 – order created as gift
Failed = 10 – the payment system determined that an error occurred during the payment processing
Cancelled = 15 – the order is canceled (by the payment system), as a rule, due to user actions

PaySystem:
Interkassa = 0,
PayPal = 1,
YandexMoney = 2,
Robokassa = 3,
Manual = 4,
Qiwi = 5,
LiqPay = 7

DiscountType:
Percent = 0
Money = 1
How does it work:
After successful payment of the order (or its manual confirmation), a request is sent using the POST method to the URL, which you specified in the JV settings.
Encoding - UTF8

Content-Type - application/json
Also in the Authorization header is sent a string of the form: CustomSecretKey sgdflgfdsg ==, where sgdflgfdsg == this is Base64 of your secret key, which you specified in the SP settings.