This property allows you to control what action the /batch/addresses endpoint will take with the entered address. There are two supported actions:

• U - Insert or update the address using the one entered in the request.
• R - Remove the address included in the request.

This property allows you to choose what type of record will have an address added, updated, or removed. This property supports the following options:

• C - Customer
• E - Employee
• S - Store
• V - Vendor / Supplier

Passport API will use this property and the entityId property to determine the specific record where an address will be added, updated, or removed.

This property is where you enter the ID of the desired record for a Customer, Employee, Store, or Supplier. Passport API will use this property and the category property to determine the specific record where an address will be added, updated, or removed.

EXAMPLE: If Customer ID 4133696682008 needed to have their Home address updated, the entityId in the batch update request would be "4133696682008" and the associated category would be "C".

Purpose of Property

• In CATAPULT, there can be different types of addresses. These are referred to and identified as Address Descriptions.
• This property allows you to specify the Address Description of the address that is being added, updated, or removed.

Using this Property

• Adding an Address to a Record

  • action = U
  • If the entered Address Description matches an existing one in CATAPULT, the system will use the existing Address Description on the new address.
  • If the entered Address Description doesn't match any existing Address Description in CATAPULT, the system will create a new Address Description.

• Updating an Address on a Record

  • action = U
  • If the entered Address Description matches an existing one in CATAPULT, the system will update the address on the record accordingly.
  • If the entered Address Description doesn't match any existing Address Description in CATAPULT, the system will create a new Address Description and add the entered address to the record (not update the existing address).

• Removing an Address from a Record

  • action = R
  • If the entered Address Description matches an existing one in CATAPULT, the system will remove the entered address from the record.
  • If the entered Address Description doesn't match any existing Address Description in CATAPULT, the system will not remove the entered address from the record and log an error in the /batch/importMessages endpoint.

This property is where you enter the first line of the record's address (e.g., 277 Howard Street).

This property is where you enter the second line of the record's address (e.g., Suite 299).

This property is where you enter the city of the record's address (e.g., Boone).

Purpose of Property

• This property is where you enter the two-character state or province abbreviation where the record's address is located (e.g., NC for North Carolina).
• This property supports a maximum of 2 characters; any more and the batch record will fail.

State/Province Two-Character Abbreviations

• CATAPULT uses a standard two-character abbreviation for states and provinces. Click here for a list of 2-character codes for states and provinces.

Purpose of Property

• This property is where you enter the two-character country abbreviation where the record's address is located (e.g., US for United States).
• This property supports a maximum of 2 characters; any more and the batch record will fail.

Country Two-Character Abbreviations

• CATAPULT uses the ISO 3166 standard for two-character country abbreviations. Click here for a complete list of 2-character country codes.

Minimum BIN for range. Note any records within the min and max range are subject to normal type restrictions.

Maximum BIN for range. Defaults to MIN value if not set.

The Item ID (UPC scancode) of the recipient inventory record. See also: Item ID.

Store Number where the item is located and where the cost will update. See also: Store ID.

The unique supplier identification code to verify recipient catalog. See also: Supplier ID.

P - Permanent
T - Temporary
Defines the type of cost change. See also: Supplier Import Formats.

Specify the store where the catalog cost change will take effect. See also: Store ID.

The unique supplier identification code to verify recipient SUID and catalog. See also: Supplier ID.

Supplier-specific item code to verify which inventory record receives the cost change. See also: Supplier Unit ID.

See also: Catalog Cost.

A - Additive
R - Replacement
Required when importType = T. See also: Stacked.

Format yyyy-mm-dd.
Required when importType = T.
See also: Start Date (Supplier).

• Only the U action is supported with this endpoint; this action will insert and update Customer Records.
• Use the U action even when information needs to be removed from a Customer Record. In these scenarios, include the field you want to remove in the request and leave it blank.

Purpose of Property

• Use this property to enter the Customer ID - as found on their Customer Record in CATAPULT Web Office - of the customer being added or updated.

• The Customer ID can contain alphanumeric and/or special characters.

Using this Property

• Adding a Customer Record

  • The Customer ID entered will be used on the new Customer Record.
  • If the entered Customer ID already exists for a customer, the associated Customer Record (for the existing customer) will be updated.

• Updating a Customer Record

  • The Customer ID entered will be used to determine what Customer Record to update.
  • If the entered Customer ID does not exist in the CATAPULT system, a new Customer Record will be created with the included information.

Available in CATAPULT 5.8.170+

IMPORTANT

• Before using this property and replacing your Customer IDs, you must read the Guidelines & Best Practices for Changing Customer IDs in CATAPULT® ECRS Docs article to help ensure the replacement process is successful throughout your business.

Purpose

• The value of this property will replace the existing Customer ID on the Customer Record.

• The entered newCustomerId value will truly replace the existing Customer ID; no alternate or additional ID will be created.

Potential Use Cases of Property

• Updating the Customer IDs to a new standard set by the merchant or otherwise, or to unify the Customer ID across systems (if multiple are used).

• Replacing Customer IDs without check digits to Customer IDs with check digits.

• Updating the IDs of Customer Records who have lost their Customer ID Cards.

Property Behavior for Existing Customers

Property Behavior for New Customers

Best Practices

• In addition to the guidelines and best practices outlined in this article, a best practice when using this field is to ensure that only one Customer ID is replaced with each request.

• If multiple records with the same Customer ID are replaced in the same request, the endpoint may or may not apply the desired replacement ID due to how all batch endpoints process data (i.e., the order of the data within the request is not honored).

"RAISERROR" Scenarios

The following scenarios will return a RAISERROR, which means the customer update was not performed during batch processing. Error details are available in the /batch/importMessages endpoint.

• This property cannot be used on two separate customers to exchange their Customer IDs, respectively, in the same batch. For example, this property cannot be used to facilitate exchanging the Customer ID of Customer A to that of Customer B, and vice versa.
• Any entered newCustomerId value must not match an existing Customer ID in the CATAPULT database.
• Any entered newCustomerId property must also have an associated customerId property, as Passport API relies on the original ID value to know what record to update.

• Use this property to set or update the customer's prefix (e.g., Mr., Ms., Dr.).
• If the prefix you provide isn’t already in CATAPULT, the system will create a new one.
• If the property is included in the request, but no value is entered, any entered prefix will be removed from the Customer Record.

• Use this property to set or update the customer's first name.
• If the property is included in the request, but no value is entered, the customer's first name will be removed from the Customer Record.

• Use this property to set or update the customer's middle name.
• If the property is included in the request, but no value is entered, the customer's middle name will be removed from the Customer Record.

• Use this property to set or update the customer's last name.
• If the property is included in the request, but no value is entered, the customer's last name will be removed from the Customer Record.

• Use this property to set or update the customer's suffix (e.g., Sr., Jr., III).
• If the suffix you provide isn’t already in CATAPULT, the system will create a new one.
• If the property is included in the request, but no value is entered, any entered suffix will be removed from the Customer Record.

• Use this property to set or update the customer's alias (e.g., "Bob" for a person named Robert).
• If the property is included in the request, but no value is entered, any entered alias will be removed from the Customer Record.

• Use this property to set or update the customer's Power Field 1 value.
• If the Power Field 1 value provided isn’t already in CATAPULT, the system will create a new one.
• If the property is included in the request, but no value is entered, any selected Power Field 1 value will be removed from the Customer Record.

• Use this property to set or update the customer's Power Field 2 value.
• If the Power Field 2 value provided isn’t already in CATAPULT, the system will create a new one.
• If the property is included in the request, but no value is entered, any selected Power Field 2 value will be removed from the Customer Record.

• Use this property to set or update the customer's Power Field 3 value.
• If the Power Field 3 value provided isn’t already in CATAPULT, the system will create a new one.
• If the property is included in the request, but no value is entered, any selected Power Field 3 value will be removed from the Customer Record.

• Use this property to set or update the customer's Power Field 4 value.
• If the Power Field 4 value provided isn’t already in CATAPULT, the system will create a new one.
• If the property is included in the request, but no value is entered, any selected Power Field 4 value will be removed from the Customer Record.

• Use this property to set or update the customer's Power Field 5 value.
• If the property is included in the request, but no value is entered, any entered Power Field 5 value will be removed from the Customer Record.

• Use this property to set or update the customer's Power Field 6 value.
• If the property is included in the request, but no value is entered, any entered Power Field 6 value will be removed from the Customer Record.

• Use this property to set or update the customer's Power Field 7 value.
• If the property is included in the request, but no value is entered, any entered Power Field 7 value will be removed from the Customer Record.

• Use this property to set or update the customer's Power Field 8 value.
• If the property is included in the request, but no value is entered, any entered Power Field 8 value will be removed from the Customer Record.

• Use this property to set or update the customer's title (e.g., "Doctor", "Honorable","CEO").
• If the property is included in the request, but no value is entered, any entered title will be removed from the Customer Record.

• Use this property to set or update the company that the customer is associated with.
• If the property is included in the request, but no value is entered, any entered company will be removed from the Customer Record.

• Use this property to set or update the memo field for the customer.
• If the property is included in the request, but no value is entered, any entered memo text will be removed from the Customer Record.

• Use this property to set or update the customer's birthday.
• If the property is included in the request, but no value is entered, any entered birthday will be removed from the Customer Record.

• Use this property to set or update the customer's assigned Price Level (e.g., 1, 2, 3, or 4). A customer's assigned Price Level will determine the price they pay for items. An item's price - for each Price Level - it set on the Inventory Record in CATAPULT Web Office.
• For existing customers, if this property is included in the request, but no value is entered, the customer's Price Level assignment will not change.
• For new customers, if this property is included in the request, but no value is entered, the customer will not receive an assigned Price Level and will instead pay the Base Price (i.e., Price Level 1) for items.

Context

• In CATAPULT, return limits are established through Return Limit profiles, which can in turn be assigned to Customer Records to limit their return activity at the point of sale.

Purpose

• Use this property to set or update the customer's assigned return limits by entering the name of the Return Limit profile (exactly as it appears in CATAPULT Web Office).

Property Behavior

• Only one Return Limit profile can be specified with this property.
• If the name of the Return Limit profile entered does not match an existing profile in CATAPULT, the batch record will still process, but no Return Limit profile will be created or assigned to the customer.
• Any Return Limit profile specified with this property will replace the customer's current Return Limit profile assignment.

Use this property to set or update the customer's "Opt Out Printed Receipt" preference.

• true = The customer will be opted out of printed receipts.
• false = The customer will NOT be opted out of printed receipts.

If this property is included in the request, but no value is entered, the customer will NOT be opted out of printed receipts (i.e., default behavior).

Use this property to set or update the customer's "Block Suspended Sales" setting.

• true = The customer will be blocked from having their sale/transaction suspended (to be resumed later) at the Point of Sale.
• false = The customer will NOT be blocked from having their sale/transaction suspended at the Point of Sale.

If this property is included in the request, but no value is entered, the customer will NOT be blocked from suspending transactions (i.e., default behavior).

Use this property to set or update the customer's "Hide from Customer Lookup" setting.

• true = The customer will be hidden from customer lookups when they are performed in CATAPULT Transaction Server.
• false = The customer will NOT be hidden from customer lookups when they are performed in CATAPULT Transaction Server.

If this property is included in the request, but no value is entered, the customer will NOT be hidden in customer lookup (i.e., default behavior).

Use this property to set or update the customer's "Inactive" status.

If set to false, the customer will be set as "Active" (i.e., not Inactive).

If set to true, the customer will be marked as "Inactive", and the following will be true:

• The customer will be hidden entirely from customer lookups in CATAPULT Transaction Server.
• Should the cashier try and associate the customer to a transaction at a Point of Sale terminal anywhere in the enterprise, Transaction Server will present the cashier with a message stating that their account is inactive and guide them to contact store personnel for assistance.
• Should the customer try and associate themselves to any variation of Transaction Server kiosk (e.g., Self-Checkout, Made-To-Order, Vending) in the enterprise, Transaction Server will not allow them to associate themselves but instead display a full-screen message stating their account is inactive and guide them to contact store personnel for assistance.
• Should the customer try and associate themselves at any fuel pumps controlled by CATAPULT Fuel in the enterprise, the fuel pump will prevent association and alert the customer that their account is inactive.
• Any established Household relationships for inactive customers will be retained so that if the customer is made "Active" again, their Household affiliation will be preserved. Likewise, because an inactive customer cannot be associated to a transaction, they will not be able to contribute to any Household loyalty balance or redeem/spend any of the available Household rewards.
• Inactive customers will still be included in CATAPULT reports, but their inclusion will vary on the context of the reports, the data the contain, and any filters established. For example, if a customer was previously "active" last month, but have been "inactive" in the current month, reports displaying transaction activity for this month would not include the inactive customer.

If this property is included in the request, but no value is entered, the customer will NOT be "Inactive" (i.e., default behavior).

Use this property to set or update whether or not the customer earns loyalty points.

• true = The customer will be opted into earning loyalty points for the default loyalty program at the store.
• false = The customer will be opted out of earning loyalty points (for any loyalty program).

If this property is included in the request, but no value is entered, the customer will be opted out of earning loyalty points (i.e., default behavior).

• Use this property to set or update the customer's multiplier on loyalty points earned for the default loyalty program.
• If this property is included in the request, but no value is entered, the customer's Loyalty Accrual Multiplier will be set to "0.000" (i.e., default value).

Purpose

Use this property to set or update a customer's tax exempt status for ALL taxes.

• true = The customer will be marked as exempt from ALL taxes.
• false = The customer will not be marked as exempt from ANY taxes.

Conditional Property Behavior

• If this property is included in the request, but no value is entered, the customer will not be marked as exempt from any taxes (i.e., default behavior).
• Exempting a customer from a specific tax is not possible with this property; instead, use the taxExemptState property for this purpose.

Context

• In CATAPULT, Tax Records can be created and assigned to Item Records, Customer Records, and more. Tax Records contain key details on how the software is to treat and apply the tax during transactions.
• Tax Records in CATAPULT have a field called Tax PowerField. One of the primary uses of this field is to define what state the tax is associated with, but the names of cities, towns, or municipalities can also be entered in this field to label taxes.

Purpose

• Use this property to set what specific taxes a customer is exempt from.
• This property references the Tax PowerField field on Tax Records to determine the tax(es) the customer is exempt from. Therefore, the value entered with this property must match the text in at least one Tax PowerField field exactly.
• If multiple taxes have the same Tax PowerField value, the endpoint will mark the customer as exempt from all of those taxes.

Example

• If..."taxExemptState":"NC"
• Then...The customer will be marked as exempt from all Tax Records with a Tax PowerField value of "NC".

Requirements to Use this Property

• The taxExempt property for the same record/customer in the same batch must be set to true.
  • If the taxExempt property is set to false, this property will not affect the endpoint's behavior and the customer will not be marked as exempt from any taxes.
• The value entered with this property must match the text in at least one Tax PowerField field exactly.
  • If the entered value does not match an existing Tax PowerField, the batch record will still process, but the endpoint will not a) add the entered value to the Tax Record, or b) take any action with the customer's tax exemption.

Conditional Property Behavior

• This property only adds the tax(es) that a customer is exempt from (based on the Tax PowerField specified). It does not replace existing tax exemption records or remove them.

Purpose

• Use this property to set or update the Store Coupons / Customer Groups assigned to the customer.

Restrictions

• Any specified Store Coupon / Customer Group names must be 30 characters or less.

Property Behavior

• The exact name of the Store Coupon / Customer Group - as it is entered in CATAPULT Web Office - must be entered in this property. If the entered name does not match, the system will not create a new Store Coupon and the specified record will not be assigned to the customer.

• Multiple Store Coupons / Customer Groups can be set or updated on a Customer Record using this property. To do so, separate each Store Coupon name by a colon ( : ) without spaces (e.g., "BOGO Free:Happy Birthday:10% Off").

• Any Store Coupons / Customer Groups entered with this property will replace any Store Coupons / Customer Groups currently assigned to the customer.

• Enter NONE for this property's value to remove all currently assigned Store Coupons / Customer Groups on the customer.

• Use this property to set or update the customer's Head of Household. If used, this property should contain the Customer ID of the desired Head of Household.

• This property only allows for a customer to be placed within a household, under the specified Head of Household. It does not permit for a current household member to be made a Head of Household.

Purpose

Use this property to set or update the customer's relationship to the specified Head of Household. This property depends on the Head of Household specified with the householdMainCustomerId property.

• EXAMPLE: If Customer ID (12345) has Customer ID (98765) as their Head of Household, and Customer "12345" is the daughter of Customer "98765", then Daughter would be entered in this property.

Property Behavior

• If no Head of Household is specified, the customer's Household Relation will not be updated.

• If this property is included in the request, but no value is entered, the customer's "Relationship" to the Head of Household will be cleared/removed.

Purpose

Use this property to allow or prevent the customer from redeeming loyalty points earned by their household. This property depends on the Head of Household specified with the householdMainCustomerId property.

Property Behavior

• Setting this property to true will allow the customer to redeem household loyalty points.

• Setting this property to false will prevent the customer from redeeming household loyalty points.

• If no Head of Household is specified, the customer's "Redeem Household Loyalty" status will not be updated.

• If this property is included in the request, but no value is entered, the customer's "Redeem Household Loyalty" status will not be changed.

Type of Action to be Performed:

• 'U' - Insert or Update
• 'R' - Remove

Category of the address:

• 'C' - Customer Address
• 'E' - Employee Address
• 'S' - Store Address
• 'V' - Vendor / Supplier Address
  See also: E-mail Profiles.

Exact value of the entityId depends entirely on, and must correspond to, the selected category: it can conditionally be the customerId, employeeId, storeId, or supplierId.

Enter the name of the Email Description to use. See also: E-mail Description.

See also: E-mail Address.

Purpose

• This property is where the fuel product's assigned number is entered so Passport API can identify which fuel product to update prices for. A fuel product's number is assigned in the next generation of CATAPULT Web Office, in the Fuel Products & Pricing section.
• Passport API will use this property in conjunction with the storeId to determine which fuel product to update pricing for.
• Fuel product numbers range between 1-9, and will be unique to each store. When specifying a fuel product number, ensure the number matches the desired product at the correct store.

Scenario-Based Property Behavior

Purpose

• This property is where the ID of the store is entered so Passport API can know the scope of the pricing updates for the specified fuel product.
• Passport API will use this property in conjunction with the fuelProductNumber to determine which fuel product to update pricing for.

Scenario-Based Property Behavior

Purpose

• This property allows you to update a fuel product's cash price at the specified store.
• If the cash price of a fuel product does not need to be updated, this property should not be included in the request.

Using This Property To Update A Fuel Product's Cash Price

• The entered cash price must be less than or equal to 99.9999.
• Passport API will round the entered cash price to four decimal places if five or more decimal places are entered (e.g., a price of 3.78917 would be rounded to 3.7892).
• The entered cash price must not include dollar or monetary symbols; Passport API will not process the cash price updates if the symbols are included.

Scenario-Based Property Behavior

See also: Worksheet Name (IL).

See also: Store ID.

See also: Add Items (IL).

See also: Type (IL).

See also: Type (IL).

Type of Action to be Performed:

• 'U' - Insert or Update
• 'R' - Remove

See also: Item ID.

See also: Alternate ID Scancode.

See also: Alternate ID Receipt Alias.

See also: Item Groups, Linked Items.

See also: Item Groups, Linked Items.

See also: Item ID.

Type of Action to be Performed:

• U - Insert or Update
• R - Remove

The Item ID of the item being added or edited.

Available with CATAPULT 5.8.163 or Newer

IMPORTANT

• Before using this field and replacing your Item IDs, you must read the Guidelines & Best Practices for Changing Item IDs in CATAPULT® article in the ECRS Online Manual to help ensure the replacement process is successful throughout your business.

Purpose

• This field allows you to replace the existing Item ID of an item with another ID.

Potential Use Cases of Property

• Replacing non-standard PLUs on produce items to standard PLUs.
• Replacing the Item IDs of non-barcoded items (e.g., homemade baked goods) to a new standard set by the merchant or otherwise.
• Replacing Item IDs without check digits to Item IDs with check digits.

Property Behavior

• The entered replaceItemID value will not create an Alternate ID for the item; it will truly replace the existing Item ID.
• The entered replaceItemID value must not match any existing Item ID or Alternate ID in the CATAPULT database. Item records with replaceItemID values that match an existing ID will be rejected during batch processing, with error details available in the /batch/importMessages endpoint.
• Any replaceItemID values with leading spaces will be automatically adjusted to remove those spaces.
• Any replaceItemID values with one or more spaces in the middle of the value will be preserved (i.e., the spaces won't be removed).
• If a replaceItemID value has one or more spaces at the end of the value, those spaces will be ignored and not processed.
• Any replaceItemID values longer than 14 characters will be automatically truncated during batch processing (e.g., A value of 73852073966492000 would be truncated to 73852073966492).

Best Practices

• In addition to the guidelines and best practices outlined in this article, a best practice when using this field is to ensure that only one record of an Item ID is being replaced in each request. If multiple records with the same Item ID are being replaced in the same request, the endpoint may or may not apply the desired replacement ID due to how all batch endpoints process data (i.e., the order of the data within the request is not honored).

• The number of the Department that the item should be added or moved into.
• This value is required for new items.

• The name of the Department that the item should be added or moved into.
• This value is required for new items.

The descriptive name of the item.

• The descriptive text of the item that will appear on receipts.
• This value is required for new items.

• The Brand of the item.
• Enter NONE to set to null/no choice.

The package size of the item (e.g., 16 OZ).

• The list of Cashier Prompts that should be assigned to the item. Any entered names must exactly match the corresponding records in CATAPULT.
• Multiple Cashier Prompts must be separated by a colon (e.g., Paper or Plastic:Tax Exempt Number).
• The entered list of Cashier Prompts will replace any assigned Cashier Prompts on the item.
• If this property is not included in the request, or an empty string is passed, then the Cashier Prompts assigned to the item will remain unchanged.
• Enter NONE to remove all Cashier Prompts currently assigned to an existing item.

Purpose

• The list of Manual Discounts that are allowed to be used on the item. Any entered names must exactly match the corresponding records in CATAPULT.
• Multiple discount names must be separated by a colon (e.g., Military Discount:Farmer Discount).

Property Behavior

• The entered list of Manual Discounts will replace any assigned Manual Discounts on the item.
• If this property is not included in the request, or an empty string is passed, then the Manual Discounts assigned to the item will remain unchanged.

Additional Property Values

• Enter NONE to remove all Manual Discounts currently assigned to an existing item.

• Enter DEFAULT to assign the default discounts to the item. The discounts assigned will depend on the Item Hierarchy that the item is a part of; specifically, the discounts assigned will come from the lowest level of Item Hierarchy that the item is a part of.

  EXAMPLES: Default Discount Assignment

  • If Item A is a part of an Item Hierarchy structure down to the Category level, and that Category has "Senior Discount" as the default Manual Discounts, then Item A will be assigned "Senior Discount" as the Manual Discount if DEFAULT is sent for the discountList property.

  • If Item B is a part of an Item Hierarchy structure down to the Sub-Category level, and that Sub-Category has no default Manual Discounts selected, then the Manual Discounts field for Item B will be empty if DEFAULT is sent for the discountList property.

The suggested retail price (SRP) of the item.

• The item's Power Field 1 assignment.
• Enter NONE to set to null/no choice.

• The item's Power Field 2 assignment.
• Enter NONE to set to null/no choice.

• The item's Power Field 3 assignment.
• Enter NONE to set to null/no choice.

• The item's Power Field 4 assignment.
• Enter NONE to set to null/no choice.

The item's Power Field 5 assignment.

The item's Power Field 6 assignment.

The item's Power Field 7 assignment.

The item's Power Field 8 assignment.

Any text that should be entered into the Memo field on the item's inventory record.

• This parameter allows you to specify a Linked Item Group for the item.
• If a Linked Item Group is specified, it will be appllied to ALL stores for that item.
• Enter NONE to set to null/no choice.
• NOTE: If you want to choose an item's Linked Item Group for a specific store, use the Batch Item Store Data endpoint.

Determines if the item is returnable or not.

• true: The item cannot be returned, and the corresponding "Item cannot be returned" checkbox on the item's inventory record in Web Office will be checked.
• false: The item can be returned, and the corresponding "Item cannot be returned" checkbox on the item's inventory record in Web Office will NOT be checked.

Determines if the sale of the embedded price package for the item will be treated as a single unit.

• true: The "Treat the sale of embedded price package as a single unit" checkbox on the item's inventory record in Web Office will be checked.
• false: The "Treat the sale of embedded price package as a single unit" checkbox on the item's inventory record in Web Office will NOT be checked.

The item's "Country of Origin Label" text that can be used for identification and marketing purposes.

• The number of the Sub-Department Item Hierarchy level that the item should be added or moved into.
• You must also specify a deptNo if using this field.

• The number of the Category Item Hierarchy level that the item should be added or moved into.
• You must also specify a deptNo and subDeptNumber if using this field.

• The number of the Sub-Category Item Hierarchy level that the item should be added or moved into.
• You must also specify a deptNo, subDeptNumber, and categoryNumber if using this field.

Type of Action to be Performed:

• 'U' - Insert or Update
• 'R' - Remove
• 'D' - Discontinue

The Item ID of the item - as entered in CATAPULT Web Office on the Inventory Record - that is to have ordering information updated.

The ID Number of the item's Supplier, as entered in CATAPULT Web Office on the Supplier Record. This ID should match the Supplier for the item where ordering information needs to be updated.

The Supplier Unit ID (SUID) of the item - as entered in CATAPULT Web Office on the Inventory Record - that is to have ordering information updated.

• The quantity of packages/items included in one order unit.
• IMPORTANT: This field is required if the U action is performed.

A descriptive name for the unit that the order item comes as (e.g., CS or EA).

Adding/Inserting New Supplier Unit ID Records

• IMPORTANT: The orderUnitName field is required if new Supplier Unit ID records are being added to inventory records via the U action. If no name is specified, the Supplier Unit ID record will not be added and an error will be recorded in the /batch/importMessages endpoint for the corresponding batch.
• With CATAPULT 5.8.161 and newer, new Order Units will be created if the name specified in the request does not match an existing entry in the CATAPULT database. If new Order Units are created, they will have a default orderQty of 0. In previous CATAPULT versions, passing an orderUnitName that did not match an existing Order Unit would result in an error.

Updating Existing Supplier Unit ID Records

• The orderUnitName field is NOT required if updates to existing Supplier Unit ID records are being made (via the U action).
• If existing Supplier Unit ID records are being updated, and an orderUnitName is included in the request, the specified name must exactly match an existing Order Unit Name in the CATAPULT database. If the specified Order Unit Name does not match an existing record, then either a new Order Unit will be created (with CATAPULT 5.8.161 and newer), or an error will be recorded in the /batch/importMessages endpoint for the corresponding batch (with CATAPULT 5.8.160 or older).

Determines whether or not the SUID is the Default ordering preference for the item for the specified Supplier.

• true = The SUID is the Default selection.
• false = The SUID is not the Default selection.

Available with CATAPULT 5.6.101 and newer

• This field allows you to look up or create a Supplier Distribution Center record's "ID" field.
• Each inventory item's orderId (a.k.a Supplier Unit ID) will be used to identify the correct Supplier where the Distribution Center needs to be looked up or added.
• If this field is populated, along with the vendorDistributionCenterName, new Distribution Center records will be added for the supplier if they are not originally found.
• If this field is populated with NONE, then the Distribution Center will be removed/unassociated from the item's orderId.

Available with CATAPULT 5.6.101 and newer

• This field allows you to enter the name of a new Distribution Center being added for a supplier.
• Each inventory item's orderId (a.k.a Supplier Unit ID) will be used to identify the correct Supplier where the Distribution Center needs to be added.
• This field is only required when adding a new Distribution Center for a Supplier.
• If this field is not populated, and a new Distribution Center is being added, the vendorDistributionCenterID value will be copied and used as the "Name" for the new Distribution Center.

This field allows you to specify the Supplier Unit ID's minimum order quantity (i.e., the quantity of the Supplier Unit ID (SUID) that must be ordered from the supplier at any given time).

Note the following:

• The Minimum Order Quantity entered must be a positive number. If negative, the request will fail.
• The Minimum Order Quantity entered must not be longer than the maximum length of 999999999999.999. If longer, then the request will fail.
• This field is not required, but if no Minimum Order Quantity is specified, and default value of 0.000 will be used.
• Only if minimumOrder is included in the request will the corresponding field be updated for the inventory item. Meaning, other aspects about the item's Supplier Unit ID can be updated or specified and the minimumOrder can remain unchanged, if desired.

See also: Item ID.

See also: Zones.

See also: Price Levels.

See also: Prompt for Price.

See also: Auto Discount.

See also: Count Towards Quantity.

See also: Ideal Margin.

See also: Pricing Divider.

Family Line name. Enter 'NONE' to set to null/no choice. See also: Family Lines.

Applies to all stores in the Zone specified. Use 'Batch Item Store Data' for updates to a single store. This value will be recorded with transactions. See also: Retail Value.

Type of Action to be Performed:

• 'U' - Insert or Update
• 'R' - Remove
• 'D' - Discontinue

See also: Name).

See also: Pricing Zone.

See also: Store Groups.

See also: Receipt Alias.

See also: Minimum Purchase Amount.

See also: Maximum Purchase Amount.

See also: Maximum Transaction Discount.

See also: Maximum Discount/Promotion.