Skip to main content

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.

EntityActions
CustomersList, Get, Context Store Search
OrdersList, Get
ProductsList, Get
Product VariantsList, Get, Context Store Search
Product ImagesList, Get, Context Store Search
Abandoned CheckoutsList, Context Store Search
LocationsList, Get, Context Store Search
Inventory LevelsList, Context Store Search
Inventory ItemsList, Get, Context Store Search
ShopGet, Context Store Search
Price RulesList, Get, Context Store Search
Discount CodesList, Get, Context Store Search
Custom CollectionsList, Get, Context Store Search
Smart CollectionsList, Get, Context Store Search
CollectsList, Get, Context Store Search
Draft OrdersList, Get, Context Store Search
FulfillmentsList, Get, Context Store Search
Order RefundsList, Get, Context Store Search
TransactionsList, Get
Tender TransactionsList, Context Store Search
CountriesList, Get, Context Store Search
Metafield ShopsList, Get, Context Store Search
Metafield CustomersList, Context Store Search
Metafield ProductsList, Context Store Search
Metafield OrdersList, Context Store Search
Metafield Draft OrdersList, Context Store Search
Metafield LocationsList, Context Store Search
Metafield Product VariantsList, Context Store Search
Metafield Smart CollectionsList, Context Store Search
Metafield Product ImagesList, Context Store Search
Customer AddressList, Get
Fulfillment OrdersList, Get, Context Store Search

Customers​

Customers List​

Returns a list of customers from the store

Python SDK​

await shopify.customers.list()

API​

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 NameTypeRequiredDescription
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
created_at_minstringNoShow customers created after date (ISO 8601 format)
created_at_maxstringNoShow customers created before date (ISO 8601 format)
updated_at_minstringNoShow customers last updated after date (ISO 8601 format)
updated_at_maxstringNoShow customers last updated before date (ISO 8601 format)
Response Schema

Records​

Field NameTypeDescription
idinteger
emailstring | null
accepts_marketingboolean | null
created_atstring | null
updated_atstring | null
first_namestring | null
last_namestring | null
orders_countinteger | null
statestring | null
total_spentstring | null
last_order_idinteger | null
notestring | null
verified_emailboolean | null
multipass_identifierstring | null
tax_exemptboolean | null
tagsstring | null
last_order_namestring | null
currencystring | null
phonestring | null
addressesarray | null
addresses[].idinteger
addresses[].customer_idinteger | null
addresses[].first_namestring | null
addresses[].last_namestring | null
addresses[].companystring | null
addresses[].address1string | null
addresses[].address2string | null
addresses[].citystring | null
addresses[].provincestring | null
addresses[].countrystring | null
addresses[].zipstring | null
addresses[].phonestring | null
addresses[].namestring | null
addresses[].province_codestring | null
addresses[].country_codestring | null
addresses[].country_namestring | null
addresses[].defaultboolean | null
accepts_marketing_updated_atstring | null
marketing_opt_in_levelstring | null
tax_exemptionsarray | null
email_marketing_consentobject | any
sms_marketing_consentobject | any
admin_graphql_api_idstring | null
default_addressobject | any

Meta​

Field NameTypeDescription
next_page_urlstring

Customers Get​

Retrieves a single customer by ID

Python SDK​

await shopify.customers.get(
    customer_id=0
)

API​

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 NameTypeRequiredDescription
customer_idintegerYesThe customer ID
Response Schema

Records​

Field NameTypeDescription
idinteger
emailstring | null
accepts_marketingboolean | null
created_atstring | null
updated_atstring | null
first_namestring | null
last_namestring | null
orders_countinteger | null
statestring | null
total_spentstring | null
last_order_idinteger | null
notestring | null
verified_emailboolean | null
multipass_identifierstring | null
tax_exemptboolean | null
tagsstring | null
last_order_namestring | null
currencystring | null
phonestring | null
addressesarray | null
addresses[].idinteger
addresses[].customer_idinteger | null
addresses[].first_namestring | null
addresses[].last_namestring | null
addresses[].companystring | null
addresses[].address1string | null
addresses[].address2string | null
addresses[].citystring | null
addresses[].provincestring | null
addresses[].countrystring | null
addresses[].zipstring | null
addresses[].phonestring | null
addresses[].namestring | null
addresses[].province_codestring | null
addresses[].country_codestring | null
addresses[].country_namestring | null
addresses[].defaultboolean | null
accepts_marketing_updated_atstring | null
marketing_opt_in_levelstring | null
tax_exemptionsarray | null
email_marketing_consentobject | any
sms_marketing_consentobject | any
admin_graphql_api_idstring | null
default_addressobject | any

Search and filter customers records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.customers.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the customer
emailstringPrimary email address of the customer
phonestringPrimary phone number of the customer
first_namestringFirst name of the customer
last_namestringLast name of the customer
statestringAccount state (disabled, invited, enabled, declined)
orders_countintegerNumber of orders placed by the customer
total_spentstringTotal lifetime amount spent by the customer
currencystringISO 4217 currency code for the customer's total spend
created_atstringISO 8601 timestamp when the customer record was created
updated_atstringISO 8601 timestamp when the customer record was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the customer
data[].emailstringPrimary email address of the customer
data[].phonestringPrimary phone number of the customer
data[].first_namestringFirst name of the customer
data[].last_namestringLast name of the customer
data[].statestringAccount state (disabled, invited, enabled, declined)
data[].orders_countintegerNumber of orders placed by the customer
data[].total_spentstringTotal lifetime amount spent by the customer
data[].currencystringISO 4217 currency code for the customer's total spend
data[].created_atstringISO 8601 timestamp when the customer record was created
data[].updated_atstringISO 8601 timestamp when the customer record was last updated

Orders​

Orders List​

Returns a list of orders from the store

Python SDK​

await shopify.orders.list()

API​

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 NameTypeRequiredDescription
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
created_at_minstringNoShow orders created after date (ISO 8601 format)
created_at_maxstringNoShow orders created before date (ISO 8601 format)
updated_at_minstringNoShow orders last updated after date (ISO 8601 format)
updated_at_maxstringNoShow orders last updated before date (ISO 8601 format)
status"open" | "closed" | "cancelled" | "any"NoFilter orders by status
financial_status"authorized" | "pending" | "paid" | "partially_paid" | "refunded" | "voided" | "partially_refunded" | "any" | "unpaid"NoFilter orders by financial status
fulfillment_status"shipped" | "partial" | "unshipped" | "any" | "unfulfilled"NoFilter orders by fulfillment status
Response Schema

Records​

Field NameTypeDescription
idinteger
admin_graphql_api_idstring | null
app_idinteger | null
browser_ipstring | null
buyer_accepts_marketingboolean | null
cancel_reasonstring | null
cancelled_atstring | null
cart_tokenstring | null
checkout_idinteger | null
checkout_tokenstring | null
client_detailsobject | null
closed_atstring | null
companyobject | null
confirmation_numberstring | null
confirmedboolean | null
contact_emailstring | null
created_atstring | null
currencystring | null
current_subtotal_pricestring | null
current_subtotal_price_setobject | null
current_total_additional_fees_setobject | null
current_total_discountsstring | null
current_total_discounts_setobject | null
current_total_duties_setobject | null
current_total_pricestring | null
current_total_price_setobject | null
current_total_taxstring | null
current_total_tax_setobject | null
customerobject | any
customer_localestring | null
device_idinteger | null
discount_applicationsarray | null
discount_codesarray | null
emailstring | null
estimated_taxesboolean | null
financial_statusstring | null
fulfillment_statusstring | null
fulfillmentsarray | null
fulfillments[].idinteger
fulfillments[].order_idinteger | null
fulfillments[].statusstring | null
fulfillments[].created_atstring | null
fulfillments[].servicestring | null
fulfillments[].updated_atstring | null
fulfillments[].tracking_companystring | null
fulfillments[].shipment_statusstring | null
fulfillments[].location_idinteger | null
fulfillments[].origin_addressobject | null
fulfillments[].line_itemsarray | null
fulfillments[].line_items[].idinteger
fulfillments[].line_items[].admin_graphql_api_idstring | null
fulfillments[].line_items[].attributed_staffsarray | null
fulfillments[].line_items[].current_quantityinteger | null
fulfillments[].line_items[].fulfillable_quantityinteger | null
fulfillments[].line_items[].fulfillment_servicestring | null
fulfillments[].line_items[].fulfillment_statusstring | null
fulfillments[].line_items[].gift_cardboolean | null
fulfillments[].line_items[].gramsinteger | null
fulfillments[].line_items[].namestring | null
fulfillments[].line_items[].pricestring | null
fulfillments[].line_items[].price_setobject | null
fulfillments[].line_items[].product_existsboolean | null
fulfillments[].line_items[].product_idinteger | null
fulfillments[].line_items[].propertiesarray | null
fulfillments[].line_items[].quantityinteger | null
fulfillments[].line_items[].requires_shippingboolean | null
fulfillments[].line_items[].skustring | null
fulfillments[].line_items[].taxableboolean | null
fulfillments[].line_items[].titlestring | null
fulfillments[].line_items[].total_discountstring | null
fulfillments[].line_items[].total_discount_setobject | null
fulfillments[].line_items[].variant_idinteger | null
fulfillments[].line_items[].variant_inventory_managementstring | null
fulfillments[].line_items[].variant_titlestring | null
fulfillments[].line_items[].vendorstring | null
fulfillments[].line_items[].tax_linesarray | null
fulfillments[].line_items[].dutiesarray | null
fulfillments[].line_items[].discount_allocationsarray | null
fulfillments[].tracking_numberstring | null
fulfillments[].tracking_numbersarray | null
fulfillments[].tracking_urlstring | null
fulfillments[].tracking_urlsarray | null
fulfillments[].receiptobject | null
fulfillments[].namestring | null
fulfillments[].admin_graphql_api_idstring | null
gatewaystring | null
landing_sitestring | null
landing_site_refstring | null
line_itemsarray | null
line_items[].idinteger
line_items[].admin_graphql_api_idstring | null
line_items[].attributed_staffsarray | null
line_items[].current_quantityinteger | null
line_items[].fulfillable_quantityinteger | null
line_items[].fulfillment_servicestring | null
line_items[].fulfillment_statusstring | null
line_items[].gift_cardboolean | null
line_items[].gramsinteger | null
line_items[].namestring | null
line_items[].pricestring | null
line_items[].price_setobject | null
line_items[].product_existsboolean | null
line_items[].product_idinteger | null
line_items[].propertiesarray | null
line_items[].quantityinteger | null
line_items[].requires_shippingboolean | null
line_items[].skustring | null
line_items[].taxableboolean | null
line_items[].titlestring | null
line_items[].total_discountstring | null
line_items[].total_discount_setobject | null
line_items[].variant_idinteger | null
line_items[].variant_inventory_managementstring | null
line_items[].variant_titlestring | null
line_items[].vendorstring | null
line_items[].tax_linesarray | null
line_items[].dutiesarray | null
line_items[].discount_allocationsarray | null
location_idinteger | null
merchant_of_record_app_idinteger | null
merchant_business_entity_idstring | null
duties_includedboolean | null
total_cash_rounding_payment_adjustment_setobject | null
total_cash_rounding_refund_adjustment_setobject | null
payment_termsobject | null
namestring | null
notestring | null
note_attributesarray | null
numberinteger | null
order_numberinteger | null
order_status_urlstring | null
original_total_additional_fees_setobject | null
original_total_duties_setobject | null
payment_gateway_namesarray | null
phonestring | null
po_numberstring | null
presentment_currencystring | null
processed_atstring | null
referencestring | null
referring_sitestring | null
refundsarray | null
refunds[].idinteger
refunds[].order_idinteger | null
refunds[].created_atstring | null
refunds[].notestring | null
refunds[].user_idinteger | null
refunds[].processed_atstring | null
refunds[].restockboolean | null
refunds[].dutiesarray | null
refunds[].total_duties_setobject | null
refunds[].returnobject | null
refunds[].refund_line_itemsarray | null
refunds[].transactionsarray | null
refunds[].transactions[].idinteger
refunds[].transactions[].order_idinteger | null
refunds[].transactions[].kindstring | null
refunds[].transactions[].gatewaystring | null
refunds[].transactions[].statusstring | null
refunds[].transactions[].messagestring | null
refunds[].transactions[].created_atstring | null
refunds[].transactions[].testboolean | null
refunds[].transactions[].authorizationstring | null
refunds[].transactions[].location_idinteger | null
refunds[].transactions[].user_idinteger | null
refunds[].transactions[].parent_idinteger | null
refunds[].transactions[].processed_atstring | null
refunds[].transactions[].device_idinteger | null
refunds[].transactions[].error_codestring | null
refunds[].transactions[].source_namestring | null
refunds[].transactions[].receiptobject | null
refunds[].transactions[].currency_exchange_adjustmentobject | null
refunds[].transactions[].amountstring | null
refunds[].transactions[].currencystring | null
refunds[].transactions[].payment_idstring | null
refunds[].transactions[].total_unsettled_setobject | null
refunds[].transactions[].manual_payment_gatewayboolean | null
refunds[].transactions[].admin_graphql_api_idstring | null
refunds[].order_adjustmentsarray | null
refunds[].admin_graphql_api_idstring | null
refunds[].refund_shipping_linesarray | null
shipping_addressobject | any
shipping_linesarray | null
source_identifierstring | null
source_namestring | null
source_urlstring | null
subtotal_pricestring | null
subtotal_price_setobject | null
tagsstring | null
tax_exemptboolean | null
tax_linesarray | null
taxes_includedboolean | null
testboolean | null
tokenstring | null
total_discountsstring | null
total_discounts_setobject | null
total_line_items_pricestring | null
total_line_items_price_setobject | null
total_outstandingstring | null
total_pricestring | null
total_price_setobject | null
total_shipping_price_setobject | null
total_taxstring | null
total_tax_setobject | null
total_tip_receivedstring | null
total_weightinteger | null
updated_atstring | null
user_idinteger | null
billing_addressobject | any

Meta​

Field NameTypeDescription
next_page_urlstring

Orders Get​

Retrieves a single order by ID

Python SDK​

await shopify.orders.get(
    order_id=0
)

API​

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 NameTypeRequiredDescription
order_idintegerYesThe order ID
Response Schema

Records​

Field NameTypeDescription
idinteger
admin_graphql_api_idstring | null
app_idinteger | null
browser_ipstring | null
buyer_accepts_marketingboolean | null
cancel_reasonstring | null
cancelled_atstring | null
cart_tokenstring | null
checkout_idinteger | null
checkout_tokenstring | null
client_detailsobject | null
closed_atstring | null
companyobject | null
confirmation_numberstring | null
confirmedboolean | null
contact_emailstring | null
created_atstring | null
currencystring | null
current_subtotal_pricestring | null
current_subtotal_price_setobject | null
current_total_additional_fees_setobject | null
current_total_discountsstring | null
current_total_discounts_setobject | null
current_total_duties_setobject | null
current_total_pricestring | null
current_total_price_setobject | null
current_total_taxstring | null
current_total_tax_setobject | null
customerobject | any
customer_localestring | null
device_idinteger | null
discount_applicationsarray | null
discount_codesarray | null
emailstring | null
estimated_taxesboolean | null
financial_statusstring | null
fulfillment_statusstring | null
fulfillmentsarray | null
fulfillments[].idinteger
fulfillments[].order_idinteger | null
fulfillments[].statusstring | null
fulfillments[].created_atstring | null
fulfillments[].servicestring | null
fulfillments[].updated_atstring | null
fulfillments[].tracking_companystring | null
fulfillments[].shipment_statusstring | null
fulfillments[].location_idinteger | null
fulfillments[].origin_addressobject | null
fulfillments[].line_itemsarray | null
fulfillments[].line_items[].idinteger
fulfillments[].line_items[].admin_graphql_api_idstring | null
fulfillments[].line_items[].attributed_staffsarray | null
fulfillments[].line_items[].current_quantityinteger | null
fulfillments[].line_items[].fulfillable_quantityinteger | null
fulfillments[].line_items[].fulfillment_servicestring | null
fulfillments[].line_items[].fulfillment_statusstring | null
fulfillments[].line_items[].gift_cardboolean | null
fulfillments[].line_items[].gramsinteger | null
fulfillments[].line_items[].namestring | null
fulfillments[].line_items[].pricestring | null
fulfillments[].line_items[].price_setobject | null
fulfillments[].line_items[].product_existsboolean | null
fulfillments[].line_items[].product_idinteger | null
fulfillments[].line_items[].propertiesarray | null
fulfillments[].line_items[].quantityinteger | null
fulfillments[].line_items[].requires_shippingboolean | null
fulfillments[].line_items[].skustring | null
fulfillments[].line_items[].taxableboolean | null
fulfillments[].line_items[].titlestring | null
fulfillments[].line_items[].total_discountstring | null
fulfillments[].line_items[].total_discount_setobject | null
fulfillments[].line_items[].variant_idinteger | null
fulfillments[].line_items[].variant_inventory_managementstring | null
fulfillments[].line_items[].variant_titlestring | null
fulfillments[].line_items[].vendorstring | null
fulfillments[].line_items[].tax_linesarray | null
fulfillments[].line_items[].dutiesarray | null
fulfillments[].line_items[].discount_allocationsarray | null
fulfillments[].tracking_numberstring | null
fulfillments[].tracking_numbersarray | null
fulfillments[].tracking_urlstring | null
fulfillments[].tracking_urlsarray | null
fulfillments[].receiptobject | null
fulfillments[].namestring | null
fulfillments[].admin_graphql_api_idstring | null
gatewaystring | null
landing_sitestring | null
landing_site_refstring | null
line_itemsarray | null
line_items[].idinteger
line_items[].admin_graphql_api_idstring | null
line_items[].attributed_staffsarray | null
line_items[].current_quantityinteger | null
line_items[].fulfillable_quantityinteger | null
line_items[].fulfillment_servicestring | null
line_items[].fulfillment_statusstring | null
line_items[].gift_cardboolean | null
line_items[].gramsinteger | null
line_items[].namestring | null
line_items[].pricestring | null
line_items[].price_setobject | null
line_items[].product_existsboolean | null
line_items[].product_idinteger | null
line_items[].propertiesarray | null
line_items[].quantityinteger | null
line_items[].requires_shippingboolean | null
line_items[].skustring | null
line_items[].taxableboolean | null
line_items[].titlestring | null
line_items[].total_discountstring | null
line_items[].total_discount_setobject | null
line_items[].variant_idinteger | null
line_items[].variant_inventory_managementstring | null
line_items[].variant_titlestring | null
line_items[].vendorstring | null
line_items[].tax_linesarray | null
line_items[].dutiesarray | null
line_items[].discount_allocationsarray | null
location_idinteger | null
merchant_of_record_app_idinteger | null
merchant_business_entity_idstring | null
duties_includedboolean | null
total_cash_rounding_payment_adjustment_setobject | null
total_cash_rounding_refund_adjustment_setobject | null
payment_termsobject | null
namestring | null
notestring | null
note_attributesarray | null
numberinteger | null
order_numberinteger | null
order_status_urlstring | null
original_total_additional_fees_setobject | null
original_total_duties_setobject | null
payment_gateway_namesarray | null
phonestring | null
po_numberstring | null
presentment_currencystring | null
processed_atstring | null
referencestring | null
referring_sitestring | null
refundsarray | null
refunds[].idinteger
refunds[].order_idinteger | null
refunds[].created_atstring | null
refunds[].notestring | null
refunds[].user_idinteger | null
refunds[].processed_atstring | null
refunds[].restockboolean | null
refunds[].dutiesarray | null
refunds[].total_duties_setobject | null
refunds[].returnobject | null
refunds[].refund_line_itemsarray | null
refunds[].transactionsarray | null
refunds[].transactions[].idinteger
refunds[].transactions[].order_idinteger | null
refunds[].transactions[].kindstring | null
refunds[].transactions[].gatewaystring | null
refunds[].transactions[].statusstring | null
refunds[].transactions[].messagestring | null
refunds[].transactions[].created_atstring | null
refunds[].transactions[].testboolean | null
refunds[].transactions[].authorizationstring | null
refunds[].transactions[].location_idinteger | null
refunds[].transactions[].user_idinteger | null
refunds[].transactions[].parent_idinteger | null
refunds[].transactions[].processed_atstring | null
refunds[].transactions[].device_idinteger | null
refunds[].transactions[].error_codestring | null
refunds[].transactions[].source_namestring | null
refunds[].transactions[].receiptobject | null
refunds[].transactions[].currency_exchange_adjustmentobject | null
refunds[].transactions[].amountstring | null
refunds[].transactions[].currencystring | null
refunds[].transactions[].payment_idstring | null
refunds[].transactions[].total_unsettled_setobject | null
refunds[].transactions[].manual_payment_gatewayboolean | null
refunds[].transactions[].admin_graphql_api_idstring | null
refunds[].order_adjustmentsarray | null
refunds[].admin_graphql_api_idstring | null
refunds[].refund_shipping_linesarray | null
shipping_addressobject | any
shipping_linesarray | null
source_identifierstring | null
source_namestring | null
source_urlstring | null
subtotal_pricestring | null
subtotal_price_setobject | null
tagsstring | null
tax_exemptboolean | null
tax_linesarray | null
taxes_includedboolean | null
testboolean | null
tokenstring | null
total_discountsstring | null
total_discounts_setobject | null
total_line_items_pricestring | null
total_line_items_price_setobject | null
total_outstandingstring | null
total_pricestring | null
total_price_setobject | null
total_shipping_price_setobject | null
total_taxstring | null
total_tax_setobject | null
total_tip_receivedstring | null
total_weightinteger | null
updated_atstring | null
user_idinteger | null
billing_addressobject | any

Products​

Products List​

Returns a list of products from the store

Python SDK​

await shopify.products.list()

API​

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 NameTypeRequiredDescription
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
created_at_minstringNoShow products created after date (ISO 8601 format)
created_at_maxstringNoShow products created before date (ISO 8601 format)
updated_at_minstringNoShow products last updated after date (ISO 8601 format)
updated_at_maxstringNoShow products last updated before date (ISO 8601 format)
status"active" | "archived" | "draft"NoFilter products by status
product_typestringNoFilter by product type
vendorstringNoFilter by vendor
collection_idintegerNoFilter by collection ID
Response Schema

Records​

Field NameTypeDescription
idinteger
titlestring | null
body_htmlstring | null
vendorstring | null
product_typestring | null
created_atstring | null
handlestring | null
updated_atstring | null
published_atstring | null
template_suffixstring | null
published_scopestring | null
tagsstring | null
statusstring | null
admin_graphql_api_idstring | null
variantsarray | null
variants[].idinteger
variants[].product_idinteger | null
variants[].titlestring | null
variants[].pricestring | null
variants[].skustring | null
variants[].positioninteger | null
variants[].inventory_policystring | null
variants[].compare_at_pricestring | null
variants[].fulfillment_servicestring | null
variants[].inventory_managementstring | null
variants[].option1string | null
variants[].option2string | null
variants[].option3string | null
variants[].created_atstring | null
variants[].updated_atstring | null
variants[].taxableboolean | null
variants[].barcodestring | null
variants[].gramsinteger | null
variants[].image_idinteger | null
variants[].weightnumber | null
variants[].weight_unitstring | null
variants[].inventory_item_idinteger | null
variants[].inventory_quantityinteger | null
variants[].old_inventory_quantityinteger | null
variants[].requires_shippingboolean | null
variants[].admin_graphql_api_idstring | null
optionsarray | null
imagesarray | null
images[].idinteger
images[].product_idinteger | null
images[].positioninteger | null
images[].created_atstring | null
images[].updated_atstring | null
images[].altstring | null
images[].widthinteger | null
images[].heightinteger | null
images[].srcstring | null
images[].variant_idsarray | null
images[].admin_graphql_api_idstring | null
imageobject | any

Meta​

Field NameTypeDescription
next_page_urlstring

Products Get​

Retrieves a single product by ID

Python SDK​

await shopify.products.get(
    product_id=0
)

API​

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 NameTypeRequiredDescription
product_idintegerYesThe product ID
Response Schema

Records​

Field NameTypeDescription
idinteger
titlestring | null
body_htmlstring | null
vendorstring | null
product_typestring | null
created_atstring | null
handlestring | null
updated_atstring | null
published_atstring | null
template_suffixstring | null
published_scopestring | null
tagsstring | null
statusstring | null
admin_graphql_api_idstring | null
variantsarray | null
variants[].idinteger
variants[].product_idinteger | null
variants[].titlestring | null
variants[].pricestring | null
variants[].skustring | null
variants[].positioninteger | null
variants[].inventory_policystring | null
variants[].compare_at_pricestring | null
variants[].fulfillment_servicestring | null
variants[].inventory_managementstring | null
variants[].option1string | null
variants[].option2string | null
variants[].option3string | null
variants[].created_atstring | null
variants[].updated_atstring | null
variants[].taxableboolean | null
variants[].barcodestring | null
variants[].gramsinteger | null
variants[].image_idinteger | null
variants[].weightnumber | null
variants[].weight_unitstring | null
variants[].inventory_item_idinteger | null
variants[].inventory_quantityinteger | null
variants[].old_inventory_quantityinteger | null
variants[].requires_shippingboolean | null
variants[].admin_graphql_api_idstring | null
optionsarray | null
imagesarray | null
images[].idinteger
images[].product_idinteger | null
images[].positioninteger | null
images[].created_atstring | null
images[].updated_atstring | null
images[].altstring | null
images[].widthinteger | null
images[].heightinteger | null
images[].srcstring | null
images[].variant_idsarray | null
images[].admin_graphql_api_idstring | null
imageobject | any

Product Variants​

Product Variants List​

Returns a list of variants for a product

Python SDK​

await shopify.product_variants.list(
    product_id=0
)

API​

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": "product_variants",
    "action": "list",
    "params": {
        "product_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
product_idintegerYesThe product ID
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
Response Schema

Records​

Field NameTypeDescription
idinteger
product_idinteger | null
titlestring | null
pricestring | null
skustring | null
positioninteger | null
inventory_policystring | null
compare_at_pricestring | null
fulfillment_servicestring | null
inventory_managementstring | null
option1string | null
option2string | null
option3string | null
created_atstring | null
updated_atstring | null
taxableboolean | null
barcodestring | null
gramsinteger | null
image_idinteger | null
weightnumber | null
weight_unitstring | null
inventory_item_idinteger | null
inventory_quantityinteger | null
old_inventory_quantityinteger | null
requires_shippingboolean | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Product Variants Get​

Retrieves a single product variant by ID

Python SDK​

await shopify.product_variants.get(
    variant_id=0
)

API​

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": "product_variants",
    "action": "get",
    "params": {
        "variant_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
variant_idintegerYesThe variant ID
Response Schema

Records​

Field NameTypeDescription
idinteger
product_idinteger | null
titlestring | null
pricestring | null
skustring | null
positioninteger | null
inventory_policystring | null
compare_at_pricestring | null
fulfillment_servicestring | null
inventory_managementstring | null
option1string | null
option2string | null
option3string | null
created_atstring | null
updated_atstring | null
taxableboolean | null
barcodestring | null
gramsinteger | null
image_idinteger | null
weightnumber | null
weight_unitstring | null
inventory_item_idinteger | null
inventory_quantityinteger | null
old_inventory_quantityinteger | null
requires_shippingboolean | null
admin_graphql_api_idstring | null

Search and filter product variants records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.product_variants.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "product_variants",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the product variant
product_idintegerIdentifier of the parent product
titlestringDisplay title of the variant
skustringStock keeping unit for the variant
pricestringPrice of the variant in the shop's currency
compare_at_pricestringOriginal (compare-at) price of the variant, if set
positionintegerDisplay position of the variant within the product
inventory_policystringBehaviour when out of stock (deny or continue)
created_atstringISO 8601 timestamp when the variant was created
updated_atstringISO 8601 timestamp when the variant was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the product variant
data[].product_idintegerIdentifier of the parent product
data[].titlestringDisplay title of the variant
data[].skustringStock keeping unit for the variant
data[].pricestringPrice of the variant in the shop's currency
data[].compare_at_pricestringOriginal (compare-at) price of the variant, if set
data[].positionintegerDisplay position of the variant within the product
data[].inventory_policystringBehaviour when out of stock (deny or continue)
data[].created_atstringISO 8601 timestamp when the variant was created
data[].updated_atstringISO 8601 timestamp when the variant was last updated

Product Images​

Product Images List​

Returns a list of images for a product

Python SDK​

await shopify.product_images.list(
    product_id=0
)

API​

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": "product_images",
    "action": "list",
    "params": {
        "product_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
product_idintegerYesThe product ID
since_idintegerNoRestrict results to after the specified ID
Response Schema

Records​

Field NameTypeDescription
idinteger
product_idinteger | null
positioninteger | null
created_atstring | null
updated_atstring | null
altstring | null
widthinteger | null
heightinteger | null
srcstring | null
variant_idsarray | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Product Images Get​

Retrieves a single product image by ID

Python SDK​

await shopify.product_images.get(
    product_id=0,
    image_id=0
)

API​

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": "product_images",
    "action": "get",
    "params": {
        "product_id": 0,
        "image_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
product_idintegerYesThe product ID
image_idintegerYesThe image ID
Response Schema

Records​

Field NameTypeDescription
idinteger
product_idinteger | null
positioninteger | null
created_atstring | null
updated_atstring | null
altstring | null
widthinteger | null
heightinteger | null
srcstring | null
variant_idsarray | null
admin_graphql_api_idstring | null

Search and filter product images records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.product_images.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "product_images",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the product image
product_idintegerIdentifier of the product the image belongs to
positionintegerDisplay position of the image within the product
altstringAlt text for the image
widthintegerImage width in pixels
heightintegerImage height in pixels
srcstringPublic URL of the image
created_atstringISO 8601 timestamp when the image was created
updated_atstringISO 8601 timestamp when the image was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the product image
data[].product_idintegerIdentifier of the product the image belongs to
data[].positionintegerDisplay position of the image within the product
data[].altstringAlt text for the image
data[].widthintegerImage width in pixels
data[].heightintegerImage height in pixels
data[].srcstringPublic URL of the image
data[].created_atstringISO 8601 timestamp when the image was created
data[].updated_atstringISO 8601 timestamp when the image was last updated

Abandoned Checkouts​

Abandoned Checkouts List​

Returns a list of abandoned checkouts

Python SDK​

await shopify.abandoned_checkouts.list()

API​

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": "abandoned_checkouts",
    "action": "list"
}'

Parameters​

Parameter NameTypeRequiredDescription
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
created_at_minstringNoShow checkouts created after date (ISO 8601 format)
created_at_maxstringNoShow checkouts created before date (ISO 8601 format)
updated_at_minstringNoShow checkouts last updated after date (ISO 8601 format)
updated_at_maxstringNoShow checkouts last updated before date (ISO 8601 format)
status"open" | "closed" | "any"NoFilter checkouts by status
Response Schema

Records​

Field NameTypeDescription
idinteger
tokenstring | null
cart_tokenstring | null
emailstring | null
gatewaystring | null
buyer_accepts_marketingboolean | null
created_atstring | null
updated_atstring | null
landing_sitestring | null
notestring | null
note_attributesarray | null
referring_sitestring | null
shipping_linesarray | null
taxes_includedboolean | null
total_weightinteger | null
currencystring | null
completed_atstring | null
closed_atstring | null
user_idinteger | null
location_idinteger | null
source_identifierstring | null
source_urlstring | null
device_idinteger | null
phonestring | null
customer_localestring | null
line_itemsarray | null
line_items[].idinteger
line_items[].admin_graphql_api_idstring | null
line_items[].attributed_staffsarray | null
line_items[].current_quantityinteger | null
line_items[].fulfillable_quantityinteger | null
line_items[].fulfillment_servicestring | null
line_items[].fulfillment_statusstring | null
line_items[].gift_cardboolean | null
line_items[].gramsinteger | null
line_items[].namestring | null
line_items[].pricestring | null
line_items[].price_setobject | null
line_items[].product_existsboolean | null
line_items[].product_idinteger | null
line_items[].propertiesarray | null
line_items[].quantityinteger | null
line_items[].requires_shippingboolean | null
line_items[].skustring | null
line_items[].taxableboolean | null
line_items[].titlestring | null
line_items[].total_discountstring | null
line_items[].total_discount_setobject | null
line_items[].variant_idinteger | null
line_items[].variant_inventory_managementstring | null
line_items[].variant_titlestring | null
line_items[].vendorstring | null
line_items[].tax_linesarray | null
line_items[].dutiesarray | null
line_items[].discount_allocationsarray | null
namestring | null
sourcestring | null
abandoned_checkout_urlstring | null
discount_codesarray | null
tax_linesarray | null
source_namestring | null
presentment_currencystring | null
buyer_accepts_sms_marketingboolean | null
sms_marketing_phonestring | null
total_discountsstring | null
total_line_items_pricestring | null
total_pricestring | null
total_taxstring | null
subtotal_pricestring | null
total_dutiesstring | null
billing_addressobject | any
shipping_addressobject | any
customerobject | any
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Search and filter abandoned checkouts records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.abandoned_checkouts.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "abandoned_checkouts",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the abandoned checkout
tokenstringUnique token identifying the checkout
emailstringEmail address provided for the checkout
phonestringPhone number provided for the checkout
namestringShopify-assigned display name for the checkout (e.g. #C12345)
currencystringISO 4217 currency code for the checkout totals
total_pricestringTotal price of the checkout in the shop's currency
created_atstringISO 8601 timestamp when the checkout was created
updated_atstringISO 8601 timestamp when the checkout was last updated
completed_atstringISO 8601 timestamp when the checkout was completed, if applicable
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the abandoned checkout
data[].tokenstringUnique token identifying the checkout
data[].emailstringEmail address provided for the checkout
data[].phonestringPhone number provided for the checkout
data[].namestringShopify-assigned display name for the checkout (e.g. #C12345)
data[].currencystringISO 4217 currency code for the checkout totals
data[].total_pricestringTotal price of the checkout in the shop's currency
data[].created_atstringISO 8601 timestamp when the checkout was created
data[].updated_atstringISO 8601 timestamp when the checkout was last updated
data[].completed_atstringISO 8601 timestamp when the checkout was completed, if applicable

Locations​

Locations List​

Returns a list of locations for the store

Python SDK​

await shopify.locations.list()

API​

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": "locations",
    "action": "list"
}'
Response Schema

Records​

Field NameTypeDescription
idinteger
namestring | null
address1string | null
address2string | null
citystring | null
zipstring | null
provincestring | null
countrystring | null
phonestring | null
created_atstring | null
updated_atstring | null
country_codestring | null
country_namestring | null
province_codestring | null
legacyboolean | null
activeboolean | null
admin_graphql_api_idstring | null
localized_country_namestring | null
localized_province_namestring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Locations Get​

Retrieves a single location by ID

Python SDK​

await shopify.locations.get(
    location_id=0
)

API​

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": "locations",
    "action": "get",
    "params": {
        "location_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
location_idintegerYesThe location ID
Response Schema

Records​

Field NameTypeDescription
idinteger
namestring | null
address1string | null
address2string | null
citystring | null
zipstring | null
provincestring | null
countrystring | null
phonestring | null
created_atstring | null
updated_atstring | null
country_codestring | null
country_namestring | null
province_codestring | null
legacyboolean | null
activeboolean | null
admin_graphql_api_idstring | null
localized_country_namestring | null
localized_province_namestring | null

Search and filter locations records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.locations.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "locations",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the location
namestringDisplay name of the location
address1stringPrimary street address of the location
citystringCity of the location
provincestringProvince, state, or region of the location
countrystringCountry name of the location
country_codestringISO 3166-1 alpha-2 country code of the location
phonestringPhone number for the location
activebooleanWhether the location is currently active
created_atstringISO 8601 timestamp when the location was created
updated_atstringISO 8601 timestamp when the location was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the location
data[].namestringDisplay name of the location
data[].address1stringPrimary street address of the location
data[].citystringCity of the location
data[].provincestringProvince, state, or region of the location
data[].countrystringCountry name of the location
data[].country_codestringISO 3166-1 alpha-2 country code of the location
data[].phonestringPhone number for the location
data[].activebooleanWhether the location is currently active
data[].created_atstringISO 8601 timestamp when the location was created
data[].updated_atstringISO 8601 timestamp when the location was last updated

Inventory Levels​

Inventory Levels List​

Returns a list of inventory levels for a specific location

Python SDK​

await shopify.inventory_levels.list(
    location_id=0
)

API​

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": "inventory_levels",
    "action": "list",
    "params": {
        "location_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
location_idintegerYesThe location ID
limitintegerNoMaximum number of results to return (max 250)
Response Schema

Records​

Field NameTypeDescription
inventory_item_idinteger
location_idinteger | null
availableinteger | null
updated_atstring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Search and filter inventory levels records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.inventory_levels.context_store_search(
    query={"filter": {"eq": {"inventory_item_id": 0}}}
)

API​

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": "inventory_levels",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"inventory_item_id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
inventory_item_idintegerIdentifier of the inventory item
location_idintegerIdentifier of the location holding the inventory
availableintegerNumber of units available at the location
updated_atstringISO 8601 timestamp when the inventory level was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].inventory_item_idintegerIdentifier of the inventory item
data[].location_idintegerIdentifier of the location holding the inventory
data[].availableintegerNumber of units available at the location
data[].updated_atstringISO 8601 timestamp when the inventory level was last updated

Inventory Items​

Inventory Items List​

Returns a list of inventory items

Python SDK​

await shopify.inventory_items.list(
    ids="<str>"
)

API​

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": "inventory_items",
    "action": "list",
    "params": {
        "ids": "<str>"
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
idsstringYesComma-separated list of inventory item IDs
limitintegerNoMaximum number of results to return (max 250)
Response Schema

Records​

Field NameTypeDescription
idinteger
skustring | null
created_atstring | null
updated_atstring | null
requires_shippingboolean | null
coststring | null
country_code_of_originstring | null
province_code_of_originstring | null
harmonized_system_codestring | null
trackedboolean | null
country_harmonized_system_codesarray | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Inventory Items Get​

Retrieves a single inventory item by ID

Python SDK​

await shopify.inventory_items.get(
    inventory_item_id=0
)

API​

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": "inventory_items",
    "action": "get",
    "params": {
        "inventory_item_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
inventory_item_idintegerYesThe inventory item ID
Response Schema

Records​

Field NameTypeDescription
idinteger
skustring | null
created_atstring | null
updated_atstring | null
requires_shippingboolean | null
coststring | null
country_code_of_originstring | null
province_code_of_originstring | null
harmonized_system_codestring | null
trackedboolean | null
country_harmonized_system_codesarray | null
admin_graphql_api_idstring | null

Search and filter inventory items records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.inventory_items.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "inventory_items",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the inventory item
skustringStock keeping unit associated with the inventory item
trackedbooleanWhether Shopify is tracking inventory for this item
requires_shippingbooleanWhether the item requires shipping
country_code_of_originstringISO country code of the item's country of origin
created_atstringISO 8601 timestamp when the inventory item was created
updated_atstringISO 8601 timestamp when the inventory item was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the inventory item
data[].skustringStock keeping unit associated with the inventory item
data[].trackedbooleanWhether Shopify is tracking inventory for this item
data[].requires_shippingbooleanWhether the item requires shipping
data[].country_code_of_originstringISO country code of the item's country of origin
data[].created_atstringISO 8601 timestamp when the inventory item was created
data[].updated_atstringISO 8601 timestamp when the inventory item was last updated

Shop​

Shop Get​

Retrieves the shop's configuration

Python SDK​

await shopify.shop.get()

API​

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": "shop",
    "action": "get"
}'
Response Schema

Records​

Field NameTypeDescription
idinteger
namestring | null
emailstring | null
domainstring | null
provincestring | null
countrystring | null
address1string | null
zipstring | null
citystring | null
sourcestring | null
phonestring | null
latitudenumber | null
longitudenumber | null
primary_localestring | null
address2string | null
created_atstring | null
updated_atstring | null
country_codestring | null
country_namestring | null
currencystring | null
customer_emailstring | null
timezonestring | null
iana_timezonestring | null
shop_ownerstring | null
money_formatstring | null
money_with_currency_formatstring | null
weight_unitstring | null
province_codestring | null
taxes_includedboolean | null
auto_configure_tax_inclusivityboolean | null
tax_shippingboolean | null
county_taxesboolean | null
plan_display_namestring | null
plan_namestring | null
has_discountsboolean | null
has_gift_cardsboolean | null
myshopify_domainstring | null
google_apps_domainstring | null
google_apps_login_enabledboolean | null
money_in_emails_formatstring | null
money_with_currency_in_emails_formatstring | null
eligible_for_paymentsboolean | null
requires_extra_payments_agreementboolean | null
password_enabledboolean | null
has_storefrontboolean | null
financesboolean | null
primary_location_idinteger | null
checkout_api_supportedboolean | null
multi_location_enabledboolean | null
setup_requiredboolean | null
pre_launch_enabledboolean | null
enabled_presentment_currenciesarray | null
transactional_sms_disabledboolean | null
marketing_sms_consent_enabled_at_checkoutboolean | null

Search and filter shop records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.shop.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "shop",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the shop
namestringDisplay name of the shop
emailstringPrimary contact email for the shop
domainstringCustom domain configured for the shop, if any
myshopify_domainstringCanonical *.myshopify.com domain for the shop
country_codestringISO 3166-1 alpha-2 country code of the shop
currencystringISO 4217 currency code used by the shop
timezonestringTimezone configured for the shop (e.g. (GMT-05:00) Eastern Time)
plan_namestringShopify plan identifier (e.g. shopify_plus, basic)
created_atstringISO 8601 timestamp when the shop was created
updated_atstringISO 8601 timestamp when the shop was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the shop
data[].namestringDisplay name of the shop
data[].emailstringPrimary contact email for the shop
data[].domainstringCustom domain configured for the shop, if any
data[].myshopify_domainstringCanonical *.myshopify.com domain for the shop
data[].country_codestringISO 3166-1 alpha-2 country code of the shop
data[].currencystringISO 4217 currency code used by the shop
data[].timezonestringTimezone configured for the shop (e.g. (GMT-05:00) Eastern Time)
data[].plan_namestringShopify plan identifier (e.g. shopify_plus, basic)
data[].created_atstringISO 8601 timestamp when the shop was created
data[].updated_atstringISO 8601 timestamp when the shop was last updated

Price Rules​

Price Rules List​

Returns a list of price rules

Python SDK​

await shopify.price_rules.list()

API​

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": "price_rules",
    "action": "list"
}'

Parameters​

Parameter NameTypeRequiredDescription
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
created_at_minstringNoShow price rules created after date (ISO 8601 format)
created_at_maxstringNoShow price rules created before date (ISO 8601 format)
updated_at_minstringNoShow price rules last updated after date (ISO 8601 format)
updated_at_maxstringNoShow price rules last updated before date (ISO 8601 format)
Response Schema

Records​

Field NameTypeDescription
idinteger
value_typestring | null
valuestring | null
customer_selectionstring | null
target_typestring | null
target_selectionstring | null
allocation_methodstring | null
allocation_limitinteger | null
once_per_customerboolean | null
usage_limitinteger | null
starts_atstring | null
ends_atstring | null
created_atstring | null
updated_atstring | null
entitled_product_idsarray | null
entitled_variant_idsarray | null
entitled_collection_idsarray | null
entitled_country_idsarray | null
prerequisite_product_idsarray | null
prerequisite_variant_idsarray | null
prerequisite_collection_idsarray | null
customer_segment_prerequisite_idsarray | null
prerequisite_customer_idsarray | null
prerequisite_subtotal_rangeobject | null
prerequisite_quantity_rangeobject | null
prerequisite_shipping_price_rangeobject | null
prerequisite_to_entitlement_quantity_ratioobject | null
prerequisite_to_entitlement_purchaseobject | null
titlestring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Price Rules Get​

Retrieves a single price rule by ID

Python SDK​

await shopify.price_rules.get(
    price_rule_id=0
)

API​

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": "price_rules",
    "action": "get",
    "params": {
        "price_rule_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
price_rule_idintegerYesThe price rule ID
Response Schema

Records​

Field NameTypeDescription
idinteger
value_typestring | null
valuestring | null
customer_selectionstring | null
target_typestring | null
target_selectionstring | null
allocation_methodstring | null
allocation_limitinteger | null
once_per_customerboolean | null
usage_limitinteger | null
starts_atstring | null
ends_atstring | null
created_atstring | null
updated_atstring | null
entitled_product_idsarray | null
entitled_variant_idsarray | null
entitled_collection_idsarray | null
entitled_country_idsarray | null
prerequisite_product_idsarray | null
prerequisite_variant_idsarray | null
prerequisite_collection_idsarray | null
customer_segment_prerequisite_idsarray | null
prerequisite_customer_idsarray | null
prerequisite_subtotal_rangeobject | null
prerequisite_quantity_rangeobject | null
prerequisite_shipping_price_rangeobject | null
prerequisite_to_entitlement_quantity_ratioobject | null
prerequisite_to_entitlement_purchaseobject | null
titlestring | null
admin_graphql_api_idstring | null

Search and filter price rules records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.price_rules.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "price_rules",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the price rule
titlestringAdministrative title of the price rule
value_typestringHow the discount value is interpreted (fixed_amount or percentage)
valuestringDiscount value applied by the rule
target_typestringType of target the rule applies to (line_item or shipping_line)
target_selectionstringWhich target items the rule applies to (all or entitled)
allocation_methodstringHow the discount is allocated (each or across)
starts_atstringISO 8601 timestamp when the rule starts being active
ends_atstringISO 8601 timestamp when the rule stops being active, if applicable
created_atstringISO 8601 timestamp when the rule was created
updated_atstringISO 8601 timestamp when the rule was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the price rule
data[].titlestringAdministrative title of the price rule
data[].value_typestringHow the discount value is interpreted (fixed_amount or percentage)
data[].valuestringDiscount value applied by the rule
data[].target_typestringType of target the rule applies to (line_item or shipping_line)
data[].target_selectionstringWhich target items the rule applies to (all or entitled)
data[].allocation_methodstringHow the discount is allocated (each or across)
data[].starts_atstringISO 8601 timestamp when the rule starts being active
data[].ends_atstringISO 8601 timestamp when the rule stops being active, if applicable
data[].created_atstringISO 8601 timestamp when the rule was created
data[].updated_atstringISO 8601 timestamp when the rule was last updated

Discount Codes​

Discount Codes List​

Returns a list of discount codes for a price rule

Python SDK​

await shopify.discount_codes.list(
    price_rule_id=0
)

API​

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": "discount_codes",
    "action": "list",
    "params": {
        "price_rule_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
price_rule_idintegerYesThe price rule ID
limitintegerNoMaximum number of results to return (max 250)
Response Schema

Records​

Field NameTypeDescription
idinteger
price_rule_idinteger | null
codestring | null
usage_countinteger | null
created_atstring | null
updated_atstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Discount Codes Get​

Retrieves a single discount code by ID

Python SDK​

await shopify.discount_codes.get(
    price_rule_id=0,
    discount_code_id=0
)

API​

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": "discount_codes",
    "action": "get",
    "params": {
        "price_rule_id": 0,
        "discount_code_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
price_rule_idintegerYesThe price rule ID
discount_code_idintegerYesThe discount code ID
Response Schema

Records​

Field NameTypeDescription
idinteger
price_rule_idinteger | null
codestring | null
usage_countinteger | null
created_atstring | null
updated_atstring | null

Search and filter discount codes records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.discount_codes.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "discount_codes",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the discount code
price_rule_idintegerIdentifier of the parent price rule
codestringDiscount code string shoppers enter at checkout
usage_countintegerNumber of times the code has been redeemed
created_atstringISO 8601 timestamp when the code was created
updated_atstringISO 8601 timestamp when the code was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the discount code
data[].price_rule_idintegerIdentifier of the parent price rule
data[].codestringDiscount code string shoppers enter at checkout
data[].usage_countintegerNumber of times the code has been redeemed
data[].created_atstringISO 8601 timestamp when the code was created
data[].updated_atstringISO 8601 timestamp when the code was last updated

Custom Collections​

Custom Collections List​

Returns a list of custom collections

Python SDK​

await shopify.custom_collections.list()

API​

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": "custom_collections",
    "action": "list"
}'

Parameters​

Parameter NameTypeRequiredDescription
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
titlestringNoFilter by collection title
product_idintegerNoFilter by product ID
updated_at_minstringNoShow collections last updated after date (ISO 8601 format)
updated_at_maxstringNoShow collections last updated before date (ISO 8601 format)
Response Schema

Records​

Field NameTypeDescription
idinteger
handlestring | null
titlestring | null
updated_atstring | null
body_htmlstring | null
published_atstring | null
sort_orderstring | null
template_suffixstring | null
published_scopestring | null
admin_graphql_api_idstring | null
imageobject | null
products_countinteger | null

Meta​

Field NameTypeDescription
next_page_urlstring

Custom Collections Get​

Retrieves a single custom collection by ID

Python SDK​

await shopify.custom_collections.get(
    collection_id=0
)

API​

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": "custom_collections",
    "action": "get",
    "params": {
        "collection_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
collection_idintegerYesThe collection ID
Response Schema

Records​

Field NameTypeDescription
idinteger
handlestring | null
titlestring | null
updated_atstring | null
body_htmlstring | null
published_atstring | null
sort_orderstring | null
template_suffixstring | null
published_scopestring | null
admin_graphql_api_idstring | null
imageobject | null
products_countinteger | null

Search and filter custom collections records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.custom_collections.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "custom_collections",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the custom collection
handlestringURL-friendly handle for the custom collection
titlestringDisplay title of the custom collection
sort_orderstringHow products are sorted within the collection (e.g. best-selling)
published_scopestringPublishing scope (web or global)
published_atstringISO 8601 timestamp when the collection was published
updated_atstringISO 8601 timestamp when the collection was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the custom collection
data[].handlestringURL-friendly handle for the custom collection
data[].titlestringDisplay title of the custom collection
data[].sort_orderstringHow products are sorted within the collection (e.g. best-selling)
data[].published_scopestringPublishing scope (web or global)
data[].published_atstringISO 8601 timestamp when the collection was published
data[].updated_atstringISO 8601 timestamp when the collection was last updated

Smart Collections​

Smart Collections List​

Returns a list of smart collections

Python SDK​

await shopify.smart_collections.list()

API​

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": "smart_collections",
    "action": "list"
}'

Parameters​

Parameter NameTypeRequiredDescription
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
titlestringNoFilter by collection title
product_idintegerNoFilter by product ID
updated_at_minstringNoShow collections last updated after date (ISO 8601 format)
updated_at_maxstringNoShow collections last updated before date (ISO 8601 format)
Response Schema

Records​

Field NameTypeDescription
idinteger
handlestring | null
titlestring | null
updated_atstring | null
body_htmlstring | null
published_atstring | null
sort_orderstring | null
template_suffixstring | null
disjunctiveboolean | null
rulesarray | null
published_scopestring | null
admin_graphql_api_idstring | null
imageobject | null
products_countinteger | null

Meta​

Field NameTypeDescription
next_page_urlstring

Smart Collections Get​

Retrieves a single smart collection by ID

Python SDK​

await shopify.smart_collections.get(
    collection_id=0
)

API​

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": "smart_collections",
    "action": "get",
    "params": {
        "collection_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
collection_idintegerYesThe collection ID
Response Schema

Records​

Field NameTypeDescription
idinteger
handlestring | null
titlestring | null
updated_atstring | null
body_htmlstring | null
published_atstring | null
sort_orderstring | null
template_suffixstring | null
disjunctiveboolean | null
rulesarray | null
published_scopestring | null
admin_graphql_api_idstring | null
imageobject | null
products_countinteger | null

Search and filter smart collections records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.smart_collections.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "smart_collections",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the smart collection
handlestringURL-friendly handle for the smart collection
titlestringDisplay title of the smart collection
sort_orderstringHow products are sorted within the collection
published_scopestringPublishing scope (web or global)
published_atstringISO 8601 timestamp when the collection was published
updated_atstringISO 8601 timestamp when the collection was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the smart collection
data[].handlestringURL-friendly handle for the smart collection
data[].titlestringDisplay title of the smart collection
data[].sort_orderstringHow products are sorted within the collection
data[].published_scopestringPublishing scope (web or global)
data[].published_atstringISO 8601 timestamp when the collection was published
data[].updated_atstringISO 8601 timestamp when the collection was last updated

Collects​

Collects List​

Returns a list of collects (links between products and collections)

Python SDK​

await shopify.collects.list()

API​

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": "collects",
    "action": "list"
}'

Parameters​

Parameter NameTypeRequiredDescription
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
collection_idintegerNoFilter by collection ID
product_idintegerNoFilter by product ID
Response Schema

Records​

Field NameTypeDescription
idinteger
collection_idinteger | null
product_idinteger | null
created_atstring | null
updated_atstring | null
positioninteger | null
sort_valuestring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Collects Get​

Retrieves a single collect by ID

Python SDK​

await shopify.collects.get(
    collect_id=0
)

API​

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": "collects",
    "action": "get",
    "params": {
        "collect_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
collect_idintegerYesThe collect ID
Response Schema

Records​

Field NameTypeDescription
idinteger
collection_idinteger | null
product_idinteger | null
created_atstring | null
updated_atstring | null
positioninteger | null
sort_valuestring | null

Search and filter collects records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.collects.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "collects",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the collect
collection_idintegerIdentifier of the collection the product belongs to
product_idintegerIdentifier of the product in the collection
positionintegerPosition of the product within the collection
created_atstringISO 8601 timestamp when the collect was created
updated_atstringISO 8601 timestamp when the collect was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the collect
data[].collection_idintegerIdentifier of the collection the product belongs to
data[].product_idintegerIdentifier of the product in the collection
data[].positionintegerPosition of the product within the collection
data[].created_atstringISO 8601 timestamp when the collect was created
data[].updated_atstringISO 8601 timestamp when the collect was last updated

Draft Orders​

Draft Orders List​

Returns a list of draft orders

Python SDK​

await shopify.draft_orders.list()

API​

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": "draft_orders",
    "action": "list"
}'

Parameters​

Parameter NameTypeRequiredDescription
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
status"open" | "invoice_sent" | "completed"NoFilter draft orders by status
updated_at_minstringNoShow draft orders last updated after date (ISO 8601 format)
updated_at_maxstringNoShow draft orders last updated before date (ISO 8601 format)
Response Schema

Records​

Field NameTypeDescription
idinteger
notestring | null
emailstring | null
taxes_includedboolean | null
currencystring | null
invoice_sent_atstring | null
created_atstring | null
updated_atstring | null
tax_exemptboolean | null
completed_atstring | null
namestring | null
statusstring | null
line_itemsarray | null
line_items[].idinteger
line_items[].admin_graphql_api_idstring | null
line_items[].attributed_staffsarray | null
line_items[].current_quantityinteger | null
line_items[].fulfillable_quantityinteger | null
line_items[].fulfillment_servicestring | null
line_items[].fulfillment_statusstring | null
line_items[].gift_cardboolean | null
line_items[].gramsinteger | null
line_items[].namestring | null
line_items[].pricestring | null
line_items[].price_setobject | null
line_items[].product_existsboolean | null
line_items[].product_idinteger | null
line_items[].propertiesarray | null
line_items[].quantityinteger | null
line_items[].requires_shippingboolean | null
line_items[].skustring | null
line_items[].taxableboolean | null
line_items[].titlestring | null
line_items[].total_discountstring | null
line_items[].total_discount_setobject | null
line_items[].variant_idinteger | null
line_items[].variant_inventory_managementstring | null
line_items[].variant_titlestring | null
line_items[].vendorstring | null
line_items[].tax_linesarray | null
line_items[].dutiesarray | null
line_items[].discount_allocationsarray | null
shipping_addressobject | any
billing_addressobject | any
invoice_urlstring | null
applied_discountobject | null
order_idinteger | null
shipping_lineobject | null
tax_linesarray | null
tagsstring | null
note_attributesarray | null
total_pricestring | null
subtotal_pricestring | null
total_taxstring | null
payment_termsobject | null
admin_graphql_api_idstring | null
customerobject | any
allow_discount_codes_in_checkout?boolean | null
b2b?boolean | null
api_client_idinteger | null
created_on_api_version_handlestring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Draft Orders Get​

Retrieves a single draft order by ID

Python SDK​

await shopify.draft_orders.get(
    draft_order_id=0
)

API​

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": "draft_orders",
    "action": "get",
    "params": {
        "draft_order_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
draft_order_idintegerYesThe draft order ID
Response Schema

Records​

Field NameTypeDescription
idinteger
notestring | null
emailstring | null
taxes_includedboolean | null
currencystring | null
invoice_sent_atstring | null
created_atstring | null
updated_atstring | null
tax_exemptboolean | null
completed_atstring | null
namestring | null
statusstring | null
line_itemsarray | null
line_items[].idinteger
line_items[].admin_graphql_api_idstring | null
line_items[].attributed_staffsarray | null
line_items[].current_quantityinteger | null
line_items[].fulfillable_quantityinteger | null
line_items[].fulfillment_servicestring | null
line_items[].fulfillment_statusstring | null
line_items[].gift_cardboolean | null
line_items[].gramsinteger | null
line_items[].namestring | null
line_items[].pricestring | null
line_items[].price_setobject | null
line_items[].product_existsboolean | null
line_items[].product_idinteger | null
line_items[].propertiesarray | null
line_items[].quantityinteger | null
line_items[].requires_shippingboolean | null
line_items[].skustring | null
line_items[].taxableboolean | null
line_items[].titlestring | null
line_items[].total_discountstring | null
line_items[].total_discount_setobject | null
line_items[].variant_idinteger | null
line_items[].variant_inventory_managementstring | null
line_items[].variant_titlestring | null
line_items[].vendorstring | null
line_items[].tax_linesarray | null
line_items[].dutiesarray | null
line_items[].discount_allocationsarray | null
shipping_addressobject | any
billing_addressobject | any
invoice_urlstring | null
applied_discountobject | null
order_idinteger | null
shipping_lineobject | null
tax_linesarray | null
tagsstring | null
note_attributesarray | null
total_pricestring | null
subtotal_pricestring | null
total_taxstring | null
payment_termsobject | null
admin_graphql_api_idstring | null
customerobject | any
allow_discount_codes_in_checkout?boolean | null
b2b?boolean | null
api_client_idinteger | null
created_on_api_version_handlestring | null

Search and filter draft orders records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.draft_orders.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "draft_orders",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the draft order
namestringShopify-assigned display name for the draft order (e.g. #D12345)
emailstringEmail address associated with the draft order
statusstringStatus of the draft order (open, invoice_sent, completed)
currencystringISO 4217 currency code for the draft order totals
total_pricestringTotal price of the draft order
order_idintegerIdentifier of the completed order, if the draft has been completed
created_atstringISO 8601 timestamp when the draft order was created
updated_atstringISO 8601 timestamp when the draft order was last updated
completed_atstringISO 8601 timestamp when the draft order was completed, if applicable
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the draft order
data[].namestringShopify-assigned display name for the draft order (e.g. #D12345)
data[].emailstringEmail address associated with the draft order
data[].statusstringStatus of the draft order (open, invoice_sent, completed)
data[].currencystringISO 4217 currency code for the draft order totals
data[].total_pricestringTotal price of the draft order
data[].order_idintegerIdentifier of the completed order, if the draft has been completed
data[].created_atstringISO 8601 timestamp when the draft order was created
data[].updated_atstringISO 8601 timestamp when the draft order was last updated
data[].completed_atstringISO 8601 timestamp when the draft order was completed, if applicable

Fulfillments​

Fulfillments List​

Returns a list of fulfillments for an order

Python SDK​

await shopify.fulfillments.list(
    order_id=0
)

API​

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": "fulfillments",
    "action": "list",
    "params": {
        "order_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
order_idintegerYesThe order ID
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
created_at_minstringNoShow fulfillments created after date (ISO 8601 format)
created_at_maxstringNoShow fulfillments created before date (ISO 8601 format)
updated_at_minstringNoShow fulfillments last updated after date (ISO 8601 format)
updated_at_maxstringNoShow fulfillments last updated before date (ISO 8601 format)
Response Schema

Records​

Field NameTypeDescription
idinteger
order_idinteger | null
statusstring | null
created_atstring | null
servicestring | null
updated_atstring | null
tracking_companystring | null
shipment_statusstring | null
location_idinteger | null
origin_addressobject | null
line_itemsarray | null
line_items[].idinteger
line_items[].admin_graphql_api_idstring | null
line_items[].attributed_staffsarray | null
line_items[].current_quantityinteger | null
line_items[].fulfillable_quantityinteger | null
line_items[].fulfillment_servicestring | null
line_items[].fulfillment_statusstring | null
line_items[].gift_cardboolean | null
line_items[].gramsinteger | null
line_items[].namestring | null
line_items[].pricestring | null
line_items[].price_setobject | null
line_items[].product_existsboolean | null
line_items[].product_idinteger | null
line_items[].propertiesarray | null
line_items[].quantityinteger | null
line_items[].requires_shippingboolean | null
line_items[].skustring | null
line_items[].taxableboolean | null
line_items[].titlestring | null
line_items[].total_discountstring | null
line_items[].total_discount_setobject | null
line_items[].variant_idinteger | null
line_items[].variant_inventory_managementstring | null
line_items[].variant_titlestring | null
line_items[].vendorstring | null
line_items[].tax_linesarray | null
line_items[].dutiesarray | null
line_items[].discount_allocationsarray | null
tracking_numberstring | null
tracking_numbersarray | null
tracking_urlstring | null
tracking_urlsarray | null
receiptobject | null
namestring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Fulfillments Get​

Retrieves a single fulfillment by ID

Python SDK​

await shopify.fulfillments.get(
    order_id=0,
    fulfillment_id=0
)

API​

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": "fulfillments",
    "action": "get",
    "params": {
        "order_id": 0,
        "fulfillment_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
order_idintegerYesThe order ID
fulfillment_idintegerYesThe fulfillment ID
Response Schema

Records​

Field NameTypeDescription
idinteger
order_idinteger | null
statusstring | null
created_atstring | null
servicestring | null
updated_atstring | null
tracking_companystring | null
shipment_statusstring | null
location_idinteger | null
origin_addressobject | null
line_itemsarray | null
line_items[].idinteger
line_items[].admin_graphql_api_idstring | null
line_items[].attributed_staffsarray | null
line_items[].current_quantityinteger | null
line_items[].fulfillable_quantityinteger | null
line_items[].fulfillment_servicestring | null
line_items[].fulfillment_statusstring | null
line_items[].gift_cardboolean | null
line_items[].gramsinteger | null
line_items[].namestring | null
line_items[].pricestring | null
line_items[].price_setobject | null
line_items[].product_existsboolean | null
line_items[].product_idinteger | null
line_items[].propertiesarray | null
line_items[].quantityinteger | null
line_items[].requires_shippingboolean | null
line_items[].skustring | null
line_items[].taxableboolean | null
line_items[].titlestring | null
line_items[].total_discountstring | null
line_items[].total_discount_setobject | null
line_items[].variant_idinteger | null
line_items[].variant_inventory_managementstring | null
line_items[].variant_titlestring | null
line_items[].vendorstring | null
line_items[].tax_linesarray | null
line_items[].dutiesarray | null
line_items[].discount_allocationsarray | null
tracking_numberstring | null
tracking_numbersarray | null
tracking_urlstring | null
tracking_urlsarray | null
receiptobject | null
namestring | null
admin_graphql_api_idstring | null

Search and filter fulfillments records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.fulfillments.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "fulfillments",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the fulfillment
order_idintegerIdentifier of the parent order
statusstringFulfillment status (e.g. pending, open, success, cancelled)
shipment_statusstringCarrier shipment status (e.g. delivered, in_transit)
tracking_companystringName of the shipping carrier
tracking_numberstringPrimary tracking number for the shipment
location_idintegerIdentifier of the fulfilling location
created_atstringISO 8601 timestamp when the fulfillment was created
updated_atstringISO 8601 timestamp when the fulfillment was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the fulfillment
data[].order_idintegerIdentifier of the parent order
data[].statusstringFulfillment status (e.g. pending, open, success, cancelled)
data[].shipment_statusstringCarrier shipment status (e.g. delivered, in_transit)
data[].tracking_companystringName of the shipping carrier
data[].tracking_numberstringPrimary tracking number for the shipment
data[].location_idintegerIdentifier of the fulfilling location
data[].created_atstringISO 8601 timestamp when the fulfillment was created
data[].updated_atstringISO 8601 timestamp when the fulfillment was last updated

Order Refunds​

Order Refunds List​

Returns a list of refunds for an order

Python SDK​

await shopify.order_refunds.list(
    order_id=0
)

API​

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": "order_refunds",
    "action": "list",
    "params": {
        "order_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
order_idintegerYesThe order ID
limitintegerNoMaximum number of results to return (max 250)
Response Schema

Records​

Field NameTypeDescription
idinteger
order_idinteger | null
created_atstring | null
notestring | null
user_idinteger | null
processed_atstring | null
restockboolean | null
dutiesarray | null
total_duties_setobject | null
returnobject | null
refund_line_itemsarray | null
transactionsarray | null
transactions[].idinteger
transactions[].order_idinteger | null
transactions[].kindstring | null
transactions[].gatewaystring | null
transactions[].statusstring | null
transactions[].messagestring | null
transactions[].created_atstring | null
transactions[].testboolean | null
transactions[].authorizationstring | null
transactions[].location_idinteger | null
transactions[].user_idinteger | null
transactions[].parent_idinteger | null
transactions[].processed_atstring | null
transactions[].device_idinteger | null
transactions[].error_codestring | null
transactions[].source_namestring | null
transactions[].receiptobject | null
transactions[].currency_exchange_adjustmentobject | null
transactions[].amountstring | null
transactions[].currencystring | null
transactions[].payment_idstring | null
transactions[].total_unsettled_setobject | null
transactions[].manual_payment_gatewayboolean | null
transactions[].admin_graphql_api_idstring | null
order_adjustmentsarray | null
admin_graphql_api_idstring | null
refund_shipping_linesarray | null

Meta​

Field NameTypeDescription
next_page_urlstring

Order Refunds Get​

Retrieves a single refund by ID

Python SDK​

await shopify.order_refunds.get(
    order_id=0,
    refund_id=0
)

API​

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": "order_refunds",
    "action": "get",
    "params": {
        "order_id": 0,
        "refund_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
order_idintegerYesThe order ID
refund_idintegerYesThe refund ID
Response Schema

Records​

Field NameTypeDescription
idinteger
order_idinteger | null
created_atstring | null
notestring | null
user_idinteger | null
processed_atstring | null
restockboolean | null
dutiesarray | null
total_duties_setobject | null
returnobject | null
refund_line_itemsarray | null
transactionsarray | null
transactions[].idinteger
transactions[].order_idinteger | null
transactions[].kindstring | null
transactions[].gatewaystring | null
transactions[].statusstring | null
transactions[].messagestring | null
transactions[].created_atstring | null
transactions[].testboolean | null
transactions[].authorizationstring | null
transactions[].location_idinteger | null
transactions[].user_idinteger | null
transactions[].parent_idinteger | null
transactions[].processed_atstring | null
transactions[].device_idinteger | null
transactions[].error_codestring | null
transactions[].source_namestring | null
transactions[].receiptobject | null
transactions[].currency_exchange_adjustmentobject | null
transactions[].amountstring | null
transactions[].currencystring | null
transactions[].payment_idstring | null
transactions[].total_unsettled_setobject | null
transactions[].manual_payment_gatewayboolean | null
transactions[].admin_graphql_api_idstring | null
order_adjustmentsarray | null
admin_graphql_api_idstring | null
refund_shipping_linesarray | null

Search and filter order refunds records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.order_refunds.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "order_refunds",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the refund
order_idintegerIdentifier of the refunded order
user_idintegerIdentifier of the staff user who processed the refund
notestringMerchant-provided note explaining the refund
created_atstringISO 8601 timestamp when the refund was created
processed_atstringISO 8601 timestamp when the refund was processed
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the refund
data[].order_idintegerIdentifier of the refunded order
data[].user_idintegerIdentifier of the staff user who processed the refund
data[].notestringMerchant-provided note explaining the refund
data[].created_atstringISO 8601 timestamp when the refund was created
data[].processed_atstringISO 8601 timestamp when the refund was processed

Transactions​

Transactions List​

Returns a list of transactions for an order

Python SDK​

await shopify.transactions.list(
    order_id=0
)

API​

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": "transactions",
    "action": "list",
    "params": {
        "order_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
order_idintegerYesThe order ID
since_idintegerNoRestrict results to after the specified ID
Response Schema

Records​

Field NameTypeDescription
idinteger
order_idinteger | null
kindstring | null
gatewaystring | null
statusstring | null
messagestring | null
created_atstring | null
testboolean | null
authorizationstring | null
location_idinteger | null
user_idinteger | null
parent_idinteger | null
processed_atstring | null
device_idinteger | null
error_codestring | null
source_namestring | null
receiptobject | null
currency_exchange_adjustmentobject | null
amountstring | null
currencystring | null
payment_idstring | null
total_unsettled_setobject | null
manual_payment_gatewayboolean | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Transactions Get​

Retrieves a single transaction by ID

Python SDK​

await shopify.transactions.get(
    order_id=0,
    transaction_id=0
)

API​

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": "transactions",
    "action": "get",
    "params": {
        "order_id": 0,
        "transaction_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
order_idintegerYesThe order ID
transaction_idintegerYesThe transaction ID
Response Schema

Records​

Field NameTypeDescription
idinteger
order_idinteger | null
kindstring | null
gatewaystring | null
statusstring | null
messagestring | null
created_atstring | null
testboolean | null
authorizationstring | null
location_idinteger | null
user_idinteger | null
parent_idinteger | null
processed_atstring | null
device_idinteger | null
error_codestring | null
source_namestring | null
receiptobject | null
currency_exchange_adjustmentobject | null
amountstring | null
currencystring | null
payment_idstring | null
total_unsettled_setobject | null
manual_payment_gatewayboolean | null
admin_graphql_api_idstring | null

Tender Transactions​

Tender Transactions List​

Returns a list of tender transactions

Python SDK​

await shopify.tender_transactions.list()

API​

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": "tender_transactions",
    "action": "list"
}'

Parameters​

Parameter NameTypeRequiredDescription
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
processed_at_minstringNoShow tender transactions processed after date (ISO 8601 format)
processed_at_maxstringNoShow tender transactions processed before date (ISO 8601 format)
order"processed_at ASC" | "processed_at DESC"NoOrder of results
Response Schema

Records​

Field NameTypeDescription
idinteger
order_idinteger | null
amountstring | null
currencystring | null
user_idinteger | null
testboolean | null
processed_atstring | null
remote_referencestring | null
payment_detailsobject | null
payment_methodstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Search and filter tender transactions records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.tender_transactions.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "tender_transactions",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the tender transaction
order_idintegerIdentifier of the order the transaction belongs to
user_idintegerIdentifier of the staff user who processed the transaction
amountstringAmount of the transaction in the shop's currency
currencystringISO 4217 currency code for the transaction amount
payment_methodstringPayment method used (e.g. credit_card, paypal)
testbooleanWhether the transaction was a test transaction
processed_atstringISO 8601 timestamp when the transaction was processed
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the tender transaction
data[].order_idintegerIdentifier of the order the transaction belongs to
data[].user_idintegerIdentifier of the staff user who processed the transaction
data[].amountstringAmount of the transaction in the shop's currency
data[].currencystringISO 4217 currency code for the transaction amount
data[].payment_methodstringPayment method used (e.g. credit_card, paypal)
data[].testbooleanWhether the transaction was a test transaction
data[].processed_atstringISO 8601 timestamp when the transaction was processed

Countries​

Countries List​

Returns a list of countries

Python SDK​

await shopify.countries.list()

API​

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": "countries",
    "action": "list"
}'

Parameters​

Parameter NameTypeRequiredDescription
since_idintegerNoRestrict results to after the specified ID
Response Schema

Records​

Field NameTypeDescription
idinteger
namestring | null
codestring | null
tax_namestring | null
taxnumber | null
provincesarray | null

Meta​

Field NameTypeDescription
next_page_urlstring

Countries Get​

Retrieves a single country by ID

Python SDK​

await shopify.countries.get(
    country_id=0
)

API​

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": "countries",
    "action": "get",
    "params": {
        "country_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
country_idintegerYesThe country ID
Response Schema

Records​

Field NameTypeDescription
idinteger
namestring | null
codestring | null
tax_namestring | null
taxnumber | null
provincesarray | null

Search and filter countries records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.countries.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "countries",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the country tax row
namestringHuman-readable country name
codestringISO 3166-1 alpha-2 country code
tax_namestringLocalized name of the tax applied in this country
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the country tax row
data[].namestringHuman-readable country name
data[].codestringISO 3166-1 alpha-2 country code
data[].tax_namestringLocalized name of the tax applied in this country

Metafield Shops​

Metafield Shops List​

Returns a list of metafields for the shop

Python SDK​

await shopify.metafield_shops.list()

API​

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": "metafield_shops",
    "action": "list"
}'

Parameters​

Parameter NameTypeRequiredDescription
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
namespacestringNoFilter by namespace
keystringNoFilter by key
typestringNoFilter by type
Response Schema

Records​

Field NameTypeDescription
idinteger
namespacestring | null
keystring | null
valuestring | integer | boolean | null
typestring | null
descriptionstring | null
owner_idinteger | null
created_atstring | null
updated_atstring | null
owner_resourcestring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Metafield Shops Get​

Retrieves a single metafield by ID

Python SDK​

await shopify.metafield_shops.get(
    metafield_id=0
)

API​

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": "metafield_shops",
    "action": "get",
    "params": {
        "metafield_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
metafield_idintegerYesThe metafield ID
Response Schema

Records​

Field NameTypeDescription
idinteger
namespacestring | null
keystring | null
valuestring | integer | boolean | null
typestring | null
descriptionstring | null
owner_idinteger | null
created_atstring | null
updated_atstring | null
owner_resourcestring | null
admin_graphql_api_idstring | null

Search and filter metafield shops records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.metafield_shops.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "metafield_shops",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the metafield
namespacestringNamespace group for the metafield
keystringKey of the metafield within its namespace
valuestringSerialized value stored in the metafield
typestringShopify metafield type (e.g. single_line_text_field, json)
descriptionstringHuman-readable description of the metafield
owner_idintegerIdentifier of the resource that owns this metafield
owner_resourcestringResource type that owns this metafield (e.g. product, customer)
created_atstringISO 8601 timestamp when the metafield was created
updated_atstringISO 8601 timestamp when the metafield was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the metafield
data[].namespacestringNamespace group for the metafield
data[].keystringKey of the metafield within its namespace
data[].valuestringSerialized value stored in the metafield
data[].typestringShopify metafield type (e.g. single_line_text_field, json)
data[].descriptionstringHuman-readable description of the metafield
data[].owner_idintegerIdentifier of the resource that owns this metafield
data[].owner_resourcestringResource type that owns this metafield (e.g. product, customer)
data[].created_atstringISO 8601 timestamp when the metafield was created
data[].updated_atstringISO 8601 timestamp when the metafield was last updated

Metafield Customers​

Metafield Customers List​

Returns a list of metafields for a customer

Python SDK​

await shopify.metafield_customers.list(
    customer_id=0
)

API​

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": "metafield_customers",
    "action": "list",
    "params": {
        "customer_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
customer_idintegerYesThe customer ID
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
namespacestringNoFilter by namespace
keystringNoFilter by key
Response Schema

Records​

Field NameTypeDescription
idinteger
namespacestring | null
keystring | null
valuestring | integer | boolean | null
typestring | null
descriptionstring | null
owner_idinteger | null
created_atstring | null
updated_atstring | null
owner_resourcestring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Search and filter metafield customers records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.metafield_customers.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "metafield_customers",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the metafield
namespacestringNamespace group for the metafield
keystringKey of the metafield within its namespace
valuestringSerialized value stored in the metafield
typestringShopify metafield type (e.g. single_line_text_field, json)
descriptionstringHuman-readable description of the metafield
owner_idintegerIdentifier of the resource that owns this metafield
owner_resourcestringResource type that owns this metafield (e.g. product, customer)
created_atstringISO 8601 timestamp when the metafield was created
updated_atstringISO 8601 timestamp when the metafield was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the metafield
data[].namespacestringNamespace group for the metafield
data[].keystringKey of the metafield within its namespace
data[].valuestringSerialized value stored in the metafield
data[].typestringShopify metafield type (e.g. single_line_text_field, json)
data[].descriptionstringHuman-readable description of the metafield
data[].owner_idintegerIdentifier of the resource that owns this metafield
data[].owner_resourcestringResource type that owns this metafield (e.g. product, customer)
data[].created_atstringISO 8601 timestamp when the metafield was created
data[].updated_atstringISO 8601 timestamp when the metafield was last updated

Metafield Products​

Metafield Products List​

Returns a list of metafields for a product

Python SDK​

await shopify.metafield_products.list(
    product_id=0
)

API​

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": "metafield_products",
    "action": "list",
    "params": {
        "product_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
product_idintegerYesThe product ID
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
namespacestringNoFilter by namespace
keystringNoFilter by key
Response Schema

Records​

Field NameTypeDescription
idinteger
namespacestring | null
keystring | null
valuestring | integer | boolean | null
typestring | null
descriptionstring | null
owner_idinteger | null
created_atstring | null
updated_atstring | null
owner_resourcestring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Search and filter metafield products records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.metafield_products.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "metafield_products",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the metafield
namespacestringNamespace group for the metafield
keystringKey of the metafield within its namespace
valuestringSerialized value stored in the metafield
typestringShopify metafield type (e.g. single_line_text_field, json)
descriptionstringHuman-readable description of the metafield
owner_idintegerIdentifier of the resource that owns this metafield
owner_resourcestringResource type that owns this metafield (e.g. product, customer)
created_atstringISO 8601 timestamp when the metafield was created
updated_atstringISO 8601 timestamp when the metafield was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the metafield
data[].namespacestringNamespace group for the metafield
data[].keystringKey of the metafield within its namespace
data[].valuestringSerialized value stored in the metafield
data[].typestringShopify metafield type (e.g. single_line_text_field, json)
data[].descriptionstringHuman-readable description of the metafield
data[].owner_idintegerIdentifier of the resource that owns this metafield
data[].owner_resourcestringResource type that owns this metafield (e.g. product, customer)
data[].created_atstringISO 8601 timestamp when the metafield was created
data[].updated_atstringISO 8601 timestamp when the metafield was last updated

Metafield Orders​

Metafield Orders List​

Returns a list of metafields for an order

Python SDK​

await shopify.metafield_orders.list(
    order_id=0
)

API​

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": "metafield_orders",
    "action": "list",
    "params": {
        "order_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
order_idintegerYesThe order ID
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
namespacestringNoFilter by namespace
keystringNoFilter by key
Response Schema

Records​

Field NameTypeDescription
idinteger
namespacestring | null
keystring | null
valuestring | integer | boolean | null
typestring | null
descriptionstring | null
owner_idinteger | null
created_atstring | null
updated_atstring | null
owner_resourcestring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Search and filter metafield orders records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.metafield_orders.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "metafield_orders",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the metafield
namespacestringNamespace group for the metafield
keystringKey of the metafield within its namespace
valuestringSerialized value stored in the metafield
typestringShopify metafield type (e.g. single_line_text_field, json)
descriptionstringHuman-readable description of the metafield
owner_idintegerIdentifier of the resource that owns this metafield
owner_resourcestringResource type that owns this metafield (e.g. product, customer)
created_atstringISO 8601 timestamp when the metafield was created
updated_atstringISO 8601 timestamp when the metafield was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the metafield
data[].namespacestringNamespace group for the metafield
data[].keystringKey of the metafield within its namespace
data[].valuestringSerialized value stored in the metafield
data[].typestringShopify metafield type (e.g. single_line_text_field, json)
data[].descriptionstringHuman-readable description of the metafield
data[].owner_idintegerIdentifier of the resource that owns this metafield
data[].owner_resourcestringResource type that owns this metafield (e.g. product, customer)
data[].created_atstringISO 8601 timestamp when the metafield was created
data[].updated_atstringISO 8601 timestamp when the metafield was last updated

Metafield Draft Orders​

Metafield Draft Orders List​

Returns a list of metafields for a draft order

Python SDK​

await shopify.metafield_draft_orders.list(
    draft_order_id=0
)

API​

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": "metafield_draft_orders",
    "action": "list",
    "params": {
        "draft_order_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
draft_order_idintegerYesThe draft order ID
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
namespacestringNoFilter by namespace
keystringNoFilter by key
Response Schema

Records​

Field NameTypeDescription
idinteger
namespacestring | null
keystring | null
valuestring | integer | boolean | null
typestring | null
descriptionstring | null
owner_idinteger | null
created_atstring | null
updated_atstring | null
owner_resourcestring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Search and filter metafield draft orders records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.metafield_draft_orders.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "metafield_draft_orders",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the metafield
namespacestringNamespace group for the metafield
keystringKey of the metafield within its namespace
valuestringSerialized value stored in the metafield
typestringShopify metafield type (e.g. single_line_text_field, json)
descriptionstringHuman-readable description of the metafield
owner_idintegerIdentifier of the resource that owns this metafield
owner_resourcestringResource type that owns this metafield (e.g. product, customer)
created_atstringISO 8601 timestamp when the metafield was created
updated_atstringISO 8601 timestamp when the metafield was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the metafield
data[].namespacestringNamespace group for the metafield
data[].keystringKey of the metafield within its namespace
data[].valuestringSerialized value stored in the metafield
data[].typestringShopify metafield type (e.g. single_line_text_field, json)
data[].descriptionstringHuman-readable description of the metafield
data[].owner_idintegerIdentifier of the resource that owns this metafield
data[].owner_resourcestringResource type that owns this metafield (e.g. product, customer)
data[].created_atstringISO 8601 timestamp when the metafield was created
data[].updated_atstringISO 8601 timestamp when the metafield was last updated

Metafield Locations​

Metafield Locations List​

Returns a list of metafields for a location

Python SDK​

await shopify.metafield_locations.list(
    location_id=0
)

API​

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": "metafield_locations",
    "action": "list",
    "params": {
        "location_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
location_idintegerYesThe location ID
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
namespacestringNoFilter by namespace
keystringNoFilter by key
Response Schema

Records​

Field NameTypeDescription
idinteger
namespacestring | null
keystring | null
valuestring | integer | boolean | null
typestring | null
descriptionstring | null
owner_idinteger | null
created_atstring | null
updated_atstring | null
owner_resourcestring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Search and filter metafield locations records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.metafield_locations.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "metafield_locations",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the metafield
namespacestringNamespace group for the metafield
keystringKey of the metafield within its namespace
valuestringSerialized value stored in the metafield
typestringShopify metafield type (e.g. single_line_text_field, json)
descriptionstringHuman-readable description of the metafield
owner_idintegerIdentifier of the resource that owns this metafield
owner_resourcestringResource type that owns this metafield (e.g. product, customer)
created_atstringISO 8601 timestamp when the metafield was created
updated_atstringISO 8601 timestamp when the metafield was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the metafield
data[].namespacestringNamespace group for the metafield
data[].keystringKey of the metafield within its namespace
data[].valuestringSerialized value stored in the metafield
data[].typestringShopify metafield type (e.g. single_line_text_field, json)
data[].descriptionstringHuman-readable description of the metafield
data[].owner_idintegerIdentifier of the resource that owns this metafield
data[].owner_resourcestringResource type that owns this metafield (e.g. product, customer)
data[].created_atstringISO 8601 timestamp when the metafield was created
data[].updated_atstringISO 8601 timestamp when the metafield was last updated

Metafield Product Variants​

Metafield Product Variants List​

Returns a list of metafields for a product variant

Python SDK​

await shopify.metafield_product_variants.list(
    variant_id=0
)

API​

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": "metafield_product_variants",
    "action": "list",
    "params": {
        "variant_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
variant_idintegerYesThe variant ID
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
namespacestringNoFilter by namespace
keystringNoFilter by key
Response Schema

Records​

Field NameTypeDescription
idinteger
namespacestring | null
keystring | null
valuestring | integer | boolean | null
typestring | null
descriptionstring | null
owner_idinteger | null
created_atstring | null
updated_atstring | null
owner_resourcestring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Search and filter metafield product variants records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.metafield_product_variants.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "metafield_product_variants",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the metafield
namespacestringNamespace group for the metafield
keystringKey of the metafield within its namespace
valuestringSerialized value stored in the metafield
typestringShopify metafield type (e.g. single_line_text_field, json)
descriptionstringHuman-readable description of the metafield
owner_idintegerIdentifier of the resource that owns this metafield
owner_resourcestringResource type that owns this metafield (e.g. product, customer)
created_atstringISO 8601 timestamp when the metafield was created
updated_atstringISO 8601 timestamp when the metafield was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the metafield
data[].namespacestringNamespace group for the metafield
data[].keystringKey of the metafield within its namespace
data[].valuestringSerialized value stored in the metafield
data[].typestringShopify metafield type (e.g. single_line_text_field, json)
data[].descriptionstringHuman-readable description of the metafield
data[].owner_idintegerIdentifier of the resource that owns this metafield
data[].owner_resourcestringResource type that owns this metafield (e.g. product, customer)
data[].created_atstringISO 8601 timestamp when the metafield was created
data[].updated_atstringISO 8601 timestamp when the metafield was last updated

Metafield Smart Collections​

Metafield Smart Collections List​

Returns a list of metafields for a smart collection

Python SDK​

await shopify.metafield_smart_collections.list(
    collection_id=0
)

API​

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": "metafield_smart_collections",
    "action": "list",
    "params": {
        "collection_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
collection_idintegerYesThe collection ID
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
namespacestringNoFilter by namespace
keystringNoFilter by key
Response Schema

Records​

Field NameTypeDescription
idinteger
namespacestring | null
keystring | null
valuestring | integer | boolean | null
typestring | null
descriptionstring | null
owner_idinteger | null
created_atstring | null
updated_atstring | null
owner_resourcestring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Search and filter metafield smart collections records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.metafield_smart_collections.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "metafield_smart_collections",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the metafield
namespacestringNamespace group for the metafield
keystringKey of the metafield within its namespace
valuestringSerialized value stored in the metafield
typestringShopify metafield type (e.g. single_line_text_field, json)
descriptionstringHuman-readable description of the metafield
owner_idintegerIdentifier of the resource that owns this metafield
owner_resourcestringResource type that owns this metafield (e.g. product, customer)
created_atstringISO 8601 timestamp when the metafield was created
updated_atstringISO 8601 timestamp when the metafield was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the metafield
data[].namespacestringNamespace group for the metafield
data[].keystringKey of the metafield within its namespace
data[].valuestringSerialized value stored in the metafield
data[].typestringShopify metafield type (e.g. single_line_text_field, json)
data[].descriptionstringHuman-readable description of the metafield
data[].owner_idintegerIdentifier of the resource that owns this metafield
data[].owner_resourcestringResource type that owns this metafield (e.g. product, customer)
data[].created_atstringISO 8601 timestamp when the metafield was created
data[].updated_atstringISO 8601 timestamp when the metafield was last updated

Metafield Product Images​

Metafield Product Images List​

Returns a list of metafields for a product image

Python SDK​

await shopify.metafield_product_images.list(
    product_id=0,
    image_id=0
)

API​

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": "metafield_product_images",
    "action": "list",
    "params": {
        "product_id": 0,
        "image_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
product_idintegerYesThe product ID
image_idintegerYesThe image ID
limitintegerNoMaximum number of results to return (max 250)
since_idintegerNoRestrict results to after the specified ID
namespacestringNoFilter by namespace
keystringNoFilter by key
Response Schema

Records​

Field NameTypeDescription
idinteger
namespacestring | null
keystring | null
valuestring | integer | boolean | null
typestring | null
descriptionstring | null
owner_idinteger | null
created_atstring | null
updated_atstring | null
owner_resourcestring | null
admin_graphql_api_idstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Search and filter metafield product images records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.metafield_product_images.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "metafield_product_images",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the metafield
namespacestringNamespace group for the metafield
keystringKey of the metafield within its namespace
valuestringSerialized value stored in the metafield
typestringShopify metafield type (e.g. single_line_text_field, json)
descriptionstringHuman-readable description of the metafield
owner_idintegerIdentifier of the resource that owns this metafield
owner_resourcestringResource type that owns this metafield (e.g. product, customer)
created_atstringISO 8601 timestamp when the metafield was created
updated_atstringISO 8601 timestamp when the metafield was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the metafield
data[].namespacestringNamespace group for the metafield
data[].keystringKey of the metafield within its namespace
data[].valuestringSerialized value stored in the metafield
data[].typestringShopify metafield type (e.g. single_line_text_field, json)
data[].descriptionstringHuman-readable description of the metafield
data[].owner_idintegerIdentifier of the resource that owns this metafield
data[].owner_resourcestringResource type that owns this metafield (e.g. product, customer)
data[].created_atstringISO 8601 timestamp when the metafield was created
data[].updated_atstringISO 8601 timestamp when the metafield was last updated

Customer Address​

Customer Address List​

Returns a list of addresses for a customer

Python SDK​

await shopify.customer_address.list(
    customer_id=0
)

API​

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": "customer_address",
    "action": "list",
    "params": {
        "customer_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
customer_idintegerYesThe customer ID
limitintegerNoMaximum number of results to return (max 250)
Response Schema

Records​

Field NameTypeDescription
idinteger
customer_idinteger | null
first_namestring | null
last_namestring | null
companystring | null
address1string | null
address2string | null
citystring | null
provincestring | null
countrystring | null
zipstring | null
phonestring | null
namestring | null
province_codestring | null
country_codestring | null
country_namestring | null
defaultboolean | null

Meta​

Field NameTypeDescription
next_page_urlstring

Customer Address Get​

Retrieves a single customer address by ID

Python SDK​

await shopify.customer_address.get(
    customer_id=0,
    address_id=0
)

API​

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": "customer_address",
    "action": "get",
    "params": {
        "customer_id": 0,
        "address_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
customer_idintegerYesThe customer ID
address_idintegerYesThe address ID
Response Schema

Records​

Field NameTypeDescription
idinteger
customer_idinteger | null
first_namestring | null
last_namestring | null
companystring | null
address1string | null
address2string | null
citystring | null
provincestring | null
countrystring | null
zipstring | null
phonestring | null
namestring | null
province_codestring | null
country_codestring | null
country_namestring | null
defaultboolean | null

Fulfillment Orders​

Fulfillment Orders List​

Returns a list of fulfillment orders for a specific order

Python SDK​

await shopify.fulfillment_orders.list(
    order_id=0
)

API​

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": "fulfillment_orders",
    "action": "list",
    "params": {
        "order_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
order_idintegerYesThe order ID
Response Schema

Records​

Field NameTypeDescription
idinteger
shop_idinteger | null
order_idinteger | null
assigned_location_idinteger | null
request_statusstring | null
statusstring | null
supported_actionsarray | null
destinationobject | null
line_itemsarray | null
fulfill_atstring | null
fulfill_bystring | null
international_dutiesobject | null
fulfillment_holdsarray | null
delivery_methodobject | null
assigned_locationobject | null
merchant_requestsarray | null
created_atstring | null
updated_atstring | null

Meta​

Field NameTypeDescription
next_page_urlstring

Fulfillment Orders Get​

Retrieves a single fulfillment order by ID

Python SDK​

await shopify.fulfillment_orders.get(
    fulfillment_order_id=0
)

API​

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": "fulfillment_orders",
    "action": "get",
    "params": {
        "fulfillment_order_id": 0
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
fulfillment_order_idintegerYesThe fulfillment order ID
Response Schema

Records​

Field NameTypeDescription
idinteger
shop_idinteger | null
order_idinteger | null
assigned_location_idinteger | null
request_statusstring | null
statusstring | null
supported_actionsarray | null
destinationobject | null
line_itemsarray | null
fulfill_atstring | null
fulfill_bystring | null
international_dutiesobject | null
fulfillment_holdsarray | null
delivery_methodobject | null
assigned_locationobject | null
merchant_requestsarray | null
created_atstring | null
updated_atstring | null

Search and filter fulfillment orders records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK​

await shopify.fulfillment_orders.context_store_search(
    query={"filter": {"eq": {"id": 0}}}
)

API​

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": "fulfillment_orders",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": 0}}}
    }
}'

Parameters​

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields​

Field NameTypeDescription
idintegerUnique identifier for the fulfillment order
order_idintegerIdentifier of the parent order
shop_idintegerIdentifier of the shop that owns the fulfillment order
assigned_location_idintegerIdentifier of the location assigned to fulfill the order
statusstringFulfillment order status (e.g. open, in_progress, closed)
request_statusstringStatus of the fulfillment request (e.g. unsubmitted, submitted)
created_atstringISO 8601 timestamp when the fulfillment order was created
updated_atstringISO 8601 timestamp when the fulfillment order was last updated
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique identifier for the fulfillment order
data[].order_idintegerIdentifier of the parent order
data[].shop_idintegerIdentifier of the shop that owns the fulfillment order
data[].assigned_location_idintegerIdentifier of the location assigned to fulfill the order
data[].statusstringFulfillment order status (e.g. open, in_progress, closed)
data[].request_statusstringStatus of the fulfillment request (e.g. unsubmitted, submitted)
data[].created_atstringISO 8601 timestamp when the fulfillment order was created
data[].updated_atstringISO 8601 timestamp when the fulfillment order was last updated
Was this page helpful?