Module 2021/01

Type declaration

• accessScopes:function

  • accessScopes(): "/admin/oauth/access_scopes.json"

  • Route for:

    • GET /admin/oauth/access_scopes.json

    remarks

    This route should NOT be ran through the buildRoute function.

    Returns "/admin/oauth/access_scopes.json"

• customer:function

  • customer(customerId: number): `/admin/api/2020-04/customers/${number}.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

    Parameters

    • customerId: number

    Returns `/admin/api/2020-04/customers/${number}.json`

• customerAccountActivationUrl:function

  • customerAccountActivationUrl(customerId: number): `/admin/api/2020-04/customers/${number}/account_activation_url.json`

  • Route for:

    • POST /admin/api/2020-04/customers/{customer.id}/account_activation_url.json

    Parameters

    • customerId: number

    Returns `/admin/api/2020-04/customers/${number}/account_activation_url.json`

• customerAddress:function

  • customerAddress(customerId: number, addressId: number): `/admin/api/2020-04/customers/${number}/addresses/${number}.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

    Parameters

    • customerId: number

    • addressId: number

    Returns `/admin/api/2020-04/customers/${number}/addresses/${number}.json`

• customerAddresses:function

  • customerAddresses(customerId: number): `/admin/api/2020-04/customers/${number}/addresses.json`

  • Route for:

    • GET /admin/api/2020-04/customers/{customer.id}/addresses.json
    • POST /admin/api/2020-04/customers/{customer.id}/addresses.json

    Parameters

    • customerId: number

    Returns `/admin/api/2020-04/customers/${number}/addresses.json`

• customerCount:function

  • customerCount(): "/admin/api/2020-04/customers/count.json"

  • Route for:

    • GET /admin/api/2020-04/customers/count.json

    Returns "/admin/api/2020-04/customers/count.json"

• customerOrders:function

  • customerOrders(customerId: number): `/admin/api/2020-04/customers/${number}/orders.json`

  • Route for:

    • GET /admin/api/2020-04/customers/{customer_id}/orders.json

    Parameters

    • customerId: number

    Returns `/admin/api/2020-04/customers/${number}/orders.json`

• customerSavedSearch:function

  • 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}.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

    Parameters

    • customerSavedSearchId: number

    Returns `/admin/api/2020-04/customer_saved_searches/${number}.json`

• customerSavedSearchCustomers:function

  • customerSavedSearchCustomers(customerSavedSearchId: number): `/admin/api/2020-04/customer_saved_searches/${number}/customers.json`

  • Route for:

    • GET /admin/api/2020-04/customer_saved_searches/{customer_saved_search.id}/customers.json

    Parameters

    • customerSavedSearchId: number

    Returns `/admin/api/2020-04/customer_saved_searches/${number}/customers.json`

• customerSavedSearches:function

  • customerSavedSearches(): "/admin/api/2020-04/customer_saved_searches.json"

  • Route for:

    • GET /admin/api/2020-04/customer_saved_searches.json
    • POST /admin/api/2020-04/customer_saved_searches.json

    Returns "/admin/api/2020-04/customer_saved_searches.json"

• customerSavedSearchesCount:function

  • customerSavedSearchesCount(): "/admin/api/2020-04/customer_saved_searches/count.json"

  • Route for:

    • GET /admin/api/2020-04/customer_saved_searches/count.json

    Returns "/admin/api/2020-04/customer_saved_searches/count.json"

• customerSearch:function

  • customerSearch(): "/admin/api/2020-04/customers/search.json"

  • Route for:

    • GET /admin/api/2020-04/customers/search.json

    Returns "/admin/api/2020-04/customers/search.json"

• customerSendInvite:function

  • customerSendInvite(customerId: number): `/admin/api/2020-04/customers/${number}/send_invite.json`

  • Route for:

    • POST /admin/api/2020-04/customers/{customer.id}/send_invite.json

    Parameters

    • customerId: number

    Returns `/admin/api/2020-04/customers/${number}/send_invite.json`

• customers:function

  • customers(): "/admin/api/2020-04/customers.json"

  • Route for:

    • GET /admin/api/2020-04/customers.json
    • POST /admin/api/2020-04/customers.json

    Returns "/admin/api/2020-04/customers.json"

• customizeRecurringApplicationCharge:function

  • customizeRecurringApplicationCharge(recurringApplicationChargeId: number): `/recurring_application_charges/${number}/customize.json`

  • Route for:

    • PUT /recurring_application_charges/{recurring_application_charge.id}/customize.json

    Parameters

    • recurringApplicationChargeId: number

    Returns `/recurring_application_charges/${number}/customize.json`

• metafield:function

  • metafield(metafieldId: number): `/admin/api/2020-04/metafields/${number}.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

    Parameters

    • metafieldId: number

    Returns `/admin/api/2020-04/metafields/${number}.json`

• metafieldCount:function

  • metafieldCount(): "/admin/api/2020-04/metafields/count.json"

  • Route for:

    • GET /admin/api/2020-04/metafields/count.json

    Returns "/admin/api/2020-04/metafields/count.json"

• metafields:function

  • metafields(): "/admin/api/2020-04/metafields.json"

  • Route for:

    • GET /admin/api/2020-04/metafields.json
    • POST /admin/api/2020-04/metafields.json

    Returns "/admin/api/2020-04/metafields.json"

• productImageMetafields:function

  • 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/metafields.json?metafield[owner_id]={owner.id}&metafield[owner.resource]={owner.resouce}

    Parameters

    • ownerId: number

    • ownerResource: string

    Returns `/admin/api/2020-04/metafields.json?metafield[owner_id]=${number}&metafield[owner.resource]=${string}`

• recurringApplicationCharge:function

  • recurringApplicationCharge(recurringApplicationChargeId: number): `/recurring_application_charges/${number}.json`

  • Route for:

    • GET /recurring_application_charges/{recurring_application_charge.id}.json
    • DELETE /recurring_application_charges/{recurring_application_charge.id}.json

    Parameters

    • recurringApplicationChargeId: number

    Returns `/recurring_application_charges/${number}.json`

• recurringApplicationCharges:function

  • recurringApplicationCharges(): "/recurring_application_charges.json"

  • Route for:

    • GET /recurring_application_charges.json
    • POST /recurring_application_charges.json

    Returns "/recurring_application_charges.json"

• report:function

  • report(reportId: number): `/reports/${number}.json`

  • Route for:

    • GET /reports/{report.id}.json
    • PUT /reports/{report.id}.json
    • DELETE /reports/{report.id}.json

    Parameters

    • reportId: number

    Returns `/reports/${number}.json`

• reports:function

  • reports(): "/reports.json"

  • Route for:

    • GET /reports.json
    • POST /reports.json

    Returns "/reports.json"

• setCustomerAddresses:function

  • setCustomerAddresses(customerId: number): `/admin/api/2020-04/customers/${number}/addresses/set.json`

  • Route for:

    • PUT /admin/api/2020-04/customers/{customer.id}/addresses/set.json

    Parameters

    • customerId: number

    Returns `/admin/api/2020-04/customers/${number}/addresses/set.json`

• setDefaultCustomerAddress:function

  • setDefaultCustomerAddress(customerId: number, addressId: number): `/admin/api/2020-04/customers/${number}/addresses/${number}/default.json`

  • Route for:

    • PUT /admin/api/2020-04/customers/{customer.id}/addresses/{address.id}/default.json

    Parameters

    • customerId: number

    • addressId: number

    Returns `/admin/api/2020-04/customers/${number}/addresses/${number}/default.json`

• storefrontAccessToken:function

  • storefrontAccessToken(storefrontAccessTokenId: number): `/storefront_access_tokens/${number}.json`

  • Route for:

    • DELETE /storefront_access_tokens/{storefront_access_token.id}.json

    Parameters

    • storefrontAccessTokenId: number

    Returns `/storefront_access_tokens/${number}.json`

• storefrontAccessTokens:function

  • storefrontAccessTokens(): "/storefront_access_tokens.json"

  • Route for:

    • GET /storefront_access_tokens.json
    • POST /storefront_access_tokens.json

    Returns "/storefront_access_tokens.json"

• usageCharge:function

  • usageCharge(recurringApplicationChargeId: number, usageChargeId: number): `/recurring_application_charges/${number}/usage_charges/${number}.json`

  • Route for:

    • GET /recurring_application_charges/{recurring_application_charge.id}/usage_charges/{usage_charge.id}.json

    Parameters

    • recurringApplicationChargeId: number

    • usageChargeId: number

    Returns `/recurring_application_charges/${number}/usage_charges/${number}.json`

• usageCharges:function

  • usageCharges(recurringApplicationChargeId: number): `/recurring_application_charges/${number}/usage_charges.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

    Parameters

    • recurringApplicationChargeId: number

    Returns `/recurring_application_charges/${number}/usage_charges.json`