{"id":21525842,"url":"https://github.com/bkwld/shopify-admin-api-typings","last_synced_at":"2025-03-17T18:19:58.381Z","repository":{"id":232209181,"uuid":"771838667","full_name":"BKWLD/shopify-admin-api-typings","owner":"BKWLD","description":"Typings for shopify admin API","archived":false,"fork":false,"pushed_at":"2024-03-15T21:21:57.000Z","size":655,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-05T10:02:05.643Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BKWLD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-14T03:28:25.000Z","updated_at":"2024-03-14T03:29:23.000Z","dependencies_parsed_at":"2024-04-08T17:01:55.321Z","dependency_job_id":null,"html_url":"https://github.com/BKWLD/shopify-admin-api-typings","commit_stats":null,"previous_names":["bkwld/shopify-admin-api-typings"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BKWLD%2Fshopify-admin-api-typings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BKWLD%2Fshopify-admin-api-typings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BKWLD%2Fshopify-admin-api-typings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BKWLD%2Fshopify-admin-api-typings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BKWLD","download_url":"https://codeload.github.com/BKWLD/shopify-admin-api-typings/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244085008,"owners_count":20395523,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T01:38:39.724Z","updated_at":"2025-03-17T18:19:58.359Z","avatar_url":"https://github.com/BKWLD.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shopify Admin API Types\n\n![Dependencies](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)\n![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange.svg)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\n## Overview\n\nAuto-generated Typescript type definitions for **Shopify Admin API**. Current version includes all types for version: `2020-04`.\n\nIf you're looking for typings for **Shopify Storefront Api**, checkout the [shopify-storefront-api-typings](https://www.npmjs.com/package/shopify-storefront-api-typings) package.\n\n![types](https://user-images.githubusercontent.com/1438153/72280575-eb2ec200-3638-11ea-9609-4196400219f5.jpg)\n\n## How to use\n\n1. Install package: `npm i -S shopify-admin-api-typings`\n2. Import typings in your code. (vscode should find the typings and auto import for you).\n\n```js\nimport { Order, OrderConnection } from \"shopify-admin-api-typings\";\n```\n\nHere is how you can get strongly typed queries with apollo:\n\n```ts\nconst QUERY_ORDERS = gql`\n  query Orders {\n    orders(first: 5) {\n      edges {\n        node {\n          createdAt\n        }\n      }\n    }\n  }\n`;\n\nconst {\n  data: { orders },\n} = await client.query\u003c{ orders: OrderConnection }\u003e({\n  query: QUERY_ORDERS,\n});\n```\n\nUse the `Partial\u003c\u003e` utility if you want to create subsets of the type without getting type errors.\n\n```js\nconst variant: Partial\u003cOrder\u003e = { name: \"#001\" };\n```\n\n## Build your own typings\n\nIf you want to customise the namings or the Admin API version you can build your own typings. To do that, you need to create a Private app with Admin API enabled.\n\n1. Clone this repository\n\n```sh\ngit clone https://github.com/caki0915/shopify-admin-api-typings.git\n```\n\n2. Rename `.env.example` to `.env`.\n3. Inside `.env` add your Shopify Admin API endpoint and access-token.\n4. Run `npm start`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbkwld%2Fshopify-admin-api-typings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbkwld%2Fshopify-admin-api-typings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbkwld%2Fshopify-admin-api-typings/lists"}