sync:full
On this page
sync:full forces a full re-download of POS data from the server. An optional object parameter limits the sync to a single object type rather than re-downloading everything.
This action is also triggered from the Data Management section in POS settings via the “Re-sync all data” button (which shows a confirmation modal before executing).
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
object |
String | No | Sync only this object. Accepts a standard POS sync object API name (e.g. product2, s_c__cart__c) or a legacy alias (see below). Case-insensitive. If omitted, all objects are re-synced. |
Legacy aliases
Some resources use friendly names rather than Salesforce object API names:
| Alias | Resource |
|---|---|
orders |
Orders |
stores |
Stores |
fulfillments |
Fulfillments |
If object is provided but not recognized as a valid sync object or legacy alias, the action logs sync:full: unknown object <name> to the console and does nothing.
Behavior
object value |
Effect |
|---|---|
| Omitted | Sets the force-sync flag to clear all existing data and starts a full sync of every object. |
| Valid sync object | Resets that object’s sync cursor and re-paginates it from the start. Other objects are untouched. |
| Legacy alias | Resets the matching legacy cursor and triggers a full re-sync for that resource only. Other objects are untouched. |
| Unknown value | Logs an error to the console and does nothing. |
Usage
Action item configuration
Set the Action field on a s_c__Pos_Action_Item__c record:
sync:full
To sync a single object, set Params to:
object=product2
JavaScript
javascript
scAction('sync:full') // re-sync everything
scAction('sync:full', { object: 'product2' }) // single regular object
scAction('sync:full', { object: 'orders' }) // single legacy resource
Related
-
[[pos-sc-action scAction]] — the global JavaScript function for triggering actions -
[[pos-actions-reference POS actions reference]] — list of all available actions