Plentymarkets interface documentation
Contracts
Core
ElasticSyncMappingFilterRepositoryContract
This interface allows you to get, list, create, update and delete elastic sync mapping filters.
Namespace
Plenty\Modules\ElasticSync\Contracts\Core
Methods
public createSyncMappingFilter($mappingId, $data):void
Create a sync mapping filter.
Name |
Type |
Description |
|
The id of the mapping |
|
|
The request data |
public getSyncMappingFilter($filterId):void
Get a sync mapping filter.
Name |
Type |
Description |
|
public listSyncMappingFilters($mappingId, $filters = [], $with = []):void
List sync mapping filters.
Name |
Type |
Description |
|
||
|
||
|
public updateSyncMappingFilter($filterId, $data):void
Update a sync mapping filter.
Name |
Type |
Description |
|
||
|
public deleteSyncMappingFilter($filterId):void
Delete a sync mapping filter.
Name |
Type |
Description |
|
public createSyncMappingFilters($mappingId, $data):void
Create sync mapping filters.
Name |
Type |
Description |
|
The id of the mapping |
|
|
The request data |
public updateSyncMappingFilters($mappingId, $data):void
Update sync mapping filters.
Name |
Type |
Description |
|
||
|
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters($filters = []):void
Sets the filter array.
Name |
Type |
Description |
|
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
ElasticSyncMappingRepositoryContract
This interface allows you to get, list, create, update and delete elastic sync mappings.
Namespace
Plenty\Modules\ElasticSync\Contracts\Core
Methods
public createSyncMapping($syncId, $data):void
Create a sync mapping.
Name |
Type |
Description |
|
||
|
The request data |
public getSyncMapping($mappingId, $with = []):void
Get a sync mapping.
Name |
Type |
Description |
|
||
|
public listSyncMappings($syncId, $page = 1, $itemsPerPage = 50, $paginate = 1, $filters = [], $with = []):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult
List sync mappings.
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
||
|
public updateSyncMapping($mappingId, $data):void
Update a sync mapping.
Name |
Type |
Description |
|
||
|
public deleteSyncMapping($mappingId):void
Delete a sync mapping.
Name |
Type |
Description |
|
public deleteSyncMappings($mappingIds):void
Delete one or more mappings.
Name |
Type |
Description |
|
public copySyncMapping($mappingIds):array
Copy sync mapping.
Name |
Type |
Description |
|
public mappingValues($sync_type):array
Get the mapping values.
Name |
Type |
Description |
|
public fieldValuesMap():array
Deprecated!
This method will not be supported in the future. Please refrain from using it as soon as possible. |
Get the field value map for all sync types.
public listVariationMatched():array
Get a list with variation matches.
public modelKeyToFieldValueKey($syncType):array
Get the model key to field value key.
Name |
Type |
Description |
|
public filterLabelList():array
Get the label list for mapping filtration.
public mappingValuesTree($data):array
Get the mapping values tree.
Name |
Type |
Description |
|
public csvColumns($syncId):array
Get the csv columns of a sync.
Name |
Type |
Description |
|
public rowCsv($syncId):array
Get the csv rows.
Name |
Type |
Description |
|
public getPlentyFieldsValueMap($syncDataType):array
Get the plenty fields value map for a particular sync type.
Name |
Type |
Description |
|
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters($filters = []):void
Sets the filter array.
Name |
Type |
Description |
|
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
ElasticSyncMappingRowRepositoryContract
This interface allows you to get, list, create, update and delete elastic sync mapping rows.
Namespace
Plenty\Modules\ElasticSync\Contracts\Core
Methods
public createSyncMappingRow($mappingId, $data):void
Create a sync mapping row.
Name |
Type |
Description |
|
The id of the mapping |
|
|
The request data |
public getSyncMappingRow($rowId):void
Get a sync mapping row.
Name |
Type |
Description |
|
public listSyncMappingRows($mappingId, $filters = [], $with = [], $page = 1, $itemsPerPage = 25):void
List sync mapping rows.
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
public updateSyncMappingRow($rowId, $data):void
Update a sync mapping row.
Name |
Type |
Description |
|
||
|
public deleteSyncMappingRow($rowId):void
Delete a sync mapping row.
Name |
Type |
Description |
|
public updateSyncMappingRows($mappingId, $data):void
Update sync mapping rows.
Name |
Type |
Description |
|
||
|
public createSyncMappingRows($mappingId, $data):void
Create sync mapping rows.
Name |
Type |
Description |
|
The id of the mapping |
|
|
The request data |
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters($filters = []):void
Sets the filter array.
Name |
Type |
Description |
|
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
ElasticSyncMatchingRepositoryContract
This interface allows you to get, list, create, update and delete elastic sync matches.
Namespace
Plenty\Modules\ElasticSync\Contracts\Core
Methods
public createSyncMatching($syncId, $data):void
Create a sync matching.
Name |
Type |
Description |
|
The id of the sync |
|
|
The request data |
public getSyncMatching($matchingId):void
Get a sync matching.
Name |
Type |
Description |
|
public listSyncMatches($syncId, $filters = [], $with = []):void
List sync matches.
Name |
Type |
Description |
|
||
|
||
|
public updateSyncMatching($matchingId, $data):void
Update a sync matching.
Name |
Type |
Description |
|
||
|
public deleteSyncMatching($matchingId):void
Delete a sync matching.
Name |
Type |
Description |
|
public getEntity($syncId):array
Get an entity.
Name |
Type |
Description |
|
public matchingFields($syncType):array
Get a list of all mappings for a particular sync type.
Name |
Type |
Description |
|
public createSyncMatches($syncId, $data):void
Create sync matches.
Name |
Type |
Description |
|
The id of the sync |
|
|
The request data |
public updateSyncMatches($syncId, $data):void
Update sync matches.
Name |
Type |
Description |
|
||
|
public listDecimals():array
Get list of decimals.
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters($filters = []):void
Sets the filter array.
Name |
Type |
Description |
|
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
ElasticSyncOptionRepositoryContract
This interface allows you to get, list, create, update and delete elastic sync options.
Namespace
Plenty\Modules\ElasticSync\Contracts\Core
Methods
public createSyncOption($syncId, $data):void
Create a sync option.
Name |
Type |
Description |
|
The sync id |
|
|
The request data |
public getSyncOption($optionId):void
Get a sync option.
Name |
Type |
Description |
|
public listSyncOptions($syncId, $filters = [], $with = []):void
List sync options.
Name |
Type |
Description |
|
The sync id |
|
|
||
|
public updateSyncOption($optionId, $data):void
Update a sync option.
Name |
Type |
Description |
|
||
|
public deleteSyncOption($optionId):void
Delete a sync option.
Name |
Type |
Description |
|
public createSyncOptions($syncId, $data):void
Create sync options.
Name |
Type |
Description |
|
The sync id |
|
|
The request data |
public updateSyncOptions($syncId, $data):void
Update sync options.
Name |
Type |
Description |
|
||
|
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters($filters = []):void
Sets the filter array.
Name |
Type |
Description |
|
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
ElasticSyncSyncRepositoryContract
This interface allows you to get, list, create, update and delete elastic sync syncs.
Namespace
Plenty\Modules\ElasticSync\Contracts\Core
Methods
public createSync($data):void
Create a sync.
Name |
Type |
Description |
|
The request data |
public getSync($syncId, $with = []):array
Get a sync.
Name |
Type |
Description |
|
||
|
public listSyncs($page = 1, $itemsPerPage = 50, $paginate = 1, $filters = [], $with = []):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult
Get all syncs
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
public updateSync($syncId, $data):void
Update a sync.
Name |
Type |
Description |
|
||
|
public deleteSync($syncId):void
Delete a sync.
Name |
Type |
Description |
|
public deleteSyncs($syncIds):void
Delete syncs.
Name |
Type |
Description |
|
public getListTypes():array
Get list of sync types.
public getListIntervals():array
Get list of sync intervals.
public getListDecimals():array
Get list of sync decimals.
public export($syncIds):array
Export the syncs.
Name |
Type |
Description |
|
public copy($syncIds):array
Copy the syncs.
Name |
Type |
Description |
|
public resetCache():array
Reset the cache.
public sourcePreview($syncId):array
Preview the syncs.
Name |
Type |
Description |
|
public scheduleTimes():string
Get schedule times.
public getReportLogs($page = 1, $itemsPerPage = 50, $paginate = 1, $filters = [], $with = []):Plenty\Repositories\Models\PaginatedResult
Deprecated!
This method will not be supported in the future. Please refrain from using it as soon as possible. |
Return type: PaginatedResult
Check Report Log.
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
public saveCsvToS3($data):void
Save the CSV on S3.
Name |
Type |
Description |
|
public importSyncDifferent($data):void
Import the sync with different plentyId.
Name |
Type |
Description |
|
public getPreviewValues($syncId):array
Get preview of csv values.
Name |
Type |
Description |
|
public run($syncId, $data):void
Execute the run procedure.
Name |
Type |
Description |
|
||
|
public newRun($syncId, $data):array
Execute the new run procedure.
Name |
Type |
Description |
|
||
|
public report($id):array
Deprecated!
This method will not be supported in the future. Please refrain from using it as soon as possible. |
Get Log by ID
Name |
Type |
Description |
|
public reportAvailable($page = 1, $itemsPerPage = 50, $paginate = 1, $filters = [], $with = []):array
Deprecated!
This method will not be supported in the future. Please refrain from using it as soon as possible. |
Check Report Log.
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
public exportSync($syncId):array
Export the sync.
Name |
Type |
Description |
|
public syncStatus():array
Get syncs status.
public updateCsvSync($data):void
Update the Csv of a Sync.
Name |
Type |
Description |
|
public importSyncJson($data):void
Save the CSV on S3.
Name |
Type |
Description |
|
public importSyncJsonDifferent($data):void
Import the sync with different plentyId.
Name |
Type |
Description |
|
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters($filters = []):void
Sets the filter array.
Name |
Type |
Description |
|
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
Mapper
Report
ElasticSyncReportOptionRepositoryContract
This interface provides methods to CRUD report options
Namespace
Plenty\Modules\ElasticSync\Contracts\Report
Methods
public create($data):Plenty\Modules\ElasticSync\Models\Report\RunReportOption
Return type: RunReportOption
Creates a run report option
Name |
Type |
Description |
|
public get($id):Plenty\Modules\ElasticSync\Models\Report\RunReportOption
Return type: RunReportOption
Gets a run report option
Name |
Type |
Description |
|
public update($id, $data):Plenty\Modules\ElasticSync\Models\Report\RunReportOption
Return type: RunReportOption
Updates a run report option
Name |
Type |
Description |
|
||
|
public delete($id):void
Deletes a run report option
Name |
Type |
Description |
|
public set($report, $name, $value = null, $type = "string"):void
Sets a run report option
Name |
Type |
Description |
|
||
|
||
|
||
|
public getOptionByName($report, $name):void
Gets the option of a report by name
Name |
Type |
Description |
|
||
|
public getValueByName($report, $name):void
Gets the value of a report option
Name |
Type |
Description |
|
||
|
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters($filters = []):void
Sets the filter array.
Name |
Type |
Description |
|
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
ElasticSyncReportRepositoryContract
This interface provides methods to list reports
Namespace
Plenty\Modules\ElasticSync\Contracts\Report
Methods
public getRunReport($id):Plenty\Modules\ElasticSync\Models\Report\RunReport
Return type: RunReport
Gets a run report
Name |
Type |
Description |
|
public getRunReportLog($id):void
Gets a run report log
Name |
Type |
Description |
|
public cancelRun($id):void
Cancels a run
Name |
Type |
Description |
|
public listRunReports($page = 1, $itemsPerPage = 50, $filters = []):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult
Lists run reports
Name |
Type |
Description |
|
||
|
||
|
public listJobReports($reportId, $page = 1, $itemsPerPage = 50, $filters = []):array
Lists job reports for a specific run
Name |
Type |
Description |
|
||
|
||
|
||
|
public listJobs($reportId):array
Name |
Type |
Description |
|
public listOutcomes($reportId, $job):array
Name |
Type |
Description |
|
||
|
public clearCriteria():void
Resets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():void
Applies criteria classes to the current repository.
public setFilters($filters = []):void
Sets the filter array.
Name |
Type |
Description |
|
public getFilters():void
Returns the filter array.
public getConditions():void
Returns a collection of parsed filters as Condition object
public clearFilters():void
Clears the filter array.
Models
Core
ElasticSyncMapping
The elastic sync mapping model.
Namespace
Plenty\Modules\ElasticSync\Models\Core
Name | Type | Description |
---|---|---|
id |
The ID of the elastic sync mapping |
|
syncId |
The ID of the elastic sync sync |
|
name |
The name of the elastic sync mapping |
|
position |
The position of the elastic sync mapping |
|
active |
The state of the elastic sync mapping |
Methods
public toArray()
Returns this model as an array.
ElasticSyncMappingFilter
The elastic sync mapping filter model.
Namespace
Plenty\Modules\ElasticSync\Models\Core
Name | Type | Description |
---|---|---|
id |
The ID of the elastic sync mapping filter |
|
mappingId |
The ID of the elastic sync mapping |
|
type |
The type of the elastic sync mapping filter |
|
operator |
The operator of the elastic sync mapping filter |
|
source |
The source of the elastic sync mapping filter |
|
value |
The value of the elastic sync mapping filter |
Methods
public toArray()
Returns this model as an array.
ElasticSyncMappingRow
The elastic sync mapping row model.
Namespace
Plenty\Modules\ElasticSync\Models\Core
Name | Type | Description |
---|---|---|
id |
The ID of the elastic sync mapping row |
|
mappingId |
The ID of the elastic sync mapping |
|
targetModel |
The target model of the elastic sync mapping row |
|
targetAttribute |
The target attribute of the elastic sync mapping row |
|
active |
The state of the elastic sync mapping row |
|
entityType |
The entity type of the elastic sync mapping row (array values: 'ownValue', 'ownAssignment', 'regularExpression', 'csvColumn') |
|
value |
The value of the elastic sync mapping row |
|
settings |
The settings of the elastic sync mapping row |
|
identifiers |
The identifiers of the elastic sync mapping row |
Methods
public toArray()
Returns this model as an array.
ElasticSyncMatching
The elastic sync matching model.
Namespace
Plenty\Modules\ElasticSync\Models\Core
Name | Type | Description |
---|---|---|
id |
The ID of the elastic sync matching |
|
syncId |
The ID of the elastic sync sync |
|
target |
The target of the elastic sync matching |
|
source |
The source of the elastic sync matching |
|
additionalValue |
The additional value of the elastic sync matching |
Methods
public toArray()
Returns this model as an array.
ElasticSyncOption
The elastic sync option model.
Namespace
Plenty\Modules\ElasticSync\Models\Core
Name | Type | Description |
---|---|---|
id |
The ID of the elastic sync option |
|
syncId |
The ID of the elastic sync sync |
|
optionIdentifier |
The option identifier of the elastic sync option |
|
key |
The key of the elastic sync option |
|
value |
The value of the elastic sync option |
|
createdAt |
The date when the elastic sync option was created |
|
updatedAt |
The date when the elastic sync option was last updated |
Methods
public toArray()
Returns this model as an array.
ElasticSyncSync
The elastic sync sync model.
Namespace
Plenty\Modules\ElasticSync\Models\Core
Name | Type | Description |
---|---|---|
id |
The ID of the elastic sync sync |
|
name |
The name of the elastic sync sync |
|
syncType |
The type of the elastic sync sync |
|
sourceType |
The source type of the elastic sync sync |
|
sourceDataType |
The source data type of the elastic sync sync |
|
lastRun |
The date when elastic sync sync was last run |
|
createdAt |
The date when the elastic sync sync was created |
|
updatedAt |
The date when the elastic sync sync was last updated |
|
matching |
The matching relation |
|
options |
The options relation |
|
mappings |
The mapping relation |
|
reports |
The reports relation |
Methods
public toArray()
Returns this model as an array.
Report
RunReport
The run report model.
Namespace
Plenty\Modules\ElasticSync\Models\Report
Name | Type | Description |
---|---|---|
id |
The ID of the run report |
|
sync_id |
The ID of the sync |
|
jobs_total |
The total number of jobs |
|
jobs_completed |
The number of completed jobs |
|
errors |
The number of errors |
|
sync_type |
The type of the sync |
|
children_identifier |
The identifier used by children job reports |
|
report_filename |
The name of the S3 report counterpart |
|
rows |
The number of rows in the file |
|
rows_successful |
The number of successful rows in the file |
|
date |
The date when this report was created |
Methods
public toArray()
Returns this model as an array.
RunReportOption
The run report option model.
Namespace
Plenty\Modules\ElasticSync\Models\Report
Name | Type | Description |
---|---|---|
id |
The ID of the run report option |
|
run_report_id |
The ID of the run report |
|
name |
The name |
|
value |
The value |
|
type |
The type |
Methods
public toArray()
Returns this model as an array.
Sync
Mapping
The mapping model.
Namespace
Plenty\Modules\ElasticSync\Models\Sync
Name | Type | Description |
---|---|---|
id |
The ID of the mapping |
|
data |
The data of the mapping |
|
createdAt |
The date when the mapping was created |
|
updatedAt |
The date when the mapping was last updated |
|
mapping |
The mapping from ElasticSync. |
Methods
public toArray()
Returns this model as an array.
Sync
The sync model.
Namespace
Plenty\Modules\ElasticSync\Models\Sync
Name | Type | Description |
---|---|---|
id |
The ID of the sync |
|
data |
The data of the sync |
|
createdAt |
The date when the sync was created |
|
updatedAt |
The date when the sync was last updated |
|
sync |
The sync from ElasticSync. |
Methods
public toArray()
Returns this model as an array.
SyncLog
The synclog model.
Namespace
Plenty\Modules\ElasticSync\Models\Sync
Name | Type | Description |
---|---|---|
id |
The ID of the synclog |
|
syncId |
The syncId of the synclog |
|
syncHash |
The syncHash of the synclog |
|
jobHash |
The jobHash of the synclog |
|
hashDate |
The hashDate of the synclog |
|
createdAt |
The date when the synclog was created |
|
updatedAt |
The date when the synclog was last updated |
|
syncLog |
The sync log from ElasticSync. |
Methods
public toArray()
Returns this model as an array.