Param name | Description |
---|---|
organization_id required |
Filter sync plans by organization name or label Validations:
|
name optional |
filter by name Validations:
|
sync_date optional |
filter by sync date Validations:
|
interval optional |
filter by interval Validations:
|
search optional |
Search string Validations:
|
page optional |
Page number, starting at 1 Validations:
|
per_page optional |
Number of results per page to return Validations:
|
order optional |
Sort field and order, eg. 'name DESC' Validations:
|
full_result optional |
Whether or not to show all results Validations:
|
sort optional |
Hash version of 'order' param Validations:
|
sort[by] optional |
Field to sort the results on Validations:
|
sort[order] optional |
How to order the sorted results (e.g. ASC for ascending) Validations:
|
Param name | Description |
---|---|
organization_id optional |
Filter sync plans by organization name or label Validations:
|
id required |
sync plan numeric identifier Validations:
|
Param name | Description |
---|---|
organization_id required |
Filter sync plans by organization name or label Validations:
|
name required |
sync plan name Validations:
|
interval required |
how often synchronization should run Validations:
|
sync_date required |
start datetime of synchronization Validations:
|
description optional |
sync plan description Validations:
|
enabled required |
enables or disables synchronization Validations:
|
Param name | Description |
---|---|
organization_id optional |
Filter sync plans by organization name or label Validations:
|
id required |
sync plan numeric identifier Validations:
|
name optional |
sync plan name Validations:
|
interval optional |
how often synchronization should run Validations:
|
sync_date optional |
start datetime of synchronization Validations:
|
description optional |
sync plan description Validations:
|
enabled optional |
enables or disables synchronization Validations:
|
Param name | Description |
---|---|
organization_id optional |
Filter sync plans by organization name or label Validations:
|
id optional |
sync plan numeric identifier Validations:
|
Param name | Description |
---|---|
id required |
ID of the sync plan Validations:
|
product_ids required |
List of product ids to add to the sync plan Validations:
|
Param name | Description |
---|---|
id required |
ID of the sync plan Validations:
|
product_ids required |
List of product ids to remove from the sync plan Validations:
|
Param name | Description |
---|---|
id required |
ID of the sync plan Validations:
|