Change increment ID for a DB entity (order, invoice, credit memo, etc.) on particular store

This article discusses how to change the increment ID for a Magento database (DB) entity (order, invoice, credit memo, etc.) on a particular Magento store using the ALTER TABLE SQL statement.

Affected versions

• Magento Commerce: 2.x.x  
• Magento Commerce (Cloud): 2.x.x
• MySQL: any supported version

When would you need to change increment ID (cases)

You might need to change the increment ID for new DB entities in these cases:

• After a hard backup restore on a Live site
• Some order records have been lost, but their ID's are already being used by payment gateways (like PayPal) for your current Merchant account. Such being the case, the payment  gateways stop processing new orders that have the same ID's, returning the "Duplicate invoice id" error

You may also fix the payment gateway issue for PayPal by allowing multiple payments per invoice ID in PayPal's Payment Receiving Preferences. See the Knowledge Base article: PayPal gateway rejected request - duplicate invoice issue .

Prerequisite steps

1. Find stores and entities for which the new increment ID should be changed.
2. Connect to your MySQL DB.
   For Magento Commerce (Cloud), at first, you need to SSH to your environment.
3. Check the current auto_increment value for the entity sequence table using the following query:
   

   SHOW TABLE STATUS FROM `{database_name}` WHERE `name` LIKE 'sequence_{entity_type}_{store_id}';
   

Example

If you are checking an auto increment for an order on the store with ID=1, the table name would be:

'sequence_order_1'

If the value of the auto_increment column is 1234, the next order placed at the store with ID=1 will have the ID #100001234.

Related documentation on DevDocs

• Set up a remote MySQL database connection

Update entity to change increment ID

Update the entity using the following query:

ALTER TABLE sequence_{entity_type}_{store_id} AUTO_INCREMENT = {new_increment_value};

Important: The new increment value must be greater than the current one, not less!

Example

After executing the following query:

ALTER TABLE sequence_order_1 AUTO_INCREMENT = 2000;

the next order placed at the store with ID=1 will have the ID #100002000.

Additional recommended steps on Production environment (Cloud) 

Before executing the ALTER TABLE query on the Production environment of Magento Commerce (Cloud), we strongly recommend performing these steps:

• Test the entire procedure of changing the increment ID on your Staging environment
• Create a DB backup to restore your Production DB in case of failure

Related documentation

• Create database dump on Cloud
• SSH to your environment