summary
Help Page for ETL Configuration of Shopify Data Settings.
Setting items
STEP1 Basic settings
| item name | indispensable | default value | Contents |
|---|---|---|---|
| Shopify Connection Configuration | Yes | - | Select the previously registered Connection Configuration that has the necessary permissions for this ETL Configuration. If you do not have a registered Connection Configuration, please go to Add Connection Configuration to create one. Connection Configuration requires either a custom app created from the Shopify admin panel to generate an access token, or a private app (deprecated) to generate an API key and password. Please grant read access privileges for product management, order management, and customer management, respectively. |
| target | Yes | - | Select the data type to be acquired from the following Order Customer Product Metafield Transaction Collection *If you select a metafield or transaction or collection, you must use a custom app-based Connection Configuration in the Shopify Connection Configuration. In addition, the metafield and transaction preview screens display results based on dummy data. Please refer to the following reference for specific items that can be obtained. https://shopify.dev/docs/admin-api/rest/reference/ |
| Owner Type | Yes | - | Only metafields can be specified. Select the type of owner (order, customer, or product) to which the meta field is associated. |
| creation-day | No | - | Select the start and end dates for the creation date of the data to be searched. The format is (%Y-%m-%dT%H:%M:%S%z). |
| update date | No | - | Select the start and end dates for the update date of the data to be searched. The format is (%Y-%m-%dT%H:%M:%S%z). |
| Order Status | Yes | - | Only orders can be specified. Specify the order status. For a description of each item, please refer to this STATUS item . |
| Financial Status | Yes | - | Only orders can be specified. Specifies financial status. For a description of each item, please refer to the financial_status item here. |
| fulfillment status | No | - | Only orders can be specified. Specify the fulfillment status. For a description of each item, please refer to the FULFILLMENT_STATUS item here. |
| publication date | No | - | Only products can be specified. Select the start and end dates for the release date of the data to be searched. The format is (%Y-%m-%dT%H:%M:%S%z). |
| Product Status | No | - | Only products can be specified. Specify the commodity status. For a description of each item, please refer to this STATUS item . |
| Publication Status | No | - | Only products can be specified. Specifies the publication status. For a description of each item, please refer to the published_status item here. |
Available data
metafield
API Documentation: https://shopify.dev/api/admin-graphql/2024-01/objects/Metafield#fields
schema
| column (esp. in chemistry, file, equipment, etc.) | type (e.g. of machine, goods, etc.) | Description. |
|---|---|---|
| id | long | Numeric part of Iadmin_graphql_api_id |
| admin_graphql_api_id | string | ID (for GraphQL) |
| namespace | string | Namespace for grouping metafields |
| key | string | Metafield identifier that is unique for each namespace |
| value | string | Meta Field Value |
| description | string | remarks |
| owner_type | string | Owner Type Type of object to which the metafield is associated (order / customer / product) |
| type | string | value data types ( Metafield types) |
| legacy_resource_id | long | ID (for REST API) |
| created_at | timestamp | Creation Date |
| updated_at | timestamp | Update Date |
| owner_id | long | Numeric part of admin_graphql_api_owner_id |
| admin_graphql_api_owner_id | string | ID of the object to which the metafield is attached (for GraphQL) |
transaction
API Documentation: https://shopify.dev/api/admin-graphql/2024-01/objects/OrderTransaction
schema
| column (esp. in chemistry, file, equipment, etc.) | type (e.g. of machine, goods, etc.) | Description. |
|---|---|---|
| account_number | string | Account number associated with the payment masking the previous 12 digits |
| amount_set_presentment_money_amount | double | Customer Display Amount |
| amount_set_presentment_money_currency_code | string | Customer Display Currency |
| amount_set_shop_money_amount | double | Store Settlement Amount |
| amount_set_shop_money_currency_code | string | Store Settlement Currency |
| authorization_code | string | Authentication Code |
| authorization_expires_at | timestamp | Authentication expiration date (available for Shopify Plus plans only) |
| created_at | timestamp | Creation Date |
| error_code | string | error code |
| fees | json | commission |
| formatted_gateway | string | Payment gateway (formatted notation) |
| gateway | string | Payment Gateway |
| id | long | ID (for REST API) |
| admin_api_graphql_id | string | ID (for GraphQL) |
| kind | string | Settlement Type |
| manually_capturable | boolean | Manual Capture Availability |
| maximum_refundable_v2_amount | double | Refundable amount |
| maximum_refundable_v2_currency_code | string | Refundable Currency |
| multi_capturable | boolean | Multiple Capture Availability |
| order_id | long | ID of the order to which the transaction is tied (for REST API) |
| admin_api_graphql_order_id | string | ID of the order to which the transaction is tied (for GraphQL) |
| parent_transaction_id | long | ID of parent transaction (for REST API) |
| admin_api_graphql_parent_transaction_id | string | ID of parent transaction (for GraphQL) |
| payment_icon_alt_text | string | settlement company |
| processed_at | timestamp | Processing Date |
| receipt | json | (formal) receipt |
| settlement_currency | string | Settlement Currency |
| settlement_currency_rate | double | settlement rate |
| shopify_payment_set_extended_authorization_expires_at | timestamp | Extended authorization period expiration date |
| shopify_payment_set_standard_authorization_expires_at | timestamp | Authorization period expiration date |
| status | string | Settlement Status |
| test | boolean | Test Settlement Flag |
| total_unsettled_set_presentment_money_amount | double | Amount Capable of Capture by Customer Display Amount |
| total_unsettled_set_presentment_money_currency_code | string | Capable of capturing in customer display currency |
| total_unsettled_set_shop_money_amount | double | Capturable by Shop Settlement Amount |
| total_unsettled_set_sho_money_currency_code | string | Capturable in store settlement currency |
collection
API Documentation: https://shopify.dev/docs/api/admin-graphql/2024-01/queries/collections
schema
| column (esp. in chemistry, file, equipment, etc.) | type (e.g. of machine, goods, etc.) | Description. |
|---|---|---|
| description | string | remarks |
| description_html | string | Remarks (HTML) |
| handle | string | String that is unique for each collection |
| id | string | ID (for GRAPHQL API) |
| legacy_resource_id | string | ID (for REST API) |
| products_count | long | Number of productions in the collection |
| sort_order | string | Sort order of productions in the collection |
| template_suffix | string | Suffix for the collection used for Liquidtemplate |
| title | string | collection name |
| updated_at | timestamp | Update Date |