| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| v:2.0:receipt [2017/06/22 07:24] – [Specifying a custom transaction ID for your store] adam | v:2.0:receipt [2020/10/03 00:34] (current) – [Where the Receipt Fits Into the Order Flow] foxybrett |
|---|
| * General | * General |
| * Payment gateway or processor response | * Payment gateway or processor response |
| * Your store's name (as configured in your store settings | * Your store's name (as configured in your store settings) |
| * The date and time | * The date and time |
| * Order | * Order |
| - Back to your site. | - Back to your site. |
| |
| Also worth noting is that <wrap tip>you can configure the "continue" link</wrap> that's displayed on the receipt in your store's "settings" page. If the continue link is not explicitly set in your store's settings it will use the most recent referring page (ie. the last page that the customer visited before the cart or checkout). If you'd like to set the ''href'' of that link dynamically you can do so with a bit of javascript and the [[.:json|JSON cart object]], which is available on the receipt. | Also worth noting is that <wrap tip>you can configure the "continue" link</wrap> that's displayed on the receipt in your store's "settings" page. If the continue link is not explicitly set in your store's settings it will use the most recent referring page (ie. the last page that the customer visited before the cart or checkout). Or you can [[:v:2.0:snippets:change_continue_category|set the ''href'' of that link dynamically]] |
| |
| ===== Specifying a custom transaction ID for your store ===== | ===== Specifying a custom transaction ID for your store ===== |
| To enable custom ID's for your store, navigate to the ''Advanced'' settings page, and check the ''enable a custom receipt display id'' option. This will provide a few options to customise the ID: | To enable custom ID's for your store, navigate to the ''Advanced'' settings page, and check the ''enable a custom receipt display id'' option. This will provide a few options to customise the ID: |
| |
| ; ''start value'' | ; Start Value |
| : **Description:** The starting number for the custom ID of the next transaction for your store. Setting this as ''1'' will cause the next transaction to have a custom display ID of ''1''. Once you start using a custom display ID, you can only change the start value to a higher number than the last custom display ID number used for a transaction on your store. | : **Description:** The starting number for the custom ID of the next transaction for your store. Setting this as ''1'' will cause the next transaction to have a custom display ID of ''1''. Once you start using a custom display ID, you can only change the start value to a higher number than the last custom display ID number used for a transaction on your store. |
| : **Default:** ''1'' | : **Default:** ''1'' |
| ; **minimum length** | ; Minimum Length |
| : **Description:** Used to set the minimum total length of the auto-incrementing part of the display ID you'd like to have. The display ID will be padded with leading zeros as needed. For example, if you'd like your first display ID to be "00000001" enter a length of 8. | : **Description:** Used to set the minimum total length of the auto-incrementing part of the display ID you'd like to have. The display ID will be padded with leading zeros as needed. For example, if you'd like your first display ID to be "00000001" enter a length of 8. |
| : **Default:** ''1'' | : **Default:** ''1'' |
| ; **prefix** | ; Prefix |
| : **Description:** A value to be appended to the start of the custom ID. For example, if you set the prefix to ''inv-'', your custom ID could look like ''inv-1'' | : **Description:** A value to be appended to the start of the custom ID. For example, if you set the prefix to ''inv-'', your custom ID could look like ''inv-1'' |
| : **Default:** n/a | ; Suffix |
| ; **suffix** | |
| : **Description:** A value to be appended to the end of the custom ID. For example, if you set the prefix to ''_2017'', your custom ID could look like ''1_2017'' | : **Description:** A value to be appended to the end of the custom ID. For example, if you set the prefix to ''_2017'', your custom ID could look like ''1_2017'' |
| : **Default:** n/a | |
| |
| Note that enabling the custom display ID's will only apply to new transactions placed after it's enabled. Any transactions placed while this setting was not enabled will simply have the default global transaction ID | \\ |
| | <WRAP center round info 90%> |
| | Note that enabling the custom display ID's will only apply to new transactions placed after it's enabled. Any transactions placed while this setting was not enabled will simply have the default global transaction ID. |
| | </WRAP> |
| |
| ==== Filtering transactions in the Admin or API ==== | |
| | ==== Filtering by Custom ID in the Admin or API ==== |
| |
| To look for transactions when using a custom display ID, you can use the "Display Id" filter in the admin's transactions report, or filter using ''display_id'' in the API. | To look for transactions when using a custom display ID, you can use the "Display Id" filter in the admin's transactions report, or filter using ''display_id'' in the API. |
