Shopify Admin API
API version: 2020-10
Auth
ApiKey token in path
Base URL
Not specified.
Setup
- Set your API key in the appropriate header
- GET /admin/oauth/access_scopes.json -- verify access
- POST /admin/api/2020-01/storefront_access_tokens.json -- create first storefront_access_tokens.json
Endpoints
1473 endpoints across 3 groups. See references/api-spec.lap for full details.
admin
| Method | Path | Description |
|---|---|---|
| GET | /admin/oauth/access_scopes.json | Retrieves a list of access scopes associated to the access token. |
| POST | /admin/api/2020-01/storefront_access_tokens.json | Creates a new storefront access token |
| GET | /admin/api/2020-01/storefront_access_tokens.json | Retrieves a list of storefront access tokens that have been issued |
| DELETE | /admin/api/2020-01/storefront_access_tokens/{storefront_access_token_id}.json | Deletes an existing storefront access token |
| POST | /admin/api/2020-04/storefront_access_tokens.json | Creates a new storefront access token |
| GET | /admin/api/2020-04/storefront_access_tokens.json | Retrieves a list of storefront access tokens that have been issued |
| DELETE | /admin/api/2020-04/storefront_access_tokens/{storefront_access_token_id}.json | Deletes an existing storefront access token |
| POST | /admin/api/2020-07/storefront_access_tokens.json | Creates a new storefront access token |
| GET | /admin/api/2020-07/storefront_access_tokens.json | Retrieves a list of storefront access tokens that have been issued |
| DELETE | /admin/api/2020-07/storefront_access_tokens/{storefront_access_token_id}.json | Deletes an existing storefront access token |
| POST | /admin/api/2020-10/storefront_access_tokens.json | Creates a new storefront access token |
| GET | /admin/api/2020-10/storefront_access_tokens.json | Retrieves a list of storefront access tokens that have been issued |
| DELETE | /admin/api/2020-10/storefront_access_tokens/{storefront_access_token_id}.json | Deletes an existing storefront access token |
| POST | /admin/api/2021-01/storefront_access_tokens.json | Creates a new storefront access token |
| GET | /admin/api/2021-01/storefront_access_tokens.json | Retrieves a list of storefront access tokens that have been issued |
| DELETE | /admin/api/2021-01/storefront_access_tokens/{storefront_access_token_id}.json | Deletes an existing storefront access token |
| POST | /admin/api/unstable/storefront_access_tokens.json | Creates a new storefront access token |
| GET | /admin/api/unstable/storefront_access_tokens.json | Retrieves a list of storefront access tokens that have been issued |
| DELETE | /admin/api/unstable/storefront_access_tokens/{storefront_access_token_id}.json | Deletes an existing storefront access token |
| GET | /admin/api/2020-01/reports.json | Retrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-01/reports.json | Creates a new report |
| GET | /admin/api/2020-01/reports/{report_id}.json | Retrieves a single report created by your app |
| PUT | /admin/api/2020-01/reports/{report_id}.json | Updates a report |
| DELETE | /admin/api/2020-01/reports/{report_id}.json | Deletes a report |
| GET | /admin/api/2020-04/reports.json | Retrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-04/reports.json | Creates a new report |
| GET | /admin/api/2020-04/reports/{report_id}.json | Retrieves a single report created by your app |
| PUT | /admin/api/2020-04/reports/{report_id}.json | Updates a report |
| DELETE | /admin/api/2020-04/reports/{report_id}.json | Deletes a report |
| GET | /admin/api/2020-07/reports.json | Retrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-07/reports.json | Creates a new report |
| GET | /admin/api/2020-07/reports/{report_id}.json | Retrieves a single report created by your app |
| PUT | /admin/api/2020-07/reports/{report_id}.json | Updates a report |
| DELETE | /admin/api/2020-07/reports/{report_id}.json | Deletes a report |
| GET | /admin/api/2020-10/reports.json | Retrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-10/reports.json | Creates a new report |
| GET | /admin/api/2020-10/reports/{report_id}.json | Retrieves a single report created by your app |
| PUT | /admin/api/2020-10/reports/{report_id}.json | Updates a report |
| DELETE | /admin/api/2020-10/reports/{report_id}.json | Deletes a report |
| GET | /admin/api/2021-01/reports.json | Retrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2021-01/reports.json | Creates a new report |
| GET | /admin/api/2021-01/reports/{report_id}.json | Retrieves a single report created by your app |
| PUT | /admin/api/2021-01/reports/{report_id}.json | Updates a report |
| DELETE | /admin/api/2021-01/reports/{report_id}.json | Deletes a report |
| GET | /admin/api/unstable/reports.json | Retrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/unstable/reports.json | Creates a new report |
| GET | /admin/api/unstable/reports/{report_id}.json | Retrieves a single report created by your app |
| PUT | /admin/api/unstable/reports/{report_id}.json | Updates a report |
| DELETE | /admin/api/unstable/reports/{report_id}.json | Deletes a report |
| POST | /admin/api/2020-01/application_charges.json | Creates an application charge |
| GET | /admin/api/2020-01/application_charges.json | Retrieves a list of application charges |
| GET | /admin/api/2020-01/application_charges/{application_charge_id}.json | Retrieves an application charge |
| POST | /admin/api/2020-01/application_charges/{application_charge_id}/activate.json | Caution |
| POST | /admin/api/2020-04/application_charges.json | Creates an application charge |
| GET | /admin/api/2020-04/application_charges.json | Retrieves a list of application charges |
| GET | /admin/api/2020-04/application_charges/{application_charge_id}.json | Retrieves an application charge |
| POST | /admin/api/2020-04/application_charges/{application_charge_id}/activate.json | Caution |
| POST | /admin/api/2020-07/application_charges.json | Creates an application charge |
| GET | /admin/api/2020-07/application_charges.json | Retrieves a list of application charges |
| GET | /admin/api/2020-07/application_charges/{application_charge_id}.json | Retrieves an application charge |
| POST | /admin/api/2020-07/application_charges/{application_charge_id}/activate.json | Caution |
| POST | /admin/api/2020-10/application_charges.json | Creates an application charge |
| GET | /admin/api/2020-10/application_charges.json | Retrieves a list of application charges |
| GET | /admin/api/2020-10/application_charges/{application_charge_id}.json | Retrieves an application charge |
| POST | /admin/api/2020-10/application_charges/{application_charge_id}/activate.json | Caution |
| POST | /admin/api/2021-01/application_charges.json | Creates an application charge |
| GET | /admin/api/2021-01/application_charges.json | Retrieves a list of application charges |
| GET | /admin/api/2021-01/application_charges/{application_charge_id}.json | Retrieves an application charge |
| POST | /admin/api/unstable/application_charges.json | Creates an application charge |
| GET | /admin/api/unstable/application_charges.json | Retrieves a list of application charges |
| GET | /admin/api/unstable/application_charges/{application_charge_id}.json | Retrieves an application charge |
| POST | /admin/api/2020-01/application_credits.json | Creates an application credit |
| GET | /admin/api/2020-01/application_credits.json | Retrieves all application credits |
| GET | /admin/api/2020-01/application_credits/{application_credit_id}.json | Retrieves a single application credit |
| POST | /admin/api/2020-04/application_credits.json | Creates an application credit |
| GET | /admin/api/2020-04/application_credits.json | Retrieves all application credits |
| GET | /admin/api/2020-04/application_credits/{application_credit_id}.json | Retrieves a single application credit |
| POST | /admin/api/2020-07/application_credits.json | Creates an application credit |
| GET | /admin/api/2020-07/application_credits.json | Retrieves all application credits |
| GET | /admin/api/2020-07/application_credits/{application_credit_id}.json | Retrieves a single application credit |
| POST | /admin/api/2020-10/application_credits.json | Creates an application credit |
| GET | /admin/api/2020-10/application_credits.json | Retrieves all application credits |
| GET | /admin/api/2020-10/application_credits/{application_credit_id}.json | Retrieves a single application credit |
| POST | /admin/api/2021-01/application_credits.json | Creates an application credit |
| GET | /admin/api/2021-01/application_credits.json | Retrieves all application credits |
| GET | /admin/api/2021-01/application_credits/{application_credit_id}.json | Retrieves a single application credit |
| POST | /admin/api/unstable/application_credits.json | Creates an application credit |
| GET | /admin/api/unstable/application_credits.json | Retrieves all application credits |
| GET | /admin/api/unstable/application_credits/{application_credit_id}.json | Retrieves a single application credit |
| POST | /admin/api/2020-01/recurring_application_charges.json | Creates a recurring application charge |
| GET | /admin/api/2020-01/recurring_application_charges.json | Retrieves a list of recurring application charges |
| GET | /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}.json | Retrieves a single charge |
| DELETE | /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}.json | Cancels a recurring application charge |
| POST | /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/activate.json | Caution |
| PUT | /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/customize.json | Updates the capped amount of an active recurring application charge |
| POST | /admin/api/2020-04/recurring_application_charges.json | Creates a recurring application charge |
| GET | /admin/api/2020-04/recurring_application_charges.json | Retrieves a list of recurring application charges |
| GET | /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}.json | Retrieves a single charge |
| DELETE | /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}.json | Cancels a recurring application charge |
| POST | /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/activate.json | Caution |
| PUT | /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/customize.json | Updates the capped amount of an active recurring application charge |
| POST | /admin/api/2020-07/recurring_application_charges.json | Creates a recurring application charge |
| GET | /admin/api/2020-07/recurring_application_charges.json | Retrieves a list of recurring application charges |
| GET | /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}.json | Retrieves a single charge |
| DELETE | /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}.json | Cancels a recurring application charge |
| POST | /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/activate.json | Caution |
| PUT | /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/customize.json | Updates the capped amount of an active recurring application charge |
| POST | /admin/api/2020-10/recurring_application_charges.json | Creates a recurring application charge |
| GET | /admin/api/2020-10/recurring_application_charges.json | Retrieves a list of recurring application charges |
| GET | /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}.json | Retrieves a single charge |
| DELETE | /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}.json | Cancels a recurring application charge |
| POST | /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/activate.json | Caution |
| PUT | /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/customize.json | Updates the capped amount of an active recurring application charge |
| POST | /admin/api/2021-01/recurring_application_charges.json | Creates a recurring application charge |
| GET | /admin/api/2021-01/recurring_application_charges.json | Retrieves a list of recurring application charges |
| GET | /admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}.json | Retrieves a single charge |
| DELETE | /admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}.json | Cancels a recurring application charge |
| PUT | /admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/customize.json | Updates the capped amount of an active recurring application charge |
| POST | /admin/api/unstable/recurring_application_charges.json | Creates a recurring application charge |
| GET | /admin/api/unstable/recurring_application_charges.json | Retrieves a list of recurring application charges |
| GET | /admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}.json | Retrieves a single charge |
| DELETE | /admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}.json | Cancels a recurring application charge |
| PUT | /admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/customize.json | Updates the capped amount of an active recurring application charge |
| POST | /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Creates a usage charge |
| GET | /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Retrieves a list of usage charges |
| GET | /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json | Retrieves a single charge |
| POST | /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Creates a usage charge |
| GET | /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Retrieves a list of usage charges |
| GET | /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json | Retrieves a single charge |
| POST | /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Creates a usage charge |
| GET | /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Retrieves a list of usage charges |
| GET | /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json | Retrieves a single charge |
| POST | /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Creates a usage charge |
| GET | /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Retrieves a list of usage charges |
| GET | /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json | Retrieves a single charge |
| POST | /admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Creates a usage charge |
| GET | /admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Retrieves a list of usage charges |
| GET | /admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json | Retrieves a single charge |
| POST | /admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Creates a usage charge |
| GET | /admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json | Retrieves a list of usage charges |
| GET | /admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json | Retrieves a single charge |
| GET | /admin/api/2020-01/customers.json | Retrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-01/customers.json | Creates a customer. |
| GET | /admin/api/2020-01/customers/search.json | Searches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| GET | /admin/api/2020-01/customers/{customer_id}.json | Retrieves a single customer. |
| PUT | /admin/api/2020-01/customers/{customer_id}.json | Updates a customer. |
| DELETE | /admin/api/2020-01/customers/{customer_id}.json | Deletes a customer. A customer can't be deleted if they have existing orders. |
| POST | /admin/api/2020-01/customers/{customer_id}/account_activation_url.json | Generate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. |
| POST | /admin/api/2020-01/customers/{customer_id}/send_invite.json | Sends an account invite to a customer. |
| GET | /admin/api/2020-01/customers/count.json | Retrieves a count of all customers. |
| GET | /admin/api/2020-01/customers/{customer_id}/orders.json | Retrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint. |
| GET | /admin/api/2020-04/customers.json | Retrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-04/customers.json | Creates a customer. |
| GET | /admin/api/2020-04/customers/search.json | Searches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| GET | /admin/api/2020-04/customers/{customer_id}.json | Retrieves a single customer. |
| PUT | /admin/api/2020-04/customers/{customer_id}.json | Updates a customer. |
| DELETE | /admin/api/2020-04/customers/{customer_id}.json | Deletes a customer. A customer can't be deleted if they have existing orders. |
| POST | /admin/api/2020-04/customers/{customer_id}/account_activation_url.json | Generate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. |
| POST | /admin/api/2020-04/customers/{customer_id}/send_invite.json | Sends an account invite to a customer. |
| GET | /admin/api/2020-04/customers/count.json | Retrieves a count of all customers. |
| GET | /admin/api/2020-04/customers/{customer_id}/orders.json | Retrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint. |
| GET | /admin/api/2020-07/customers.json | Retrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-07/customers.json | Creates a customer. |
| GET | /admin/api/2020-07/customers/search.json | Searches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| GET | /admin/api/2020-07/customers/{customer_id}.json | Retrieves a single customer. |
| PUT | /admin/api/2020-07/customers/{customer_id}.json | Updates a customer. |
| DELETE | /admin/api/2020-07/customers/{customer_id}.json | Deletes a customer. A customer can't be deleted if they have existing orders. |
| POST | /admin/api/2020-07/customers/{customer_id}/account_activation_url.json | Generate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. |
| POST | /admin/api/2020-07/customers/{customer_id}/send_invite.json | Sends an account invite to a customer. |
| GET | /admin/api/2020-07/customers/count.json | Retrieves a count of all customers. |
| GET | /admin/api/2020-07/customers/{customer_id}/orders.json | Retrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint. |
| GET | /admin/api/2020-10/customers.json | Retrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-10/customers.json | Creates a customer. |
| GET | /admin/api/2020-10/customers/search.json | Searches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| GET | /admin/api/2020-10/customers/{customer_id}.json | Retrieves a single customer. |
| PUT | /admin/api/2020-10/customers/{customer_id}.json | Updates a customer. |
| DELETE | /admin/api/2020-10/customers/{customer_id}.json | Deletes a customer. A customer can't be deleted if they have existing orders. |
| POST | /admin/api/2020-10/customers/{customer_id}/account_activation_url.json | Generate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. |
| POST | /admin/api/2020-10/customers/{customer_id}/send_invite.json | Sends an account invite to a customer. |
| GET | /admin/api/2020-10/customers/count.json | Retrieves a count of all customers. |
| GET | /admin/api/2020-10/customers/{customer_id}/orders.json | Retrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint. |
| GET | /admin/api/2021-01/customers.json | Retrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2021-01/customers.json | Creates a customer. |
| GET | /admin/api/2021-01/customers/search.json | Searches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| GET | /admin/api/2021-01/customers/{customer_id}.json | Retrieves a single customer. |
| PUT | /admin/api/2021-01/customers/{customer_id}.json | Updates a customer. |
| DELETE | /admin/api/2021-01/customers/{customer_id}.json | Deletes a customer. A customer can't be deleted if they have existing orders. |
| POST | /admin/api/2021-01/customers/{customer_id}/account_activation_url.json | Generate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. |
| POST | /admin/api/2021-01/customers/{customer_id}/send_invite.json | Sends an account invite to a customer. |
| GET | /admin/api/2021-01/customers/count.json | Retrieves a count of all customers. |
| GET | /admin/api/2021-01/customers/{customer_id}/orders.json | Retrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint. |
| GET | /admin/api/unstable/customers.json | Retrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/unstable/customers.json | Creates a customer. |
| GET | /admin/api/unstable/customers/search.json | Searches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| GET | /admin/api/unstable/customers/{customer_id}.json | Retrieves a single customer. |
| PUT | /admin/api/unstable/customers/{customer_id}.json | Updates a customer. |
| DELETE | /admin/api/unstable/customers/{customer_id}.json | Deletes a customer. A customer can't be deleted if they have existing orders. |
| POST | /admin/api/unstable/customers/{customer_id}/account_activation_url.json | Generate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. |
| POST | /admin/api/unstable/customers/{customer_id}/send_invite.json | Sends an account invite to a customer. |
| GET | /admin/api/unstable/customers/count.json | Retrieves a count of all customers. |
| GET | /admin/api/unstable/customers/{customer_id}/orders.json | Retrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint. |
| GET | /admin/api/2020-01/customers/{customer_id}/addresses.json | Retrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-01/customers/{customer_id}/addresses.json | Creates a new address for a customer. |
| GET | /admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json | Retrieves details a single customer address. |
| PUT | /admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json | Updates an existing customer address. |
| DELETE | /admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json | Removes an address from a customer’s address list. |
| PUT | /admin/api/2020-01/customers/{customer_id}/addresses/set.json | Performs bulk operations for multiple customer addresses. |
| PUT | /admin/api/2020-01/customers/{customer_id}/addresses/{address_id}/default.json | Sets the default address for a customer. |
| GET | /admin/api/2020-04/customers/{customer_id}/addresses.json | Retrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-04/customers/{customer_id}/addresses.json | Creates a new address for a customer. |
| GET | /admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json | Retrieves details a single customer address. |
| PUT | /admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json | Updates an existing customer address. |
| DELETE | /admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json | Removes an address from a customer’s address list. |
| PUT | /admin/api/2020-04/customers/{customer_id}/addresses/set.json | Performs bulk operations for multiple customer addresses. |
| PUT | /admin/api/2020-04/customers/{customer_id}/addresses/{address_id}/default.json | Sets the default address for a customer. |
| GET | /admin/api/2020-07/customers/{customer_id}/addresses.json | Retrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-07/customers/{customer_id}/addresses.json | Creates a new address for a customer. |
| GET | /admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json | Retrieves details a single customer address. |
| PUT | /admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json | Updates an existing customer address. |
| DELETE | /admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json | Removes an address from a customer’s address list. |
| PUT | /admin/api/2020-07/customers/{customer_id}/addresses/set.json | Performs bulk operations for multiple customer addresses. |
| PUT | /admin/api/2020-07/customers/{customer_id}/addresses/{address_id}/default.json | Sets the default address for a customer. |
| GET | /admin/api/2020-10/customers/{customer_id}/addresses.json | Retrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-10/customers/{customer_id}/addresses.json | Creates a new address for a customer. |
| GET | /admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json | Retrieves details a single customer address. |
| PUT | /admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json | Updates an existing customer address. |
| DELETE | /admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json | Removes an address from a customer’s address list. |
| PUT | /admin/api/2020-10/customers/{customer_id}/addresses/set.json | Performs bulk operations for multiple customer addresses. |
| PUT | /admin/api/2020-10/customers/{customer_id}/addresses/{address_id}/default.json | Sets the default address for a customer. |
| GET | /admin/api/2021-01/customers/{customer_id}/addresses.json | Retrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2021-01/customers/{customer_id}/addresses.json | Creates a new address for a customer. |
| GET | /admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json | Retrieves details a single customer address. |
| PUT | /admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json | Updates an existing customer address. |
| DELETE | /admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json | Removes an address from a customer’s address list. |
| PUT | /admin/api/2021-01/customers/{customer_id}/addresses/set.json | Performs bulk operations for multiple customer addresses. |
| PUT | /admin/api/2021-01/customers/{customer_id}/addresses/{address_id}/default.json | Sets the default address for a customer. |
| GET | /admin/api/unstable/customers/{customer_id}/addresses.json | Retrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/unstable/customers/{customer_id}/addresses.json | Creates a new address for a customer. |
| GET | /admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json | Retrieves details a single customer address. |
| PUT | /admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json | Updates an existing customer address. |
| DELETE | /admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json | Removes an address from a customer’s address list. |
| PUT | /admin/api/unstable/customers/{customer_id}/addresses/set.json | Performs bulk operations for multiple customer addresses. |
| PUT | /admin/api/unstable/customers/{customer_id}/addresses/{address_id}/default.json | Sets the default address for a customer. |
| GET | /admin/api/2020-01/customer_saved_searches.json | Retrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-01/customer_saved_searches.json | Creates a customer saved search. |
| GET | /admin/api/2020-01/customer_saved_searches/count.json | Retrieves a count of all customer saved searches. |
| GET | /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json | Retrieves a single customer saved search. |
| PUT | /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json | Updates a customer saved search. |
| DELETE | /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json | Deletes a customer saved search. |
| GET | /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}/customers.json | Retrieves all customers returned by a customer saved search. |
| GET | /admin/api/2020-04/customer_saved_searches.json | Retrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-04/customer_saved_searches.json | Creates a customer saved search. |
| GET | /admin/api/2020-04/customer_saved_searches/count.json | Retrieves a count of all customer saved searches. |
| GET | /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json | Retrieves a single customer saved search. |
| PUT | /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json | Updates a customer saved search. |
| DELETE | /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json | Deletes a customer saved search. |
| GET | /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}/customers.json | Retrieves all customers returned by a customer saved search. |
| GET | /admin/api/2020-07/customer_saved_searches.json | Retrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-07/customer_saved_searches.json | Creates a customer saved search. |
| GET | /admin/api/2020-07/customer_saved_searches/count.json | Retrieves a count of all customer saved searches. |
| GET | /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json | Retrieves a single customer saved search. |
| PUT | /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json | Updates a customer saved search. |
| DELETE | /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json | Deletes a customer saved search. |
| GET | /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}/customers.json | Retrieves all customers returned by a customer saved search. |
| GET | /admin/api/2020-10/customer_saved_searches.json | Retrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. |
| POST | /admin/api/2020-10/customer_saved_searches.json | Creates a customer saved search. |
| GET | /admin/api/2020-10/customer_saved_searches/count.json | Retrieves a count of all customer saved searches. |
| GET | /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json | Retrieves a single customer saved search. |
| PUT | /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json | Updates a customer saved search. |
| DELETE | /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json | Deletes a customer saved search. |
| GET | /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}/customers.json | Retrieves all customers returned by a customer saved search. |
| GET | /admin/api/2021-01/customer_saved_searches.json | Retrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by u |
…(truncated)