# Shopify full reference

> This is the full reference documentation for the Shopify agent connector.

- Skill: `tools-only/shopify-full-reference` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add tools-only/shopify-full-reference`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tools-only/shopify-full-reference/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: tools-only (https://skillmd.com/u/tools-only)
- Updated: 2026-09-29
- Page: https://skillmd.com/skills/tools-only/shopify-full-reference

---

# Shopify full reference

This is the full reference documentation for the Shopify agent connector.

## Supported entities and actions

The Shopify connector supports the following entities and actions.

| Entity | Actions |
|--------|---------|
| Customers | [List](#customers-list), [Get](#customers-get) |
| Orders | [List](#orders-list), [Get](#orders-get) |
| Products | [List](#products-list), [Get](#products-get) |
| Product Variants | [List](#product-variants-list), [Get](#product-variants-get) |
| Product Images | [List](#product-images-list), [Get](#product-images-get) |
| Abandoned Checkouts | [List](#abandoned-checkouts-list) |
| Locations | [List](#locations-list), [Get](#locations-get) |
| Inventory Levels | [List](#inventory-levels-list) |
| Inventory Items | [List](#inventory-items-list), [Get](#inventory-items-get) |
| Shop | [Get](#shop-get) |
| Price Rules | [List](#price-rules-list), [Get](#price-rules-get) |
| Discount Codes | [List](#discount-codes-list), [Get](#discount-codes-get) |
| Custom Collections | [List](#custom-collections-list), [Get](#custom-collections-get) |
| Smart Collections | [List](#smart-collections-list), [Get](#smart-collections-get) |
| Collects | [List](#collects-list), [Get](#collects-get) |
| Draft Orders | [List](#draft-orders-list), [Get](#draft-orders-get) |
| Fulfillments | [List](#fulfillments-list), [Get](#fulfillments-get) |
| Order Refunds | [List](#order-refunds-list), [Get](#order-refunds-get) |
| Transactions | [List](#transactions-list), [Get](#transactions-get) |
| Tender Transactions | [List](#tender-transactions-list) |
| Countries | [List](#countries-list), [Get](#countries-get) |
| Metafield Shops | [List](#metafield-shops-list), [Get](#metafield-shops-get) |
| Metafield Customers | [List](#metafield-customers-list) |
| Metafield Products | [List](#metafield-products-list) |
| Metafield Orders | [List](#metafield-orders-list) |
| Metafield Draft Orders | [List](#metafield-draft-orders-list) |
| Metafield Locations | [List](#metafield-locations-list) |
| Metafield Product Variants | [List](#metafield-product-variants-list) |
| Metafield Smart Collections | [List](#metafield-smart-collections-list) |
| Metafield Product Images | [List](#metafield-product-images-list) |
| Customer Address | [List](#customer-address-list), [Get](#customer-address-get) |
| Fulfillment Orders | [List](#fulfillment-orders-list), [Get](#fulfillment-orders-get) |

## Customers

### Customers List

Returns a list of customers from the store

#### Python SDK

```python
await shopify.customers.list()
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "list"
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of results to return (max 250) |
| `since_id` | `integer` | No | Restrict results to after the specified ID |
| `created_at_min` | `string` | No | Show customers created after date (ISO 8601 format) |
| `created_at_max` | `string` | No | Show customers created before date (ISO 8601 format) |
| `updated_at_min` | `string` | No | Show customers last updated after date (ISO 8601 format) |
| `updated_at_max` | `string` | No | Show customers last updated before date (ISO 8601 format) |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `integer` |  |
| `email` | `string \| null` |  |
| `accepts_marketing` | `boolean \| null` |  |
| `created_at` | `string \| null` |  |
| `updated_at` | `string \| null` |  |
| `first_name` | `string \| null` |  |
| `last_name` | `string \| null` |  |
| `orders_count` | `integer \| null` |  |
| `state` | `string \| null` |  |
| `total_spent` | `string \| null` |  |
| `last_order_id` | `integer \| null` |  |
| `note` | `string \| null` |  |
| `verified_email` | `boolean \| null` |  |
| `multipass_identifier` | `string \| null` |  |
| `tax_exempt` | `boolean \| null` |  |
| `tags` | `string \| null` |  |
| `last_order_name` | `string \| null` |  |
| `currency` | `string \| null` |  |
| `phone` | `string \| null` |  |
| `addresses` | `array \| null` |  |
| `addresses[].id` | `integer` |  |
| `addresses[].customer_id` | `integer \| null` |  |
| `addresses[].first_name` | `string \| null` |  |
| `addresses[].last_name` | `string \| null` |  |
| `addresses[].company` | `string \| null` |  |
| `addresses[].address1` | `string \| null` |  |
| `addresses[].address2` | `string \| null` |  |
| `addresses[].city` | `string \| null` |  |
| `addresses[].province` | `string \| null` |  |
| `addresses[].country` | `string \| null` |  |
| `addresses[].zip` | `string \| null` |  |
| `addresses[].phone` | `string \| null` |  |
| `addresses[].name` | `string \| null` |  |
| `addresses[].province_code` | `string \| null` |  |
| `addresses[].country_code` | `string \| null` |  |
| `addresses[].country_name` | `string \| null` |  |
| `addresses[].default` | `boolean \| null` |  |
| `accepts_marketing_updated_at` | `string \| null` |  |
| `marketing_opt_in_level` | `string \| null` |  |
| `tax_exemptions` | `array \| null` |  |
| `email_marketing_consent` | `object \| any` |  |
| `sms_marketing_consent` | `object \| any` |  |
| `admin_graphql_api_id` | `string \| null` |  |
| `default_address` | `object \| any` |  |


#### Meta

| Field Name | Type | Description |
|------------|------|-------------|
| `next_page_url` | `string` |  |

</details>

### Customers Get

Retrieves a single customer by ID

#### Python SDK

```python
await shopify.customers.get(
    customer_id=0
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "get",
    "params": {
        "customer_id": 0
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `customer_id` | `integer` | Yes | The customer ID |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `integer` |  |
| `email` | `string \| null` |  |
| `accepts_marketing` | `boolean \| null` |  |
| `created_at` | `string \| null` |  |
| `updated_at` | `string \| null` |  |
| `first_name` | `string \| null` |  |
| `last_name` | `string \| null` |  |
| `orders_count` | `integer \| null` |  |
| `state` | `string \| null` |  |
| `total_spent` | `string \| null` |  |
| `last_order_id` | `integer \| null` |  |
| `note` | `string \| null` |  |
| `verified_email` | `boolean \| null` |  |
| `multipass_identifier` | `string \| null` |  |
| `tax_exempt` | `boolean \| null` |  |
| `tags` | `string \| null` |  |
| `last_order_name` | `string \| null` |  |
| `currency` | `string \| null` |  |
| `phone` | `string \| null` |  |
| `addresses` | `array \| null` |  |
| `addresses[].id` | `integer` |  |
| `addresses[].customer_id` | `integer \| null` |  |
| `addresses[].first_name` | `string \| null` |  |
| `addresses[].last_name` | `string \| null` |  |
| `addresses[].company` | `string \| null` |  |
| `addresses[].address1` | `string \| null` |  |
| `addresses[].address2` | `string \| null` |  |
| `addresses[].city` | `string \| null` |  |
| `addresses[].province` | `string \| null` |  |
| `addresses[].country` | `string \| null` |  |
| `addresses[].zip` | `string \| null` |  |
| `addresses[].phone` | `string \| null` |  |
| `addresses[].name` | `string \| null` |  |
| `addresses[].province_code` | `string \| null` |  |
| `addresses[].country_code` | `string \| null` |  |
| `addresses[].country_name` | `string \| null` |  |
| `addresses[].default` | `boolean \| null` |  |
| `accepts_marketing_updated_at` | `string \| null` |  |
| `marketing_opt_in_level` | `string \| null` |  |
| `tax_exemptions` | `array \| null` |  |
| `email_marketing_consent` | `object \| any` |  |
| `sms_marketing_consent` | `object \| any` |  |
| `admin_graphql_api_id` | `string \| null` |  |
| `default_address` | `object \| any` |  |


</details>

## Orders

### Orders List

Returns a list of orders from the store

#### Python SDK

```python
await shopify.orders.list()
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "orders",
    "action": "list"
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of results to return (max 250) |
| `since_id` | `integer` | No | Restrict results to after the specified ID |
| `created_at_min` | `string` | No | Show orders created after date (ISO 8601 format) |
| `created_at_max` | `string` | No | Show orders created before date (ISO 8601 format) |
| `updated_at_min` | `string` | No | Show orders last updated after date (ISO 8601 format) |
| `updated_at_max` | `string` | No | Show orders last updated before date (ISO 8601 format) |
| `status` | `"open" \| "closed" \| "cancelled" \| "any"` | No | Filter orders by status |
| `financial_status` | `"authorized" \| "pending" \| "paid" \| "partially_paid" \| "refunded" \| "voided" \| "partially_refunded" \| "any" \| "unpaid"` | No | Filter orders by financial status |
| `fulfillment_status` | `"shipped" \| "partial" \| "unshipped" \| "any" \| "unfulfilled"` | No | Filter orders by fulfillment status |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `integer` |  |
| `admin_graphql_api_id` | `string \| null` |  |
| `app_id` | `integer \| null` |  |
| `browser_ip` | `string \| null` |  |
| `buyer_accepts_marketing` | `boolean \| null` |  |
| `cancel_reason` | `string \| null` |  |
| `cancelled_at` | `string \| null` |  |
| `cart_token` | `string \| null` |  |
| `checkout_id` | `integer \| null` |  |
| `checkout_token` | `string \| null` |  |
| `client_details` | `object \| null` |  |
| `closed_at` | `string \| null` |  |
| `company` | `object \| null` |  |
| `confirmation_number` | `string \| null` |  |
| `confirmed` | `boolean \| null` |  |
| `contact_email` | `string \| null` |  |
| `created_at` | `string \| null` |  |
| `currency` | `string \| null` |  |
| `current_subtotal_price` | `string \| null` |  |
| `current_subtotal_price_set` | `object \| null` |  |
| `current_total_additional_fees_set` | `object \| null` |  |
| `current_total_discounts` | `string \| null` |  |
| `current_total_discounts_set` | `object \| null` |  |
| `current_total_duties_set` | `object \| null` |  |
| `current_total_price` | `string \| null` |  |
| `current_total_price_set` | `object \| null` |  |
| `current_total_tax` | `string \| null` |  |
| `current_total_tax_set` | `object \| null` |  |
| `customer` | `object \| any` |  |
| `customer_locale` | `string \| null` |  |
| `device_id` | `integer \| null` |  |
| `discount_applications` | `array \| null` |  |
| `discount_codes` | `array \| null` |  |
| `email` | `string \| null` |  |
| `estimated_taxes` | `boolean \| null` |  |
| `financial_status` | `string \| null` |  |
| `fulfillment_status` | `string \| null` |  |
| `fulfillments` | `array \| null` |  |
| `fulfillments[].id` | `integer` |  |
| `fulfillments[].order_id` | `integer \| null` |  |
| `fulfillments[].status` | `string \| null` |  |
| `fulfillments[].created_at` | `string \| null` |  |
| `fulfillments[].service` | `string \| null` |  |
| `fulfillments[].updated_at` | `string \| null` |  |
| `fulfillments[].tracking_company` | `string \| null` |  |
| `fulfillments[].shipment_status` | `string \| null` |  |
| `fulfillments[].location_id` | `integer \| null` |  |
| `fulfillments[].origin_address` | `object \| null` |  |
| `fulfillments[].line_items` | `array \| null` |  |
| `fulfillments[].line_items[].id` | `integer` |  |
| `fulfillments[].line_items[].admin_graphql_api_id` | `string \| null` |  |
| `fulfillments[].line_items[].attributed_staffs` | `array \| null` |  |
| `fulfillments[].line_items[].current_quantity` | `integer \| null` |  |
| `fulfillments[].line_items[].fulfillable_quantity` | `integer \| null` |  |
| `fulfillments[].line_items[].fulfillment_service` | `string \| null` |  |
| `fulfillments[].line_items[].fulfillment_status` | `string \| null` |  |
| `fulfillments[].line_items[].gift_card` | `boolean \| null` |  |
| `fulfillments[].line_items[].grams` | `integer \| null` |  |
| `fulfillments[].line_items[].name` | `string \| null` |  |
| `fulfillments[].line_items[].price` | `string \| null` |  |
| `fulfillments[].line_items[].price_set` | `object \| null` |  |
| `fulfillments[].line_items[].product_exists` | `boolean \| null` |  |
| `fulfillments[].line_items[].product_id` | `integer \| null` |  |
| `fulfillments[].line_items[].properties` | `array \| null` |  |
| `fulfillments[].line_items[].quantity` | `integer \| null` |  |
| `fulfillments[].line_items[].requires_shipping` | `boolean \| null` |  |
| `fulfillments[].line_items[].sku` | `string \| null` |  |
| `fulfillments[].line_items[].taxable` | `boolean \| null` |  |
| `fulfillments[].line_items[].title` | `string \| null` |  |
| `fulfillments[].line_items[].total_discount` | `string \| null` |  |
| `fulfillments[].line_items[].total_discount_set` | `object \| null` |  |
| `fulfillments[].line_items[].variant_id` | `integer \| null` |  |
| `fulfillments[].line_items[].variant_inventory_management` | `string \| null` |  |
| `fulfillments[].line_items[].variant_title` | `string \| null` |  |
| `fulfillments[].line_items[].vendor` | `string \| null` |  |
| `fulfillments[].line_items[].tax_lines` | `array \| null` |  |
| `fulfillments[].line_items[].duties` | `array \| null` |  |
| `fulfillments[].line_items[].discount_allocations` | `array \| null` |  |
| `fulfillments[].tracking_number` | `string \| null` |  |
| `fulfillments[].tracking_numbers` | `array \| null` |  |
| `fulfillments[].tracking_url` | `string \| null` |  |
| `fulfillments[].tracking_urls` | `array \| null` |  |
| `fulfillments[].receipt` | `object \| null` |  |
| `fulfillments[].name` | `string \| null` |  |
| `fulfillments[].admin_graphql_api_id` | `string \| null` |  |
| `gateway` | `string \| null` |  |
| `landing_site` | `string \| null` |  |
| `landing_site_ref` | `string \| null` |  |
| `line_items` | `array \| null` |  |
| `line_items[].id` | `integer` |  |
| `line_items[].admin_graphql_api_id` | `string \| null` |  |
| `line_items[].attributed_staffs` | `array \| null` |  |
| `line_items[].current_quantity` | `integer \| null` |  |
| `line_items[].fulfillable_quantity` | `integer \| null` |  |
| `line_items[].fulfillment_service` | `string \| null` |  |
| `line_items[].fulfillment_status` | `string \| null` |  |
| `line_items[].gift_card` | `boolean \| null` |  |
| `line_items[].grams` | `integer \| null` |  |
| `line_items[].name` | `string \| null` |  |
| `line_items[].price` | `string \| null` |  |
| `line_items[].price_set` | `object \| null` |  |
| `line_items[].product_exists` | `boolean \| null` |  |
| `line_items[].product_id` | `integer \| null` |  |
| `line_items[].properties` | `array \| null` |  |
| `line_items[].quantity` | `integer \| null` |  |
| `line_items[].requires_shipping` | `boolean \| null` |  |
| `line_items[].sku` | `string \| null` |  |
| `line_items[].taxable` | `boolean \| null` |  |
| `line_items[].title` | `string \| null` |  |
| `line_items[].total_discount` | `string \| null` |  |
| `line_items[].total_discount_set` | `object \| null` |  |
| `line_items[].variant_id` | `integer \| null` |  |
| `line_items[].variant_inventory_management` | `string \| null` |  |
| `line_items[].variant_title` | `string \| null` |  |
| `line_items[].vendor` | `string \| null` |  |
| `line_items[].tax_lines` | `array \| null` |  |
| `line_items[].duties` | `array \| null` |  |
| `line_items[].discount_allocations` | `array \| null` |  |
| `location_id` | `integer \| null` |  |
| `merchant_of_record_app_id` | `integer \| null` |  |
| `merchant_business_entity_id` | `string \| null` |  |
| `duties_included` | `boolean \| null` |  |
| `total_cash_rounding_payment_adjustment_set` | `object \| null` |  |
| `total_cash_rounding_refund_adjustment_set` | `object \| null` |  |
| `payment_terms` | `object \| null` |  |
| `name` | `string \| null` |  |
| `note` | `string \| null` |  |
| `note_attributes` | `array \| null` |  |
| `number` | `integer \| null` |  |
| `order_number` | `integer \| null` |  |
| `order_status_url` | `string \| null` |  |
| `original_total_additional_fees_set` | `object \| null` |  |
| `original_total_duties_set` | `object \| null` |  |
| `payment_gateway_names` | `array \| null` |  |
| `phone` | `string \| null` |  |
| `po_number` | `string \| null` |  |
| `presentment_currency` | `string \| null` |  |
| `processed_at` | `string \| null` |  |
| `reference` | `string \| null` |  |
| `referring_site` | `string \| null` |  |
| `refunds` | `array \| null` |  |
| `refunds[].id` | `integer` |  |
| `refunds[].order_id` | `integer \| null` |  |
| `refunds[].created_at` | `string \| null` |  |
| `refunds[].note` | `string \| null` |  |
| `refunds[].user_id` | `integer \| null` |  |
| `refunds[].processed_at` | `string \| null` |  |
| `refunds[].restock` | `boolean \| null` |  |
| `refunds[].duties` | `array \| null` |  |
| `refunds[].total_duties_set` | `object \| null` |  |
| `refunds[].return` | `object \| null` |  |
| `refunds[].refund_line_items` | `array \| null` |  |
| `refunds[].transactions` | `array \| null` |  |
| `refunds[].transactions[].id` | `integer` |  |
| `refunds[].transactions[].order_id` | `integer \| null` |  |
| `refunds[].transactions[].kind` | `string \| null` |  |
| `refunds[].transactions[].gateway` | `string \| null` |  |
| `refunds[].transactions[].status` | `string \| null` |  |
| `refunds[].transactions[].message` | `string \| null` |  |
| `refunds[].transactions[].created_at` | `string \| null` |  |
| `refunds[].transactions[].test` | `boolean \| null` |  |
| `refunds[].transactions[].authorization` | `string \| null` |  |
| `refunds[].transactions[].location_id` | `integer \| null` |  |
| `refunds[].transactions[].user_id` | `integer \| null` |  |
| `refunds[].transactions[].parent_id` | `integer \| null` |  |
| `refunds[].transactions[].processed_at` | `string \| null` |  |
| `refunds[].transactions[].device_id` | `integer \| null` |  |
| `refunds[].transactions[].error_code` | `string \| null` |  |
| `refunds[].transactions[].source_name` | `string \| null` |  |
| `refunds[].transactions[].receipt` | `object \| null` |  |
| `refunds[].transactions[].currency_exchange_adjustment` | `object \| null` |  |
| `refunds[].transactions[].amount` | `string \| null` |  |
| `refunds[].transactions[].currency` | `string \| null` |  |
| `refunds[].transactions[].payment_id` | `string \| null` |  |
| `refunds[].transactions[].total_unsettled_set` | `object \| null` |  |
| `refunds[].transactions[].manual_payment_gateway` | `boolean \| null` |  |
| `refunds[].transactions[].admin_graphql_api_id` | `string \| null` |  |
| `refunds[].order_adjustments` | `array \| null` |  |
| `refunds[].admin_graphql_api_id` | `string \| null` |  |
| `refunds[].refund_shipping_lines` | `array \| null` |  |
| `shipping_address` | `object \| any` |  |
| `shipping_lines` | `array \| null` |  |
| `source_identifier` | `string \| null` |  |
| `source_name` | `string \| null` |  |
| `source_url` | `string \| null` |  |
| `subtotal_price` | `string \| null` |  |
| `subtotal_price_set` | `object \| null` |  |
| `tags` | `string \| null` |  |
| `tax_exempt` | `boolean \| null` |  |
| `tax_lines` | `array \| null` |  |
| `taxes_included` | `boolean \| null` |  |
| `test` | `boolean \| null` |  |
| `token` | `string \| null` |  |
| `total_discounts` | `string \| null` |  |
| `total_discounts_set` | `object \| null` |  |
| `total_line_items_price` | `string \| null` |  |
| `total_line_items_price_set` | `object \| null` |  |
| `total_outstanding` | `string \| null` |  |
| `total_price` | `string \| null` |  |
| `total_price_set` | `object \| null` |  |
| `total_shipping_price_set` | `object \| null` |  |
| `total_tax` | `string \| null` |  |
| `total_tax_set` | `object \| null` |  |
| `total_tip_received` | `string \| null` |  |
| `total_weight` | `integer \| null` |  |
| `updated_at` | `string \| null` |  |
| `user_id` | `integer \| null` |  |
| `billing_address` | `object \| any` |  |


#### Meta

| Field Name | Type | Description |
|------------|------|-------------|
| `next_page_url` | `string` |  |

</details>

### Orders Get

Retrieves a single order by ID

#### Python SDK

```python
await shopify.orders.get(
    order_id=0
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "orders",
    "action": "get",
    "params": {
        "order_id": 0
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `order_id` | `integer` | Yes | The order ID |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `integer` |  |
| `admin_graphql_api_id` | `string \| null` |  |
| `app_id` | `integer \| null` |  |
| `browser_ip` | `string \| null` |  |
| `buyer_accepts_marketing` | `boolean \| null` |  |
| `cancel_reason` | `string \| null` |  |
| `cancelled_at` | `string \| null` |  |
| `cart_token` | `string \| null` |  |
| `checkout_id` | `integer \| null` |  |
| `checkout_token` | `string \| null` |  |
| `client_details` | `object \| null` |  |
| `closed_at` | `string \| null` |  |
| `company` | `object \| null` |  |
| `confirmation_number` | `string \| null` |  |
| `confirmed` | `boolean \| null` |  |
| `contact_email` | `string \| null` |  |
| `created_at` | `string \| null` |  |
| `currency` | `string \| null` |  |
| `current_subtotal_price` | `string \| null` |  |
| `current_subtotal_price_set` | `object \| null` |  |
| `current_total_additional_fees_set` | `object \| null` |  |
| `current_total_discounts` | `string \| null` |  |
| `current_total_discounts_set` | `object \| null` |  |
| `current_total_duties_set` | `object \| null` |  |
| `current_total_price` | `string \| null` |  |
| `current_total_price_set` | `object \| null` |  |
| `current_total_tax` | `string \| null` |  |
| `current_total_tax_set` | `object \| null` |  |
| `customer` | `object \| any` |  |
| `customer_locale` | `string \| null` |  |
| `device_id` | `integer \| null` |  |
| `discount_applications` | `array \| null` |  |
| `discount_codes` | `array \| null` |  |
| `email` | `string \| null` |  |
| `estimated_taxes` | `boolean \| null` |  |
| `financial_status` | `string \| null` |  |
| `fulfillment_status` | `string \| null` |  |
| `fulfillments` | `array \| null` |  |
| `fulfillments[].id` | `integer` |  |
| `fulfillments[].order_id` | `integer \| null` |  |
| `fulfillments[].status` | `string \| null` |  |
| `fulfillments[].created_at` | `string \| null` |  |
| `fulfillments[].service` | `string \| null` |  |
| `fulfillments[].updated_at` | `string \| null` |  |
| `fulfillments[].tracking_company` | `string \| null` |  |
| `fulfillments[].shipment_status` | `string \| null` |  |
| `fulfillments[].location_id` | `integer \| null` |  |
| `fulfillments[].origin_address` | `object \| null` |  |
| `fulfillments[].line_items` | `array \| null` |  |
| `fulfillments[].line_items[].id` | `integer` |  |
| `fulfillments[].line_items[].admin_graphql_api_id` | `string \| null` |  |
| `fulfillments[].line_items[].attributed_staffs` | `array \| null` |  |
| `fulfillments[].line_items[].current_quantity` | `integer \| null` |  |
| `fulfillments[].line_items[].fulfillable_quantity` | `integer \| null` |  |
| `fulfillments[].line_items[].fulfillment_service` | `string \| null` |  |
| `fulfillments[].line_items[].fulfillment_status` | `string \| null` |  |
| `fulfillments[].line_items[].gift_card` | `boolean \| null` |  |
| `fulfillments[].line_items[].grams` | `integer \| null` |  |
| `fulfillments[].line_items[].name` | `string \| null` |  |
| `fulfillments[].line_items[].price` | `string \| null` |  |
| `fulfillments[].line_items[].price_set` | `object \| null` |  |
| `fulfillments[].line_items[].product_exists` | `boolean \| null` |  |
| `fulfillments[].line_items[].product_id` | `integer \| null` |  |
| `fulfillments[].line_items[].properties` | `array \| null` |  |
| `fulfillments[].line_items[].quantity` | `integer \| null` |  |
| `fulfillments[].line_items[].requires_shipping` | `boolean \| null` |  |
| `fulfillments[].line_items[].sku` | `string \| null` |  |
| `fulfillments[].line_items[].taxable` | `boolean \| null` |  |
| `fulfillments[].line_items[].title` | `string \| null` |  |
| `fulfillments[].line_items[].total_discount` | `string \| null` |  |
| `fulfillments[].line_items[].total_discount_set` | `object \| null` |  |
| `fulfillments[].line_items[].variant_id` | `integer \| null` |  |
| `fulfillments[].line_items[].variant_inventory_management` | `string \| null` |  |
| `fulfillments[].line_items[].variant_title` | `string \| null` |  |
| `fulfillments[].line_items[].vendor` | `string \| null` |  |
| `fulfillments[].line_items[].tax_lines` | `array \| null` |  |
| `fulfillments[].line_items[].duties` | `array \| null` |  |
| `fulfillments[].line_items[].discount_allocations` | `array \| null` |  |
| `fulfillments[].tracking_number` | `string \| null` |  |
| `fulfillments[].tracking_numbers` | `array \| null` |  |
| `fulfillments[].tracking_url` | `string \| null` |  |
| `fulfillments[].tracking_urls` | `array \| null` |  |
| `fulfillments[].receipt` | `object \| null` |  |
| `fulfillments[].name` | `string \| null` |  |
| `fulfillments[].admin_graphql_api_id` | `string \| null` |  |
| `gateway` | `string \| null` |  |
| `landing_site` | `string \| null` |  |
| `landing_site_ref` | `string \| null` |  |
| `line_items` | `array \| null` |  |
| `line_items[].id` | `integer` |  |
| `line_items[].admin_graphql_api_id` | `string \| null` |  |
| `line_items[].attributed_staffs` | `array \| null` |  |
| `line_items[].current_quantity` | `integer \| null` |  |
| `line_items[].fulfillable_quantity` | `integer \| null` |  |
| `line_items[].fulfillment_service` | `string \| null` |  |
| `line_items[].fulfillment_status` | `string \| null` |  |
| `line_items[].gift_card` | `boolean \| null` |  |
| `line_items[].grams` | `integer \| null` |  |
| `line_items[].name` | `string \| null` |  |
| `line_items[].price` | `string \| null` |  |
| `line_items[].price_set` | `object \| null` |  |
| `line_items[].product_exists` | `boolean \| null` |  |
| `line_items[].product_id` | `integer \| null` |  |
| `line_items[].properties` | `array \| null` |  |
| `line_items[].quantity` | `integer \| null` |  |
| `line_items[].requires_shipping` | `boolean \| null` |  |
| `line_items[].sku` | `string \| null` |  |
| `line_items[].taxable` | `boolean \| null` |  |
| `line_items[].title` | `string \| null` |  |
| `line_items[].total_discount` | `string \| null` |  |
| `line_items[].total_discount_set` | `object \| null` |  |
| `line_items[].variant_id` | `integer \| null` |  |
| `line_items[].variant_inventory_management` | `string \| null` |  |
| `line_items[].variant_title` | `string \| null` |  |
| `line_items[].vendor` | `string \| null` |  |
| `line_items[].tax_lines` | `array \| null` |  |
| `line_items[].duties` | `array \| null` |  |
| `line_items[].discount_allocations` | `array \| null` |  |
| `location_id` | `integer \| null` |  |
| `merchant_of_record_app_id` | `integer \| null` |  |
| `merchant_business_entity_id` | `string \| null` |  |
| `duties_included` | `boolean \| null` |  |
| `total_cash_rounding_payment_adjustment_set` | `object \| null` |  |
| `total_cash_rounding_refund_adjustment_set` | `object \| null` |  |
| `payment_terms` | `object \| null` |  |
| `name` | `string \| null` |  |
| `note` | `string \| null` |  |
| `note_attributes` | `array \| null` |  |
| `number` | `integer \| null` |  |
| `order_number` | `integer \| null` |  |
| `order_status_url` | `string \| null` |  |
| `original_total_additional_fees_set` | `object \| null` |  |
| `original_total_duties_set` | `object \| null` |  |
| `payment_gateway_names` | `array \| null` |  |
| `phone` | `string \| null` |  |
| `po_number` | `string \| null` |  |
| `presentment_currency` | `string \| null` |  |
| `processed_at` | `string \| null` |  |
| `reference` | `string \| null` |  |
| `referring_site` | `string \| null` |  |
| `refunds` | `array \| null` |  |
| `refunds[].id` | `integer` |  |
| `refunds[].order_id` | `integer \| null` |  |
| `refunds[].created_at` | `string \| null` |  |
| `refunds[].note` | `string \| null` |  |
| `refunds[].user_id` | `integer \| null` |  |
| `refunds[].processed_at` | `string \| null` |  |
| `refunds[].restock` | `boolean \| null` |  |
| `refunds[].duties` | `array \| null` |  |
| `refunds[].total_duties_set` | `object \| null` |  |
| `refunds[].return` | `object \| null` |  |
| `refunds[].refund_line_items` | `array \| null` |  |
| `refunds[].transactions` | `array \| null` |  |
| `refunds[].transactions[].id` | `integer` |  |
| `refunds[].transactions[].order_id` | `integer \| null` |  |
| `refunds[].transactions[].kind` | `string \| null` |  |
| `refunds[].transactions[].gateway` | `string \| null` |  |
| `refunds[].transactions[].status` | `string \| null` |  |
| `refunds[].transactions[].message` | `string \| null` |  |
| `refunds[].transactions[].created_at` | `string \| null` |  |
| `refunds[].transactions[].test` | `boolean \| null` |  |
| `refunds[].transactions[].authorization` | `string \| null` |  |
| `refunds[].transactions[].location_id` | `integer \| null` |  |
| `refunds[].transactions[].user_id` | `integer \| null` |  |
| `refunds[].transactions[].parent_id` | `integer \| null` |  |
| `refunds[].transactions[].processed_at` | `string \| null` |  |
| `refunds[].transactions[].device_id` | `integer \| null` |  |
| `refunds[].transactions[].error_code` | `string \| null` |  |
| `refunds[].transactions[].source_name` | `string \| null` |  |
| `refunds[].transactions[].receipt` | `object \| null` |  |
| `refunds[].transactions[].currency_exchange_adjustment` | `object \| null` |  |
| `refunds[].transactions[].amount` | `string \| null` |  |
| `refunds[].transactions[].currency` | `string \| null` |  |
| `refunds[].transactions[].payment_id` | `string \| null` |  |
| `refunds[].transactions[].total_unsettled_set` | `object \| null` |  |
| `refunds[].transactions[].manual_payment_gateway` | `boolean \| null` |  |
| `refunds[].transactions[].admin_graphql_api_id` | `string \| null` |  |
| `refunds[].order_adjustments` | `array \| null` |  |
| `refunds[].admin_graphql_api_id` | `string \| null` |  |
| `refunds[].refund_shipping_lines` | `array \| null` |  |
| `shipping_address` | `object \| any` |  |
| `shipping_lines` | `array \| null` |  |
| `source_identifier` | `string \| null` |  |
| `source_name` | `string \| null` |  |
| `source_url` | `string \| null` |  |
| `subtotal_price` | `string \| null` |  |
| `subtotal_price_set` | `object \| null` |  |
| `tags` | `string \| null` |  |
| `tax_exempt` | `boolean \| null` |  |
| `tax_lines` | `array \| null` |  |
| `taxes_included` | `boolean \| null` |  |
| `test` | `boolean \| null` |  |
| `token` | `string \| null` |  |
| `total_discounts` | `string \| null` |  |
| `total_discounts_set` | `object \| null` |  |
| `total_line_items_price` | `string \| null` |  |
| `total_line_items_price_set` | `object \| null` |  |
| `total_outstanding` | `string \| null` |  |
| `total_price` | `string \| null` |  |
| `total_price_set` | `object \| null` |  |
| `total_shipping_price_set` | `object \| null` |  |
| `total_tax` | `string \| null` |  |
| `total_tax_set` | `object \| null` |  |
| `total_tip_received` | `string \| null` |  |
| `total_weight` | `integer \| null` |  |
| `updated_at` | `string \| null` |  |
| `user_id` | `integer \| null` |  |
| `billing_address` | `object \| any` |  |


</details>

## Products

### Products List

Returns a list of products from the store

#### Python SDK

```python
await shopify.products.list()
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "products",
    "action": "list"
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of results to return (max 250) |
| `since_id` | `integer` | No | Restrict results to after the specified ID |
| `created_at_min` | `string` | No | Show products created after date (ISO 8601 format) |
| `created_at_max` | `string` | No | Show products created before date (ISO 8601 format) |
| `updated_at_min` | `string` | No | Show products last updated after date (ISO 8601 format) |
| `updated_at_max` | `string` | No | Show products last updated before date (ISO 8601 format) |
| `status` | `"active" \| "archived" \| "draft"` | No | Filter products by status |
| `product_type` | `string` | No | Filter by product type |
| `vendor` | `string` | No | Filter by vendor |
| `collection_id` | `integer` | No | Filter by collection ID |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `integer` |  |
| `title` | `string \| null` |  |
| `body_html` | `string \| null` |  |
| `vendor` | `string \| null` |  |
| `product_type` | `string \| null` |  |
| `created_at` | `string \| null` |  |
| `handle` | `string \| null` |  |
| `updated_at` | `string \| null` |  |
| `published_at` | `string \| null` |  |
| `template_suffix` | `string \| null` |  |
| `published_scope` | `string \| null` |  |
| `tags` | `string \| null` |  |
| `status` | `string \| null` |  |
| `admin_graphql_api_id` | `string \| null` |  |
| `variants` | `array \| null` |  |
| `variants[].id` | `integer` |  |
| `variants[].product_id` | `integer \| null` |  |
| `variants[].title` | `string \| null` |  |
| `variants[].price` | `string \| null` |  |
| `variants[].sku` | `string \| null` |  |
| `variants[].position` | `integer \| null` |  |
| `variants[].inventory_policy` | `string \| null` |  |
| `variants[].compare_at_price` | `string \| null` |  |
| `variants[].fulfillment_service` | `string \| null` |  |
| `variants[].inventory_management` | `string \| null` |  |
| `variants[].option1` | `string \| null` |  |
| `variants[].option2` | `string \| null` |  |
| `variants[].option3` | `string \| null` |  |
| `variants[].created_at` | `string \| null` |  |
| `variants[].updated_at` | `string \| null` |  |
| `variants[].taxable` | `boolean \| null` |  |
| `variants[].barcode` | `string \| null` |  |
| `variants[].grams` | `integer \| null` |  |
| `variants[].image_id` | `integer \| null` |  |
| `variants[].weight` | `number \| null` |  |
| `variants[].weight_unit` | `string \| null` |  |
| `variants[].inventory_item_id` | `integer \| null` |  |
| `variants[].inventory_quantity` | `integer \| null` |  |
| `variants[].old_inventory_quantity` | `integer \| null` |  |
| `variants[].requires_shipping` | `boolean \| null` |  |
| `variants[].admin_graphql_api_id` | `string \| null` |  |
| `options` | `array \| null` |  |
| `images` | `array \| null` |  |
| `images[].id` | `integer` |  |
| `images[].product_id` | `integer \| null` |  |
| `images[].position` | `integer \| null` |  |
| `images[].created_at` | `string \| null` |  |
| `images[].updated_at` | `string \| null` |  |
| `images[].alt` | `string \| null` |  |
| `images[].width` | `integer \| null` |  |
| `images[].height` | `integer \| null` |  |
| `images[].src` | `string \| null` |  |
| `images[].variant_ids` | `array \| null` |  |
| `images[].admin_graphql_api_id` | `string \| null` |  |
| `image` | `object \| any` |  |


#### Meta

| Field Name | Type | Description |
|------------|------|-------------|
| `next_page_url` | `string` |  |

</details>

### Products Get

Retrieves a single product by ID

#### Python SDK

```python
await shopify.products.get(
    product_id=0
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "products",
    "action": "get",
    "params": {
        "product_id": 0
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `product_id` | `integer` | Yes | The product ID |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `integer` |  |
| `title` | `string \| null` |  |
| `body_html` | `string \| null` |  |
| `vendor` | `string \| null` |  |
| `product_type` | `string \| null` |  |
| `created_at` | `string \| null` |  |
| `handle` | `string \| null` |  |
| `updated_at` | `string \| null` |  |
| `published_at` | `string \| null` |  |
| `template_suffix` | `string \| null` |  |
| `published_scope` | `string \| null` |  |
| `tags` | `string \| null` |  |
| `status` | `string \| null` |  |
| `admin_graphql_api_id` | `string \| null` |  |
| `variants` | `array \| null` |  |
| `variants[].id` | `integer` |  |
| `variants[].product_id` | `integer \| null` |  |
| `variants[].title` | `string \| null` |  |
| `variants[].price` | `string \| null` |  |
| `variants[].sku` | `string \| null` |  |
| `variants[].position` | `integer \| null` |  |
| `variants[].inventory_policy` | `string \| null` |  |
| `variants[].compare_at_price` | `string \| null` |  |
| `variants[].fulfillment_service` | `string \| null` |  |
| `variants[].inventory_management` | `string \| null` |  |
| `variants[].option1` | `string \| null` |  |
| `variants[].option2` | `string \| null` |  |
| `variants[].option3` | `string \| null` |  |
| `variants[].created_at` | `string \| null` |  |
| `variants[].updated_at` | `string \| null` |  |
| `variants[].taxable` | `boolean \| null` |  |
| `variants[].barcode` | `string \| null` |  |
| `variants[].grams` | `integer \| null` |  |
| `variants[].image_id` | `integer \| null` |  |
| `variants[].weight` | `number \| null` |  |
| `variants[].weight_unit` | `string \| null` |  |
| `variants[].inventory_item_id` | `integer \| null` |  |
| `variants[].inventory_quantity` | `integer \| null` |  |
| `variants[].old_inventory_quantity` | `integer \| null` |  |
| `variants[].requires_shipping` | `boolean \| null` |  |
| `variants[].admin_graphql_api_id` | `string \| null` |  |
| `options` | `array \| null` |  |
| `images` | `array \| null` |  |
| `images[].id` | `integer` |  |
| `images[].product_id` | `integer \| null` |  |
| `images[].position` | `integer \| null` |  |
| `images[].created_at` | `string \| null` |  |
| `images[].updated_at` | `string \| null` |  |
| `images[].alt` | `string \| null` |  |
| `images[].width` | `integer \| null` |  |
| `images[].height` | `integer \| null` |  |
| `images[].src` | `string \| null` |  |
| `images[].vari

…(truncated)