A Typescript Interface for the Shopify API Node Module
Shopify's official documentation
Typescript type definitions for the Shopify API Node module.
npm i shopify-api-node-interface --save-dev
import {Shopify} from 'shopify-api-node-interface';
const Shopify: Shopify = require('shopify-api-node');
... bingo
Though incomplete, all the listed actions are at least plugged by an "any" type, so there is top-level intellisense.
| Action | Complete | Started | Not started |
|---|---|---|---|
| Product | ✔️ | ||
| Order | ✔️ | ||
| ScriptTag | ✔️ | ||
| AbandonedCheckouts | ✔️ | ||
| ApplicationCharge | ✔️ | ||
| ApplicationCredit | ✔️ | ||
| Article | ✔️ | ||
| Asset | ✔️ | ||
| Blog | ✔️ | ||
| CarrierService | ✔️ | ||
| Checkout | ✔️ | ||
| Collect | ✔️ | ||
| CollectionListing | ✔️ | ||
| Comment | ✔️ | ||
| Country | ✔️ | ||
| CustomCollection | ✔️ | ||
| Customer | ✔️ | ||
| CustomerAddress | ✔️ | ||
| DiscountCode | ✔️ | ||
| DraftOrder | ✔️ | ||
| Event | ✔️ | ||
| Fulfillment | ✔️ | ||
| FulfillmentEvent | ✔️ | ||
| FulfillmentService | ✔️ | ||
| Gift Card | ✔️ | ||
| Location | ✔️ | ||
| Marketing Event | ✔️ | ||
| Metafield | ✔️ | ||
| Multipass | ✔️ | ||
| Order Risks | ✔️ | ||
| Page | ✔️ | ||
| Policy | ✔️ | ||
| PriceRule | ✔️ | ||
| Product Image | ✔️ | ||
| Product Variant | ✔️ | ||
| ProductListing | ✔️ | ||
| Province | ✔️ | ||
| RecurringApplicationCharge | ✔️ | ||
| Redirect | ✔️ | ||
| Refund | ✔️ | ||
| Report | ✔️ | ||
| ResourceFeedback | ✔️ | ||
| ShippingZone | ✔️ | ||
| Shop | ✔️ | ||
| SmartCollection | ✔️ | ||
| Storefront Access Token | ✔️ | ||
| Theme | ✔️ | ||
| Transaction | ✔️ | ||
| UsageCharge | ✔️ | ||
| User (shopify plus) | ✔️ | ||
| Webhook | ✔️ | ||
| ShopifyQL | ✔️ |