---
displayed_sidebar: jsClientSidebar
slug: /references/js-client/Admin
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# Admin

This class includes properties used to send requests to the [Admin API Routes](https://docs.medusajs.com/api/admin). All its properties
are available in the JS Client under the `medusa.admin` property.

## Properties

<ParameterTypes parameters={[
  {
    "name": "auth",
    "type": "[AdminAuthResource](js_client.AdminAuthResource.mdx)",
    "description": "An instance of [AdminAuthResource](js_client.AdminAuthResource.mdx) used to send requests to [Admin Auth API Routes](https://docs.medusajs.com/api/admin#auth).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "batchJobs",
    "type": "[AdminBatchJobsResource](js_client.AdminBatchJobsResource.mdx)",
    "description": "An instance of [AdminBatchJobsResource](js_client.AdminBatchJobsResource.mdx) used to send requests to [Admin Batch Job API Routes](https://docs.medusajs.com/api/admin#batch-jobs).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "collections",
    "type": "[AdminCollectionsResource](js_client.AdminCollectionsResource.mdx)",
    "description": "An instance of [AdminCollectionsResource](js_client.AdminCollectionsResource.mdx) used to send requests to [Admin Product Collection API Routes](https://docs.medusajs.com/api/admin#product-collections).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "currencies",
    "type": "[AdminCurrenciesResource](js_client.AdminCurrenciesResource.mdx)",
    "description": "An instance of [AdminCurrenciesResource](js_client.AdminCurrenciesResource.mdx) used to send requests to [Admin Currency API Routes](https://docs.medusajs.com/api/admin#currencies\\_getcurrencies).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "custom",
    "type": "[AdminCustomResource](js_client.AdminCustomResource.mdx)",
    "description": "An instance of [AdminCustomResource](js_client.AdminCustomResource.mdx) used to send requests to custom API Routes.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "customerGroups",
    "type": "[AdminCustomerGroupsResource](js_client.AdminCustomerGroupsResource.mdx)",
    "description": "An instance of [AdminCustomerGroupsResource](js_client.AdminCustomerGroupsResource.mdx) used to send requests to [Admin Customer Group API Routes](https://docs.medusajs.com/api/admin#customer-groups).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "customers",
    "type": "[AdminCustomersResource](js_client.AdminCustomersResource.mdx)",
    "description": "An instance of [AdminCustomersResource](js_client.AdminCustomersResource.mdx) used to send requests to [Admin Customer API Routes](https://docs.medusajs.com/api/admin#customers).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "discounts",
    "type": "[AdminDiscountsResource](js_client.AdminDiscountsResource.mdx)",
    "description": "An instance of [AdminDiscountsResource](js_client.AdminDiscountsResource.mdx) used to send requests to [Admin Discount API Routes](https://docs.medusajs.com/api/admin#discounts).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "draftOrders",
    "type": "[AdminDraftOrdersResource](js_client.AdminDraftOrdersResource.mdx)",
    "description": "An instance of [AdminDraftOrdersResource](js_client.AdminDraftOrdersResource.mdx) used to send requests to [Admin Draft Order API Routes](https://docs.medusajs.com/api/admin#draft-orders).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "giftCards",
    "type": "[AdminGiftCardsResource](js_client.AdminGiftCardsResource.mdx)",
    "description": "An instance of [AdminGiftCardsResource](js_client.AdminGiftCardsResource.mdx) used to send requests to [Admin Gift Card API Routes](https://docs.medusajs.com/api/admin#gift-cards).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "inventoryItems",
    "type": "[AdminInventoryItemsResource](js_client.AdminInventoryItemsResource.mdx)",
    "description": "An instance of [AdminInventoryItemsResource](js_client.AdminInventoryItemsResource.mdx) used to send requests to [Admin Inventory Item API Routes](https://docs.medusajs.com/api/admin#inventory-items).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "invites",
    "type": "[AdminInvitesResource](js_client.AdminInvitesResource.mdx)",
    "description": "An instance of [AdminInvitesResource](js_client.AdminInvitesResource.mdx) used to send requests to [Admin Invite API Routes](https://docs.medusajs.com/api/admin#invites).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "notes",
    "type": "[AdminNotesResource](js_client.AdminNotesResource.mdx)",
    "description": "An instance of [AdminNotesResource](js_client.AdminNotesResource.mdx) used to send requests to [Admin Note API Routes](https://docs.medusajs.com/api/admin#notes).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "notifications",
    "type": "[AdminNotificationsResource](js_client.AdminNotificationsResource.mdx)",
    "description": "An instance of [AdminNotificationsResource](js_client.AdminNotificationsResource.mdx) used to send requests to [Admin Notification API Routes](https://docs.medusajs.com/api/admin#notifications).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "orderEdits",
    "type": "[AdminOrderEditsResource](js_client.AdminOrderEditsResource.mdx)",
    "description": "An instance of [AdminOrderEditsResource](js_client.AdminOrderEditsResource.mdx) used to send requests to [Admin Order Edit API Routes](https://docs.medusajs.com/api/admin#order-edits).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "orders",
    "type": "[AdminOrdersResource](js_client.AdminOrdersResource.mdx)",
    "description": "An instance of [AdminOrdersResource](js_client.AdminOrdersResource.mdx) used to send requests to [Admin Order API Routes](https://docs.medusajs.com/api/admin#orders).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "paymentCollections",
    "type": "[AdminPaymentCollectionsResource](js_client.AdminPaymentCollectionsResource.mdx)",
    "description": "An instance of [AdminPaymentCollectionsResource](js_client.AdminPaymentCollectionsResource.mdx) used to send requests to [Admin Payment Collection API Routes](https://docs.medusajs.com/api/admin#payment-collections).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "payments",
    "type": "[AdminPaymentsResource](js_client.AdminPaymentsResource.mdx)",
    "description": "An instance of [AdminPaymentsResource](js_client.AdminPaymentsResource.mdx) used to send requests to [Admin Payment API Routes](https://docs.medusajs.com/api/admin#payments).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "priceLists",
    "type": "[AdminPriceListResource](js_client.AdminPriceListResource.mdx)",
    "description": "An instance of [AdminPriceListResource](js_client.AdminPriceListResource.mdx) used to send requests to [Admin Price List API Routes](https://docs.medusajs.com/api/admin#price-lists).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "productCategories",
    "type": "[AdminProductCategoriesResource](js_client.AdminProductCategoriesResource.mdx)",
    "description": "An instance of [AdminProductCategoriesResource](js_client.AdminProductCategoriesResource.mdx) used to send requests to [Admin Product Category API Routes](https://docs.medusajs.com/api/admin#product-categories).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "productTags",
    "type": "[AdminProductTagsResource](js_client.AdminProductTagsResource.mdx)",
    "description": "An instance of [AdminProductTagsResource](js_client.AdminProductTagsResource.mdx) used to send requests to [Admin Product Tag API Routes](https://docs.medusajs.com/api/admin#product-tags).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "productTypes",
    "type": "[AdminProductTypesResource](js_client.AdminProductTypesResource.mdx)",
    "description": "An instance of [AdminProductTypesResource](js_client.AdminProductTypesResource.mdx) used to send requests to [Admin Product Type API Routes](https://docs.medusajs.com/api/admin#product-types).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "products",
    "type": "[AdminProductsResource](js_client.AdminProductsResource.mdx)",
    "description": "An instance of [AdminProductsResource](js_client.AdminProductsResource.mdx) used to send requests to [Admin Product API Routes](https://docs.medusajs.com/api/admin#products).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "publishableApiKeys",
    "type": "[AdminPublishableApiKeyResource](js_client.AdminPublishableApiKeyResource.mdx)",
    "description": "An instance of [AdminPublishableApiKeyResource](js_client.AdminPublishableApiKeyResource.mdx) used to send requests to [Admin Publishable API Key API Routes](https://docs.medusajs.com/api/admin#publishable-api-keys).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "regions",
    "type": "[AdminRegionsResource](js_client.AdminRegionsResource.mdx)",
    "description": "An instance of [AdminRegionsResource](js_client.AdminRegionsResource.mdx) used to send requests to [Admin Region API Routes](https://docs.medusajs.com/api/admin#regions).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "reservations",
    "type": "[AdminReservationsResource](js_client.AdminReservationsResource.mdx)",
    "description": "An instance of [AdminReservationsResource](js_client.AdminReservationsResource.mdx) used to send requests to [Admin Reservation API Routes](https://docs.medusajs.com/api/admin#reservations).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "returnReasons",
    "type": "[AdminReturnReasonsResource](js_client.AdminReturnReasonsResource.mdx)",
    "description": "An instance of [AdminReturnReasonsResource](js_client.AdminReturnReasonsResource.mdx) used to send requests to [Admin Return Reason API Routes](https://docs.medusajs.com/api/admin#return-reasons).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "returns",
    "type": "[AdminReturnsResource](js_client.AdminReturnsResource.mdx)",
    "description": "An instance of [AdminReturnsResource](js_client.AdminReturnsResource.mdx) used to send requests to [Admin Return API Routes](https://docs.medusajs.com/api/admin#returns).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "salesChannels",
    "type": "[AdminSalesChannelsResource](js_client.AdminSalesChannelsResource.mdx)",
    "description": "An instance of [AdminSalesChannelsResource](js_client.AdminSalesChannelsResource.mdx) used to send requests to [Admin Sales Channel API Routes](https://docs.medusajs.com/api/admin#sales-channels).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "shippingOptions",
    "type": "[AdminShippingOptionsResource](js_client.AdminShippingOptionsResource.mdx)",
    "description": "An instance of [AdminShippingOptionsResource](js_client.AdminShippingOptionsResource.mdx) used to send requests to [Admin Shipping Option API Routes](https://docs.medusajs.com/api/admin#shipping-options).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "shippingProfiles",
    "type": "[AdminShippingProfilesResource](js_client.AdminShippingProfilesResource.mdx)",
    "description": "An instance of [AdminShippingProfilesResource](js_client.AdminShippingProfilesResource.mdx) used to send requests to [Admin Shipping Profile API Routes](https://docs.medusajs.com/api/admin#shipping-profiles).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "stockLocations",
    "type": "[AdminStockLocationsResource](js_client.AdminStockLocationsResource.mdx)",
    "description": "An instance of [AdminStockLocationsResource](js_client.AdminStockLocationsResource.mdx) used to send requests to [Admin Stock Location API Routes](https://docs.medusajs.com/api/admin#stock-locations).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "store",
    "type": "[AdminStoresResource](js_client.AdminStoresResource.mdx)",
    "description": "An instance of [AdminStoresResource](js_client.AdminStoresResource.mdx) used to send requests to [Admin Store API Routes](https://docs.medusajs.com/api/admin#store).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "swaps",
    "type": "[AdminSwapsResource](js_client.AdminSwapsResource.mdx)",
    "description": "An instance of [AdminSwapsResource](js_client.AdminSwapsResource.mdx) used to send requests to [Admin Swap API Routes](https://docs.medusajs.com/api/admin#swaps).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "taxRates",
    "type": "[AdminTaxRatesResource](js_client.AdminTaxRatesResource.mdx)",
    "description": "An instance of [AdminTaxRatesResource](js_client.AdminTaxRatesResource.mdx) used to send requests to [Admin Tax Rate API Routes](https://docs.medusajs.com/api/admin#tax-rates).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "uploads",
    "type": "[AdminUploadsResource](js_client.AdminUploadsResource.mdx)",
    "description": "An instance of [AdminUploadsResource](js_client.AdminUploadsResource.mdx) used to send requests to [Admin Upload API Routes](https://docs.medusajs.com/api/admin#uploads).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "users",
    "type": "[AdminUsersResource](js_client.AdminUsersResource.mdx)",
    "description": "An instance of [AdminUsersResource](js_client.AdminUsersResource.mdx) used to send requests to [Admin User API Routes](https://docs.medusajs.com/api/admin#users).",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "variants",
    "type": "[AdminVariantsResource](js_client.AdminVariantsResource.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/>
