# Shopify Custom API Library
A custom Shopify API library that make shopify api call more easy.
## Table of Contents
- [Shopify Custom API Library](#shopify-custom-api-library)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Installation](#installation)
- [Getting started](#getting-started)
- [setup](#setup)
- [option](#option)
- [get](#get)
- [post](#post)
- [put](#put)
- [delete](#delete)
## Features
- Easy authentication with Shopify.
- Simplified methods for common API operations.
- Support for additional Shopify API endpoints not covered by the official library.
## Installation
To install the package, you can use `pip`:
```sh
pip install -U shopify_custom_api
```
## Getting started
- Generate access token for your store by following instruction
(https://help.plytix.com/en/getting-api-credentials-from-your-shopify-store)
- checkout shopify api document
(https://shopify.dev/docs/api/admin-rest)
### setup
```py
from cshopify import API
shop = API(store_url='STORE_NAME', access_token='shpat_xxxxxxxxxxxxxxxxxxxxxxx', api_version='2024-01')
```
### option
|parameter|description|
|----|------------------|
|data| JSON format data |
|endpoint| Resource type that need to be processed |
|params| Additional parameters for query |
#### get
```py
.get(endpoint, params)
```
#### post
```py
.post(endpoint, data)
```
#### put
```py
.put(endpoint, data)
```
#### delete
```py
.delete(endpoint)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/bachnguyen2001/shopify_custom_api.git",
"name": "shopify-custom-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "shopify rest api",
"author": "Nguyen Ngoc Bach",
"author_email": "bachnguyenfptu@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/df/d7/7c09c3f956fd488b5e5882486b9e3e494675ff3bae45cffa926c79903016/shopify_custom_api-0.1.3.tar.gz",
"platform": null,
"description": "# Shopify Custom API Library\n\nA custom Shopify API library that make shopify api call more easy.\n\n## Table of Contents\n\n- [Shopify Custom API Library](#shopify-custom-api-library)\n - [Table of Contents](#table-of-contents)\n - [Features](#features)\n - [Installation](#installation)\n - [Getting started](#getting-started)\n - [setup](#setup)\n - [option](#option)\n - [get](#get)\n - [post](#post)\n - [put](#put)\n - [delete](#delete)\n## Features\n\n- Easy authentication with Shopify.\n- Simplified methods for common API operations.\n- Support for additional Shopify API endpoints not covered by the official library.\n\n## Installation\n\nTo install the package, you can use `pip`:\n\n```sh\npip install -U shopify_custom_api\n```\n## Getting started\n- Generate access token for your store by following instruction\n (https://help.plytix.com/en/getting-api-credentials-from-your-shopify-store)\n\n- checkout shopify api document\n (https://shopify.dev/docs/api/admin-rest)\n\n### setup\n```py\nfrom cshopify import API\n\nshop = API(store_url='STORE_NAME', access_token='shpat_xxxxxxxxxxxxxxxxxxxxxxx', api_version='2024-01')\n```\n\n### option \n|parameter|description|\n|----|------------------|\n|data| JSON format data |\n|endpoint| Resource type that need to be processed |\n|params| Additional parameters for query |\n#### get\n```py\n.get(endpoint, params)\n```\n#### post\n```py\n.post(endpoint, data)\n```\n#### put\n```py\n.put(endpoint, data)\n```\n#### delete\n```py\n.delete(endpoint)\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple library that helps call Shopify's API",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/bachnguyen2001/shopify_custom_api.git"
},
"split_keywords": [
"shopify",
"rest",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b44845f0eec298a21bd07f74843633feca705c38487198c683080dda243c05a",
"md5": "6cb6c58f76026a0c25d8ac0268f481f6",
"sha256": "936f511446d0680a29ade45ef71d27c811db0f665d87d329193e7c22fa4f8e50"
},
"downloads": -1,
"filename": "shopify_custom_api-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6cb6c58f76026a0c25d8ac0268f481f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3699,
"upload_time": "2024-05-28T02:39:21",
"upload_time_iso_8601": "2024-05-28T02:39:21.836308Z",
"url": "https://files.pythonhosted.org/packages/7b/44/845f0eec298a21bd07f74843633feca705c38487198c683080dda243c05a/shopify_custom_api-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dfd77c09c3f956fd488b5e5882486b9e3e494675ff3bae45cffa926c79903016",
"md5": "ac1133329fb9806fc6b9c19fd7150172",
"sha256": "2b8b0d6092eddd66f762aa596b1dd85e409ffdd8983fb5acc82d551190a76999"
},
"downloads": -1,
"filename": "shopify_custom_api-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "ac1133329fb9806fc6b9c19fd7150172",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3281,
"upload_time": "2024-05-28T02:39:23",
"upload_time_iso_8601": "2024-05-28T02:39:23.354121Z",
"url": "https://files.pythonhosted.org/packages/df/d7/7c09c3f956fd488b5e5882486b9e3e494675ff3bae45cffa926c79903016/shopify_custom_api-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-28 02:39:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bachnguyen2001",
"github_project": "shopify_custom_api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "shopify-custom-api"
}
JSON
