shopify-api-types
Version:
typings for Shopify Admin API
184 lines • 7.55 kB
TypeScript
export * from './access';
export * from './analytics';
export * from './customers';
export * from './billing';
export * from './metafield';
export declare const APIVersion = "2021-01";
export declare const Routes: {
/**
* Route for:
* - GET `/admin/oauth/access_scopes.json`
*
* @remarks This route should NOT be ran through the buildRoute function.
*/
accessScopes(): "/admin/oauth/access_scopes.json";
/**
* Route for:
* - GET `/storefront_access_tokens.json`
* - POST `/storefront_access_tokens.json`
*/
storefrontAccessTokens(): "/storefront_access_tokens.json";
/**
* Route for:
* - DELETE `/storefront_access_tokens/{storefront_access_token.id}.json `
*/
storefrontAccessToken(storefrontAccessTokenId: number): `/storefront_access_tokens/${number}.json`;
/**
* Route for:
* - GET `/reports.json`
* - POST `/reports.json`
*/
reports(): "/reports.json";
/**
* Route for:
* - GET `/reports/{report.id}.json`
* - PUT `/reports/{report.id}.json`
* - DELETE `/reports/{report.id}.json`
*/
report(reportId: number): `/reports/${number}.json`;
/**
* Route for:
* - GET `/recurring_application_charges.json`
* - POST `/recurring_application_charges.json`
*/
recurringApplicationCharges(): "/recurring_application_charges.json";
/**
* Route for:
* - GET `/recurring_application_charges/{recurring_application_charge.id}.json`
* - DELETE `/recurring_application_charges/{recurring_application_charge.id}.json`
*/
recurringApplicationCharge(recurringApplicationChargeId: number): `/recurring_application_charges/${number}.json`;
/**
* Route for:
* - PUT `/recurring_application_charges/{recurring_application_charge.id}/customize.json`
*/
customizeRecurringApplicationCharge(recurringApplicationChargeId: number): `/recurring_application_charges/${number}/customize.json`;
/**
* Route for:
* - GET `/recurring_application_charges/{recurring_application_charge.id}/usage_charges.json`
* - POST `/recurring_application_charges/{recurring_application_charge.id}/usage_charges.json`
*/
usageCharges(recurringApplicationChargeId: number): `/recurring_application_charges/${number}/usage_charges.json`;
/**
* Route for:
* - GET `/recurring_application_charges/{recurring_application_charge.id}/usage_charges/{usage_charge.id}.json`
*/
usageCharge(recurringApplicationChargeId: number, usageChargeId: number): `/recurring_application_charges/${number}/usage_charges/${number}.json`;
/**
* Route for:
* - GET `/admin/api/2020-04/metafields.json`
* - POST `/admin/api/2020-04/metafields.json`
*/
metafields(): "/admin/api/2020-04/metafields.json";
/**
* Route for:
* - GET `/admin/api/2020-04/metafields/{metafield.id}.json`
* - PUT `/admin/api/2020-04/metafields/{metafield.id}.json`
* - DELETE `/admin/api/2020-04/metafields/{metafield.id}.json`
*/
metafield(metafieldId: number): `/admin/api/2020-04/metafields/${number}.json`;
/**
* Route for:
* - GET `/admin/api/2020-04/metafields/count.json`
*/
metafieldCount(): "/admin/api/2020-04/metafields/count.json";
/**
* Route for:
* - GET `/admin/api/2020-04/metafields.json?metafield[owner_id]={owner.id}&metafield[owner.resource]={owner.resouce}
*/
productImageMetafields(ownerId: number, ownerResource: string): `/admin/api/2020-04/metafields.json?metafield[owner_id]=${number}&metafield[owner.resource]=${string}`;
/**
* Route for:
* - GET `/admin/api/2020-04/customers.json`
* - POST `/admin/api/2020-04/customers.json`
*/
customers(): "/admin/api/2020-04/customers.json";
/**
* Route for:
* - GET `/admin/api/2020-04/customers/{customer.id}.json`
* - PUT `/admin/api/2020-04/customers/{customer.id}.json`
* - DELETE `/admin/api/2020-04/customers/{customer.id}.json`
*/
customer(customerId: number): `/admin/api/2020-04/customers/${number}.json`;
/**
* Route for:
* - GET `/admin/api/2020-04/customers/search.json`
*/
customerSearch(): "/admin/api/2020-04/customers/search.json";
/**
* Route for:
* - POST `/admin/api/2020-04/customers/{customer.id}/account_activation_url.json`
*/
customerAccountActivationUrl(customerId: number): `/admin/api/2020-04/customers/${number}/account_activation_url.json`;
/**
* Route for:
* - POST `/admin/api/2020-04/customers/{customer.id}/send_invite.json`
*/
customerSendInvite(customerId: number): `/admin/api/2020-04/customers/${number}/send_invite.json`;
/**
* Route for:
*
* - GET `/admin/api/2020-04/customers/count.json`
*/
customerCount(): "/admin/api/2020-04/customers/count.json";
/**
* Route for:
*
* - GET `/admin/api/2020-04/customers/{customer_id}/orders.json`
*/
customerOrders(customerId: number): `/admin/api/2020-04/customers/${number}/orders.json`;
/**
* Route for:
*
* - GET `/admin/api/2020-04/customers/{customer.id}/addresses.json`
* - POST `/admin/api/2020-04/customers/{customer.id}/addresses.json`
*/
customerAddresses(customerId: number): `/admin/api/2020-04/customers/${number}/addresses.json`;
/**
* Route for:
*
* - GET `/admin/api/2020-04/customers/{customer.id}/addresses/{address.id}.json`
* - PUT `/admin/api/2020-04/customers/{customer.id}/addresses/{address.id}.json`
* - DELETE `/admin/api/2020-04/customers/{customer.id}/addresses/{address.id}.json`
*/
customerAddress(customerId: number, addressId: number): `/admin/api/2020-04/customers/${number}/addresses/${number}.json`;
/**
* Route for:
* - PUT `/admin/api/2020-04/customers/{customer.id}/addresses/set.json`
*/
setCustomerAddresses(customerId: number): `/admin/api/2020-04/customers/${number}/addresses/set.json`;
/**
* Route for:
*
* - PUT `/admin/api/2020-04/customers/{customer.id}/addresses/{address.id}/default.json`
*/
setDefaultCustomerAddress(customerId: number, addressId: number): `/admin/api/2020-04/customers/${number}/addresses/${number}/default.json`;
/**
* Route for:
*
* - GET `/admin/api/2020-04/customer_saved_searches.json`
* - POST `/admin/api/2020-04/customer_saved_searches.json`
*/
customerSavedSearches(): "/admin/api/2020-04/customer_saved_searches.json";
/**
* Route for:
*
* - GET `/admin/api/2020-04/customer_saved_searches/count.json`
*/
customerSavedSearchesCount(): "/admin/api/2020-04/customer_saved_searches/count.json";
/**
* Route for:
*
* - GET `/admin/api/2020-04/customer_saved_searches/{customer_saved_search.id}.json`
* - PUT `/admin/api/2020-04/customer_saved_searches/{customer_saved_search.id}.json`
* - DELETE `/admin/api/2020-04/customer_saved_searches/{customer_saved_search.id}.json`
*/
customerSavedSearch(customerSavedSearchId: number): `/admin/api/2020-04/customer_saved_searches/${number}.json`;
/**
* Route for:
*
* - GET `/admin/api/2020-04/customer_saved_searches/{customer_saved_search.id}/customers.json`
*/
customerSavedSearchCustomers(customerSavedSearchId: number): `/admin/api/2020-04/customer_saved_searches/${number}/customers.json`;
};
//# sourceMappingURL=index.d.ts.map