# WebHook Resource
# Properties
# Endpoints
# Using fields property
We can define which fields should be sent by shoprenter when certain events occur.
For this, we need to pass the desired field names in an array in the fields property of webHookParameters.
The following table contains all the field names that can be specified, as well as which data is available for certain event types.
# Fields usable in the order confirmed event
| ## Property name | Order confirm (order_confirm) | Order status change (order_status_change) | Description |
|---|---|---|---|
| order_storeName | x | x | Shop name |
| order_innerId | x | x | Order inner id |
| order_innerResourceId | x | x | Order inner resource id |
| order_outerResourceId | x | x | Order outer id |
| order_firstname | x | x | Customer firstname |
| order_lastname | x | x | Customer lastname |
| order_phone | x | x | Customer telephone |
| order_fax | x | x | Customer tax |
| order_email | x | x | Customer email |
| order_email_hash | x | x | Customer email sha256 hash |
| order_cart_token | x | x | Cart token. That cart was been purchased. |
| order_shippingFirstname | x | x | Shipping address: Firstname |
| order_shippingLastname | x | x | Shipping address: Lastname |
| order_shippingCompany | x | x | Shipping address: Company name |
| order_shippingAddress1 | x | x | Shipping address: Address 1 |
| order_shippingAddress2 | x | x | Shipping address: Address 2 |
| order_shippingCity | x | x | Shipping address: City |
| order_shippingCountryName | x | x | Shipping address: Country name |
| order_shippingZoneName | x | x | Shipping address: Geo zone name |
| order_shippingPostcode | x | x | Shipping address: Zipcode |
| order_expectedDeliveryDate | x | Estimated delivery date (Y-m-d) | |
| order_paymentFirstname | x | x | Billing address: Firstname |
| order_paymentLastname | x | x | Billing address: Lastname |
| order_paymentCompany | x | x | Billing address: Company name |
| order_paymentAddress1 | x | x | Billing address: Address 1 |
| order_paymentAddress2 | x | x | Billing address: Address 2 |
| order_paymentCity | x | x | Billing address: City |
| order_paymentCountryName | x | x | Billing address: Country name |
| order_paymentZoneName | x | x | Billing address: Geo zone name |
| order_paymentPostcode | x | x | Billing address: Zipcode |
| order_paymentTaxnumber | x | x | Billing address: Taxnumber |
| order_shippingMethodName | x | x | Shipping method name. It will be displayed in the language in which the order was placed |
| order_shippingMethodCode | x | Shipping method inner code | |
| order_shippingNetPrice | x | x | Net price of the shipping |
| order_shippingGrossPrice | x | x | Gross price of the shipping |
| order_shippingAdditionalCostNet | x | x | Net amount of the shipping additional cost |
| order_shippingAdditionalCostGross | x | x | Gross amount of the shipping additional cost |
| order_shippingInnerResourceId | x | x | Resource id of the shipping method |
| order_shippingCountryIsoCode2 | x | x | The ISO 3166-1 alpha-2 code of the destination country of the order |
| order_shippingCountryIsoCode3 | x | x | The ISO 3166-1 alpha-3 code of the destination country of the order |
| order_paymentCountryIsoCode2 | x | x | The ISO 3166-1 alpha-2 code of the country associated with the billing address of the order. |
| order_paymentCountryIsoCode3 | x | x | The ISO 3166-1 alpha-3 code of the country associated with the billing address of the order. |
| order_paymentMethodName | x | x | Payment method name. It will be displayed in the language in which the order was placed |
| order_paymentMethodCode | x | Payment method internal code | |
| order_paymentNetPrice | x | x | Net price for the payment method |
| order_paymentGrossPrice | x | x | Gross price for payment method |
| order_couponCode | x | x | Coupon code used to place order |
| order_couponGrossPrice | x | x | Gross amount of coupon |
| order_cartAmountDiscount | x | x | Quantity discount value. The number has a negative sign |
| order_languageId | x | x | The internal id of the language of the order |
| order_languageCode | x | x | ISO 2 code of the language of the order |
| order_comment | x | x | Comment written by the customer for the order |
| order_total | x | x | Order net total |
| order_totalGross | x | x | Gross order total |
| order_taxPrice | x | x | Order includes VAT |
| order_currency | x | x | Order currency code |
| order_newsletterChecked | x | Have you subscribed to the newsletter? | |
| order_reloadLink | x | x | Order reload link, in case of abandoned cart |
| order_customerId | x | Customer id. | |
| order_shippingId | x | Order shipping method internal id. | |
| order_shippingCountryId | x | Shipping address country id. | |
| order_paymentCountryId | x | Payment address country id. | |
| orderHistory_status | x | x | The internal id of the order's current status |
| orderHistory_statusText | x | x | Text representation of the current status of the order |
| orderHistory_comment | x | x | County record written for the status of the order |
| orderCreditCard_date | x | Order paid by bank card: Date of payment | |
| orderCreditCard_transactionId | x | Order paid by bank card: Transaction identifier | |
| orderCreditCard_licenceNumber | x | Order paid by bank card: License number | |
| orderCreditCard_bankAnswerCode | x | Order paid by bank card: Bank response code | |
| orderCreditCard_bankAnswer | x | Order paid by bank card: Bank's response | |
| orderProduct_innerId | x | x | Internal ID of the ordered product (Not equal to the Product ID) |
| orderProduct_innerResourceId | x | x | Ordered product resource id (Not the same as the Product resource id) |
| orderProduct_outerResourceId | x | x | Ordered product outer id (Not the same as the Product outer id) |
| orderProduct_name | x | x | Ordered product name |
| orderProduct_sku | x | x | SKU of the ordered product |
| orderProduct_price | x | x | Net price of ordered product |
| orderProduct_currency | x | x | Currency of the price of the ordered product |
| orderProduct_taxRate | x | x | VAT rate of ordered product (e.g.: 27,000 for 27% VAT) |
| orderProduct_quantity | x | x | Ordered product quantity |
| orderProduct_image | x | x | The url of the product image of the ordered product |
| orderProduct_category | x | x | Categories of ordered products, separated by commas |
| orderProduct_volume | x | x | Ordered product volume data: height: Height width: Width length: Length volumeUnit: Unit data { unit: The unit of measure in which the volume is expressed language: The ISO 3 code of the language of the unit of measure (in Hungarian, the volume data is displayed in e.g. cm) } |
| orderProduct_weight | x | x | Ordered product weight data: weight: Weight value weightUnit: Weight data { unit: The unit in which the weight is expressed * language*: ISO 3 code of the language of the weight (in Hungarian, e.g. the weight data is displayed in kg) } |
| orderProduct_durableMediaDevice | x | Boolean value indicating whether the ordered product is a durable media device, enabling billing systems to associate the appropriate license code. | |
| orderProduct_grossPrice | x | x | Net price of ordered product. |
| orderProductOption_name | x | x | The name of the optional parameter of the version assigned to the product |
| orderProductOption_valueName | x | x | The value of the optional parameter of the version assigned to the product |
| orderProductOption_price | x | x | The amount of the price change is net. |
| orderProductOption_prefix | x | x | Price change sign (+ or -) |
| orderProduct_productId | x | Product id of the ordered product. | |
| orderProductExtra | x | Ordered products' extra informations. | |
| orderProductAddon | x | Order product addon objects with addon data.
| |
| order_loyaltyPoints | x | x | The number of loyalty points earned from the order. |
| order_loyaltyPointsUsed | x | x | The number of loyalty points applied to the order. |
# Fields usable in the newsletter subscribe event
| ## Property name | newsletter_subscribe | newsletter_unsubscribe | newsletter_update_subscriber | Description |
|---|---|---|---|---|
| subscriber_id | x | x | x | Subscriber id |
| subscriber_firstname | x | x | x | Firstname |
| subscriber_lastname | x | x | x | Lastname |
| subscriber_email | x | x | x | |
| subscriber_phone | x | x | x | Telephone |
| subscriber_status | x | x | x | Status |
| subscriber_language | x | x | x | Language for the subscribing |
| subscriber_hash | x | x | x | Hash for activating and deactivating |
| subscriber_subscribe_date | x | x | x | Date of subscribe |