Magento 2 (APIs)
Magento 2 (APIs)
Magento 2 ETL connector for data replication
Snapshot
| Features | Details |
| Release Status | Released |
| Source API Version | v1 |
| Table Selection | Yes |
| Column Selection | Yes |
| Edit Integration | Yes |
| Replication Type Selection | No |
| Authentication Parameters | Magento-2 Domain Name Magento-2 Access Token |
| Replication Type | Full Replication Key Based Incremental |
Replication Key: updated_at date Suggested Replication Frequency | 1 hr
| ##Tables/APIs Supported | |
| DirectoryCountryInformationAcquirerV1 | CatalogProductAttributeTypesListV1 |
| CatalogProductLinkTypeListV1 | CatalogProductTypeListV1 |
| CustomerAddressMetadataV1 | DirectoryCurrencyInformationAcquirerV1 |
| InventoryApiSourceRepositoryV1 | StoreGroupRepositoryV1 |
| StoreStoreRepositoryV1 | StoreWebsiteRepositoryV1 |
| CatalogProductCustomOptionTypeListV1 | CatalogCategoryListV1 |
| SalesOrderItemRepositoryV1 | SalesCreditmemoRepositoryV1 |
| SalesInvoiceRepositoryV1 | SalesOrderRepositoryV1 |
| SalesRuleCouponRepositoryV1 | SalesRuleRuleRepositoryV1 |
| SalesShipmentRepositoryV1 | SalesTransactionRepositoryV1 |
| CatalogAttributeSetRepositoryV1 | CatalogCategoryAttributeRepositoryV1 |
| CatalogProductAttributeGroupRepositoryV1 | CatalogProductAttributeRepositoryV1 |
| CatalogProductRepositoryV1 | CustomerCustomerRepositoryV1 |
| CustomerGroupManagementV1 |
Integrate Magento-2 with Daton
- Sign in to Daton
- Select Magento-2 from the Integrations page
- Provide Integration Name, Replication Frequency, and History. The integration name would be used in creating tables for the integration and cannot be changed later
- You will be redirected to the second page where you need to provide the Domain Name and an Access Token for your Magento-2
- Select the required tables from the available list of tables
- Then select all required fields for each table
- Submit the integration
Workflow
- Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
- Users would be able to edit/pause/re-activate/delete integration anytime
- Users can view job status and process logs from the integration details page by clicking on the integration name from the active list
TABLES
DirectoryCountryInformationAcquirerV1
Purpose: Get all countries and regions information for the store.
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| id | INTEGER |
| two_letter_abbreviation | STRING |
| three_letter_abbreviation | STRING |
| full_name_locale | STRING |
| full_name_english | STRING |
| available_regions | RECORD |
CatalogProductAttributeTypesListV1
Purpose: Retrieve list of product attribute types
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| value | STRING |
| label | STRING |
CatalogProductLinkTypeListV1
Purpose: Retrieve information about available product link types
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| code | STRING |
| name | STRING |
CatalogProductTypeListV1
Purpose: Retrieve available product types
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| name | STRING |
| label | STRING |
CustomerAddressMetadataV1
Purpose: Get all attribute metadata.
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| frontend_input | STRING |
| input_filter | STRING |
| store_label | STRING |
| validation_rules | RECORD |
| multiline_count | INTEGER |
| visible | BOOLEAN |
| required | BOOLEAN |
| data_model | STRING |
| options | RECORD |
| frontend_class | STRING |
| user_defined | BOOLEAN |
| sort_order | INTEGER |
| frontend_label | STRING |
| note | STRING |
| system | BOOLEAN |
| backend_type | STRING |
| is_used_in_grid | BOOLEAN |
| is_visible_in_grid | BOOLEAN |
| is_filterable_in_grid | BOOLEAN |
| is_searchable_in_grid | BOOLEAN |
| attribute_code | STRING |
DirectoryCurrencyInformationAcquirerV1
Purpose: Get currency information for the store.
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| base_currency_code | STRING |
| base_currency_symbol | STRING |
| default_display_currency_code | STRING |
| default_display_currency_symbol | STRING |
| available_currency_codes | STRING |
| exchange_rates | RECORD |
InventoryApiSourceRepositoryV1
Purpose: Find Sources by SearchCriteria SearchCriteria is not required because load all stocks is useful case.
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| items | RECORD |
| search_criteria | RECORD |
| total_count | INTEGER |
StoreGroupRepositoryV1
Purpose: Retrieve list of all groups.
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| id | INTEGER |
| website_id | INTEGER |
| root_category_id | INTEGER |
| default_store_id | INTEGER |
| name | STRING |
| code | STRING |
StoreStoreRepositoryV1
Purpose: Retrieve list of all stores
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| id | INTEGER |
| code | STRING |
| name | STRING |
| website_id | INTEGER |
| store_group_id | INTEGER |
| is_active | INTEGER |
StoreWebsiteRepositoryV1
Purpose: Retrieve list of all websites
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| id | INTEGER |
| code | STRING |
| name | STRING |
| default_group_id | INTEGER |
CatalogProductCustomOptionTypeListV1
Purpose: Get custom option types
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| label | STRING |
| code | STRING |
| group | STRING |
CatalogCategoryListV1
Purpose: Get category list
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| items | RECORD |
| search_criteria | RECORD |
| total_count | INTEGER |
SalesOrderItemRepositoryV1
Purpose: Lists order items
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Key-Based Replication
Replication Key: updated_at
Fields
| Name | Target Datatype |
| items | RECORD |
| search_criteria | RECORD |
| total_count | INTEGER |
SalesCreditmemoRepositoryV1
Purpose: Lists credit memos
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Key-Based Replication
Replication Key: updated_at
Fields
| Name | Target Datatype |
| items | RECORD |
| search_criteria | RECORD |
| total_count | INTEGER |
SalesInvoiceRepositoryV1
Purpose: Lists invoices
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Key-Based Replication
Replication Key: updated_at
Fields
| Name | Target Datatype |
| items | RECORD |
##SalesOrderRepositoryV1
Purpose: Lists orders
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Key-Based Replication
Replication Key: updated_at
Fields
| Name | Target Datatype |
| items | RECORD |
##SalesRuleCouponRepositoryV1
Purpose: Retrieve a coupon
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| items | RECORD |
##SalesRuleRuleRepositoryV1
Purpose: Retrieve sales rules
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| items | RECORD |
##SalesShipmentRepositoryV1
Purpose: Lists shipments
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Key Based Replication
Replication Key: updated_at
Fields
| Name | Target Datatype |
| items | RECORD |
##SalesTransactionRepositoryV1
Purpose: Lists transactions
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Key Based Replication
Replication Key: updated_at
Fields
| Name | Target Datatype |
| items | RECORD |
##CatalogAttributeSetRepositoryV1
Purpose: Retrieve list of Attribute Sets
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| items | RECORD |
##CatalogCategoryAttributeRepositoryV1
Purpose: Retrieve all attributes for entity type
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| items | RECORD |
##CatalogProductAttributeGroupRepositoryV1
Purpose: Retrieve list of attribute groups
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| items | RECORD |
##CatalogProductAttributeRepositoryV1
Purpose: Retrieve all attributes for entity type
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| items | RECORD |
##CatalogProductRepositoryV1
Purpose: Get product list
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Key Based Replication
Replication Key: updated_at
Fields
| Name | Target Datatype |
| items | RECORD |
##CustomerCustomerRepositoryV1
Purpose: Get customer by Customer ID.
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Key Based Replication
Replication Key: updated_at
Fields
| Name | Target Datatype |
| items | RECORD |
##CustomerGroupManagementV1
Purpose: Get default customer group.
Source API Documentation https://devdocs.magento.com/swagger/index_23.html#/
Replication: Full Replication
Replication Key: N/A
Fields
| Name | Target Datatype |
| id | INTEGER |
| code | STRING |
| tax_class_id | INTEGER |
| tax_class_name | STRING |
