The internal identifier of the promotion code. This unique ID is used to reference and manage the promotion code within the system, ensuring it can be tracked and applied accurately.

Specifies the type of transaction or items to which the promotion code's discount applies. Common options can include 'Order Total,' 'Line Items,' or 'Shipping,' helping to define the scope of the discount.

The allowed values are _allSales, _firstSaleOnly.

The actual code used by customers to apply the promotion. This alphanumeric string is the key element customers enter during checkout to avail of the promotional discount.

Defines a pattern or format for the promotion code. This could include rules for valid characters, length, or structure, ensuring consistency and compliance with the business's discounting rules.

Indicates whether to replace the current list of currencies for which the promotion code is valid. If set to 'True,' this will replace the existing list with the new one, useful for multi-currency setups.

The external identifier for the custom form associated with the promotion code. This field is used when integrating with external systems or to reference specific promotional forms linked to the promotion.

The internal identifier for the custom form linked to the promotion code. This ID ties the promotion code to a particular custom form in your internal system, allowing for specialized tracking or data entry.

The name of the custom form used for the promotion code. This provides a label to help identify the form that holds additional promotion details, such as conditions or rules for the promotion.

The type of custom form applied to the promotion code. This can include categories such as 'Discount Form,' 'Voucher Form,' or 'Campaign Form,' helping classify the form based on its use.

The allowed values are account, accountingPeriod, appDefinition, appPackage, assemblyBuild, assemblyUnbuild, assemblyItem, bin, binTransfer, binWorksheet, budget, budgetCategory, calendarEvent, campaign, campaignAudience, campaignCategory, campaignChannel, campaignFamily, campaignOffer, campaignResponse, campaignSearchEngine, campaignSubscription, campaignVertical, cashRefund, cashSale, check, classification, contact, contactCategory, contactRole, costCategory, couponCode, creditMemo, crmCustomField, currency, currencyRate, customList, customRecord, customRecordCustomField, customRecordType, customer, customerCategory, customerDeposit, customerMessage, customerPayment, customerRefund, customerStatus, depositApplication, department, descriptionItem, discountItem, downloadItem, employee, entityCustomField, entityGroup, estimate, expenseCategory, expenseReport, file, folder, giftCertificate, giftCertificateItem, interCompanyJournalEntry, interCompanyTransferOrder, inventoryAdjustment, inventoryItem, inventoryNumber, inventoryTransfer, invoice, itemCustomField, itemDemandPlan, itemFulfillment, itemGroup, itemNumberCustomField, itemOptionCustomField, itemSupplyPlan, itemRevision, issue, job, jobStatus, jobType, itemReceipt, journalEntry, kitItem, leadSource, location, lotNumberedInventoryItem, lotNumberedAssemblyItem, markupItem, message, manufacturingCostTemplate, manufacturingOperationTask, manufacturingRouting, nexus, nonInventoryPurchaseItem, nonInventoryResaleItem, nonInventorySaleItem, note, noteType, opportunity, otherChargePurchaseItem, otherChargeResaleItem, otherChargeSaleItem, otherCustomField, otherNameCategory, partner, partnerCategory, paycheckJournal, paymentItem, paymentMethod, payrollItem, phoneCall, priceLevel, pricingGroup, projectTask, promotionCode, purchaseOrder, returnAuthorization, revRecSchedule, revRecTemplate, salesOrder, salesRole, salesTaxItem, serializedInventoryItem, serializedAssemblyItem, servicePurchaseItem, serviceResaleItem, serviceSaleItem, solution, siteCategory, state, subsidiary, subtotalItem, supportCase, supportCaseIssue, supportCaseOrigin, supportCasePriority, supportCaseStatus, supportCaseType, task, taxGroup, taxType, term, timeBill, topic, transferOrder, transactionBodyCustomField, transactionColumnCustomField, unitsType, vendor, vendorCategory, vendorBill, vendorCredit, vendorPayment, vendorReturnAuthorization, winLossReason, workOrder, workOrderIssue, workOrderCompletion, workOrderClose.

A textual description of the promotion code. This field provides an explanation of the promotion's purpose, conditions, or benefits, and can be shown to customers or used for internal reference.

The external identifier for the discount associated with the promotion code. This ID links the promotion code to a specific discount in external systems or business processes.

The internal identifier for the discount linked to the promotion code. It ties the promotion code to a particular discount in your internal system, facilitating reporting and management.

The name of the discount associated with the promotion code. This name provides context for the type of discount, such as '10% Off' or 'Buy One Get One Free,' making the promotion easily identifiable.

Specifies the type of discount offered by the promotion code. Common options can include 'Percentage,' 'Fixed Amount,' or 'Free Shipping,' helping to clarify how the discount is applied.

The allowed values are account, accountingPeriod, appDefinition, appPackage, assemblyBuild, assemblyUnbuild, assemblyItem, bin, binTransfer, binWorksheet, budget, budgetCategory, calendarEvent, campaign, campaignAudience, campaignCategory, campaignChannel, campaignFamily, campaignOffer, campaignResponse, campaignSearchEngine, campaignSubscription, campaignVertical, cashRefund, cashSale, check, classification, contact, contactCategory, contactRole, costCategory, couponCode, creditMemo, crmCustomField, currency, currencyRate, customList, customRecord, customRecordCustomField, customRecordType, customer, customerCategory, customerDeposit, customerMessage, customerPayment, customerRefund, customerStatus, depositApplication, department, descriptionItem, discountItem, downloadItem, employee, entityCustomField, entityGroup, estimate, expenseCategory, expenseReport, file, folder, giftCertificate, giftCertificateItem, interCompanyJournalEntry, interCompanyTransferOrder, inventoryAdjustment, inventoryItem, inventoryNumber, inventoryTransfer, invoice, itemCustomField, itemDemandPlan, itemFulfillment, itemGroup, itemNumberCustomField, itemOptionCustomField, itemSupplyPlan, itemRevision, issue, job, jobStatus, jobType, itemReceipt, journalEntry, kitItem, leadSource, location, lotNumberedInventoryItem, lotNumberedAssemblyItem, markupItem, message, manufacturingCostTemplate, manufacturingOperationTask, manufacturingRouting, nexus, nonInventoryPurchaseItem, nonInventoryResaleItem, nonInventorySaleItem, note, noteType, opportunity, otherChargePurchaseItem, otherChargeResaleItem, otherChargeSaleItem, otherCustomField, otherNameCategory, partner, partnerCategory, paycheckJournal, paymentItem, paymentMethod, payrollItem, phoneCall, priceLevel, pricingGroup, projectTask, promotionCode, purchaseOrder, returnAuthorization, revRecSchedule, revRecTemplate, salesOrder, salesRole, salesTaxItem, serializedInventoryItem, serializedAssemblyItem, servicePurchaseItem, serviceResaleItem, serviceSaleItem, solution, siteCategory, state, subsidiary, subtotalItem, supportCase, supportCaseIssue, supportCaseOrigin, supportCasePriority, supportCaseStatus, supportCaseType, task, taxGroup, taxType, term, timeBill, topic, transferOrder, transactionBodyCustomField, transactionColumnCustomField, unitsType, vendor, vendorCategory, vendorBill, vendorCredit, vendorPayment, vendorReturnAuthorization, winLossReason, workOrder, workOrderIssue, workOrderCompletion, workOrderClose.

Indicates whether the promotion code applies a discount type, such as a percentage or fixed amount. This helps categorize the discount method for easier tracking and reporting.

Indicates whether the discount is applied to individual line items. If set to 'True,' the discount will be displayed at the line level, offering more detailed information to customers during checkout.

The expiration date for the promotion code. This field determines when the promotion is no longer valid and helps manage time-sensitive discounts, ensuring they are only active within the specified timeframe.

Indicates whether certain items are excluded from the promotion code. If set to 'True,' specific items or categories can be excluded from receiving the discount, helping control the promotion's reach.

The external identifier for the promotion code. This ID is typically used for integration purposes and can be mapped to systems outside your internal environment, ensuring smooth synchronization.

The external identifier for the free shipping method linked to the promotion code. This helps to identify which shipping method will be applied for free during the promotion.

The internal identifier for the free shipping method tied to the promotion code. This ID links the promotion code to a specific shipping option within the system.

The name of the free shipping method associated with the promotion code. This provides a label for the shipping method, such as 'Standard Shipping,' helping clarify the terms of the promotion.

The type of free shipping method linked to the promotion code. It can help categorize the shipping method as 'Standard,' 'Express,' or 'International,' based on the shipping rules applied during the promotion.

The allowed values are account, accountingPeriod, appDefinition, appPackage, assemblyBuild, assemblyUnbuild, assemblyItem, bin, binTransfer, binWorksheet, budget, budgetCategory, calendarEvent, campaign, campaignAudience, campaignCategory, campaignChannel, campaignFamily, campaignOffer, campaignResponse, campaignSearchEngine, campaignSubscription, campaignVertical, cashRefund, cashSale, check, classification, contact, contactCategory, contactRole, costCategory, couponCode, creditMemo, crmCustomField, currency, currencyRate, customList, customRecord, customRecordCustomField, customRecordType, customer, customerCategory, customerDeposit, customerMessage, customerPayment, customerRefund, customerStatus, depositApplication, department, descriptionItem, discountItem, downloadItem, employee, entityCustomField, entityGroup, estimate, expenseCategory, expenseReport, file, folder, giftCertificate, giftCertificateItem, interCompanyJournalEntry, interCompanyTransferOrder, inventoryAdjustment, inventoryItem, inventoryNumber, inventoryTransfer, invoice, itemCustomField, itemDemandPlan, itemFulfillment, itemGroup, itemNumberCustomField, itemOptionCustomField, itemSupplyPlan, itemRevision, issue, job, jobStatus, jobType, itemReceipt, journalEntry, kitItem, leadSource, location, lotNumberedInventoryItem, lotNumberedAssemblyItem, markupItem, message, manufacturingCostTemplate, manufacturingOperationTask, manufacturingRouting, nexus, nonInventoryPurchaseItem, nonInventoryResaleItem, nonInventorySaleItem, note, noteType, opportunity, otherChargePurchaseItem, otherChargeResaleItem, otherChargeSaleItem, otherCustomField, otherNameCategory, partner, partnerCategory, paycheckJournal, paymentItem, paymentMethod, payrollItem, phoneCall, priceLevel, pricingGroup, projectTask, promotionCode, purchaseOrder, returnAuthorization, revRecSchedule, revRecTemplate, salesOrder, salesRole, salesTaxItem, serializedInventoryItem, serializedAssemblyItem, servicePurchaseItem, serviceResaleItem, serviceSaleItem, solution, siteCategory, state, subsidiary, subtotalItem, supportCase, supportCaseIssue, supportCaseOrigin, supportCasePriority, supportCaseStatus, supportCaseType, task, taxGroup, taxType, term, timeBill, topic, transferOrder, transactionBodyCustomField, transactionColumnCustomField, unitsType, vendor, vendorCategory, vendorBill, vendorCredit, vendorPayment, vendorReturnAuthorization, winLossReason, workOrder, workOrderIssue, workOrderCompletion, workOrderClose.

The external identifier for the implementation details of the promotion code. This links the promotion code to an external system where its implementation or conditions might be stored.

The internal identifier for the implementation details of the promotion code. This helps track and manage how the promotion is implemented within your internal systems.

The name of the implementation associated with the promotion code. This could refer to the specific process or campaign under which the promotion is applied, such as 'Holiday Sale' or 'Flash Discount.'

The type of implementation used for the promotion code. It defines whether the promotion is 'Automated,' 'Manual,' or 'Campaign-based,' helping classify the application method for the discount.

The allowed values are account, accountingPeriod, appDefinition, appPackage, assemblyBuild, assemblyUnbuild, assemblyItem, bin, binTransfer, binWorksheet, budget, budgetCategory, calendarEvent, campaign, campaignAudience, campaignCategory, campaignChannel, campaignFamily, campaignOffer, campaignResponse, campaignSearchEngine, campaignSubscription, campaignVertical, cashRefund, cashSale, check, classification, contact, contactCategory, contactRole, costCategory, couponCode, creditMemo, crmCustomField, currency, currencyRate, customList, customRecord, customRecordCustomField, customRecordType, customer, customerCategory, customerDeposit, customerMessage, customerPayment, customerRefund, customerStatus, depositApplication, department, descriptionItem, discountItem, downloadItem, employee, entityCustomField, entityGroup, estimate, expenseCategory, expenseReport, file, folder, giftCertificate, giftCertificateItem, interCompanyJournalEntry, interCompanyTransferOrder, inventoryAdjustment, inventoryItem, inventoryNumber, inventoryTransfer, invoice, itemCustomField, itemDemandPlan, itemFulfillment, itemGroup, itemNumberCustomField, itemOptionCustomField, itemSupplyPlan, itemRevision, issue, job, jobStatus, jobType, itemReceipt, journalEntry, kitItem, leadSource, location, lotNumberedInventoryItem, lotNumberedAssemblyItem, markupItem, message, manufacturingCostTemplate, manufacturingOperationTask, manufacturingRouting, nexus, nonInventoryPurchaseItem, nonInventoryResaleItem, nonInventorySaleItem, note, noteType, opportunity, otherChargePurchaseItem, otherChargeResaleItem, otherChargeSaleItem, otherCustomField, otherNameCategory, partner, partnerCategory, paycheckJournal, paymentItem, paymentMethod, payrollItem, phoneCall, priceLevel, pricingGroup, projectTask, promotionCode, purchaseOrder, returnAuthorization, revRecSchedule, revRecTemplate, salesOrder, salesRole, salesTaxItem, serializedInventoryItem, serializedAssemblyItem, servicePurchaseItem, serviceResaleItem, serviceSaleItem, solution, siteCategory, state, subsidiary, subtotalItem, supportCase, supportCaseIssue, supportCaseOrigin, supportCasePriority, supportCaseStatus, supportCaseType, task, taxGroup, taxType, term, timeBill, topic, transferOrder, transactionBodyCustomField, transactionColumnCustomField, unitsType, vendor, vendorCategory, vendorBill, vendorCredit, vendorPayment, vendorReturnAuthorization, winLossReason, workOrder, workOrderIssue, workOrderCompletion, workOrderClose.

Indicates whether the promotion code is inactive. If set to 'True,' the promotion code will not be available for use, regardless of its validity dates or other conditions.

Indicates whether the promotion code is public or private. A public promotion code is available to all customers, whereas a private one can be restricted to certain groups or by invitation only.

Indicates whether to replace the current list of eligible items for the promotion code. If set to 'True,' this will replace the existing list with the new items, ensuring the discount applies to the correct products.

The minimum order amount required to use the promotion code. This value sets the threshold that customers must meet in order to apply the discount, ensuring that promotions are used in the intended manner.

The name of the promotion code. This is a descriptive label used to identify the promotion, such as 'Summer Sale' or 'Black Friday Deal,' helping both customers and staff recognize the offer.

The number of promotion codes to generate. This field controls how many unique codes are created, useful for campaigns requiring a fixed number of promotion codes to be distributed.

Indicates whether to replace the current list of partners eligible for the promotion code. If set to 'True,' the existing partner list will be replaced, ensuring that the correct group of partners can use the promotion.

The rate at which the promotion code applies its discount, such as '10%' or '$5 Off.' This field determines the amount or percentage deducted from the total price when the promotion is applied.

The start date of the promotion code. This marks the beginning of the promotion period, during which the code can be used by customers to avail the discount.

Specifies how the promotion code is used, such as 'Single Use,' 'Multi-Use,' or 'One Per Customer.' This defines the limitations on the number of times the promotion can be applied to a transaction.

The allowed values are _multipleUses, _singleUse.