Catalyst Fire Ignition Documentation
Checkout
A "base" batch name for this transaction, which netFORUM will modify with prefixes and suffixed.
If no value is provided, NetFORUM will determine the value to use (typically "WEB").
If a value is provided, but the payment method used for checkout has an apm_suffix defined, netFORUM will use that instead.
Definition
Namespace: Ignition.Commerce.Shopping
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public string CustomBatchName { get; set; }VB
Public Property CustomBatchName As String
Get
SetC++
public:
property String^ CustomBatchName {
String^ get ();
void set (String^ value);
}F#
member CustomBatchName : string with get, setProperty Value
StringRemarks
NetFORUM will always add a date prefix ("yyyy-MM-dd-") and a numeric suffix ("-xxx", starting at 001) to the provided name.
If the resulting name matches an existing usable batch, it will be used; otherwise a new batch will be created.
If an existing batch is found but is not usable (ie, is closed), then the numeric
suffix will be incremented until a either a usable batch is found, or a new batch is created.
This option is mutually exclusive with CustomBatchId.