Skip to main content

Endpoints and Requests

Admin API endpoints are organized by resource type. You’ll need to use different endpoints depending on your app’s requirements.

All Admin REST API endpoints follow this pattern:

https://{store_domain}/api/v3/admin/{resource}

Request types

The Admin REST API supports the following request types:

  • GET: Retrieves resources.
  • POST: Creates resources.
  • PUT: Updates resources.
  • DELETE: Deletes resources.

Request parameters

The Admin REST API supports the following request parameters:

  • limit: Limits the number of resources in the response. The default value is 50.
  • sort: Sorts the resources in the response. The default value is id:asc.
  • filter: Filters the resources in the response. For example, filter[id]=1,2,3&filter[name]=John.
  • include: Includes related resources in the response. For example, include=variants.

Request headers

The Admin REST API supports the following request headers:

  • Accept: Specifies the response format.
  • Content-Type: Specifies the request format.
  • Authorization: Specifies the authentication method and token.

Request body

The Admin REST API supports the following request body formats:

  • JSON: The request body is a JSON object.
  • Form: The request body is a form.