Skip to content

Commit

Permalink
Dedicated settings section
Browse files Browse the repository at this point in the history
  • Loading branch information
AugustMiller committed Apr 2, 2024
1 parent e4772aa commit 5eb77d1
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,12 +125,7 @@ php craft shopify/sync/products

Going forward, your products will be automatically kept in sync via [webhooks](#set-up-webhooks).

The following settings available for controlling the product synchronization process:

| Setting | Type | Default | Description |
|-------------------------|--------|---------|-------------|
| `syncProductMetafields` | `bool` | `true` | Whether product metafields should be included when syncing products. This adds an extra API request per product. |
| `syncVariantMetafields` | `bool` | `false` | Whether variant metafields should be included when syncing products. This adds an extra API request per variant. |
The [`syncProductMetafields` and `syncVariantMetafields` settings](#settings) govern what data is synchronized via this process.

> [!NOTE]
> Smaller stores with only a few products can perform synchronization via the **Shopify Sync** utility.
Expand Down Expand Up @@ -792,6 +787,16 @@ There is no need to query the Shopify API to render product details in your temp

## Going Further

### Settings

The following settings can be controlled by creating a `shopify.php` file in your `config/` directory.

| Setting | Type | Default | Description |
|-------------------------|--------|---------|-------------|
| `syncProductMetafields` | `bool` | `true` | Whether product metafields should be included when syncing products. This adds an extra API request per product. |
| `syncVariantMetafields` | `bool` | `false` | Whether variant metafields should be included when syncing products. This adds an extra API request per variant. |


### Events

#### `craft\shopify\services\Products::EVENT_BEFORE_SYNCHRONIZE_PRODUCT`
Expand Down Expand Up @@ -862,4 +867,4 @@ return [

## Rate Limiting

The Shopify API implements [rate limiting rules](https://shopify.dev/docs/api/usage/rate-limits) the plugin makes its best effort to avoid hitting these limits.
The Shopify API implements [rate limiting rules](https://shopify.dev/docs/api/usage/rate-limits) the plugin makes its best effort to avoid hitting these limits.

0 comments on commit 5eb77d1

Please sign in to comment.