Orders
Variables | Description |
|---|---|
| Id | Unique identifier for the order |
| OrgId | Organization identifier |
| CompanyId | Company identifier |
| CustomNo | Custom order number |
| OrderNo | Order number |
| OrderDate | Date when the order was placed |
| DueDate | Due date for the order |
| GrandTotal | Final amount for the order |
| Tax1 | Tax amount applied based on order total |
| TaxPercent | Tax % applied |
| SubTotal | Total amount before tax |
| StatusCode | Status code representing for the order |
| Status | Status of the order |
| ShippingCharges | Shipping charges |
| ShippingTax | Tax applied on shipping charges |
| TotalQty | Total quantity of items in the order |
| ShippingMethodId | Identifier for the shipping method |
| BillToAddress | Billing address for the order |
| ShipToAddress | Shipping address for the order |
| PaymentMethodSystemName | Name of the payment method used for successful payment ignoring failed attempts |
| Created | Creation date & time |
| CreatedBy | Username who created by the order |
| LastUpdated | Last updated date & time |
| LastUpdatedBy | Username who last updated the order |
| CompanyName | Company name associated with the order, only applicable for B2B order |
| CompanyEmail | Email address of the company |
| ContactName | Contact person for the order |
| BillToCity | Billing address city |
| BillToState | Billing address state |
| BillToZip | Billing address post code |
| ShipToCity | Shipping address city |
| ShipToZip | Shipping address post code |
| ShipMethodName | Shipping method name |
| ShipType | Shipping method type - standard, express, next day, pickup. |
| OrderSource | Source/Channel from which the order was placed |
| PaidAmount | Total paid amount |
| PaymentStatus | Payment status |
| UserEmail | User email address |
| PreAuth | Pre-authorization status |
| PostAuth | Post-authorization status |
| RefundAmount | Amount refunded for the order |
| DiscountAmt | Total discount amount applied |
| DiscountAmtWithoutTax | Discount amount without tax |
| DomainId | Domain identifier associated with the order |
| GiftWrapCharge | Charge for gift wrapping |
| FraudScore | Fraud Score provided by the Payment source |
| ShipmentMethodCode | Shipping method code |
| ParentOrderCustNo | Parent order reference, in case a replacement order is created |
| UserTelephone | User telephone number |
| UserMobileNo | User mobile number |
| ExternalStatus | Status code from external system (eg. ERP, OMS, WMS) |
| TrackingNo | Tracking number for the shipment |
| LangCulture | Language and culture settings |
| CurrencyCode | Currency code |
| CurrencySymbol | Currency symbol |
| IsPreOrder | Indicates if the order is a pre-order |
| ShippingPlanId | Identifier for the shipping plan |
| LeadTimeUnit | Unit of time for lead time |
| LeadTimeMin | Minimum lead time |
| LeadTimeMax | Maximum lead time |
| OpeningHours | Opening hours for the store used for PPG for example |
| CarrierName | Name of the carrier used for shipping |
| MobileNo | Mobile number associated with the order |
| CreatedByAdmin | Identifier for the admin who created the order |
| TrackingLink | Link for tracking the shipment |
| CustomQuoteNo | Custom quote number |
| CustomInfo1 | Custom information field 1 from CompanyOrder table |
| CustomInfo2 | Custom information field 2 from CompanyOrder table |
| CustomInfo3 | Custom information field 3 from CompanyOrder table |
| CustomInfo4 | Custom information field 4 from CompanyOrder table |
| CustomInfo5 | Custom information field 5 from CompanyOrder table |
| AdditionalCharge | Any additional charges associated with the order |
| ServiceTax | Tax for services provided |
| ShippingCostPrice | Cost price for shipping |
| PoNumber | Purchase order number |
| CostAdditionalCharge | Additional costs incurred |
| DeliveryInstruction | Instructions for delivery |
| HasSubscription | Indicates if the order has a subscription |
| IsSeedOrder | Indicates if the order is a seed order |
| SeedOrderId | Identifier for the associated seed order |
| SubscriptionTotal | Total cost of the subscription |
| StoreName | Reference store for the order |
| StorePostCode | Postal code of the store |
| OrderType | Type of the order |
| MembershipPlanId | Identifier for the membership plan |
| HasMembership | Indicates if the order includes a membership |
| CarrierShippingMethodCode | Code for the shipping method used by the carrier |
| CarrierShippingMethodName | Name of the shipping method used by the carrier |
| ShippingInfo1 | First piece of shipping information |
| ShippingInfo2 | Second piece of shipping information |
| PaymentAdditionalCharge | Any additional charges for payment |
OrderLines
Variables | Description |
|---|---|
| ProductStockCode | Stock code for the product. |
| ProductName | Full name of the product. |
| Qty | Quantity ordered for this line item. |
| CancelledQty | Quantity that has been canceled for this line item. |
| Discount | Total discount applied on this line item, including tax. |
| DiscountWithoutTax | Discount amount on the item, excluding tax. |
| SellPricePerUnit | Selling price per unit of the item. |
| LineTotal | Total line item cost, inclusive of discounts and taxes. |
| PriceWithoutTax | Price for the line item, excluding tax. |
| Tax | Total tax applied to this order line. |
| ShippedQty | Quantity that has been shipped from this order line. |
| ReturnQtyRequested | Quantity for which a return has been requested by the customer. |
| ReturnQtyRecd | Quantity received as a return for this order line. |
| ExternalStatus | External system status for the order line. |
| DisplayOrder | Display order for this line item in the UI or reports. |
| EngravingMessage | Custom message for engraving, if applicable. |
| EngravingColor | Color specified for the engraving text. |
| EngravingJobStatus | Status of the engraving job (e.g., completed, pending). |
| CustomInfo1 | Custom information field 1from custom fields in the table |
| CustomInfo2 | Custom information field 2; purpose varies by implementation. |
| CustomInfo3 | Custom information field 3; purpose varies by implementation. |
| CustomInfo4 | Custom information field 4; purpose varies by implementation. |
| CustomInfo5 | Custom information field 5; purpose varies by implementation. |
| AdditionalCharge | Any additional charge applied specifically to this line item. |
| ItemType | Specifies the type of item (e.g., Product, Bundle ). |
| CustomInfo1Formatted | Formatted Info in custom info 1 column of the table |
| CustomInfo2Formatted | Formatted Info in custom info 2 column of the table |
| CustomInfo3Formatted | Formatted Info in custom info 3 column of the table |
| CustomInfo4Formatted | Formatted Info in custom info 4 column of the table |
| CustomInfo5Formatted | Formatted Info in custom info 5 column of the table |
| AdditionalServiceCost | Any additional charge applied specifically to this line item. |
| WeightKg | The weight of the product in kilograms |
| LengthMm | The length of the product in millimeters |
| HeightMm | The height of the product in millimeters |
| IsSubscription | Indicates if the product is available as part of a subscription service, |
| ProductDisplayName | The name of the product as displayed to the customer on the storefront. |
| ProductUrl | URL of the product page on the website |
| IsMembership | Specifies if the product is related to a membership |
| TaxPercent | The tax percentage applied to the product line item, calculated based on the tax class. |
| Status | The current status of the order line, such as completed, pending, or canceled. |
| StatusCode | Code representing the order line’s status code, used for system processing. |
| ColorName | The color of the product, allowing customers to select specific color variants. |
| Size | The size of the product for the particular order line |
| WarehouseCode | Code assigned to the warehouse, useful for tracking inventory location. |
| Manufacturer | The name of the product manufacturer. |
| SubManufacturer | Name of the sub-manufacturer, if applicable. |
| ShortDescription | Brief description of the product, providing an overview for quick reference. |
| Description | Detailed product description, including features and benefits, for customer insight. |
| ListPrice | The listed price of the product before any discounts or promotions. |
| PreorderMessage | Message shown to customers when a product is available for preorder, e.g., estimated shipping time. |
| PreorderShortMessage | A short message indicating the product's preorder status, for quick display. |
| PreorderLanchDate | Expected launch date for preorder items, allowing customers to anticipate availability. |
| DisplayInBasket | Specifies if the product is displayed in the shopping basket summary. |
| CurrentStock | The available quantity in stock for the product, assisting in inventory management. |
| IsSampleSelector | Indicates if the product can be sampled before purchase, e.g., cosmetic samples. |
| Gender | Gender designation for the product, e.g., men’s, women’s, unisex. |
| ProductType | Classification of the product, such as electronics, apparel, etc. |
| ItemCategories | Categories assigned to the product, which help customers find it in relevant sections. |
| ImageUrl | URL to the main image of the product, used in listings and product pages. |
| ProductCost | Cost price of the product for accounting and profitability analysis. |
| Sku | Stock Keeping Unit identifier, used for inventory and tracking purposes. |
| SubscriptionUserPricingPreference | ID for any price match requests made by the customer for the product. |
| SubscriptionJson | Main category to which the product belongs, facilitating product classification. |
| MasterStockCode | Custom identifier for internal use, if the system requires specific custom numbers. |
| ExternalRefNo | Unique identifier for the order containing this line item, for order tracking purposes. |
| CustomNo | The total shipping cost for the order line item, calculated based on shipping methods. |
| ShippingCharge | Shipping cost calculated per unit, if applicable. |
| PaymentAdditionalCharge | Additional charge for any particular order line |
DeliveryPlans
| Variables | Description |
|---|---|
| RecordId | Unique identifier for each record in the delivery plan. |
| OrderId | Identifier linking to the specific order associated with the delivery plan. |
| FulfilmentChannel | Specifies the channel through which the order is fulfilled (e.g., stock,backorder,dropship). |
| ShippingMethodTypes | Types of shipping methods available for this delivery plan. |
| ShippingMethodName | Name of the shipping method used in this delivery plan. |
| ShippingMethodCode | Code representing the shipping method |
| PickupStoreCode | Code for the pickup store associated with this delivery plan. |
| FulfilmentDeliveryCenterCode | Code for the delivery center managing the fulfillment of this order. |
| TargetDate | Target date by which the delivery should be completed. |
| LeadTime | Amount of lead time required for fulfillment of this delivery. |
| Created | Timestamp indicating when this delivery plan was created. |
| CreatedBy | Username or identifier of the user who created the delivery plan. |
| LastUpdated | Timestamp for the most recent update to this delivery plan. |
| LastUpdatedBy | Username or identifier of the user who last modified the delivery plan. |
| ShippingCharge | Total charge applied for shipping as per the selected method. |
| RefStoreName | Name of the store referenced for this delivery plan, if applicable. |
| NumberOfBoxes | Number of boxes required for packing and shipping the items in this plan. |
DeliveryPlanLines
| Variables | Description |
|---|---|
| RecordId | Unique identifier for each record in the delivery plan line. |
| OrderDeliveryPlanId | Unique identifier of the delivery plan for this line item. |
| OrderLineId | Unique ID referencing the specific order line associated with the delivery. |
| StockCode | Code representing the stock item of the order |
| ProductId | Unique identifier for the product within the delivery plan. |
| Qty | Quantity of items in this delivery line. |
| Created | Timestamp for when the delivery plan line was created. |
| CreatedBy | Username or identifier of the user who created the delivery plan line. |
| LastUpdated | Timestamp for the most recent update to this delivery plan line. |
| LastUpdatedBy | Username or identifier of the user who last updated the delivery plan line. |
| ProductName | Name of the product associated with this delivery plan line. |
| LineFulfilmentChannel | Specifies the fulfillment channel (e.g., warehouse , backorder) for this line. |
| LineTargetDate | Target delivery date for this line item. |
| LineLeadTime | The lead time required to fulfill this line item. |
| LineLeadTimeUom | Unit of measurement for the lead time (e.g., days, hours). |
| LineShippingSpeed | Speed of shipping (e.g., standard, expedited) chosen for this line item. |
| Status | Current status of the delivery line item (e.g., pending, shipped). |
| StatusCode | Code representing the status of the delivery plan line item. |
| LineTotal | The total cost associated with a specific line item in the delivery plan, including any discounts or additional charges. |
| ProductExpectedDate | The estimated date when the product is expected to be delivered as per the delivery plan. |
| ReturnQtyRequested | Quantity of items requested for return. |
| ReturnQtyRecd | Quantity of items actually received as returned. |
| InventoryType | Type of inventory classification for this item (e.g., new, damaged). |
| LineDeliveryCenterCode | Code identifying the delivery center handling this line item. |
| LineDeliveryCenterId | Unique identifier for the delivery center. |
| IsMasterStock | Indicates if the stock for this item is managed as master stock. |
| ShippedQty | Quantity of the item that has already been shipped. |
| CustomInfo1Formatted | Custom information specific to the delivery plan |
Payments
| Variables | Description |
|---|---|
| CardNo | The card number associated with the payment, typically masked for security purposes. |
| OrderNo | Order number associated with the payment, linking it to a specific customer order. |
| OrderAmount | The total amount of the order for which this payment is made. |
| BalanceAmount | The remaining balance if the payment was a partial payment. |
| Created | Timestamp of when the payment was created, useful for tracking transaction timelines. |
| Status | Current status of the payment, such as completed, pending, or Declined. |
| PaymentGateway | The name of the payment gateway provider, e.g., PayPal, Stripe, etc. |
| FraudScore | Fraud score provided by the payment gateway or risk assessment service, indicating likelihood of fraud. |
| PaymentMethod | Method of payment used, e.g., credit card, debit card, PayPal. |
| CvcResult | Result of the Card Verification Code (CVC) check for this payment, indicating validation success or failure. |
| AvsResult | Address Verification System (AVS) check result, showing if the billing address matches the card issuer’s records. |
| CardHolderName | Name of the cardholder as provided during payment, useful for verification purposes. |
| IssuerCountry | Country where the card was issued, which can help in fraud assessment. |
| PostAuthRequestDate | Date when a post-authorization request was made, such as for capturing funds. |
| IsRecurring | Indicates if the payment is part of a recurring billing cycle, such as subscriptions. |
| ExternalRefNo | External reference number from a third-party system associated with the payment. |
| Token | Tokenized representation of the payment details, used to securely store payment info. |
| ExpiryMonth | Expiry month of the card used in the payment. |
| ExpiryYear | Expiry year of the card used in the payment. |
| PspSessionCookie | Session cookie generated by the Payment Service Provider (PSP) during the transaction, used for session tracking. |
| PspResponseCode | Response code from the PSP, indicating the status or result of the payment transaction. |
| PspResponseMessage | Detailed message from the PSP about the transaction result, useful for debugging or customer communication. |
| PostAuthResponseDate | Date when the post-authorization response was received, marking transaction completion. |
ShipmentDetails
| Variables | Description |
|---|---|
| TrackingLink | Payment gateway provider for refund transactions (for return merchandise authorization - RMA refunds). |
| Created | Identifier for the payment gateway used to process RMA refunds. |
UserDevices
| Variables | Description |
|---|---|
| DeviceToken | A unique identifier for the user's device, used for push notifications and tracking. |
| DeviceType | The type of device being used by the user (e.g., smartphone, tablet, desktop). |
| AppVersion | The version of the application that is installed on the user's device. |
Customer
| Id | Unique Identifier GUID for a user |
|---|---|
| FirstName | First name of the customer |
| LastName | Last name of the customer |
| Title | Title or honorific of the customer |
| PhoneNo | Primary phone number of the customer |
| Gender | Gender of the customer |
| Postcode | Postal code of the customer's address |
| DayOfBirth | Date of birth of the customer |
| UserName | Username associated with the customer account |
| Email address of the customer | |
| Country | Country of the customer |
| IsRegistered | Indicates if the customer is registered |
| IsCreatedByAdmin | Indicates if created by an admin user |
| NotifyByEmail | Preference to receive notifications by email |
| NotifyBySMS | Preference to receive notifications by SMS |
| NotifyByPost | Preference to receive notifications by post |
| Iid | Unique identifier for the customer in numbers |
| MonthOfBirth | Month of the customer’s birth |
| Created | Date the customer record was created |
| CreatedBy | User who created the customer record |
| LastUpdated | Date the customer record was last updated |
| LastUpdatedBy | User who last updated the customer record |
| City | Customer’s city of residence |
| CompanyRole | Role within the company |
| IsWelcomeEmailSent | Flag if welcome email was sent |
| Password | Password for customer account access |
| UrlReferrer | URL that referred the customer |
| HasMembership | Indicates if customer has a membership |
| HasSubscribed | Indicates if customer has subscribed |
| HasSubscription | Indicates if customer has an active subscription |
| Culture | Cultural setting or language preference |
| NewsLetterSubscribe | Flag if subscribed to newsletter |
Addresses:
| Variables | Description |
|---|---|
| AddressType | Type of address (e.g., home, business) |
| UserId | Unique identifier for user |
| Title | Title or honorific associated with the customer |
| FirstName | First name of the customer |
| LastName | Last name of the customer |
| Address1 | Primary street address |
| Address2 | Secondary street address |
| Address3 | Additional address line |
| City | City where the customer resides |
| State | State or province of the customer |
| Country | Country of residence for the customer |
| CountryCode | ISO code of the customer’s country |
| PostCode | Postal code for customer |
| Email address for contact | |
| TradingCurrency | Currency used by the customer’s company |
| PhoneNo | Contact number of the customer |
| IsDefaultDelivery | Indicates if this is the default delivery address |
| IsDefaultBilling | Indicates if this is the default billing address |
| IsDefault | Flag for default status |
| IsDefaultForSubscription | Indicates if this address is for subscription |
| CompanyName | Name of the company |
| CompanyId | Unique ID of the customer’s company |
Store
| Variables | Description |
|---|---|
| Name | Store Name |
| Latitude | Latitude Location of the Store |
| Longitude | Longitude Location of the Store |
| Address1 | Addressline 1 of the Store Address |
| Address2 | Addressline 2 of the Store Address |
| City | City of the store location |
| State | State of the store location |
| AccessCode | Unique Code assigned to a Store |
| StoreImage | Store image url |
| CountryName | Country of the store |
| CountryCode | Country Code of the store |
| PostCode | Postal Code of the Store address |
| OpeningHours | Store operating hours |
| Telephone | Store contact telephone number |
| StoreEmail | Email address for store communication |
| Fax | Store fax number |
| Active | Status indicating if store is active |
| Info1 | General information field 1 for store |
| Info2 | General information field 1 for store |
| CustomInfo1 | Custom information field for store |
| CustomInfo2 | Custom information field for store |
| CustomInfo3 | Custom information field for store |
| CustomInfo4 | Custom information field for store |
| CustomInfo5 | Custom information field for store |
| CustomInfo6 | Custom information field for store |
| CustomInfo7 | Custom information field for store |
| CustomInfo8 | Custom information field for store |
| CustomInfo9 | Custom information field for store |
| CustomInfo10 | Custom information field for store |
Promotions
| Variables | Description |
|---|---|
| PromoType | Specifies the type of promotion (e.g., discount, free shipping). |
| Name | Internal name of the promotion, used for identification within the system. |
| DisplayName | Public name displayed to customers for easy identification. |
| Code | Unique code assigned to the promotion, often used as a discount code at checkout. |
| CampaignCode | Code identifying the campaign under which this promotion falls. |
| Status | Indicates the current status of the promotion (e.g., active, Inactive). |
| FromDate | Start date of the promotion, from which it becomes available to customers. |
| ToDate | End date of the promotion, after which it is no longer valid. |
| UseWithOtherDiscountCode | Allows the promotion to be used alongside other discount codes if set to true. |
| HasVouchers | Indicates if this promotion includes vouchers |
| Channels | Lists all applicable channels (web, store, app) for the promotion. |
| IsActive | Shows if the promotion is currently active and available for use. |
| CROMessage | Message displayed to encourage customers to complete their purchase, part of conversion rate optimization. |
| IsCROEnabled | Enables or disables the CROMessage feature for this promotion. |
| CROSuccessMessage | Message shown to customers after they’ve successfully used the promotion, as part of conversion rate optimization. |
RMAHeader
| RecordId | Unique identifier for the RMA record |
|---|---|
| CustomNo | Custom number associated with the RMA |
| OrderStatusId | Status identifier of the associated Return order |
| RefOrderId | Reference ID of the original order |
| RefCustomNo | CustomNo of the original order |
| ExternalStatus | External system status of the RMA |
| GrandTotal | Return amount including all charges and taxes |
| SubTotal | Amount excluding taxes and additional charges |
| CompanyId | Unique identifier for the company handling the RMA if B2B user |
| Tax | Tax amount applicable to the RMA |
| ReasonForReturn | Reason specified for returning the item(s) |
| RequiredAction | Return Action Refund/Replacement for return Order |
| CreatedBy | User who created the RMA record |
| ContactEmail | User email linked with the RMA |
| Comments | Additional comments related to the RMA |
| PickupRequired | Indicates if pickup is required (Yes/No) |
| Created | Date and time when the RMA was created |
| CurrencyCode | Currency code used for the RMA transaction |
Product
| Variables | Description |
|---|---|
| RecordId | Unique identifier for the product |
| Brand | Brand Name of the Product |
| SubBrand | Product Sub brand Name |
| StockCode | Unique stockcode o the product |
| Sku | The Stock Keeping Unit, a unique identifier for tracking inventory and sales of the product. |
| Barcode | A machine-readable code used to identify the product, typically found on packaging. |
| Uom | The unit of measure for the product (e.g., pieces, kilograms, liters). |
| UomValue | The quantity or value associated with the unit of measure for the product. |
| Rating | The average customer rating for the product, typically on a scale of 1 to 5 or 1 to 10. |
| SoldCount | The total number of units sold for the product over a specified period. |
| CurrentStock | The current inventory level of the product available for sale. |
| DisplayInSearch | Calculated Field |
| IsActive | Indicates if the product is active |
| FulfilFromWarehouse | Indicates if fulfilled from warehouse |
| FulfilFromstore | Indicates if fulfilled from store |
| FulfilFromSupplier | Indicates if fulfilled from supplier |
| FulfilFromWarehouseDays | Days to fulfill from warehouse |
| FulfilFromSupplierDays | Days to fulfill from supplier |
| FulfilFromInstoreDays | Days to fulfill from in-store |
| IsGiftWrapApplied | Indicates if gift wrap is applied |
| GiftWrapOption | Options for gift wrapping |
| IsDiscontinued | Indicates if product is discontinued |
| DiscontinuationDate | Date when the product is discontinued |
| DisplayOrder | Order of display for the product |
| IsFeatured | Indicates if product is featured |
| SubscriptionEnabled | Indicates if subscriptions are enabled |
| LangCulture | Language culture code |
| Created | Date when the product was created |
| VideoId | ID for associated video content |
| IsMasterStock | Indicates whether the product is a master stock item that can have variations (e.g., sizes or colors). |
| IsVisible | Indicates whether the product is visible to customers on the platform or is hidden. |
| BrandLogo | Logo of the product brand |
| ProductDisplayName | Display name for the product |
| HasVariant | Indicates if product is a variant or a master product |
| BestSeller | Calculated Field |
| Color | Color of the product |
| Size | Size of the product |
| Season | Season for the product |
| NewLaunch | Calculated Field |
| LaunchDate | Published date of the product |
| OnSale | Indicates if product is on sale |
| ColorCode | Hex Color Code representing product color |
| Gender | Gender target for the product |
| Occasion | Occasion suitable for the product |
| AgeGroup | Age group target for the product |
| Pattern | Pattern type of the product |
| Material | Material of the product |
| Trending | Calculated Field |
| Finish | Finish type of the product |
| Style | Style of the product |
| Exclusive | Indicates if product is exclusive |
| ExtendedDescription | Extended description of the product |
| GeneratedAt | Timestamp when product was generated |
| MPN | Manufacturer Part Number |
| GTN | Global Trade Number |
| HSN | HSN code of the product |
| OriginCountry | The country where the product is manufactured or sourced. It’s a core attribute |
| Tags | Keywords or labels associated with the product for categorization and search optimization. |
| LastUpdated | The date and time when the product information was last updated in the system. |