Orders
Variable Group | Variables | Description |
---|---|---|
Basic Info | Id | Unique identifier for the order |
Basic Info | CustomNo | Custom order number, eg. SO12345 (prefix + numeric sequential number) |
Basic Info | OrderNo | Order number without prefix |
Basic Info | OrderDate | Order creation date |
Basic Info | DueDate | Due date for the order |
Basic Info | OrderSource | Source from which the order was placed example- Web, CustomerSupport, Telephone |
Basic Info | OrderType | The system supports the following orders types: Standard = 0, SubscriptionSeedOrder = 1, PreOrder = 3, GiftCardPhysical = 4, SubscriptionFulfilmentOrder = 5, EngravingOrders = 6, ReplacementOrders = 7, GiftCardVirtual = 8, ForwardSalesOrder = 9, GiftCardVirtualUpFront = 10, SplitOrder = 11, PickPayGO = 12 // this is a standard prepaid store order with no payment information |
Basic Info | ParentOrderCustNo | Parent order reference in case if this is a replacement order |
Basic Info | CustomQuoteNo | Custom quote number |
Basic Info | StatusCode | Order Status code |
Basic Info | Status | Status label |
Basic Info | ExternalStatus | Status in an external system (ERP, OMS, WMS) |
Basic Info | LangCulture | Language culture code based on the session captured |
Basic Info | CurrencyCode | Currency Code |
Basic Info | CurrencySymbol | Currency Symbol |
Basic Info | IsPreOrder | Indicates if the order is a pre-order |
Basic Info | CreatedByAdmin | Identifier for the admin who created the order |
Basic Info | PoNumber | PO # associated with order |
Basic Info | Created | Date and time the order was created |
Basic Info | CreatedBy | Identifier for the creator of the order |
Basic Info | LastUpdated | Date and time the order was last updated |
Basic Info | LastUpdatedBy | Identifier for the person who last updated the order |
Customer Detail | UserEmail | Email address of the user who placed the order |
Customer Detail | UserTelephone | Telephone number of the user |
Customer Detail | UserMobileNo | Duplicate property |
Customer Detail | MobileNo | Mobile number associated with the order |
Customer Detail | CompanyId | Company identifier |
Customer Detail | CompanyName | Company Name |
Customer Detail | CompanyEmail | Email address of the company |
Customer Detail | ContactName | Name of the contact person for the order |
Amounts | SubTotal | Total amount before tax |
Amounts | Tax1 | Exact Amount of the tax applied based on order total |
Amounts | TaxPercent | Percentage of tax applied configured at country settings |
Amounts | ShippingCharges | Charges for shipping |
Amounts | ShippingTax | Tax on shipping |
Amounts | DiscountAmt | Total discount amount at header level |
Amounts | DiscountAmtWithoutTax | Discount amount without tax |
Amounts | GrandTotal | Final amount for the order |
Amounts | PaidAmount | Amount that has been paid for the order |
Amounts | AdditionalCharge | Additional Payment info |
Amounts | ServiceTax | Calculated based on the Service Charge Promotion, if any applied |
Amounts | ShippingCostPrice | Shipping cost price |
Amounts | GiftWrapCharge | Charge for gift wrapping |
Amounts | RefundAmount | The total refunded amount, if any refunded against the order |
Payment | PaymentAdditionalCharge | Any additional charges for payment based on the specific payment method, for eg. COD |
Payment | PaymentMethodSystemName | Name of the payment method used for successful payment ignoring failed attempts |
Payment | PaymentStatus | Status of the payment for the order |
Payment | FraudScore | Score assessing the potential for fraud provided by your Payment source |
Address | BillToCity | Billing Address City |
Address | BillToState | Billing Address State |
Address | BillToZip | Billing Address Post Code / Zip Code |
Address | ShipToCity | Shipping Address City |
Address | ShipToZip | Shipping Address Post Code / Zip Code |
Shipment Info | ShipMethodName | Shipping method name |
Shipment Info | ShipmentMethodCode | Code of the shipment method |
Shipment Info | TrackingNo | Tracking number at order header level |
Shipment Info | TrackingLink | Link for tracking the shipment |
Shipment Info | DeliveryInstruction | Instructions for delivery |
Shipment Info | StorePostCode | Postal code of the store from which the order has been placed |
Shipment Info | OpeningHours | Opening hours for the store |
Shipment Info | CarrierShippingMethodCode | Code for the shipping method used by the carrier |
Shipment Info | CarrierShippingMethodName | Name of the shipping method used by the carrier |
Shipment Info | ShippingInfo1 | Carrier Provider name |
Custom Fields | CustomInfo1 | Custom info 1 |
Custom Fields | CustomInfo2 | Custom info 2 |
Custom Fields | CustomInfo3 | Custom info 3 |
Custom Fields | CustomInfo4 | Custom info 4 |
Custom Fields | CustomInfo5 | Custom info 5 |
Subscription Info | HasSubscription | Indicates if the order has a subscription |
Subscription Info | IsSeedOrder | Indicates if the order is a seed order |
Subscription Info | SubscriptionTotal | Total cost of the subscription |
Membership | MembershipPlanId | Identifier for the membership plan |
Membership | HasMembership | Indicates if the order includes a membership |
Order Lines
Variable Group | Variables | Description |
---|---|---|
Basic Info | CustomNo | Reference Order No |
Basic Info | ProductStockCode | Stock code for the product. |
Basic Info | MasterStockCode | Custom identifier for internal use, if the system requires specific custom numbers. |
Basic Info | Sku | This is the product code which is common across all variants, if any exist under the child. |
Basic Info | ProductName | Full name of the product. |
Basic Info | ItemType | Specifies the type of item (e.g., Product, Bundle). |
Basic Info | ExternalStatus | External system status for the order line. |
Basic Info | DisplayOrder | Display order for this line item in the UI or reports. |
Basic Info | EngravingMessage | Custom message for engraving, if applicable. |
Basic Info | EngravingColor | Color specified for the engraving text. |
Basic Info | EngravingJobStatus | Status of the engraving job (e.g., completed, pending). |
Basic Info | IsMembership | Specifies if the product is related to a membership. |
Basic Info | Status | The current status of the order line, such as delivered, pending, or canceled. |
Basic Info | StatusCode | Code representing the order line’s status code, used for system processing. |
Basic Info | ExternalRefNo | Unique identifier for the order containing this line item, for order tracking purposes. |
Qty | Qty | Quantity ordered for this line item. |
Qty | CancelledQty | Quantity that has been canceled for this line item. |
Qty | ShippedQty | Quantity that has been shipped from this order line. |
Qty | ReturnQtyRequested | Quantity for which a return has been requested by the customer. |
Qty | ReturnQtyRecd | Quantity received as a return for this order line. |
Amounts | Discount | Total discount applied on this line item, including tax. |
Amounts | DiscountWithoutTax | Discount amount on the item, excluding tax. |
Amounts | SellPricePerUnit | Selling price per unit of the item. |
Amounts | LineTotal | Total line item cost, inclusive of discounts and taxes. |
Amounts | PriceWithoutTax | Price for the line item, excluding tax. |
Amounts | Tax | Total tax applied to this order line. |
Amounts | AdditionalCharge | Any additional charge applied specifically to this line item. |
Amounts | ListPrice | The listed price of the product before any discounts or promotions. |
Amounts | TaxPercent | The tax percentage applied to the product line item, calculated based on the tax class. |
Amounts | ProductCost | Cost price of the product for accounting and profitability analysis. |
Amounts | ShippingCharge | Shipping cost calculated per unit, if applicable. |
Amounts | PaymentAdditionalCharge | Additional charge for any particular order line. |
Amounts | AdditionalServiceCost | Any additional charge applied specifically to this line item. |
Custom Fields | CustomInfo1 | Custom info 1. |
Custom Fields | CustomInfo2 | Custom info 2. |
Custom Fields | CustomInfo3 | Custom info 3. |
Custom Fields | CustomInfo4 | Custom info 4. |
Custom Fields | CustomInfo5 | Custom info 5. |
Custom Fields | CustomInfo1Formatted | Formatted value from custom info 1. |
Custom Fields | CustomInfo2Formatted | Formatted value from custom info 2. |
Custom Fields | CustomInfo3Formatted | Formatted value from custom info 3. |
Custom Fields | CustomInfo4Formatted | Formatted value from custom info 4. |
Custom Fields | CustomInfo5Formatted | Formatted value from custom info 5. |
Product Info | WeightKg | The weight of the product in kilograms. |
Product Info | LengthMm | The length of the product in millimeters. |
Product Info | HeightMm | The height of the product in millimeters. |
Product Info | ProductUrl | URL of the product page on the website. |
Product Info | ColorName | The color of the product, allowing customers to select specific color variants. |
Product Info | Size | The size of the product for the particular order line. |
Product Info | Manufacturer | The name of the product manufacturer. |
Product Info | SubManufacturer | Name of the sub-manufacturer, if applicable. |
Product Info | ShortDescription | Brief description of the product, providing an overview for quick reference. |
Product Info | Description | Detailed product description, including features and benefits, for customer insight. |
Product Info | PreorderMessage | Message shown to customers when a product is available for preorder, e.g., estimated shipping time. |
Product Info | PreorderShortMessage | A short message indicating the product's preorder status, for quick display. |
Product Info | PreorderLanchDate | Expected launch date for preorder items, allowing customers to anticipate availability. |
Product Info | ProductType | Classification of the product, such as electronics, apparel, etc. |
Product Info | ItemCategories | Categories assigned to the product, which help customers find it in relevant sections. |
Product Info | ImageUrl | URL to the main image of the product, used in listings and product pages. |
Payments
Variable Group | Variable | Description |
---|---|---|
Basic Info | OrderNo | Order number associated with the payment |
Basic Info | Status | Current status of the payment, i.e. completed, pending, or declined |
Basic Info | PaymentMethod | Method of payment used, e.g., credit card, debit card, PayPal |
Basic Info | PaymentGateway | The name of the payment gateway provider, e.g., PayPal, Stripe, etc. |
Basic Info | IsRecurring | Indicates if the payment is part of a recurring billing cycle, such as subscriptions |
Basic Info | ExternalRefNo | External reference number from a third-party system associated with the payment |
Amounts | OrderAmount | The total amount of the order for which this payment is made |
Amounts | BalanceAmount | The remaining balance if the payment was a partial payment |
PSP Response | FraudScore | Fraud score provided by the payment gateway or risk assessment service, indicating likelihood of fraud |
PSP Response | CvcResult | Result of the Card Verification Code (CVC) check for this payment, indicating validation success or failure |
PSP Response | AvsResult | Address Verification System (AVS) check result, showing if the billing address matches the card issuer’s records |
PSP Response | PspSessionCookie | Session cookie generated by the Payment Service Provider (PSP) during the transaction, used for session tracking |
PSP Response | PspResponseCode | Response code from the PSP, indicating the status or result of the payment transaction |
PSP Response | PspResponseMessage | Detailed message from the PSP about the transaction result, useful for debugging or customer communication |
PSP Response | PostAuthRequestDate | Date when a post-authorization request was made, such as for capturing funds |
PSP Response | PostAuthResponseDate | Date when the post-authorization response was received, marking transaction completion |
Card Details | Token | Tokenized representation of the payment details, used to securely store payment info |
Card Details | CardNo | The masked card number associated with the payment, showing only the last 4 digits, with the rest as Xs |
Card Details | CardHolderName | Name of the cardholder as provided during payment |
Card Details | IssuerCountry | Country where the card was issued |
Card Details | ExpiryMonth | Expiry month of the card used in the payment |
Card Details | ExpiryYear | Expiry year of the card used in the payment |
Dates | Created | Timestamp of when the payment was created |
Delivery Plans
Variable Group | Variable | Description |
---|---|---|
Basic Info | RecordId | Unique identifier for each record in the delivery plan |
Basic Info | OrderId | Identifier linking to the specific order associated with the delivery plan |
Basic Info | FulfilmentChannel | Channel through which the order is fulfilled (e.g., stock, backorder, dropship) |
Basic Info | ShippingMethodTypes | Shipping methods type |
Basic Info | ShippingMethodName | Shipping method name used in this delivery plan |
Basic Info | ShippingMethodCode | Shipping method code |
Basic Info | FulfilmentDeliveryCenterCode | Delivery center code managing the fulfillment of this order |
Basic Info | ShippingCharge | Total charge applied for shipping as per the selected method |
Basic Info | NumberOfBoxes | Number of boxes required for packing and shipping the items in this plan |
Store Info | RefStoreName | Name of the store referenced for this delivery plan, if applicable |
Store Info | PickupStoreCode | Pickup Code for click & collect order used for picking up order from store |
Dates | TargetDate | Target date by which the delivery should be completed |
Dates | LeadTime | Lead time required for fulfillment of this delivery |
Dates | Created | Delivery plan creation date and time |
Dates | CreatedBy | Username who created the delivery plan |
Dates | LastUpdated | Delivery plan last updated timestamp |
Dates | LastUpdatedBy | Username who last modified the delivery plan |
Delivery Plan Lines
Variable Group | Variables | Description |
---|---|---|
Basic Info | RecordId | Unique identifier for each record in the delivery plan line. |
Basic Info | OrderDeliveryPlanId | Unique identifier of the delivery plan for this line item. |
Basic Info | OrderLineId | Unique ID referencing the specific order line associated with the delivery. |
Basic Info | StockCode | Product Stock Code |
Basic Info | Qty | Quantity of items in this delivery line |
Dates | Created | Delivery plan line creation timestamp |
Dates | CreatedBy | Username who created the delivery plan line |
Dates | LastUpdated | Delivery plan line last updated Timestamp |
Dates | LastUpdatedBy | Username who last updated the delivery plan line |
Basic Info | ProductName | Name of the product associated with this delivery plan line |
Fulfilment Info | Status | Current status of the delivery line item (e.g., pending, shipped) |
Fulfilment Info | StatusCode | Status code for the delivery plan line item |
Fulfilment Info | LineFulfilmentChannel | Specifies the fulfillment channel (e.g., warehouse, backorder) for this line |
Fulfilment Info | LineTargetDate | Target delivery date for this line item |
Fulfilment Info | LineLeadTime | The lead time required to fulfill this line item |
Fulfilment Info | LineLeadTimeUom | Unit of measurement for the lead time (e.g., days, hours) |
Fulfilment Info | LineShippingSpeed | Speed of shipping (e.g., standard, expedited) chosen for this line item |
Fulfilment Info | ReturnQtyRequested | Quantity of items requested for return. |
Fulfilment Info | ReturnQtyRecd | Quantity of items actually received as returned. |
Fulfilment Info | LineDeliveryCenterCode | Code identifying the delivery center handling this line item. |
Fulfilment Info | ShippedQty | Quantity of the item that has already been shipped. |
Fulfilment Info | CustomInfo1Formatted | Custom information specific to the delivery plan |
Products
Variable Group | Variables | Description | |
---|---|---|---|
Basic Info | RecordId | Unique identifier for the product | |
Basic Info | ProductDisplayName | Display name for the product | |
Basic Info | Brand | Brand Name of the Product | |
Basic Info | SubBrand | Product Sub brand Name | |
Identifier | StockCode | Unique stockcode of the product | |
Identifier | Barcode | Barcode of the product | |
Identifier | MPN | Manufacturer Part Number | |
Identifier | GTN | Global Trade Number | |
Classification | Tags | A set of keywords or labels associated with the product to enhance searchability and categorization. | |
Classification | HSN | HSN code of the product | |
Classification | OriginCountry | The country where the product is manufactured or sourced from, often required for regulatory compliance. | |
Dimensions | Uom | Unit of measurement | |
Dimensions | UomValue | UOM value | |
Reviews | Rating | The average score given to the product based on customer reviews. | |
Flags | DisplayInSearch | Calculated Field - if active & visible = true and (stock > 0 OR Allow Backorder = True) | |
Flags | IsMasterStock | A flag that indicates whether the product is designated as master stock which means parent of all variants stock codes. | |
Flags | HasVariant | Indicates if product is a variant or a master product | |
Flags | IsActive | Indicates if the product is active | |
Flags | IsVisible | A flag that determines if the product is visible to customers in the online storefront. | |
Flags | IsGiftWrapApplied | Indicates if gift wrap is applied | |
Flags | GiftWrapOption | Options for gift wrapping | |
Flags | SubscriptionEnabled | Indicates if subscriptions are enabled | |
Flags | IsDiscontinued | Indicates if product is discontinued | |
Flags | DiscontinuationDate | Date when the product is discontinued | |
Auto-Flags | BestSeller | Calculated Field | |
Auto-Flags | NewLaunch | Calculated Field | |
Auto-Flags | Trending | Calculated Field | |
Auto-Flags | OnSale | Indicates if product is on sale | |
Fulfilment Info | FulfilFromWarehouse | Indicates if fulfilled from warehouse | |
Fulfilment Info | FulfilFromstore | Indicates if fulfilled from store | |
Fulfilment Info | FulfilFromSupplier | Indicates if fulfilled from supplier | |
Fulfilment Info | FulfilFromWarehouseDays | Days to fulfill from warehouse | |
Fulfilment Info | FulfilFromSupplierDays | Days to fulfill from supplier | |
Fulfilment Info | FulfilFromInstoreDays | Days to fulfill from in-store | |
Fulfilment Info | CurrentStock | The current inventory level of the product. | |
Attributes | Color | Color of the product | |
Attributes | Size | Size of the product | |
Attributes | Season | Season for the product | |
Attributes | ColorCode | Hex Color Code representing product color | |
Attributes | Gender | Gender target for the product | |
Attributes | Occasion | Occasion suitable for the product | |
Attributes | AgeGroup | Age group target for the product | |
Attributes | Pattern | Pattern type of the product | |
Attributes | Material | Material of the product | |
Attributes | Finish | Finish type of the product | |
Attributes | Style | Style of the product | |
Attributes | Exclusive | Indicates if product is exclusive | |
Collections / Objects | Custom Attributes | Collection of custom attributes and their respective values for the product. The example below: {% for att in Attributes -%} {% if att.Key == ""product.amazonsku"" %}{% assign att2 = att.ValueText%}{% endif %} {% if att.Key == ""product.flipkartsku"" %}{% assign att3= att.ValueText%}{% endif %} {% endfor -%} | |
Collections / Objects | Classification | An Object which exposes the Immediate category for the product. "categoryname": "{{Classification.MainCategoryName}}", "customsetid": "{{Classification.AttributeSetId}}", "itemtype": "{{Classification.ItemType}}" | |
Collections / Objects | MappedCategories | List of all categories that are mapped to the product. The object can be traversed within the script using the following example: {% for N in MappedCategories-%} {% if forloop.index != 1 %}, {% endif %} { "categoryid": "{{N.CategoryId}}", "categoryname": "{{N.CategoryName}}", "parentcategoryid": "{{N.ParentCategoryId}}", "parentcategoryname": "{{N.ParentCategoryName}}", "level": "{{N.Level}}" } {% endfor -%} | |
Collections / Objects | PriceList | Collection of all the price lists associated with the product. The example below shows how to use the collection within the webhook body along with its detailed properties: {% for N in PriceList-%} {% if forloop.index != 1 %}, {% endif %} { "costprice": { "minprice": "{{N.CostPrice.MinPrice}}", "minpricewithouttax": "{{N.CostPrice.MinPriceWithoutTax}}", "maxprice": "{{N.CostPrice.MaxPrice}}", "maxpricewithouttax": "{{N.CostPrice.MaxPriceWithoutTax}}", "currencydecimalseparator": "{{N.CostPrice.CurrencyDecimalSeparator}}", "currencydigitsafterdecimal": "{{N.CostPrice.CurrencyDigitsAfterDecimal}}", "currencysymbol": "{{N.CostPrice.CurrencySymbol}}", "raw": { "withtax": "{{N.CostPrice.Raw.WithTax}}", "withouttax": "{{N.CostPrice.Raw.WithoutTax}}", "tax": "{{N.CostPrice.Raw.Tax}}" }, "formatted": { "withtax": "{{N.CostPrice.Formatted.WithTax}}", "withouttax": "{{N.CostPrice.Formatted.WithoutTax}}", "tax": "{{N.CostPrice.Formatted.Tax}}" } }, "sellprice": { "minprice": "{{N.CostPrice.MinPrice}}", "minpricewithouttax": "{{N.CostPrice.MinPriceWithoutTax}}", "maxprice": "{{N.CostPrice.MaxPrice}}", "maxpricewithouttax": "{{N.CostPrice.MaxPriceWithoutTax}}", "currencydecimalseparator": "{{N.CostPrice.CurrencyDecimalSeparator}}", "currencydigitsafterdecimal": "{{N.CostPrice.CurrencyDigitsAfterDecimal}}", "currencysymbol": "{{N.CostPrice.CurrencySymbol}}", "raw": { "withtax": "{{N.CostPrice.Raw.WithTax}}", "withouttax": "{{N.CostPrice.Raw.WithoutTax}}", "tax": "{{N.CostPrice.Raw.Tax}}" }, "formatted": { "withtax": "{{N.CostPrice.Formatted.WithTax}}", "withouttax": "{{N.CostPrice.Formatted.WithoutTax}}", "tax": "{{N.CostPrice.Formatted.Tax}}" } }, "listprice": { "minprice": "{{N.ListPrice.MinPrice}}", "minpricewithouttax": "{{N.ListPrice.MinPriceWithoutTax}}", "maxprice": "{{N.ListPrice.MaxPrice}}", "maxpricewithouttax": "{{N.ListPrice.MaxPriceWithoutTax}}", "currencydecimalseparator": "{{N.ListPrice.CurrencyDecimalSeparator}}", "currencydigitsafterdecimal": "{{N.ListPrice.CurrencyDigitsAfterDecimal}}", "currencysymbol": "{{N.ListPrice.CurrencySymbol}}", "raw": { "withtax": "{{N.ListPrice.Raw.WithTax}}", "withouttax": "{{N.ListPrice.Raw.WithoutTax}}", "tax": "{{N.ListPrice.Raw.Tax}}" }, "formatted": { "withtax": "{{N.ListPrice.Formatted.WithTax}}", "withouttax": "{{N.ListPrice.Formatted.WithoutTax}}", "tax": "{{N.ListPrice.Formatted.Tax}}" } }, "type": "{{N.Type}}", "date": "{{N.Date}}" } {% endfor -%} | |
Dates | LaunchDate | Published date of the product | |
Dates | Created | Date when the product was created | |
Dates | LastUpdated | Date when the product was last updated |
Customers
Variable Group | Variables | Description |
---|---|---|
Basic Info | Id | Unique Identifier GUID for a user |
Basic Info | Iid | Unique identifier for the customer in numbers |
Basic Info | FirstName | First name of the customer |
Basic Info | LastName | Last name of the customer |
Basic Info | Title | Title of the customer |
Basic Info | DayOfBirth | Customer Day of birth |
Basic Info | MonthOfBirth | Customer birth month |
Basic Info | CompanyRole | Role within the company |
Basic Info | Gender | Gender of the customer |
Address | City | Customer’s city of residence |
Address | Country | Country of Origin - applicable only when we are running a multi-country setup and this records the country selected by user for their access |
Address | Postcode | Post code of the customer's default shipping address |
Contact Info | PhoneNo | Primary phone number of the customer |
Contact Info | Email of the customer | |
Username | UserName | Username of the customer |
Registration | IsCreatedByAdmin | Indicates if created by an admin user |
GDPR | NotifyByEmail | Receive notifications by email |
GDPR | NotifyBySMS | Receive notifications by SMS |
GDPR | NotifyByPost | Receive notifications by post |
Marketing | NewsletterSubscribe | Flag if subscribed to newsletter |
Flags | HasMembership | Indicates if customer has a membership |
Flags | HasSubscribed | Indicates if customer has subscribed |
Flags | HasSubscription | Indicates if customer has an active subscription |
Basic Info | Created | User creation timestamp |
Basic Info | CreatedBy | User who created the customer record |
Basic Info | LastUpdated | Date and time the customer record was last updated |
Basic Info | LastUpdatedBy | User who last updated the customer record |
Addresses
Variable Group | Variables | Description |
---|---|---|
Address | AddressType | Type of address (e.g., Billing, Shipping, Subscription) |
Address | UserId | Unique Identifier GUID for a user |
Address | Title | Title / Tag for the address which user can update in front end (e.g., home, work, etc.) |
Address | FirstName | First name of the customer |
Address | LastName | Last name of the customer |
Address | Address1 | Address line 1; not directly usable as it’s in an array format. Use a loop in the webhook template to extract it. |
Address | Address2 | Address line 2; not directly usable as it’s in an array format. Use a loop in the webhook template to extract it. |
Address | Address3 | Address line 3; not directly usable as it’s in an array format. Use a loop in the webhook template to extract it. |
Address | City | City from the address; not directly usable as it’s in an array format. Use a loop in the webhook template to extract it. |
Address | State | State from the address; not directly usable as it’s in an array format. Use a loop in the webhook template to extract it. |
Address | Country | Country from the address; not directly usable as it’s in an array format. Use a loop in the webhook template to extract it. |
Address | CountryCode | Country code from the address; not directly usable as it’s in an array format. Use a loop in the webhook template to extract it. |
Address | PostCode | Post code from the address; not directly usable as it’s in an array format. Use a loop in the webhook template to extract it. |
Address | PhoneNo | Phone number from the address; not directly usable as it’s in an array format. Use a loop in the webhook template to extract it. |
Address | IsDefaultDelivery | Flag for default shipping address |
Address | IsDefaultBilling | Flag for default billing address |
Address | IsDefault | Flag for customer's default address |
Address | IsDefaultForSubscription | Flag for default subscription address |
Promotions
Variable Group | Variables | Description |
---|---|---|
Basic Info | PromoType | Specifies the type of promotion (e.g., discount, free shipping). |
Basic Info | Name | Internal name of the promotion, used for identification within the system. |
Basic Info | DisplayName | Public name displayed to customers for easy identification. |
Basic Info | Code | Unique code assigned to the promotion, often used as a discount code at checkout. |
Basic Info | CampaignCode | Code identifying the campaign under which this promotion has been categorized. |
Basic Info | Status | Indicates the current status of the promotion (e.g., active, inactive). |
Basic Info | IsActive | Shows if the promotion is currently active and available for use. |
Promo Config | FromDate | Start date of the promotion, from which it becomes available to customers. |
Promo Config | ToDate | End date of the promotion, after which it is no longer valid. |
Promo Config | UseWithOtherDiscountCode | Allows the promotion to be used alongside other discount codes if set to true. |
Promo Config | HasVouchers | Indicates if this promotion includes vouchers. |
Promo Config | Channels | Lists all applicable channels (web, store, app) for the promotion. |
CRO Info | IsCROEnabled | Enables or disables the CROMessage feature for this promotion. |
CRO Info | CROMessage | Message displayed to encourage customers to complete their purchase, part of conversion rate optimization. |
CRO Info | CROSuccessMessage | Message shown to customers after they’ve successfully used the promotion, as part of conversion rate optimization. |
RMA Header
Variable Group | Variables | Description |
---|---|---|
Basic Info | CustomNo | Custom number associated with the RMA. |
Basic Info | RefCustomNo | CustomNo of the original order. |
Basic Info | ExternalStatus | External system status of the RMA. |
Basic Info | CompanyId | Unique identifier for the company, in case of B2B. |
Basic Info | ContactEmail | User email linked with the RMA. |
Basic Info | Comments | Additional comments related to the RMA. |
Basic Info | PickupRequired | Indicates if pickup is required (Yes/No). |
Amounts | SubTotal | Amount excluding taxes and additional charges. |
Amounts | Tax | Tax amount applicable to the RMA. |
Amounts | GrandTotal | Return amount including all charges and taxes. |
Basic Info | ReasonForReturn | Reason specified for returning the item(s). |
Basic Info | RequiredAction | Return Action Refund/Replacement for return Order. |
Basic Info | Created | Date and time when the RMA was created. |
Basic Info | CreatedBy | User who created the RMA record. |
Store Information
Variable Group | Variables | Description |
---|---|---|
Basic Info | AccessCode | Unique Code assigned to a Store |
Basic Info | Name | Store Name |
Address | Latitude | Latitude Location of the Store |
Address | Longitude | Longitude Location of the Store |
Address | Address1 | Addressline 1 of the Store Address |
Address | Address2 | Addressline 2 of the Store Address |
Address | City | City of the store location |
Address | State | State of the store location |
Address | StoreImage | Store image url |
Address | CountryName | Country of the store |
Address | CountryCode | Country Code of the store |
Address | PostCode | Postal Code of the Store address |
Basic Info | OpeningHours | Store operating hours |
Contact Info | Telephone | Store contact telephone number |
Contact Info | StoreEmail | Email address for store communication |
Contact Info | Fax | Store fax number |
Flags | Active | Status indicating if store is active |
Additional Info | Info1 | General information field 1 for store |
Additional Info | Info2 | General information field 2 for store |
Additional Info | CustomInfo1 | Custom information field for store |
Additional Info | CustomInfo2 | Custom information field for store |
Additional Info | CustomInfo3 | Custom information field for store |
Additional Info | CustomInfo4 | Custom information field for store |
Additional Info | CustomInfo5 | Custom information field for store |
Additional Info | CustomInfo6 | Custom information field for store |
Additional Info | CustomInfo7 | Custom information field for store |
Additional Info | CustomInfo8 | Custom information field for store |
Additional Info | CustomInfo9 | Custom information field for store |
Additional Info | CustomInfo10 | Custom information field for store |
Device Information
Variable Group | Variables | Description |
---|---|---|
Basic Info | DeviceToken | A unique token generated by the device, typically used to identify and communicate with it for notifications or security purposes. |
Basic Info | DeviceType | The type of device being used, such as "iOS," "Android," or other platform identifiers. |
Basic Info | AppVersion | The current version of the app installed on the device, often represented as a version number (e.g., "1.2.3"). |