> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.airweave.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.airweave.ai/_mcp/server.
# Shopify
> Shopify integration with Airweave
{/* AUTO-GENERATED CONTENT START */}
Shopify
This connector enables AI agents and RAG systems to retrieve context from Shopify through Airweave's unified search layer.
## Configuration
Shopify source connector integrates with the Shopify Admin API.
Uses OAuth 2.0 client credentials grant to exchange client\_id/client\_secret
for an access token, then syncs comprehensive data from your Shopify store:
* Products and their variants with pricing and inventory
* Customer profiles and purchase history
* Orders with line items and fulfillment status
* Custom and Smart Collections
* Store locations and inventory levels
* Fulfillments and shipment tracking
* Gift cards and discounts/price rules
* Metaobjects for custom data structures
* Files/media via GraphQL
* Themes and templates
#### [View Source Code](https://github.com/airweave-ai/airweave/tree/main/backend/airweave/platform/sources/shopify.py)
Explore the Shopify connector implementation
### Authentication
**Supported authentication methods:**
* Direct Credentials
### Configuration Options
This connector does not have any additional configuration options.
## Data Models
The following data models are available for this connector:
#### ShopifyProductEntity
Schema for Shopify Product resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/product](https://shopify.dev/docs/api/admin-rest/2024-01/resources/product)
| Field | Type | Description |
| --------------- | ---------------------- | ---------------------------------------------- |
| product\_id | str | Shopify product ID. |
| product\_title | str | Title of the product. |
| created\_time | datetime | When the product was created. |
| updated\_time | datetime | When the product was last updated. |
| web\_url\_value | Optional\[str] | URL to view this product in Shopify admin. |
| body\_html | Optional\[str] | Product description in HTML format |
| vendor | Optional\[str] | Name of the product vendor |
| product\_type | Optional\[str] | Product type/category |
| handle | Optional\[str] | URL-friendly product handle |
| status | Optional\[str] | Product status (active, archived, draft) |
| tags | Optional\[str] | Comma-separated list of product tags |
| variants | List\[Dict\[str, Any]] | Product variants with pricing, inventory, etc. |
| options | List\[Dict\[str, Any]] | Product options (size, color, etc.) |
| images | List\[Dict\[str, Any]] | Product images |
#### ShopifyProductVariantEntity
Schema for Shopify Product Variant resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/product-variant](https://shopify.dev/docs/api/admin-rest/2024-01/resources/product-variant)
| Field | Type | Description |
| ------------------- | ---------------- | ------------------------------------------ |
| variant\_id | str | Shopify variant ID. |
| variant\_title | str | Title of the variant. |
| created\_time | datetime | When the variant was created. |
| updated\_time | datetime | When the variant was last updated. |
| web\_url\_value | Optional\[str] | URL to view this variant in Shopify admin. |
| product\_id | Optional\[str] | ID of the parent product |
| sku | Optional\[str] | Stock keeping unit (SKU) |
| price | Optional\[str] | Price of the variant |
| compare\_at\_price | Optional\[str] | Compare-at price for sale pricing |
| inventory\_quantity | Optional\[int] | Available inventory quantity |
| weight | Optional\[float] | Weight of the variant |
| weight\_unit | Optional\[str] | Weight unit (g, kg, oz, lb) |
| barcode | Optional\[str] | Barcode (ISBN, UPC, GTIN, etc.) |
| option1 | Optional\[str] | First option value |
| option2 | Optional\[str] | Second option value |
| option3 | Optional\[str] | Third option value |
#### ShopifyCustomerEntity
Schema for Shopify Customer resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/customer](https://shopify.dev/docs/api/admin-rest/2024-01/resources/customer)
| Field | Type | Description |
| ------------------ | -------------------------- | ------------------------------------------------------------- |
| customer\_id | str | Shopify customer ID. |
| customer\_name | str | Display name of the customer. |
| created\_time | datetime | When the customer was created. |
| updated\_time | datetime | When the customer was last updated. |
| web\_url\_value | Optional\[str] | URL to view this customer in Shopify admin. |
| email | Optional\[str] | Customer's email address |
| phone | Optional\[str] | Customer's phone number |
| first\_name | Optional\[str] | Customer's first name |
| last\_name | Optional\[str] | Customer's last name |
| verified\_email | bool | Whether the email has been verified |
| accepts\_marketing | bool | Whether customer accepts marketing emails |
| orders\_count | int | Number of orders placed by customer |
| total\_spent | Optional\[str] | Total amount spent by customer |
| state | Optional\[str] | Customer account state (disabled, invited, enabled, declined) |
| currency | Optional\[str] | Customer's preferred currency |
| tags | Optional\[str] | Comma-separated list of customer tags |
| note | Optional\[str] | Notes about the customer |
| default\_address | Optional\[Dict\[str, Any]] | Customer's default address |
#### ShopifyOrderEntity
Schema for Shopify Order resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/order](https://shopify.dev/docs/api/admin-rest/2024-01/resources/order)
| Field | Type | Description |
| ------------------- | -------------------------- | ---------------------------------------------------------- |
| order\_id | str | Shopify order ID. |
| order\_name | str | Order number/name (e.g., #1001). |
| created\_time | datetime | When the order was created. |
| updated\_time | datetime | When the order was last updated. |
| web\_url\_value | Optional\[str] | URL to view this order in Shopify admin. |
| order\_number | Optional\[int] | Sequential order number |
| email | Optional\[str] | Customer's email address |
| phone | Optional\[str] | Customer's phone number |
| total\_price | Optional\[str] | Total price of the order including taxes and shipping |
| subtotal\_price | Optional\[str] | Subtotal price before taxes and shipping |
| total\_tax | Optional\[str] | Total tax amount |
| total\_discounts | Optional\[str] | Total discount amount applied |
| currency | Optional\[str] | Currency code (e.g., USD, EUR) |
| financial\_status | Optional\[str] | Payment status (pending, authorized, paid, refunded, etc.) |
| fulfillment\_status | Optional\[str] | Fulfillment status (fulfilled, partial, null) |
| customer\_id | Optional\[str] | ID of the customer who placed the order |
| line\_items | List\[Dict\[str, Any]] | Line items in the order |
| shipping\_address | Optional\[Dict\[str, Any]] | Shipping address |
| billing\_address | Optional\[Dict\[str, Any]] | Billing address |
| tags | Optional\[str] | Comma-separated list of order tags |
| note | Optional\[str] | Notes about the order |
| cancelled\_at | Optional\[datetime] | When the order was cancelled (if applicable) |
| cancel\_reason | Optional\[str] | Reason for cancellation |
#### ShopifyDraftOrderEntity
Schema for Shopify Draft Order resource.
Draft orders are orders created by merchants that haven't been completed/paid yet.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/draftorder](https://shopify.dev/docs/api/admin-rest/2024-01/resources/draftorder)
| Field | Type | Description |
| ------------------ | -------------------------- | --------------------------------------------------- |
| draft\_order\_id | str | Shopify draft order ID. |
| draft\_order\_name | str | Draft order name (e.g., #D1). |
| created\_time | datetime | When the draft order was created. |
| updated\_time | datetime | When the draft order was last updated. |
| web\_url\_value | Optional\[str] | URL to view this draft order in Shopify admin. |
| email | Optional\[str] | Customer's email address |
| status | Optional\[str] | Draft order status (open, invoice\_sent, completed) |
| total\_price | Optional\[str] | Total price of the draft order |
| subtotal\_price | Optional\[str] | Subtotal price before taxes and shipping |
| total\_tax | Optional\[str] | Total tax amount |
| currency | Optional\[str] | Currency code (e.g., USD, EUR) |
| customer\_id | Optional\[str] | ID of the customer |
| line\_items | List\[Dict\[str, Any]] | Line items in the draft order |
| shipping\_address | Optional\[Dict\[str, Any]] | Shipping address |
| billing\_address | Optional\[Dict\[str, Any]] | Billing address |
| tags | Optional\[str] | Comma-separated list of tags |
| note | Optional\[str] | Notes about the draft order |
| invoice\_sent\_at | Optional\[datetime] | When the invoice was sent |
| completed\_at | Optional\[datetime] | When the draft order was completed |
#### ShopifyCollectionEntity
Schema for Shopify Collection resources (Custom and Smart Collections).
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/customcollection](https://shopify.dev/docs/api/admin-rest/2024-01/resources/customcollection)
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/smartcollection](https://shopify.dev/docs/api/admin-rest/2024-01/resources/smartcollection)
| Field | Type | Description |
| ----------------- | ---------------------- | ----------------------------------------------------------------- |
| collection\_id | str | Shopify collection ID. |
| collection\_title | str | Title of the collection. |
| created\_time | datetime | When the collection was created. |
| updated\_time | datetime | When the collection was last updated. |
| web\_url\_value | Optional\[str] | URL to view this collection in Shopify admin. |
| handle | Optional\[str] | URL-friendly collection handle |
| body\_html | Optional\[str] | Collection description in HTML format |
| published\_at | Optional\[datetime] | When the collection was published |
| published\_scope | Optional\[str] | Publication scope (web, global) |
| sort\_order | Optional\[str] | Sort order for products in collection |
| collection\_type | str | Type of collection (custom or smart) |
| disjunctive | Optional\[bool] | For smart collections: whether rules are OR (true) or AND (false) |
| rules | List\[Dict\[str, Any]] | For smart collections: rules that define product membership |
| products\_count | Optional\[int] | Number of products in the collection |
#### ShopifyInventoryItemEntity
Schema for Shopify Inventory Item resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/inventoryitem](https://shopify.dev/docs/api/admin-rest/2024-01/resources/inventoryitem)
| Field | Type | Description |
| -------------------------- | -------------- | ------------------------------------------------- |
| inventory\_item\_id | str | Shopify inventory item ID. |
| inventory\_item\_name | str | Display name for the inventory item. |
| created\_time | datetime | When the inventory item was created. |
| updated\_time | datetime | When the inventory item was last updated. |
| web\_url\_value | Optional\[str] | URL to view this inventory item in Shopify admin. |
| sku | Optional\[str] | Stock keeping unit (SKU) |
| cost | Optional\[str] | Unit cost of the inventory item |
| tracked | bool | Whether inventory tracking is enabled |
| requires\_shipping | bool | Whether the item requires shipping |
| country\_code\_of\_origin | Optional\[str] | Country code of origin |
| province\_code\_of\_origin | Optional\[str] | Province/state code of origin |
| harmonized\_system\_code | Optional\[str] | Harmonized System (HS) tariff code |
#### ShopifyLocationEntity
Schema for Shopify Location resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/location](https://shopify.dev/docs/api/admin-rest/2024-01/resources/location)
| Field | Type | Description |
| ------------------------- | -------------- | ------------------------------------------- |
| location\_id | str | Shopify location ID. |
| location\_name | str | Name of the location. |
| created\_time | datetime | When the location was created. |
| updated\_time | datetime | When the location was last updated. |
| web\_url\_value | Optional\[str] | URL to view this location in Shopify admin. |
| address1 | Optional\[str] | Primary street address |
| address2 | Optional\[str] | Secondary address line |
| city | Optional\[str] | City |
| province | Optional\[str] | Province/state name |
| province\_code | Optional\[str] | Province/state code |
| country | Optional\[str] | Country name |
| country\_code | Optional\[str] | Country code (ISO 3166-1 alpha-2) |
| zip | Optional\[str] | Postal/ZIP code |
| phone | Optional\[str] | Phone number |
| active | bool | Whether the location is active |
| legacy | bool | Whether this is a legacy location |
| localized\_country\_name | Optional\[str] | Localized country name |
| localized\_province\_name | Optional\[str] | Localized province/state name |
#### ShopifyInventoryLevelEntity
Schema for Shopify Inventory Level resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/inventorylevel](https://shopify.dev/docs/api/admin-rest/2024-01/resources/inventorylevel)
| Field | Type | Description |
| ---------------------- | -------------- | ------------------------------------------------ |
| inventory\_level\_id | str | Composite ID (inventory\_item\_id-location\_id). |
| inventory\_level\_name | str | Display name for the inventory level. |
| created\_time | datetime | When the inventory level was created. |
| updated\_time | datetime | When the inventory level was last updated. |
| web\_url\_value | Optional\[str] | URL to view this inventory in Shopify admin. |
| inventory\_item\_id | str | ID of the inventory item |
| location\_id | str | ID of the location |
| available | Optional\[int] | Available quantity at this location |
#### ShopifyFulfillmentEntity
Schema for Shopify Fulfillment resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/fulfillment](https://shopify.dev/docs/api/admin-rest/2024-01/resources/fulfillment)
| Field | Type | Description |
| ----------------- | ---------------------- | ----------------------------------------------------------------------------- |
| fulfillment\_id | str | Shopify fulfillment ID. |
| fulfillment\_name | str | Display name for the fulfillment. |
| created\_time | datetime | When the fulfillment was created. |
| updated\_time | datetime | When the fulfillment was last updated. |
| web\_url\_value | Optional\[str] | URL to view this fulfillment in Shopify admin. |
| order\_id | str | ID of the parent order |
| status | Optional\[str] | Status of the fulfillment (pending, open, success, cancelled, error, failure) |
| tracking\_company | Optional\[str] | Name of the tracking company |
| tracking\_number | Optional\[str] | Tracking number |
| tracking\_numbers | List\[str] | List of tracking numbers |
| tracking\_url | Optional\[str] | URL for tracking the shipment |
| tracking\_urls | List\[str] | List of tracking URLs |
| location\_id | Optional\[str] | ID of the fulfillment location |
| line\_items | List\[Dict\[str, Any]] | Line items in this fulfillment |
| shipment\_status | Optional\[str] | Shipment status |
#### ShopifyGiftCardEntity
Schema for Shopify Gift Card resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/gift-card](https://shopify.dev/docs/api/admin-rest/2024-01/resources/gift-card)
| Field | Type | Description |
| ---------------- | ------------------- | -------------------------------------------- |
| gift\_card\_id | str | Shopify gift card ID. |
| gift\_card\_name | str | Display name for the gift card. |
| created\_time | datetime | When the gift card was created. |
| updated\_time | datetime | When the gift card was last updated. |
| web\_url\_value | Optional\[str] | URL to view this gift card in Shopify admin. |
| initial\_value | Optional\[str] | Initial value of the gift card |
| balance | Optional\[str] | Current balance |
| currency | Optional\[str] | Currency code |
| code | Optional\[str] | Gift card code (masked) |
| last\_characters | Optional\[str] | Last 4 characters of the code |
| disabled\_at | Optional\[datetime] | When the gift card was disabled |
| expires\_on | Optional\[str] | Expiration date |
| note | Optional\[str] | Notes about the gift card |
| customer\_id | Optional\[str] | ID of the customer who owns this gift card |
| order\_id | Optional\[str] | ID of the order that created this gift card |
#### ShopifyDiscountEntity
Schema for Shopify Price Rule / Discount resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/pricerule](https://shopify.dev/docs/api/admin-rest/2024-01/resources/pricerule)
| Field | Type | Description |
| ----------------------------- | -------------------------- | ------------------------------------------------------- |
| discount\_id | str | Shopify price rule ID. |
| discount\_title | str | Title of the discount/price rule. |
| created\_time | datetime | When the discount was created. |
| updated\_time | datetime | When the discount was last updated. |
| web\_url\_value | Optional\[str] | URL to view this discount in Shopify admin. |
| value\_type | Optional\[str] | Type of discount value (fixed\_amount, percentage) |
| value | Optional\[str] | Discount value (negative for discounts) |
| target\_type | Optional\[str] | Target type (line\_item, shipping\_line) |
| target\_selection | Optional\[str] | Target selection (all, entitled) |
| allocation\_method | Optional\[str] | Allocation method (across, each) |
| once\_per\_customer | bool | Whether the discount can only be used once per customer |
| usage\_limit | Optional\[int] | Maximum number of times the discount can be used |
| starts\_at | Optional\[datetime] | When the discount becomes active |
| ends\_at | Optional\[datetime] | When the discount expires |
| prerequisite\_subtotal\_range | Optional\[Dict\[str, Any]] | Minimum subtotal required |
| prerequisite\_quantity\_range | Optional\[Dict\[str, Any]] | Minimum quantity required |
#### ShopifyMetaobjectEntity
Schema for Shopify Metaobject resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/metaobject](https://shopify.dev/docs/api/admin-rest/2024-01/resources/metaobject)
| Field | Type | Description |
| ---------------- | -------------------------- | --------------------------------------------- |
| metaobject\_id | str | Shopify metaobject ID. |
| metaobject\_name | str | Display name/handle for the metaobject. |
| created\_time | datetime | When the metaobject was created. |
| updated\_time | datetime | When the metaobject was last updated. |
| web\_url\_value | Optional\[str] | URL to view this metaobject in Shopify admin. |
| type | str | Metaobject definition type |
| handle | Optional\[str] | Unique handle for the metaobject |
| fields | List\[Dict\[str, Any]] | Field values for the metaobject |
| capabilities | Optional\[Dict\[str, Any]] | Capabilities of the metaobject |
#### ShopifyFileEntity
Schema for Shopify File resource.
Inherits from FileEntity for consistency with other file entities in the codebase.
[https://shopify.dev/docs/api/admin-graphql/2024-01/objects/file](https://shopify.dev/docs/api/admin-graphql/2024-01/objects/file)
| Field | Type | Description |
| ------------------- | -------------- | -------------------------------------------------------- |
| file\_id | str | Shopify file ID. |
| file\_name | str | Name of the file. |
| created\_time | datetime | When the file was created. |
| updated\_time | datetime | When the file was last updated. |
| web\_url\_value | Optional\[str] | URL to view this file in Shopify admin. |
| alt | Optional\[str] | Alt text for accessibility |
| file\_status | Optional\[str] | Status of the file (UPLOADED, PROCESSING, READY, FAILED) |
| preview\_image\_url | Optional\[str] | URL of the preview image |
#### ShopifyThemeEntity
Schema for Shopify Theme resource.
[https://shopify.dev/docs/api/admin-rest/2024-01/resources/theme](https://shopify.dev/docs/api/admin-rest/2024-01/resources/theme)
| Field | Type | Description |
| ---------------- | -------------- | ---------------------------------------------- |
| theme\_id | str | Shopify theme ID. |
| theme\_name | str | Name of the theme. |
| created\_time | datetime | When the theme was created. |
| updated\_time | datetime | When the theme was last updated. |
| web\_url\_value | Optional\[str] | URL to view this theme in Shopify admin. |
| role | Optional\[str] | Role of the theme (main, unpublished, demo) |
| theme\_store\_id | Optional\[int] | ID from the Shopify Theme Store |
| previewable | bool | Whether the theme can be previewed |
| processing | bool | Whether the theme is currently being processed |
{/* AUTO-GENERATED CONTENT END */}