Function Reference

Shopify PHP API Wrapper - Function Reference

• application-charge
• article
• asset
• auth
• blog
• carrier-service
• checkout
• collect
• comment
• country
• custom-collection
• customer-address
• customer-group
• customer-saved-search
• customer
• event
• fulfillment-service
• fulfillment
• location
• metafield
• order-risk
• order
• page
• product-image
• product-variant
• product
• province
• recurring-application-charge
• redirect
• refund
• script-tag
• service-config
• shop
• smart-collection
• theme
• transaction
• user
• webhook

application-charge

getApplicationCharges()

All charges that have been requested are retrieved by this request.

• since_id (number)  Restrict results to after the specified ID.
• fields (string)  Comma-separated list of fields to include in the response.

### [getApplicationCharge()](#getApplicationCharge) Retrive a single application charge.

• *id (number)  A unique numeric identifier for the application charge.
• fields (string)  Comma-separated list of fields to include in the response.

### [createApplicationCharge()](#createApplicationCharge) Create a new one-time application charge.

• application_charge
  • name (string)  The name of the one-time application charge.
  • price (string)  The price of the the one-time application charge.
  • return_url (string)  The URL the customer is sent to once they accept/decline a charge.
  • test (boolean)  States whether or not the application charge is a test transaction. Valid values are "true" or "null".

### [activeApplicationCharge()](#activeApplicationCharge) Activate a previously accepted one-time application charge.

• *id (number)  A unique numeric identifier for the one-time application charge.
• api_client_id (number)  
• created_at (string)  The date and time when the one-time application charge was created. The API returns this value in ISO 8601 format.
• price (string)  The price of the the one-time application charge.
• return_url (string)  The URL the customer is sent to once they accept/decline a charge.
• status (string)  The status of the application charge. Valid values are: pending: The application charge is pernding. accepted: The application charge has been accepted. declined: The application charge has been declined.
• test (string)  States whether or not the application charge is a test transaction. Valid values are "true" or "null".
• updated_at (string)  The date and time when the charge was last updated. The API returns this value in ISO 8601 format.
• charge_type (string)  
• decorated_return_url (string)  

### [getArticle()](#getArticle) Get a single article by its ID and the ID of the parent blog.

• *blog_id (number)  The ID of the Blog.
• *article_id (number)  The ID of the Article.
• fields (string)  comma-separated list of fields to include in the response.

### [createArticle()](#createArticle) Create a new article for a blog

• *blog_id (number)  A unique numeric identifier for the blog containing the article.
• article
  • author (string)  The name of the author of this article.
  • title (string)  The title of the article.
  • tags (string)  Tags are additional short descriptors formatted as a string of comma-separated values. For example, if an article has three tags: tag1, tag2, tag3.
  • summary_html (string)  The text of the summary of the article, complete with HTML markup.
  • body_html (string)  The text of the body of the article, complete with HTML markup.
  • template_suffix (string)  States the name of the template an article is using if it is using an alternate template. If an article is using the default article.liquid template, the value returned is "null".
  • published (boolean)  States whether or not the article is visible. Valid values are "true" for published or "false" for hidden.
  • published_at (string)  The date and time when the article was published. The API returns this value in ISO 8601 format.
  • user_id (number)  A unique numeric identifier for the author of the article.

article

getArticles()

Get a list of all articles from a certain blog.

• *blog_id (number)  The ID of the Blog.
• limit (number)  Amount of results (default: 50)(maximum: 250).
• page (number)  Page to show (default: 1).
• since_id (number)  Restrict results to after the specified ID.
• created_at_min (string)  Show articles created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Show articles created before date (format: 2008-12-31 03:00).
• updated_at_min (string)  Show articles last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Show articles last updated before date (format: 2008-12-31 03:00).
• published_at_min (string)  Show articles published after date (format: 2008-12-31 03:00).
• published_at_max (string)  Show articles published before date (format: 2008-12-31 03:00).
• published_status (string)  published - Show only published articles. unpublished - Show only unpublished articles. any - Show all articles (default).
• fields (string)  comma-separated list of fields to include in the response.

### [getArticlesCount()](#getArticlesCount) Get a count of all articles from a certain blog.

• *blog_id (number)  The ID of the Blog.
• created_at_min (string)  Count articles created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Count articles created before date (format: 2008-12-31 03:00).
• updated_at_min (string)  Count articles last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Count articles last updated before date (format: 2008-12-31 03:00).
• published_at_min (string)  Count articles published after date (format: 2008-12-31 03:00).
• published_at_max (string)  Count articles published before date (format: 2008-12-31 03:00).
• published_status (string)  published - Count only published articles. unpublished - Count only unpublished articles. any - Count all articles (default).

### [getArticle()](#getArticle) Get a single article by its ID and the ID of the parent blog.

• *blog_id (number)  The ID of the Blog.
• *article_id (number)  The ID of the Article.
• fields (string)  comma-separated list of fields to include in the response.

### [createArticle()](#createArticle) Create a new article for a blog

• *blog_id (number)  A unique numeric identifier for the blog containing the article.
• article
  • author (string)  The name of the author of this article.
  • title (string)  The title of the article.
  • tags (string)  Tags are additional short descriptors formatted as a string of comma-separated values. For example, if an article has three tags: tag1, tag2, tag3.
  • summary_html (string)  The text of the summary of the article, complete with HTML markup.
  • body_html (string)  The text of the body of the article, complete with HTML markup.
  • template_suffix (string)  States the name of the template an article is using if it is using an alternate template. If an article is using the default article.liquid template, the value returned is "null".
  • published (boolean)  States whether or not the article is visible. Valid values are "true" for published or "false" for hidden.
  • published_at (string)  The date and time when the article was published. The API returns this value in ISO 8601 format.
  • user_id (number)  A unique numeric identifier for the author of the article.

### [updateArticle()](#updateArticle) Create a new article for a blog.

• *blog_id (number)  A unique numeric identifier for the blog containing the article.
• *article_id (number)  A unique numeric identifier for the article you are updating.
• article
  • id (number)  A unique numeric identifier for the article you are updating.
  • author (string)  The name of the author of this article.
  • title (string)  The title of the article.
  • tags (string)  Tags are additional short descriptors formatted as a string of comma-separated values. For example, if an article has three tags: tag1, tag2, tag3.
  • summary_html (string)  The text of the summary of the article, complete with HTML markup.
  • body_html (string)  The text of the body of the article, complete with HTML markup.
  • template_suffix (string)  States the name of the template an article is using if it is using an alternate template. If an article is using the default article.liquid template, the value returned is "null".
  • published (boolean)  States whether or not the article is visible. Valid values are "true" for published or "false" for hidden.
  • published_at (string)  The date and time when the article was published. The API returns this value in ISO 8601 format.
  • user_id (number)  A unique numeric identifier for the author of the article.

### [getAuthors()](#getAuthors) Get a list of all the authors of articles.
### [getTags()](#getTags) Get a list of all the tags of articles.

• popular (boolean)  A flag to indicate only to a certain number of the most popular tags.
• limit (number)  The number of tags to return.

### [getBlogTags()](#getBlogTags) Get a list of all tags from a specific blog.

• *blog_id (number)  Unique numeric identifier for the blog.
• popular (boolean)  A flag to indicate only to a certain number of the most popular tags.
• limit (number)  The number of tags to return.

### [deleteArticle()](#deleteArticle) Delete an article of a blog.

• *blog_id (number)  Unique numeric identifier for the blog.
• *article_id (number)  Unique numeric identifier for the article.

asset

getAssets()

Listing theme assets only returns metadata about each asset. You need to request assets individually in order to get their contents.

• *id (number)  
• fields (string)  Comma-separated list of fields to include in the response.

### [getAssetTemplate()](#getAssetTemplate) Get an asset.

• *id (number)  The ID of the theme.
• asset[key] (string)  

### [updateAsset()](#updateAsset) PUT takes care of both creating new assets and updating existing ones.

• *id (number)  A unique numeric identifier for the asset.
• asset
  • key (string)  The path to the asset within a shop. For example, the asset bg-body-green.gif is located in the assets folder.
  • value (string)  The asset that you are adding.
  • src (string)  Specifies the location of an asset.
  • attachment (string)  An asset attached to a store's theme.
  • source_key (string)  The source key copies an asset.

### [deleteAsset()](#deleteAsset) Delete assets from your shop.

• *id (number)  The ID of the theme.
• asset[key] (number)  

auth

postAuth()

Retrieve Access Token

• client_id (string)  The API Key for the app.
• client_secret (string)  The Shared Secret for the app.
• code (string)  The authorization code provided in the redirect.

blog

getBlogs()

Retrieve a list of all Blogs

• since_id (number)  Restrict results to after the specified ID.
• handle (string)  Filter by Blog handle.
• fields (string)  Comma-separated list of fields to include in the response.

### [getBlogCount()](#getBlogCount) Retrieve a count of all Blogs
### [getBlog()](#getBlog) Retrieve a single Blog

• *id (string)  The ID of the Blog.
• fields (string)  Comma-separated list of fields to include in the response.

### [createBlog()](#createBlog) Create a new blog

• blog
  • title (string)  The ID of the Blog.
  • commentable (string)  Indicates whether readers can post comments to the blog and if comments are moderated or not. Possible values are: no (default): Readers cannot post comments to blog articles. moderate: Readers can post comments to blog articles, but comments must be moderated before they appear. yes: Readers can post comments to blog articles without moderation.
  • feedburner_location (string)  URL to the feedburner location for blogs that have enabled feedburner through their store admin.
  • handle (string)  A human-friendly unique string for a blog automatically generated from its title. This handle is used by the Liquid templating language to refer to the blog.
  • tags (string)  Tags are additional short descriptors formatted as a string of comma-separated values. For example, if an article has three tags: tag1, tag2, tag3.
  • template_suffix (string)  States the name of the template a blog is using if it is using an alternate template. If a blog is using the default blog.liquid template, the value returned is "null".

### [updateBlog()](#updateBlog) Update a blog

• *id (number)  The ID of the Blog.
• blog
  • id (number)  The ID of the Blog.
  • title (string)  The ID of the Blog.
  • commentable (string)  Indicates whether readers can post comments to the blog and if comments are moderated or not. Possible values are: no (default): Readers cannot post comments to blog articles. moderate: Readers can post comments to blog articles, but comments must be moderated before they appear. yes: Readers can post comments to blog articles without moderation.
  • feedburner_location (string)  URL to the feedburner location for blogs that have enabled feedburner through their store admin.
  • handle (string)  A human-friendly unique string for a blog automatically generated from its title. This handle is used by the Liquid templating language to refer to the blog.
  • tags (string)  Tags are additional short descriptors formatted as a string of comma-separated values. For example, if an article has three tags: tag1, tag2, tag3.
  • template_suffix (string)  States the name of the template a blog is using if it is using an alternate template. If a blog is using the default blog.liquid template, the value returned is "null".

### [deleteBlog()](#deleteBlog) Delete a blog.

• *id (number)  Unique numeric identifier for the blog.

carrier-service

getCarrierServices()

Retrieve a list of all Carrier Services

### [getCarrierService()](#getCarrierService) Retrieve a single Carrier Service

• *id (string)  The ID of the Carrier Service.

### [createCarrierService()](#createCarrierService) Create a Carrier Service.

• carrier_service
  • name (string)  The name of the shipping service as seen by merchants and their customers.
  • callback_url (string)  States the URL endpoint that shopify needs to retrieve shipping rates. This must be a public URL.
  • format (string)  Default: json.
  • service_discovery (boolean)  States if merchants are able to send dummy data to your service through the Shopify admin to see shipping rate examples. Valid values are true and false.
  • carrier_service_type (string)  Distinguishes between api or legacy carrier services.
  • active (boolean)  

### [updateCarrierService()](#updateCarrierService) Update a Carrier Service.

• *id (number)  he ID number of the carrier service.
• carrier_service
  • id (number)  The ID number of the carrier service.
  • name (string)  The name of the shipping service as seen by merchants and their customers.
  • callback_url (string)  States the URL endpoint that shopify needs to retrieve shipping rates. This must be a public URL.
  • format (string)  Default: json.
  • service_discovery (boolean)  States if merchants are able to send dummy data to your service through the Shopify admin to see shipping rate examples. Valid values are true and false.
  • carrier_service_type (string)  Distinguishes between api or legacy carrier services.
  • active (boolean)  

### [deleteCarrierService()](#deleteCarrierService) Delete an carrier service.

• *id (number)  Unique numeric identifier for the carrier service.

checkout

getCheckouts()

Retrieve a list of all Checkouts

• limit (number)  Amount of results (Default: 50) (Maximum: 250).
• page (number)  Page to show (default: 1).
• since_id (number)  Restrict results to after the specified ID.
• created_at_min (string)  Show checkouts created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Show checkouts created before date (format: 2008-12-31 03:00).
• updated_at_min (string)  Show checkouts last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Show checkouts last updated before date (format: 2008-12-31 03:00).
• status (string)  open - All open abandoned checkouts (default). closed - Show only closed abandoned checkouts.

### [getCheckoutCount()](#getCheckoutCount) Retrieve a count of all Checkouts

collect

getCollects()

Retrieve a list of all Collects

• page (number)  Page to show (default: 1).
• limit (number)  Collects per page (default: 50) (maximum: 250).
• fields (string)  Comma-separated list of fields to include in the response.
• product_id (number)  List only collects for a certain product.
• collection_id (number)  List only collects for a certain collection.

### [getCollectCount()](#getCollectCount) Retrieve a count of all Collects

• product_id (number)  List only collects for a certain product.
• collection_id (number)  List only collects for a certain collection.

### [getCollect()](#getCollect) Retrieve a single Collect

• *id (string)  The ID of the Collect.
• fields (string)  Comma-separated list of fields to include in the response.

comment

getComments()

Get a list of all comments.

• limit (number)  Amount of results (default: 50)(maximum: 250).
• page (number)  Page to show (default: 1).
• since_id (number)  Restrict results to after the specified ID.
• created_at_min (string)  Show comments created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Show comments created before date (format: 2008-12-31 03:00).
• updated_at_min (string)  Show comments last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Show comments last updated before date (format: 2008-12-31 03:00).
• published_at_min (string)  Show comments published after date (format: 2008-12-31 03:00).
• published_at_max (string)  Show comments published before date (format: 2008-12-31 03:00).
• published_status (string)  published - Show only published comments. unpublished - Show only unpublished comments. any - Show all comments (default).
• fields (string)  Comma-separated list of fields to include in the response.
• status (string)  

### [getCommentCount()](#getCommentCount) Get a count of all comments.

• created_at_min (string)  Count comments created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Count comments created before date (format: 2008-12-31 03:00).
• updated_at_min (string)  Count comments last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Count comments last updated before date (format: 2008-12-31 03:00).
• published_at_min (string)  Count comments published after date (format: 2008-12-31 03:00).
• published_at_max (string)  Count comments published before date (format: 2008-12-31 03:00).
• published_status (string)  published - Count only published comments. unpublished - Count only unpublished comments. any - Count all comments (default).
• status (string)  

### [getComment()](#getComment) Get a single comemnts by its ID.

• *id (number)  The ID of the comment.
• fields (string)  Comma-separated list of fields to include in the response.

### [createComment()](#createComment) Create a new comement for an article.

• comment
  • body (string)  
  • body_html (string)  
  • author (string)  
  • email (string)  
  • ip (number)  
  • blog_id (number)  
  • article_id (number)  
  • template_suffix (string)  
  • published (boolean)  
  • published_at (string)  
  • user_id (number)  
  • status (string)  
  • user_agent (string)  

### [updateComment()](#updateComment) Update a comement for an article.

• *id (string)  
• comment
  • id (string)  
  • body (string)  
  • body_html (string)  
  • author (string)  
  • email (string)  
  • ip (number)  
  • blog_id (number)  
  • article_id (number)  
  • template_suffix (string)  
  • published (boolean)  
  • published_at (string)  
  • user_id (number)  
  • status (string)  
  • user_agent (string)  

### [markCommentAsSpam()](#markCommentAsSpam) Mark a comment as spam, helping to train our spam detection as well as remove the comment sometime soon.

• *id (string)  

### [markCommentAsNotSpam()](#markCommentAsNotSpam) Mark a comment as not spam, restoring a comment marked as spam back to published.

• *id (string)  

### [markCommentAsApproved()](#markCommentAsApproved) Approve a comment that is currently pending unapproved so that it will be published on the site.

• *id (string)  

### [removeComment()](#removeComment) Remove a comment.

• id (string)  

### [restoreComment()](#restoreComment) Restore a comment.

• id (string)  

country

getCountries()

Get a list of all countries.

• since_id (number)  Restrict results to after the specified ID.
• fields (string)  Comma-separated list of fields to include in the response.

### [getCountryCount()](#getCountryCount) Get a count of all countries.
### [getCountry()](#getCountry) Show country.

• *id (string)  The ID of the Country.
• fields (string)  Comma-separated list of fields to include in the response.

### [createCountry()](#createCountry) Create a country.

• country
  • name (string)  The full name of the country, in English.
  • code (string)  The ISO 3166-1 alpha-2 two-letter country code for the country. The code for a given country will be the same as the code for the same country in another shop.
  • tax (string)  The national sales tax rate to be applied to orders made by customers from that country.

### [updateCountry()](#updateCountry) Create a country.

• *id (number)  The unique numeric identifier for the country. It is important to note that the id for a given country in one shop will not be the same as the id for the same country in another shop.
• country
  • id (number)  The unique numeric identifier for the country. It is important to note that the id for a given country in one shop will not be the same as the id for the same country in another shop.
  • name (string)  The full name of the country, in English.
  • code (string)  The ISO 3166-1 alpha-2 two-letter country code for the country. The code for a given country will be the same as the code for the same country in another shop.
  • tax (string)  The national sales tax rate to be applied to orders made by customers from that country.

### [deleteCountry()](#deleteCountry) Delete a country.

• *id (number)  Unique numeric identifier for the country.

custom-collection

getCustomCollections()

Get a list of all custom collections that contain a given product

• limit (integer)  Amount of results (default: 50) (maximum: 250)
• page (integer)  Page to show (default: 1)
• since_id (integer)  Restrict results to after the specified ID
• title (string)  Filter by custom collection title
• product_id (integer)  Filter by product id
• handle (string)  Filter by custom collection handle
• updated_at_min (string)  Show custom collections last updated after date (format: 2008-12-31 03:00)
• updated_at_max (string)  Show custom collections last updated before date (format: 2008-12-31 03:00)
• published_at_min (string)  Show custom collections published after date (format: 2008-12-31 03:00)
• published_at_max (string)  Show custom collections published before date (format: 2008-12-31 03:00)
• published_status (string)  published - Show only published custom collections. unpublished - Show only unpublished custom collections. any - Show all custom collections (default)
• fields (string)  comma-separated list of fields to include in the response

### [getCustomCollectionCount()](#getCustomCollectionCount) Retrieve a count of all Custom Collections
### [getCustomCollection()](#getCustomCollection) Retrieve a single Blog

• *id (number)  The ID of the Custom Collection.

### [createCustomCollection()](#createCustomCollection) Creates a custom collection.

• custom_collection
  • body_html (string)  
  • handle (string)  
  • image (string)  
  • metafield (string)  
  • metafields (string)  
  • published (boolean)  
  • published_at (string)  
  • published_scope (string)  
  • sort_order (string)  
  • template_suffix (string)  
  • title (boolean)  
  • collects (string)  

### [updateCustomCollection()](#updateCustomCollection) Update a custom collection.

• *id (number)  
• custom_collection
  • id (number)  
  • body_html (string)  
  • handle (string)  
  • image (string)  
  • metafield (string)  
  • metafields (string)  
  • published (boolean)  
  • published_at (string)  
  • published_scope (string)  
  • sort_order (string)  
  • template_suffix (string)  
  • title (boolean)  
  • collects (string)  

### [deleteCustomCollection()](#deleteCustomCollection) Delete a custom collection.

• *id (number)  Unique numeric identifier for the custom collection.

customer-address

getCustomerAddresses()

Retrieve all addresses for a customer

• *id (integer)  The ID of the Customer.
• limit (integer)  Amount of results (default: 50) (maximum: 250)
• page (integer)  Page to show (default: 1)

### [getCustomerAddress()](#getCustomerAddress) Get a count of all articles from a certain blog

• *id (integer)  The ID of the Customer.
• *addressId (integer)  The ID of the Address.

### [createCustomerAddress()](#createCustomerAddress) Creates a new address for a customer.

• address
  • address1 (string)  
  • address2 (string)  
  • city (string)  
  • company (boolean)  
  • first_name (string)  
  • last_name (string)  
  • phone (boolean)  
  • province (string)  
  • country (string)  
  • zip (boolean)  
  • name (boolean)  
  • province_code (string)  
  • country_code (string)  
  • country_name (string)  

### [updateCustomerAddress()](#updateCustomerAddress) Update a a customers address.

• *customer_id (number)  
• *id (number)  
• address
  • customer_id (number)  
  • id (number)  
  • address1 (string)  
  • address2 (string)  
  • city (string)  
  • company (boolean)  
  • first_name (string)  
  • last_name (string)  
  • phone (boolean)  
  • province (string)  
  • country (string)  
  • zip (boolean)  
  • name (boolean)  
  • province_code (string)  
  • country_code (string)  
  • country_name (string)  

### [deleteCustomerAddress()](#deleteCustomerAddress) Delete a customers address.

• *customer_id (number)  
• *id (number)  

### [deleteCustomerAddresses()](#deleteCustomerAddresses) Ddestroying multiple customer addresses.

• *id (number)  
• address_ids[] (string)  

### [setCustomersDefaultAddress()](#setCustomersDefaultAddress) Assigning a new default address to a customer.

• *customer_id (number)  
• *id (string)  

customer-group

getCustomerGroups()

Get a list of all customer groups

### [getCustomerGroupCount()](#getCustomerGroupCount) Get a count of all customer groups
### [getCustomerGroup()](#getCustomerGroup) Retrieve a single Customer Group

• *id (number)  The ID of the Customer Group.

### [getCustomerGroupCustomers()](#getCustomerGroupCustomers) Get all customers who match the criteria for the specified customer group

• *id (number)  The ID of the Customer Group.

customer-saved-search

getCustomerSavedSearches()

Get a list of all customer saved searches

### [getCustomerSavedSearchesCount()](#getCustomerSavedSearchesCount) Get a count of all customer saved searches
### [getCustomerSavedSearch()](#getCustomerSavedSearch) Get a single customer saved search

• *id (number)  The ID of the Saved Search.

### [getCustomerSavedSearchCustomers()](#getCustomerSavedSearchCustomers) Get all customers who match the criteria for the specified customer saved search

• *id (number)  The ID of the Saved Search.

### [createCustomerSavedSearch()](#createCustomerSavedSearch) Create a new customer saved search.

• customer_saved_search
  • name (string)  
  • query (string)  
  • body (string)  
  • accepts_marketing (boolean)  
  • country (string)  
  • last_order_date (string)  
  • orders_count (string)  
  • state (string)  
  • tag (string)  
  • total_spent (string)  

### [updateCustomerSavedSearch()](#updateCustomerSavedSearch) Update a customer saved search.

• *id (number)  
• customer_saved_search
  • id (number)  
  • name (string)  
  • query (string)  
  • body (string)  
  • accepts_marketing (boolean)  
  • country (string)  
  • last_order_date (string)  
  • orders_count (string)  
  • state (string)  
  • tag (string)  
  • total_spent (string)  

### [deleteCustomerSavedSearch()](#deleteCustomerSavedSearch) Delete a customers saved search.

• *id (number)  Unique numeric identifier for the CustomerSavedSearch.

customer

getCustomers()

Retrieve all customers of a shop

### [getCustomerSearch()](#getCustomerSearch) Retrieve a count of all Blogs

• order (string)  Field and direction to order results by (default: last_order_date DESC)
• query (string)  Text to search customers
• page (number)  Page to show
• limit (number)  Amount of results
• fields (string)  comma-separated list of fields to include in the response

### [getCustomer()](#getCustomer) Retrieve a single Customer

• id (string)  The ID of the Customer.

### [createCustomer()](#createCustomer) Create a new customer record.

• customer
  • first_name (string)  The customer's first name.
  • last_name (string)  The customer's last name.
  • email (string)  The email address of the customer.
  • verified_email (boolean)  States whether or not the email address has been verified.
  • addresses (string)  A list of addresses for the customer.
  • metafields (string)  
  • send_email_invite (boolean)  
  • password (string)  
  • password_confirmation (string)  
  • send_email_welcome (boolean)  
  • accepts_marketing (boolean)  Indicates whether the customer has consented to be sent marketing material via email. Valid values are 'true' and 'false.'
  • default_address (string)  The default address for the customer.
  • multipass_identifier (string)  The customer's identifier used with Multipass login.
  • last_order_id (string)  The id of the customer's last order.
  • last_order_name (string)  The name of the customer's last order. This is directly related to the Order's name field.
  • note (string)  A note about the customer.
  • orders_count (number)  The number of orders associated with this customer.
  • state (string)  The state of the customer in a shop.
  • tags (string)  Tags are additional short descriptors formatted as a string of comma-separated values. For example, if an article has three tags: tag1, tag2, tag3.
  • total_spent (string)  The total amount of money that the customer has spent at the shop.

### [updateCustomer()](#updateCustomer) Update a customer record.

• *id (number)  The customers ID number.
• customer
  • id (number)  The customer's ID number.
  • first_name (string)  The customer's first name.
  • last_name (string)  The customer's last name.
  • email (string)  The email address of the customer.
  • verified_email (boolean)  States whether or not the email address has been verified.
  • addresses (string)  A list of addresses for the customer.
  • metafields (string)  
  • send_email_invite (boolean)  
  • password (string)  
  • password_confirmation (string)  
  • send_email_welcome (boolean)  
  • accepts_marketing (boolean)  Indicates whether the customer has consented to be sent marketing material via email. Valid values are 'true' and 'false.'
  • default_address (string)  The default address for the customer.
  • multipass_identifier (string)  The customer's identifier used with Multipass login.
  • last_order_id (string)  The id of the customer's last order.
  • last_order_name (string)  The name of the customer's last order. This is directly related to the Order's name field.
  • note (string)  A note about the customer.
  • orders_count (number)  The number of orders associated with this customer.
  • state (string)  The state of the customer in a shop.
  • tags (string)  Tags are additional short descriptors formatted as a string of comma-separated values. For example, if an article has three tags: tag1, tag2, tag3.
  • total_spent (string)  The total amount of money that the customer has spent at the shop.

### [deleteCustomer()](#deleteCustomer) Delete a customer.

• *id (number)  Unique numeric identifier for the customer.

event

getEvents()

Retrieve a list of all events.

• limit (number)  Amount of results (default: 50) (maximum: 250).
• page (number)  Page to show (default: 1).
• since_id (number)  Restrict results to after the specified ID.
• created_at_min (string)  Show articles created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Show articles created before date (format: 2008-12-31 03:00).
• filter (string)  Only show events specified in filter.
• verb (string)  Only show events of a certain kind.
• fields (string)  Comma-separated list of fields to include in the response.

### [getEventCount()](#getEventCount) Retrieve a count of all events.

• created_at_min (string)  Show articles created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Show articles created before date (format: 2008-12-31 03:00).

### [getEvent()](#getEvent) Retrieve a single event.

• *id (string)  The ID of the Event.
• fields (string)  Comma-separated list of fields to include in the response.

fulfillment-service

getFulfillmentServices()

Retrieve all fulfilment services.

• scope (string)  

### [getFulfillmentService()](#getFulfillmentService) Get a single fulfillment service.

• *id (number)  The ID number of the fulfillment service.

### [createFulfillmentService()](#createFulfillmentService) Create a fulfilment for a specific order.

• fulfillment_service
  • name (string)  
  • callback_url (string)  
  • inventory_management (boolean)  
  • tracking_support (boolean)  
  • requires_shipping_method (boolean)  
  • format (string)  
  • credential1 (string)  
  • credential2_exists (string)  
  • handle (string)  
  • provider_id (string)  

### [updateFulfillmentService()](#updateFulfillmentService) Update a fulfillment service.

• *id (number)  The ID number of the fulfilment service.
• fulfillment
  • id (number)  The ID number of the fulfillment service.
  • name (string)  
  • callback_url (string)  
  • inventory_management (boolean)  
  • tracking_support (boolean)  
  • requires_shipping_method (boolean)  
  • format (string)  
  • credential1 (string)  
  • credential2_exists (string)  
  • handle (string)  
  • provider_id (string)  

### [deleteFulfillmentService()](#deleteFulfillmentService) Delete a fulfillment service.

• *id (number)  Unique numeric identifier for the fulfillment service.

fulfillment

getFulfillments()

Retrieve all fulfilments for an order

• *order_id (number)  The ID of the order.
• limit (number)  Amount of results (default: 50) (maximum: 250).
• page (number)  Page to show (default: 1).
• since_id (number)  Restrict results to after the specified ID.
• created_at_min (string)  Show fulfillments created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Show fulfillments created before date (format: 2008-12-31 03:00).
• updated_at_min (string)  Show fulfillments last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Show fulfillments last updated before date (format: 2008-12-31 03:00).
• fields (number)  Comma-separated list of fields to include in the response.

### [getFulfillmentCount()](#getFulfillmentCount) Get a count of all fulfillments for a given order.

• *id (number)  The ID of the order.
• created_at_min (number)  Count fulfillments created after date (format: 2008-12-31 03:00).
• created_at_max (number)  Count fulfillments created before date (format: 2008-12-31 03:00).
• updated_at_max (number)  Count fulfillments last updated before date (format: 2008-12-31 03:00).

### [getFulfillment()](#getFulfillment) Get a single fulfillment for a given order.

• *order_id (number)  The ID number of the order.
• *id (number)  The ID number of the fulfillment.
• fields (number)  Comma-separated list of fields to include in the response.

### [createFulfillment()](#createFulfillment) Create a fulfilment for a specific order.

• *order_id (number)  The ID number of the order.
• fulfillment
  • tracking_number (string)  Single shipping number.
  • tracking_numbers (string)  A list of shipping numbers, provided by the shipping company.
  • notify_customer (boolean)  The ISO 3166-1 alpha-2 two-letter country code for the country. The code for a given country will be the same as the code for the same country in another shop.
  • line_items (string)  
  • tracking_company (string)  The name of the shipping company.
  • tracking_url (string)  The URL to track the fulfillment.
  • tracking_urls (string)  The URLs to track the fulfillment.
  • status (string)  The status of the fulfillment.
  • receipt (string)  Text field that provides information about the receipt.

### [updateFulfillment()](#updateFulfillment) Update a fulfilment.

• *order_id (number)  The ID number of the order.
• *id (number)  The ID number of the fulfilment.
• fulfillment
  • order_id (number)  The ID number of the order.
  • id (number)  The ID number of the fulfilment.
  • tracking_number (string)  Single shipping number.
  • tracking_numbers (string)  A list of shipping numbers, provided by the shipping company.
  • notify_customer (boolean)  The ISO 3166-1 alpha-2 two-letter country code for the country. The code for a given country will be the same as the code for the same country in another shop.
  • line_items (string)  
  • tracking_company (string)  The name of the shipping company.
  • tracking_url (string)  The URL to track the fulfillment.
  • tracking_urls (string)  The URLs to track the fulfillment.
  • status (string)  The status of the fulfillment.
  • receipt (string)  Text field that provides information about the receipt.

### [completeFulfillment()](#completeFulfillment) Complete a fulfillment.

• *order_id (number)  The ID number of the order.
• *id (number)  The ID number of the fulfilment.

### [cancelFulfillment()](#cancelFulfillment) Complete a fulfillment.

• *order_id (number)  The ID number of the order.
• *id (number)  The ID number of the fulfilment.

location

getLocations()

Get a list of all locations for a shop.

### [getLocation()](#getLocation) Get a single location by its ID.

• *id (number)  The ID of the location.

metafield

getMetafields()

Get metafields that belong to a store

• limit (number)  Amount of results (default: 50) (maximum: 250)
• since_id (number)  Restrict results to after the specified ID
• created_at_min (string)  Show metafields created after date (format: 2008-12-31 03:00)
• created_at_max (string)  Show metafields created before date (format: 2008-12-31 03:00)
• updated_at_min (string)  Show metafields last updated after date (format: 2008-12-31 03:00)
• updated_at_max (string)  Show metafields last updated before date (format: 2008-12-31 03:00)
• namepace (string)  Show metafields with given namespace
• key (string)  Show metafields with given key
• value_type (string)  string - Show only metafields with string value types. integer - Show only metafields with integer value types
• fields (string)  Comma-separated list of fields to include in the response

### [getProductMetafields()](#getProductMetafields) Get metafields that belong to a product

• *id (string)  The ID of the Product.

### [getMetafieldsCount()](#getMetafieldsCount) Get a count of metafields that belong to a store
### [getProductMetafieldsCount()](#getProductMetafieldsCount) Get a count of metafields that belong to a product

• *id (number)  The ID of the Product.

### [getMetafield()](#getMetafield) Get a single store metafield by its ID

• *id (number)  The ID of the Metafield.

### [getProductMetafield()](#getProductMetafield) Get a single product metafield by its ID

• *id (number)  The ID of the Product.
• *metafield_id (number)  The ID of the Metafield.

### [createMetafield()](#createMetafield) Create a new metafield for a store

• metafield
  • namespace (string)  The Namespace for the Metafield.
  • key (string)  The Key for the Metafield.
  • value (string)  The Value of the Metafield.
  • value_type (string)  The Value Type of the Metafield.

### [createProductMetafield()](#createProductMetafield) Create a new metafield for a product

• *id (number)  The ID of the Product.
• metafield
  • namespace (string)  The Namespace for the Metafield.
  • key (string)  The Key for the Metafield.
  • value (string)  The Value of the Metafield.
  • value_type (string)  The Value Type of the Metafield.

### [updateMetafield()](#updateMetafield) Update a store Metafield

• *id (number)  The ID of the Product.
• metafield
  • metafieldId (integer)  The ID for the Metafield.
  • value (string)  The Value of the Metafield.
  • value_type (string)  The Value Type of the Metafield.

### [updateProductMetafield()](#updateProductMetafield) Update a Product Metafield

• *id (number)  The ID of the Product.
• *metafield_id (number)  The ID of the Metafield.
• metafield
  • metafieldId (number)  The ID for the Metafield.
  • value (string)  The Value of the Metafield.
  • value_type (string)  The Value Type of the Metafield.

### [deleteMetafield()](#deleteMetafield) Delete a store Metafield

• *id (number)  The ID of the Metafield.

### [deleteProductMetafield()](#deleteProductMetafield) Delete a Product Metafield

• *id (number)  The ID of the Product.
• *metafieldId (number)  The ID of the Metafield.

order-risk

getOrderRisks()

Get a list of all Order Risks.

• *id (number)  The unique ID number for the order.

### [getOrderRisk()](#getOrderRisk) Get a count of all pages.

• *order_id (number)  The unique ID number for the order.
• *id (number)  The unique ID of the order risk.

### [updateOrderRisk()](#updateOrderRisk) Update an Order Risk entry.

• *order_id (number)  The id of the order the order risk belongs to.
• *id (number)  A unique numeric identifier for the order risk.
• risk
  • id (number)  A unique numeric identifier for the order risk.
  • message (string)  A message that should be displayed to the merchant to indicate the results of the fraud check.
  • recommendation (string)  The recommended action given to the merchant.
  • source (string)  This indicates the source of the risk assessment.
  • cause_cancel (boolean)  Use this flag when a fraud check is accompanied with a call to the Orders API to cancel the order. This will indicate to the merchant that this risk was severe enough to force cancellation of the order.
  • score (string)  A number between 0 and 1 indicating percentage likelihood of being fraud.
  • display (boolean)  States whether or not the risk is displayed. Valid values are "true" or "false".

### [deleteOrderRisk()](#deleteOrderRisk) Delete an order risk entry. Consider updating a previous order risk with display set to false rather than deleting an entry.

• *id (number)  Unique numeric identifier for the order risk.
• *order_id (number)  Unique numeric identifier for the order.

order

getOrders()

Retrieve a list of Orders (OPEN Orders by default, use status=any for ALL orders).

• limit (number)  Amount of results (default: 50) (maximum: 250).
• page (number)  Page to show (default: 1).
• since_id (number)  Restrict results to after the specified ID.
• created_at_min (string)  Show orders created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Show orders created before date (format: 2008-12-31 03:00).
• updated_at_min (string)  Show orders last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Show orders last updated before date (format: 2008-12-31 03:00).
• processed_at_min (string)  Show orders imported after date (format: 2008-12-31 03:00).
• processed_at_max (string)  Show orders imported before date (format: 2008-12-31 03:00).
• status (string)  
• financial_status (string)  
• fulfillment_status (string)  
• fields (string)  Comma-separated list of fields to include in the response.

### [getOrder()](#getOrder) Retrieve a specific order.

• id (string)  The ID of the order.
• fields (string)  Comma-separated list of fields to include in the response.

### [getOrderCount()](#getOrderCount) Retrieve a count of all the orders.

• created_at_min (string)  Count orders created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Count orders created before date (format: 2008-12-31 03:00).
• updated_at_min (string)  Count orders last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Count orders last updated before date (format: 2008-12-31 03:00).
• status (string)  
• financial_status (string)  
• fulfillment_status (string)  

### [closeOrder()](#closeOrder) Close an order.

• id (number)  The ID of the order.

### [openOrder()](#openOrder) Re-open a closed order.

• id (number)  The ID of the order.

### [cancelOrder()](#cancelOrder) Cancel an order.

• id (number)  The ID of the order.
• order
  • amount (number)  Amount to refund (decimal ex: 21.20). If set, Shopify will attempt to void/refund the payment depending on the status.
  • restock (boolean)  Restock the items for this order back to your store.
  • reason (number)  The reason for the order cancellation (one of customer, inventory, fraud, other).
  • email (boolean)  Send an email to the customer notifying them of the cancellation.

### [createOrder()](#createOrder) Create a new order.

• order
  • email (string)  The customer's email address. Is required when a billing address is present.
  • send_receipt (boolean)  The ID of the order.
  • send_fulfillment_receipt (boolean)  
  • line_items (string)  A list of line item objects, each one containing information about an item in the order.
  • tax_lines (string)  An array of tax_line objects, each of which details the total taxes applicable to the order.
  • transactions (string)  
  • total_tax (string)  The sum of all the taxes applied to the order (must be positive).
  • currency (string)  The three letter code (ISO 4217) for the currency used for the payment.
  • customer (string)  
  • financial_status (string)  
  • billing_address (string)  The mailing address associated with the payment method.
  • shipping_address (string)  The mailing address to where the order will be shipped.
  • browser_ip (string)  The IP address of the browser used by the customer when placing the order.
  • buyer_accepts_marketing (boolean)  Indicates whether or not the person who placed the order would like to receive email updates from the shop. This is set when checking the 'I want to receive occasional emails about new products, promotions and other news' checkbox during checkout. Valid values are true and false.
  • cancel_reason (string)  The reason why the order was cancelled.
  • cancelled_at (string)  The date and time when the order was cancelled. If the order was cancelled, the API returns this value in ISO 8601 format. If the order was not cancelled, this value is 'null.'
  • cart_token (string)  Unique identifier for a particular cart that is attached to a particular order.
  • client_details (string)  An object containing information about the client.
  • closed_at (string)  The date and time when the order was closed. If the order was closed, the API returns this value in ISO 8601 format. If the order was not closed, this value is null.
  • discount_codes (string)  Applicable discount codes that can be applied to the order. If no codes exist the value will default to blank.
  • fulfillments (string)  
  • fulfillment_status (string)  
  • tags (string)  Tags are additional short descriptors, commonly used for filtering and searching, formatted as a string of comma-separated values. For example, if an order has three tags: tag1, tag2, tag3. Each individual tag is limited to 40 characters in length.
  • landing_site (string)  The URL for the page where the buyer landed when entering the shop.
  • name (string)  The customer's order name as represented by a number.
  • note (string)  The text of an optional note that a shop owner can attach to the order.
  • note_attributes (string)  Extra information that is added to the order. Each array entry must contain a hash with 'name' and 'value' keys as shown above.
  • order_number (string)  A unique numeric identifier for the order. This one is used by the shop owner and customer. This is different from the id property, which is also a unique numeric identifier for the order, but used for API purposes.
  • processed_at (string)  The date and time when the order was imported, in ISO 8601 format. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated.
  • processing_method (string)  States the type of payment processing method. Valid values are: checkout, direct, manual, offsite or express.
  • referring_site (string)  The website that the customer clicked on to come to the shop.
  • refund (string)  The list of refunds applied to the order.
  • shipping_lines (string)  An array of shipping_line objects, each of which details the shipping methods used.
  • source_name (string)  Where the order originated.
  • subtotal_price (string)  Price of the order before shipping and taxes.
  • taxes_included (boolean)  States whether or not taxes are included in the order subtotal. Valid values are 'true' or 'false'.
  • token (string)  Unique identifier for a particular order.
  • total_discounts (string)  The total amount of the discounts to be applied to the price of the order.
  • total_line_items_price (string)  The sum of all the prices of all the items in the order.
  • total_price (string)  The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).
  • total_weight (string)  The sum of all the weights of the line items in the order, in grams.

### [updateOrder()](#updateOrder) Create a new order.

• id (number)  The ID of the order.
• order
  • id (number)  The ID of the order.
  • email (string)  The customer's email address. Is required when a billing address is present.
  • send_receipt (boolean)  The ID of the order.
  • send_fulfillment_receipt (boolean)  
  • line_items (string)  A list of line item objects, each one containing information about an item in the order.
  • tax_lines (string)  An array of tax_line objects, each of which details the total taxes applicable to the order.
  • transactions (string)  
  • total_tax (string)  The sum of all the taxes applied to the order (must be positive).
  • currency (string)  The three letter code (ISO 4217) for the currency used for the payment.
  • customer (string)  
  • financial_status (string)  
  • billing_address (string)  The mailing address associated with the payment method.
  • shipping_address (string)  The mailing address to where the order will be shipped.
  • browser_ip (string)  The IP address of the browser used by the customer when placing the order.
  • buyer_accepts_marketing (boolean)  Indicates whether or not the person who placed the order would like to receive email updates from the shop. This is set when checking the 'I want to receive occasional emails about new products, promotions and other news' checkbox during checkout. Valid values are true and false.
  • cancel_reason (string)  The reason why the order was cancelled.
  • cancelled_at (string)  The date and time when the order was cancelled. If the order was cancelled, the API returns this value in ISO 8601 format. If the order was not cancelled, this value is 'null.'
  • cart_token (string)  Unique identifier for a particular cart that is attached to a particular order.
  • client_details (string)  An object containing information about the client.
  • closed_at (string)  The date and time when the order was closed. If the order was closed, the API returns this value in ISO 8601 format. If the order was not closed, this value is null.
  • discount_codes (string)  Applicable discount codes that can be applied to the order. If no codes exist the value will default to blank.
  • fulfillments (string)  
  • fulfillment_status (string)  
  • tags (string)  Tags are additional short descriptors, commonly used for filtering and searching, formatted as a string of comma-separated values. For example, if an order has three tags: tag1, tag2, tag3. Each individual tag is limited to 40 characters in length.
  • landing_site (string)  The URL for the page where the buyer landed when entering the shop.
  • name (string)  The customer's order name as represented by a number.
  • note (string)  The text of an optional note that a shop owner can attach to the order.
  • note_attributes (string)  Extra information that is added to the order. Each array entry must contain a hash with 'name' and 'value' keys as shown above.
  • order_number (string)  A unique numeric identifier for the order. This one is used by the shop owner and customer. This is different from the id property, which is also a unique numeric identifier for the order, but used for API purposes.
  • processed_at (string)  The date and time when the order was imported, in ISO 8601 format. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated.
  • processing_method (string)  States the type of payment processing method. Valid values are: checkout, direct, manual, offsite or express.
  • referring_site (string)  The website that the customer clicked on to come to the shop.
  • refund (string)  The list of refunds applied to the order.
  • shipping_lines (string)  An array of shipping_line objects, each of which details the shipping methods used.
  • source_name (string)  Where the order originated.
  • subtotal_price (string)  Price of the order before shipping and taxes.
  • taxes_included (boolean)  States whether or not taxes are included in the order subtotal. Valid values are 'true' or 'false'.
  • token (string)  Unique identifier for a particular order.
  • total_discounts (string)  The total amount of the discounts to be applied to the price of the order.
  • total_line_items_price (string)  The sum of all the prices of all the items in the order.
  • total_price (string)  The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).
  • total_weight (string)  The sum of all the weights of the line items in the order, in grams.

### [deleteOrder()](#deleteOrder) Delete an order.

• id (number)  Unique numeric identifier for the order.

page

getPages()

Get a list of all pages.

• limit (number)  Amount of results (default: 50)(maximum: 250).
• page (number)  Page to show (default: 1).
• since_id (number)  Restrict results to after the specified ID.
• title (string)  Show pages by Title.
• handle (string)  Filter by Page handle.
• created_at_min (string)  Show pages created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Show pages created before date (format: 2008-12-31 03:00).
• updated_at_min (string)  Show pages last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Show pages last updated before date (format: 2008-12-31 03:00).
• published_at_min (string)  Show pages published after date (format: 2008-12-31 03:00).
• published_at_max (string)  Show pages published before date (format: 2008-12-31 03:00).
• published_status (string)  published - Show only published pages. unpublished - Show only unpublished pages. any - Show all pages (default).
• fields (string)  Comma-separated list of fields to include in the response.

### [getPageCount()](#getPageCount) Get a count of all pages.

• title (string)  Pages with a given title.
• created_at_min (string)  Pages created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Pages created before date (format: 2008-12-31 03:00).
• updated_at_min (string)  Pages last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Pages last updated before date (format: 2008-12-31 03:00).
• published_at_min (string)  Pages published after date (format: 2008-12-31 03:00).
• published_at_max (string)  Pages published before date (format: 2008-12-31 03:00).
• published_status (string)  published - Show only published pages. unpublished - Show only unpublished pages. any - Show all pages (default).

### [getPage()](#getPage) Retrieve a single page.

• *id (string)  The ID of the Page.
• fields (string)  Comma-separated list of fields to include in the response.

### [createPage()](#createPage) Create a new page.

• page
  • author (string)  The name of the person who created the page.
  • body_html (string)  Text content of the page, complete with HTML markup.
  • handle (string)  A human-friendly unique string for the page automatically generated from its title. This is used in shop themes by the Liquid templating language to refer to the page.
  • published_at (string)  
  • template_suffix (string)  The suffix of the liquid template being used. By default, the original template is called page.liquid, without any suffix. Any additional templates will be: page.suffix.liquid.
  • title (string)  The title of the page.
  • published (boolean)  

### [updatePage()](#updatePage) Update a page.

• *id (number)  The ID of the page.
• page
  • author (string)  The name of the person who created the page.
  • body_html (string)  Text content of the page, complete with HTML markup.
  • handle (string)  A human-friendly unique string for the page automatically generated from its title. This is used in shop themes by the Liquid templating language to refer to the page.
  • published_at (string)  
  • template_suffix (string)  The suffix of the liquid template being used. By default, the original template is called page.liquid, without any suffix. Any additional templates will be: page.suffix.liquid.
  • title (string)  The title of the page.
  • published (boolean)  

### [deletePage()](#deletePage) Delete a page.

• *id (number)  Unique numeric identifier for the page.

product-image

getProductImages()

Retrieve a list of all Product images.

• *id (string)  The ID of the Product.
• since_id (number)  Restrict results to after the specified ID.
• fields (integer)  Comma-separated list of fields to include in the response.

### [getProductImageCount()](#getProductImageCount) Get a count of all product images

• *id (number)  The ID of the product.
• since_id (number)  Restrict results to after the specified ID.
• created_at_min (string)  Count articles created after date (format: 2008-12-31 03:00).
• created_at_max (string)  Count articles created before date (format: 2008-12-31 03:00).
• updated_at_min (string)  Count articles last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Count articles last updated before date (format: 2008-12-31 03:00).
• published_at_min (string)  Count articles published after date (format: 2008-12-31 03:00).
• published_at_max (string)  Count articles published before date (format: 2008-12-31 03:00).

### [getProductImage()](#getProductImage) Retrieve a single product image.

• *id (number)  The ID of the product image.

### [createProductImage()](#createProductImage) Create a new product image.

• *id (number)  The ID of the product you wish to add the image to.
• image
  • attachment (string)  
  • filename (string)  
  • src (string)  Specifies the location of the product image.
  • position (number)  The order of the product image in the list. The first product image is at position 1 and is the main image for the product.
  • variant_ids (string)  An array of variant ids associated with the image.
  • metafields (string)  A categorization that a product can be tagged with, commonly used for filtering and searching.

### [updateProductImage()](#updateProductImage) Update a product image.

• *product_id (number)  The ID of the product.
• *id (number)  The ID of the image.
• image
  • product_id (number)  The ID of the product.
  • id (number)  The ID of the image.
  • attachment (string)  
  • filename (string)  
  • src (string)  Specifies the location of the product image.
  • position (number)  The order of the product image in the list. The first product image is at position 1 and is the main image for the product.
  • variant_ids (string)  An array of variant ids associated with the image.
  • metafields (string)  A categorization that a product can be tagged with, commonly used for filtering and searching.

### [deleteProductImage()](#deleteProductImage) Delete a product image.

• *id (number)  Unique numeric identifier for the image.
• *product_id (number)  Unique numeric identifier for the product.

product-variant

getProductVariants()

Retrieve a list of all product variants.

• *id (number)  ID of the product.
• limit (number)  Amount of results.
• page (number)  Page to show (Default: 1).
• since_id (number)  Restrict results to after the specified ID,
• fields (string)  Comma-separated list of fields to include in the response.

### [getProductVariantCount()](#getProductVariantCount) Get a count of product variants.

• *id (number)  The ID of hte product.

### [getProductVariant()](#getProductVariant) Get a single product variant by id.

• *id (number)  The ID of the product variant.
• fields (string)  Comma-separated list of fields to include in the response.

### [createProductVariant()](#createProductVariant) Create a new product variant.

• *id (string)  The ID of the product.
• variant
  • barcode (string)  The barcode, UPC or ISBN number for the product.
  • compare_at_price (string)  The competitors prices for the same item.
  • fulfillment_service (string)  Service who is doing the fulfillment.
  • grams (number)  The weight of the product variant in grams.
  • inventory_management (string)  Specifies whether or not Shopify tracks the number of items in stock for this product variant.
  • inventory_policy (string)  Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock.
  • inventory_quantity (string)  The number of items in stock for this product variant.
  • old_inventory_quantity (string)  The original stock level the client believes the product variant has. This should be sent to avoid a race condition when the item being adjusted is simultaneously sold online.
  • inventory_quantity_adjustment (string)  Instead of sending a new and old value for inventory an adjustment value can be sent. If an adjustment value is sent it will take priority.
  • metafield (string)  Attaches additional information to a shop's resources.
  • option (string)  Custom properties that a shop owner can use to define product variants. Multiple options can exist. Options are represented as: option1, option2, option3 etc.
  • position (string)  The order of the product variant in the list of product variants. 1 is the first position.
  • price (string)  The price of the product variant.
  • product_id (string)  The unique numeric identifier for the product.
  • requires_shipping (string)  Specifies whether or not a customer needs to provide a shipping address when placing an order for this product variant.
  • sku (string)  A unique identifier for the product in the shop.
  • taxable (boolean)  Specifies whether or not a tax is charged when the product variant is sole.
  • title (string)  The title of the product variant.
  • image_id (string)  The unique numeric identifier for one of the product's images.

### [updateProductVariant()](#updateProductVariant) Update a product variant.

• *id (string)  The ID of the variant.
• variant
  • id (string)  The ID of the variant.
  • barcode (string)  The barcode, UPC or ISBN number for the product.
  • compare_at_price (string)  The competitors prices for the same item.
  • fulfillment_service (string)  Service who is doing the fulfillment.
  • grams (number)  The weight of the product variant in grams.
  • inventory_management (string)  Specifies whether or not Shopify tracks the number of items in stock for this product variant.
  • inventory_policy (string)  Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock.
  • inventory_quantity (string)  The number of items in stock for this product variant.
  • old_inventory_quantity (string)  The original stock level the client believes the product variant has. This should be sent to avoid a race condition when the item being adjusted is simultaneously sold online.
  • inventory_quantity_adjustment (string)  Instead of sending a new and old value for inventory an adjustment value can be sent. If an adjustment value is sent it will take priority.
  • metafield (string)  Attaches additional information to a shop's resources.
  • option (string)  Custom properties that a shop owner can use to define product variants. Multiple options can exist. Options are represented as: option1, option2, option3 etc.
  • position (string)  The order of the product variant in the list of product variants. 1 is the first position.
  • price (string)  The price of the product variant.
  • product_id (string)  The unique numeric identifier for the product.
  • requires_shipping (string)  Specifies whether or not a customer needs to provide a shipping address when placing an order for this product variant.
  • sku (string)  A unique identifier for the product in the shop.
  • taxable (boolean)  Specifies whether or not a tax is charged when the product variant is sole.
  • title (string)  The title of the product variant.
  • image_id (string)  The unique numeric identifier for one of the product's images.

### [deleteProductVariant()](#deleteProductVariant) Delete a product variant.

• *id (number)  Unique numeric identifier for the variant.
• *product_id (number)  Unique numeric identifier for the product.

product

getProducts()

Retrieve a list of all Products

• limit (integer)  Amount of results (default: 50) (maximum: 250)
• page (integer)  Page to show (default: 1)
• since_id (integer)  Restrict results to after the specified ID
• vendor (string)  Filter by product vendor
• handle (string)  Filter by product handle
• product_type (string)  Filter by product type
• collection_id (integer)  Filter by collection id
• created_at_min (string)  Show products created after date (format: 2008-12-31 03:00)
• created_at_max (string)  Show products created before date (format: 2008-12-31 03:00)
• updated_at_min (string)  Show products last updated after date (format: 2008-12-31 03:00)
• updated_at_max (string)  Show products last updated before date (format: 2008-12-31 03:00)
• published_at_min (string)  Show products published after date (format: 2008-12-31 03:00)
• published_at_max (string)  Show products published before date (format: 2008-12-31 03:00)
• published_status (string)  published - Show only published products. unpublished - Show only unpublished products. any - Show all products (default)
• fields (string)  comma-separated list of fields to include in the response

### [getProductCount()](#getProductCount) Retrieve a count of all Products
### [getProduct()](#getProduct) Retrieve a single Product

• *id (number)  The ID of the Product.

### [createProduct()](#createProduct) Create a new product.

• product
  • body_html (string)  The description of the product, complete with HTML formatting.
  • vendor (string)  The name of the vendor of the product.
  • product_type (string)  A categorization that a product can be tagged with, commonly used for filtering and searching.
  • handle (string)  A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.
  • images (string)  A list of image objects, each one representing an image associated with the product.
  • options (string)  Custom product property names like Size, Color, and Material. Products are based on permutations of these options. A product may have a maximum of 3 options. 255 characters limit each.
  • published_at (string)  The date and time when the product was published. The API returns this value in ISO 8601 format.
  • published_scope (string)  The sales channels in which the product is visible.
  • tags (string)  A categorization that a product can be tagged with, commonly used for filtering and searching.
  • template_suffix (string)  The suffix of the liquid template being used. By default, the original template is called product.liquid, without any suffix. Any additional templates will be: product.suffix.liquid.
  • title (string)  The name of the product. In a shop's catalog, clicking on a product's title takes you to that product's page. On a product's page, the product's title typically appears in a large font.
  • variants (string)  A list of variant objects, each one representing a slightly different version of the product. For example, if a product comes in different sizes and colors, each size and color permutation (such as small black, medium black, large blue), would be a variant.
  • published (boolean)  The product status.

### [updateProduct()](#updateProduct) Update an existing product.

• *id (number)  The products ID number.
• product
  • id (number)  The products ID number.
  • body_html (string)  The description of the product, complete with HTML formatting.
  • vendor (string)  The name of the vendor of the product.
  • product_type (string)  A categorization that a product can be tagged with, commonly used for filtering and searching.
  • handle (string)  A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.
  • images (string)  A list of image objects, each one representing an image associated with the product.
  • options (string)  Custom product property names like Size, Color, and Material. Products are based on permutations of these options. A product may have a maximum of 3 options. 255 characters limit each.
  • published_at (string)  The date and time when the product was published. The API returns this value in ISO 8601 format.
  • published_scope (string)  The sales channels in which the product is visible.
  • tags (string)  A categorization that a product can be tagged with, commonly used for filtering and searching.
  • template_suffix (string)  The suffix of the liquid template being used. By default, the original template is called product.liquid, without any suffix. Any additional templates will be: product.suffix.liquid.
  • title (string)  The name of the product. In a shop's catalog, clicking on a product's title takes you to that product's page. On a product's page, the product's title typically appears in a large font.
  • variants (string)  A list of variant objects, each one representing a slightly different version of the product. For example, if a product comes in different sizes and colors, each size and color permutation (such as small black, medium black, large blue), would be a variant.
  • published (boolean)  The product status.

### [deleteProduct()](#deleteProduct) Delete a product from the shop.

• *id (number)  Unique numeric identifier for the product.

province

getProvinces()

Get a all provinces.

• *country_id (number)  The id of the country the province belongs to.
• since_id (number)  Restrict results to after the specified ID.
• fields (number)  Comma-separated list of fields to include in the response.

### [getProvinceCount()](#getProvinceCount) Get a count of all provinces.

• *country_id (number)  The id of the country the province belongs to.
• since_id (number)  Restrict results to after the specified ID.

### [getProvince()](#getProvince) Get a count of all provinces.

• *id (number)  The id of the province.
• *country_id (number)  The id of the country the province belongs to.
• since_id (number)  Restrict results to after the specified ID.

### [updateProvince()](#updateProvince) Update a province's tax rate.

• *id (number)  The id of the province.
• *country_id (number)  The id of the country the province belongs to.
• province
  • tax (string)  New tax rate.

recurring-application-charge

getRecurringApplicationCharges()

All past and present recurring charge requests are retrieved by this request.

• since_id (number)  
• fields (number)  

### [getRecurringApplicationCharge()](#getRecurringApplicationCharge) Get a recurring application charge.

• *id (number)  

### [createRecurringApplicationCharge()](#createRecurringApplicationCharge) Create recurring application charge.

• recurring_application_charge
  • name (string)  
  • price (string)  
  • return_url (string)  
  • test (boolean)  
  • trial_days (number)  
  • activated_on (string)  
  • billing_on (string)  
  • cancelled_on (string)  
  • trial_ends_on (string)  

### [activateRecurringApplicationCharge()](#activateRecurringApplicationCharge) Activate recurring application charge.

• *id (number)  

### [deleteRecurringApplicationCharges()](#deleteRecurringApplicationCharges) Cancel the current recurring charge for a shop.

• *id (number)  

redirect

getRedirects()

Get a list of all URL redirects for your shop.

• limit (number)  Amount of results (default: 50) (maximum: 250).
• page (number)  Page to show (default: 1).
• since_id (number)  Restrict results to after the specified ID.
• path (string)  Show Redirects with given path.
• target (string)  Show Redirects with given target.
• fields (string)  Comma-separated list of fields to include in the response

### [getRedirectsCount()](#getRedirectsCount) Get a count of all URL redirects for your shop.

• path (string)  Count Redirects with given path.
• target (string)  Count Redirects with given target.

### [getRedirect()](#getRedirect) Get a single redirect.

• *id (number)  The ID of the Product.
• fields (string)  Comma-separated list of fields to include in the response.

### [createRedirect()](#createRedirect) Create a new redirect.

• redirect
  • path (string)  The url path.
  • target (string)  The target url.

### [updateRedirect()](#updateRedirect) Update a redirect's path and/or target URIs.

• id (number)  The ID of the redirect.
• redirect

### [deleteRedirect()](#deleteRedirect) Delete a store redirect

• id (number)  The ID of the redirect.

refund

getRefund()

Receive a singe refund.

• *id (number)  The ID of the refund.
• *order_id (number)  The ID of the order.
• fields (number)  Comma-separated list of fields to include in the response.

script-tag

getScriptTags()

Receive a list of all script tags.

### [createScriptTag()](#createScriptTag) Create a new script tag.

• script_tag
  • event (string)  Should be onload
  • src (string)  

### [updateScriptTag()](#updateScriptTag) Update a script tag.

• *id (number)  The scripts ID number.
• script_tag
  • id (number)  The scripts ID number.
  • src (string)  

### [deleteScriptTag()](#deleteScriptTag) Delete a script tag.

• *id (number)  The script tag ID number.

service-config

shop

getShop()

Retrieve Shop

• fields (string)  Comma-separated list of fields to include in the response.

smart-collection

getSmartCollections()

Receive a list of all SmartCollections.

• limit (number)  Amount of results.
• page (number)  Page to show.
• since_id (number)  Restrict results to after the specified ID.
• title (number)  Show smart collections with given title.
• product_id (number)  Show smart collections that includes given product.
• handle (number)  Filter by smart collection handle.
• updated_at_min (number)  Show smart collections last updated after date (format: 2008-12-31 03:00).
• updated_at_max (number)  Show smart collections last updated before date (format: 2008-12-31 03:00).
• published_at_min (number)  Show smart collections published after date (format: 2008-12-31 03:00).
• published_at_max (number)  Show smart collections published before date (format: 2008-12-31 03:00).
• published_status (number)  
• fields (number)  Ccomma-separated list of fields to include in the response.

### [getSmartCollectionsCount()](#getSmartCollectionsCount) Get a count of all smart collections that contain a given product.

• title (string)  Show smart collections with given title.
• product_id (number)  Show smart collections that includes given product.
• updated_at_min (string)  Show smart collections last updated after date (format: 2008-12-31 03:00).
• updated_at_max (string)  Show smart collections last updated before date (format: 2008-12-31 03:00).
• published_at_min (string)  Show smart collections published after date (format: 2008-12-31 03:00).
• published_at_max (string)  Show smart collections published before date (format: 2008-12-31 03:00).
• published_status (string)  

### [getSmartCollection()](#getSmartCollection) Get a single smart collection.

• *id (number)  The ID of the smartcollection.
• fields (string)  Comma-separated list of fields to include in the response.

### [createSmartCollection()](#createSmartCollection) Create a new smart collection.

• smart_collection
  • title (number)  Show smart collections with given title.
  • image (string)  The collection image.
  • body_html (string)  The description of the smart collection, complete with HTML markup. Many templates display this on their smart collection page.
  • rules (string)  The list of rules that define what products go into the smart collection.
  • published (boolean)  
  • handle (string)  A human-friendly unique string for the smart collection automatically generated from its title. This is used in shop themes by the Liquid templating language to refer to the smart collection. Limit of 255 characters.
  • published_at (string)  
  • published_scope (string)  The sales channels in which the smart collection is visible.
  • disjunctive (boolean)  If false, products must match all of the rules to be included in the collection. If true, products can only match one of the rules.
  • sort_order (string)  The order in which products in the smart collection appear.
  • template_suffix (string)  The suffix of the template you are using. By default, the original template is called product.liquid, without any suffix. Any additional templates will be: product.suffix.liquid.

### [updateSmartCollection()](#updateSmartCollection) Update a smart collection.

• *id (number)  The ID of the smart collection.
• smart_collection
  • id (number)  The ID of the smart collection.
  • title (number)  Show smart collections with given title.
  • image (string)  The collection image.
  • body_html (string)  The description of the smart collection, complete with HTML markup. Many templates display this on their smart collection page.
  • rules (string)  The list of rules that define what products go into the smart collection.
  • published (boolean)  
  • handle (string)  A human-friendly unique string for the smart collection automatically generated from its title. This is used in shop themes by the Liquid templating language to refer to the smart collection. Limit of 255 characters.
  • published_at (string)  
  • published_scope (string)  The sales channels in which the smart collection is visible.
  • disjunctive (boolean)  If false, products must match all of the rules to be included in the collection. If true, products can only match one of the rules.
  • sort_order (string)  The order in which products in the smart collection appear.
  • template_suffix (string)  The suffix of the template you are using. By default, the original template is called product.liquid, without any suffix. Any additional templates will be: product.suffix.liquid.

### [updateSmartCollectionOrder()](#updateSmartCollectionOrder) Update a smart collections sort order.

• *id (number)  The ID of the smart collection.
• smart_collection
  • id (number)  The ID of the smart collection.
  • products (string)  Array of product ids in the order you want them arranged. (Applies only when sort_order is set to manual)
  • sort_order (string)  The type of sorting to apply. Valid values are listed in the Properties section above.

### [deleteSmartCollection()](#deleteSmartCollection) Remove a smart collection.

• *id (number)  Unique numeric identifier for the smart collection.

theme

getThemes()

Receive a list of all themes.

• role (string)  
• fields (string)  Comma-separated list of fields to include in the response.

### [getTheme()](#getTheme) Get a single theme.

• *id (string)  The ID of the theme.
• fields (string)  Comma-separated list of fields to include in the response.

### [createTheme()](#createTheme) Create a theme by providing the public URL of a .zip containing the theme. The theme always starts out with a role of unpublished. If a different role is provided in the POST request, the theme will be given that role only after all its files have been extracted and stored by Shopify (which might take a couple of minutes).

• theme
  • name (string)  The name of the theme.
  • src (string)  
  • role (string)  Specifies how the theme is being used within the shop.

### [updateTheme()](#updateTheme) Update an existing theme.

• *id (number)  The themes ID number.
• product
  • id (number)  The themes ID number.
  • name (string)  The description of the product, complete with HTML formatting.
  • role (string)  A human-friendly unique string for the page automatically generated from its title. This is used in shop themes by the Liquid templating language to refer to the page.

### [deleteTheme()](#deleteTheme) Remove a theme.

• *id (number)  Unique numeric identifier for the theme.

transaction

getTransactions()

Get a list of all transactions for a given order.

• *order_id (number)  The order ID number.
• since_id (number)  Restrict results to after the specified ID.
• fields (string)  Comma-separated list of fields to include in the response.

### [getTransactionCount()](#getTransactionCount) Count all a given order’s money transfers.

• *order_id (number)  The order ID number.

### [getTransaction()](#getTransaction) Get a single webhook by id

• *order_id (number)  The ID of the Order.
• *id (number)  The ID of the Transaction.
• fields (string)  A comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to showing only those properties you specify.

### [createTransaction()](#createTransaction) Create a new transaction.

• *order_id (number)  The ID of the order.
• transaction
  • amount (number)  The amount of money that the transaction was for.
  • authorization (string)  The authorization code associated with the transaction.
  • gateway (string)  The name of the gateway the transaction was issued through. A list of gateways can be found on Shopify's Payment Gateway page.
  • payment_details (string)  An object containing information about the credit card used for this transaction.
  • kind (string)  The kind of transaction.
  • receipt (string)  
  • error_code (string)  A standardized error code, independent of the payment provider. Value can be null.
  • status (string)  The status of the transaction. Valid values are: pending, failure, success or error.
  • test (boolean)  The option to use the transaction for testing purposes. Valid values are true or false.
  • user_id (number)  The unique identifier for the user.
  • currency (number)  The three letter code (ISO 4217) for the currency used for the payment.

### [updateWebhook()](#updateWebhook) Update a new webhook.

• *id (number)  The ID of the webhook.
• webhook
  • id (number)  The ID of the webhook.
  • topic (string)  The event that will trigger the webhook. Valid values are: orders/create, orders/delete, orders/updated, orders/paid, orders/cancelled, orders/fulfilled, orders/partially_fulfilled, order_transactions/create, carts/create, carts/update, checkouts/create, checkouts/update, checkouts/delete, refunds/create, products/create, products/update, products/delete, collections/create, collections/update, collections/delete, customer_groups/create, customer_groups/update, customer_groups/delete, customers/create, customers/enable, customers/disable, customers/update, customers/delete, fulfillments/create, fulfillments/update, shop/update, disputes/create, disputes/update, app/uninstalled,
  • address (string)  The URI where the webhook should send the POST request when the event occurs.
  • format (string)  The format in which the webhook should send the data. Valid values are json and xml.
  • metafield_namespaces (string)  (Optional) An array of namespaces for metafields that should be included in webhooks.

### [deleteRedirect()](#deleteRedirect) Delete a webhook.

• *id (number)  The ID of the webhook.

user

getUsers()

Get a list of all users.

### [getUser()](#getUser) Get a user.

• *id (number)  The ID of the user.

webhook

getWebhooks()

Get a list of all webhooks

• address (string)  Use this parameter to retrieve only webhooks that possess the URI where the webhook sends the POST request when the event occurs.
• created_at_max (string)  Use this parameter to retrieve only webhooks that were created before a given date and time (format: 2008-12-31 03:00).
• created_at_min (string)  Use this parameter to retrieve only webhooks that were created after a given date and time (format: 2008-12-31 03:00).
• fields (string)  A comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to showing only those properties you specify.
• limit (number)  The maximum number of webhooks that should be returned. Setting this parameter outside the maximum range will result in an error.
• page (number)  The page number of the result list to retrieve. Use this in tandem with limit to page through the webhooks in a shop.
• since_id (number)  Use this parameter to restrict the returned list to only webhooks whose id is greater than the specified id.
• topic (string)  Show webhooks with a given topic. Valid topics are: orders/create, orders/delete, orders/updated, orders/paid, orders/cancelled, orders/fulfilled, orders/partially_fulfilled, order_transactions/create, carts/create, carts/update, checkouts/create, checkouts/update, checkouts/delete, refunds/create, products/create, products/update, products/delete, collections/create, collections/update, collections/delete, customer_groups/create, customer_groups/update, customer_groups/delete, customers/create, customers/enable, customers/disable, customers/update, customers/delete, fulfillments/create, fulfillments/update, shop/update, disputes/create, disputes/update, app/uninstalled.
• updated_at_min (string)  Use this parameter to retrieve only webhooks that were updated before a given date and time (format: 2008-12-31 03:00).
• updated_at_max (string)  Use this parameter to retrieve only webhooks that were updated after a given date and time (format: 2008-12-31 03:00).

### [getWebhookCount()](#getWebhookCount) Get a count of webhooks

• address (string)  Use this parameter to retrieve only webhooks that possess the URI where the webhook sends the POST request when the event occurs.
• topic (string)  Show webhooks with a given topic. Valid topics are: orders/create, orders/delete, orders/updated, orders/paid, orders/cancelled, orders/fulfilled, orders/partially_fulfilled, order_transactions/create, carts/create, carts/update, checkouts/create, checkouts/update, checkouts/delete, refunds/create, products/create, products/update, products/delete, collections/create, collections/update, collections/delete, customer_groups/create, customer_groups/update, customer_groups/delete, customers/create, customers/enable, customers/disable, customers/update, customers/delete, fulfillments/create, fulfillments/update, shop/update, disputes/create, disputes/update, app/uninstalled.

### [getWebhook()](#getWebhook) Get a single webhook by id

• *id (number)  The ID of the Webhook.
• fields (string)  A comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to showing only those properties you specify.

### [createWebhook()](#createWebhook) Create a new webhook.

• webhook
  • topic (string)  The event that will trigger the webhook. Valid values are: orders/create, orders/delete, orders/updated, orders/paid, orders/cancelled, orders/fulfilled, orders/partially_fulfilled, order_transactions/create, carts/create, carts/update, checkouts/create, checkouts/update, checkouts/delete, refunds/create, products/create, products/update, products/delete, collections/create, collections/update, collections/delete, customer_groups/create, customer_groups/update, customer_groups/delete, customers/create, customers/enable, customers/disable, customers/update, customers/delete, fulfillments/create, fulfillments/update, shop/update, disputes/create, disputes/update, app/uninstalled,
  • address (string)  The URI where the webhook should send the POST request when the event occurs.
  • format (string)  The format in which the webhook should send the data. Valid values are json and xml.
  • metafield_namespaces (string)  (Optional) An array of namespaces for metafields that should be included in webhooks.

### [updateWebhook()](#updateWebhook) Update a new webhook.

• *id (number)  The ID of the webhook.
• webhook
  • id (number)  The ID of the webhook.
  • topic (string)  The event that will trigger the webhook. Valid values are: orders/create, orders/delete, orders/updated, orders/paid, orders/cancelled, orders/fulfilled, orders/partially_fulfilled, order_transactions/create, carts/create, carts/update, checkouts/create, checkouts/update, checkouts/delete, refunds/create, products/create, products/update, products/delete, collections/create, collections/update, collections/delete, customer_groups/create, customer_groups/update, customer_groups/delete, customers/create, customers/enable, customers/disable, customers/update, customers/delete, fulfillments/create, fulfillments/update, shop/update, disputes/create, disputes/update, app/uninstalled,
  • address (string)  The URI where the webhook should send the POST request when the event occurs.
  • format (string)  The format in which the webhook should send the data. Valid values are json and xml.
  • metafield_namespaces (string)  (Optional) An array of namespaces for metafields that should be included in webhooks.

### [deleteWebhook()](#deleteWebhook) Delete a webhook.

• *id (number)  The ID of the webhook.