# Magento 2 (APIs)

### 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  | <p>Magento-2 Domain Name<br>Magento-2 Access Token</p> |
| Replication Type           | <p>Full Replication<br>Key Based Incremental</p>       |

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

1. Sign in to Daton&#x20;
2. Select Magento-2 from the Integrations page
3. Provide Integration Name, Replication Frequency, and History. The integration name would be used in creating tables for the integration and cannot be changed later&#x20;
4. You will be redirected to the second page where you need to provide the Domain Name and an Access Token for your Magento-2
5. Select the required tables from the available list of tables
6. Then select all required fields for each table
7. Submit the integration

### Workflow

1. 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
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. 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          |