# Medusa ## API Docs - Store API > Carts > Auth [Customer Login (JWT)](https://nogj5unale.apifox.cn/api-177152241.md): After a successful login, a JWT token is returned for subsequent authorization. - Store API > Carts > Auth [Customer Login (JWT)](https://nogj5unale.apifox.cn/api-177152242.md): After a successful login, a JWT token is returned, which can be used to send authenticated requests. - Store API > Carts > Auth [Check if Email Exists](https://nogj5unale.apifox.cn/api-177152243.md): Check if there's a customer already registered with the provided email. - Store API > Carts > Auth [Get Current Customer](https://nogj5unale.apifox.cn/api-177152244.md): Retrieve the currently logged in Customer's details. - Store API > Carts > Auth [Customer Log out](https://nogj5unale.apifox.cn/api-177152245.md): Delete the current session for the logged in customer. - Store API > Carts > Auth [Customer Login](https://nogj5unale.apifox.cn/api-177152246.md): Log a customer in and includes the Cookie session in the response header. The cookie session can be used in subsequent requests to authenticate the customer. When using Medusa's JS or Medusa React clients, the cookie is automatically attached to subsequent requests. - Store API > Carts [Create Payment Sessions](https://nogj5unale.apifox.cn/api-177152247.md): Create Payment Sessions for each of the available Payment Providers in the Cart's Region. If there's only one payment session created, it will be selected by default. The creation of the payment session uses the payment provider and may require sending requests to third-party services. - Store API > Carts [Refresh a Payment Session](https://nogj5unale.apifox.cn/api-177152248.md): Refresh a Payment Session to ensure that it is in sync with the Cart. This is usually not necessary, but is provided for edge cases. - Store API > Carts [Create a Cart](https://nogj5unale.apifox.cn/api-177152249.md): Create a Cart. Although optional, specifying the cart's region and sales channel can affect the cart's pricing and - Store API > Carts [Complete a Cart](https://nogj5unale.apifox.cn/api-177152250.md): Complete a cart and place an order or create a swap, based on the cart's type. This includes attempting to authorize the cart's payment. - Store API > Carts [Select a Payment Session](https://nogj5unale.apifox.cn/api-177152251.md): Select the Payment Session that will be used to complete the cart. This is typically used when the customer chooses their preferred payment method during checkout. The totals of the cart will be recalculated. - Store API > Carts [Delete a Payment Session](https://nogj5unale.apifox.cn/api-177152252.md): Delete a Payment Session in a Cart. May be useful if a payment has failed. The totals will be recalculated. - Store API > Carts [Update a Payment Session](https://nogj5unale.apifox.cn/api-177152253.md): Update a Payment Session with additional data. This can be useful depending on the payment provider used. All payment sessions are updated and cart totals are recalculated afterwards. - Store API > Carts [Get a Cart](https://nogj5unale.apifox.cn/api-177152254.md): Retrieve a Cart's details. This includes recalculating its totals. - Store API > Carts [Update a Cart](https://nogj5unale.apifox.cn/api-177152255.md): Update a Cart's details. If the cart has payment sessions and the region was not changed, the payment sessions are updated. The cart's totals are also recalculated. - Store API > Carts [Add Shipping Method](https://nogj5unale.apifox.cn/api-177152256.md): Add a Shipping Method to the Cart. The validation of the `data` field is handled by the fulfillment provider of the chosen shipping option. - Store API > Carts [Update a Line Item](https://nogj5unale.apifox.cn/api-177152257.md): Update a line item's quantity. - Store API > Carts [Delete a Line Item](https://nogj5unale.apifox.cn/api-177152258.md): Delete a Line Item from a Cart. The payment sessions will be updated and the totals will be recalculated. - Store API > Carts [Add a Line Item](https://nogj5unale.apifox.cn/api-177152259.md): Generates a Line Item with a given Product Variant and adds it to the Cart - Store API > Carts [Calculate Cart Taxes](https://nogj5unale.apifox.cn/api-177152260.md): Calculate the taxes for a cart. This is useful if the `automatic_taxes` field of the cart's region is set to `false`. If the cart's region uses a tax provider other than Medusa's system provider, this may lead to sending requests to third-party services. - Store API > Carts [Remove Discount](https://nogj5unale.apifox.cn/api-177152261.md): Remove a Discount from a Cart. This only removes the application of the discount, and not completely deletes it. The totals will be re-calculated and the payment sessions will be refreshed after the removal. - Store API > Customers [Request Password Reset](https://nogj5unale.apifox.cn/api-177152262.md): Create a reset password token to be used in a subsequent Reset Password API Route. This emits the event `customer.password_reset`. If a notification provider is installed in the Medusa backend and is configured to handle this event, a notification to the customer, such as an email, may be sent with reset instructions. - Store API > Customers [Get Saved Payment Methods](https://nogj5unale.apifox.cn/api-177152263.md): Retrieve the logged-in customer's saved payment methods. This API Route only works with payment providers created with the deprecated Payment Service interface. The payment methods are saved using the Payment Service's third-party service, and not on the Medusa backend. So, they're retrieved from the third-party service. - Store API > Customers [Add a Shipping Address](https://nogj5unale.apifox.cn/api-177152264.md): Add a Shipping Address to a Customer's saved addresses. - Store API > Customers [Update Customer](https://nogj5unale.apifox.cn/api-177152265.md): Update the logged-in customer's details. - Store API > Customers [Get a Customer](https://nogj5unale.apifox.cn/api-177152266.md): Retrieve the logged-in Customer's details. - Store API > Customers [Update a Shipping Address](https://nogj5unale.apifox.cn/api-177152267.md): Update the logged-in customer's saved Shipping Address's details. - Store API > Customers [Delete an Address](https://nogj5unale.apifox.cn/api-177152268.md): Delete an Address from the Customer's saved addresses. - Store API > Customers [Create a Customer](https://nogj5unale.apifox.cn/api-177152269.md): Register a new customer. This will also automatically authenticate the customer and set their login session in the response Cookie header. The cookie session can be used in subsequent requests to authenticate the customer. When using Medusa's JS or Medusa React clients, the cookie is automatically attached to subsequent requests. - Store API > Customers [Reset Password](https://nogj5unale.apifox.cn/api-177152270.md): Reset a Customer's password using a password token created by a previous request to the Request Password Reset API Route. If the password token expired, you must create a new one. - Store API > Customers [List Orders](https://nogj5unale.apifox.cn/api-177152271.md): Retrieve a list of the logged-in Customer's Orders. The orders can be filtered by fields such as `status` or `fulfillment_status`. The orders can also be paginated. - Store API > Gift Cards [Get Gift Card by Code](https://nogj5unale.apifox.cn/api-177152272.md): Retrieve a Gift Card's details by its associated unique code. - Store API > Orders > 77 [Claim Order](https://nogj5unale.apifox.cn/api-177152273.md): Allow the logged-in customer to claim ownership of one or more orders. This generates a token that can be used later on to verify the claim using the Verify Order Claim API Route. This also emits the event `order-update-token.created`. So, if you have a notification provider installed that handles this event and sends the customer a notification, such as an email, the customer should receive instructions on how to finalize their claim ownership. - Store API > Orders [Verify Order Claim](https://nogj5unale.apifox.cn/api-177152274.md): Verify the claim order token provided to the customer when they request ownership of an order. - Store API > Orders [Get an Order](https://nogj5unale.apifox.cn/api-177152275.md): Retrieve an Order's details. - Store API > Orders [Look Up an Order](https://nogj5unale.apifox.cn/api-177152276.md): Look up an order using filters. If the filters don't narrow down the results to a single order, a 404 response is returned with no orders. - Store API > Orders [Get by Cart ID](https://nogj5unale.apifox.cn/api-177152277.md): Retrieve an Order's details by the ID of the Cart that was used to create the Order. - Store API > Order Edits [Complete an Order Edit](https://nogj5unale.apifox.cn/api-177152278.md): Complete an Order Edit and reflect its changes on the original order. Any additional payment required must be authorized first using the Payment Collection API Routes. - Store API > Order Edits [Retrieve an Order Edit](https://nogj5unale.apifox.cn/api-177152279.md): Retrieve an Order Edit's details. - Store API > Order Edits [Decline an Order Edit](https://nogj5unale.apifox.cn/api-177152280.md): Decline an Order Edit. The changes are not reflected on the original order. - Store API > Payment Collections [Authorize Payment Session](https://nogj5unale.apifox.cn/api-177152281.md): Authorize a Payment Session of a Payment Collection. - Store API > Payment Collections [Authorize Payment Sessions](https://nogj5unale.apifox.cn/api-177152282.md): Authorize the Payment Sessions of a Payment Collection. - Store API > Payment Collections [Refresh a Payment Session](https://nogj5unale.apifox.cn/api-177152283.md): Refresh a Payment Session's data to ensure that it is in sync with the Payment Collection. - Store API > Payment Collections [Get a PaymentCollection](https://nogj5unale.apifox.cn/api-177152284.md): Retrieve a Payment Collection's details. - Store API > Payment Collections [Manage Payment Sessions](https://nogj5unale.apifox.cn/api-177152285.md): Create, update, or delete a list of payment sessions of a Payment Collections. If a payment session is not provided in the `sessions` array, it's deleted. - Store API > Payment Collections [Create a Payment Session](https://nogj5unale.apifox.cn/api-177152286.md): Create a Payment Session for a payment provider in a Payment Collection. - Store API > Products [Search Products](https://nogj5unale.apifox.cn/api-177152287.md): Run a search query on products using the search service installed on the Medusa backend. The searching is handled through the search service, so the returned data's format depends on the search service you're using. - Store API > Products [List Products](https://nogj5unale.apifox.cn/api-177152288.md): Retrieves a list of products. The products can be filtered by fields such as `id` or `q`. The products can also be sorted or paginated. - Store API > Products [Get a Product](https://nogj5unale.apifox.cn/api-177152289.md): Retrieve a Product's details. For accurate and correct pricing of the product based on the customer's context, it's highly recommended to pass fields such as - Store API > Product Variants [Get a Product Variant](https://nogj5unale.apifox.cn/api-177152290.md): Retrieve a Product Variant's details. For accurate and correct pricing of the product variant based on the customer's context, it's highly recommended to pass fields such as - Store API > Product Variants [Get Product Variants](https://nogj5unale.apifox.cn/api-177152291.md): Retrieves a list of product variants. The product variants can be filtered by fields such as `id` or `title`. The product variants can also be paginated. - Store API > Product Tags [List Product Tags](https://nogj5unale.apifox.cn/api-177152292.md): Retrieve a list of product tags. The product tags can be filtered by fields such as `id` or `q`. The product tags can also be sorted or paginated. - Store API > Product Categories [List Product Categories](https://nogj5unale.apifox.cn/api-177152293.md): Retrieve a list of product categories. The product categories can be filtered by fields such as `handle` or `q`. The product categories can also be paginated. This API Route can also be used to retrieve a product category by its handle. - Store API > Product Categories [Get a Product Category](https://nogj5unale.apifox.cn/api-177152294.md): Retrieve a Product Category's details. - Store API > Product Collections [Get a Collection](https://nogj5unale.apifox.cn/api-177152295.md): Retrieve a Product Collection's details. - Store API > Product Collections [List Collections](https://nogj5unale.apifox.cn/api-177152296.md): Retrieve a list of product collections. The product collections can be filtered by fields such as `handle` or `created_at`. The product collections can also be paginated. - Store API > Product Types [List Product Types](https://nogj5unale.apifox.cn/api-177152297.md): Retrieve a list of product types. The product types can be filtered by fields such as `value` or `q`. The product types can also be sorted or paginated. - Store API > Regions [List Regions](https://nogj5unale.apifox.cn/api-177152298.md): Retrieve a list of regions. The regions can be filtered by fields such as `created_at`. The regions can also be paginated. This API Route is useful to show the customer all available regions to choose from. - Store API > Regions [Get a Region](https://nogj5unale.apifox.cn/api-177152299.md): Retrieve a Region's details. - Store API > Returns [Create Return](https://nogj5unale.apifox.cn/api-177152300.md): Create a Return for an Order. If a return shipping method is specified, the return is automatically fulfilled. - Store API > Return Reasons [List Return Reasons](https://nogj5unale.apifox.cn/api-177152301.md): Retrieve a list of Return Reasons. This is useful when implementing a Create Return flow in the storefront. - Store API > Return Reasons [Get a Return Reason](https://nogj5unale.apifox.cn/api-177152302.md): Retrieve a Return Reason's details. - Store API > Shipping Options [List for Cart](https://nogj5unale.apifox.cn/api-177152303.md): Retrieve a list of Shipping Options available for a cart. - Store API > Shipping Options [Get Shipping Options](https://nogj5unale.apifox.cn/api-177152304.md): Retrieve a list of Shipping Options. - Store API > Swaps [Get by Cart ID](https://nogj5unale.apifox.cn/api-177152305.md): Retrieve a Swap's details by the ID of its cart. - Store API > Swaps [Create a Swap](https://nogj5unale.apifox.cn/api-177152306.md): Create a Swap for an Order. This will also create a return and associate it with the swap. If a return shipping option is specified, the return will automatically be fulfilled. - Admin API > Auth > Apps Oauth [Generate Token for App](https://nogj5unale.apifox.cn/api-177152311.md): Use an app's Oauth provider to generate and store a new token for authentication. - Admin API > Auth > Apps Oauth [List Applications](https://nogj5unale.apifox.cn/api-177152312.md): Retrieve a list of applications registered in the Medusa backend. - Admin API > Auth [Get Current User](https://nogj5unale.apifox.cn/api-177152307.md): Get the currently logged in user's details. - Admin API > Auth [User Logout](https://nogj5unale.apifox.cn/api-177152308.md): Delete the current session for the logged in user. This will only work if you're using Cookie session for authentication. If the API token is still passed in the header, the user is still authorized to perform admin functionalities in other endpoints. - Admin API > Auth [User Login](https://nogj5unale.apifox.cn/api-177152309.md): Log a User in and includes the Cookie session in the response header. The cookie session can be used in subsequent requests to authorize the user to perform admin functionalities. When using Medusa's JS or Medusa React clients, the cookie is automatically attached to subsequent requests. - Admin API > Auth [User Login (JWT)](https://nogj5unale.apifox.cn/api-177152310.md): After a successful login, a JWT token is returned for subsequent authorization. - Admin API > Batch Jobs [Cancel a Batch Job](https://nogj5unale.apifox.cn/api-177152313.md): Mark a batch job as canceled. When a batch job is canceled, the processing of the batch job doesn’t automatically stop. - Admin API > Batch Jobs [Get a Batch Job](https://nogj5unale.apifox.cn/api-177152314.md): Retrieve the details of a batch job. - Admin API > Batch Jobs [Confirm a Batch Job](https://nogj5unale.apifox.cn/api-177152315.md): When a batch job is created, it is not executed automatically if `dry_run` is set to `true`. This endpoint confirms that the batch job should be executed. - Admin API > Batch Jobs [List Batch Jobs](https://nogj5unale.apifox.cn/api-177152316.md): Retrieve a list of Batch Jobs. The batch jobs can be filtered by fields such as `type` or `confirmed_at`. The batch jobs can also be sorted or paginated. - Admin API > Batch Jobs [Create a Batch Job](https://nogj5unale.apifox.cn/api-177152317.md): Create a Batch Job to be executed asynchronously in the Medusa backend. If `dry_run` is set to `true`, the batch job will not be executed until the it is confirmed, which can be done using the Confirm Batch Job endpoint. - Admin API > Currencies [List Currency](https://nogj5unale.apifox.cn/api-177152318.md): Retrieve a list of currencies. The currencies can be filtered by fields such as `code`. The currencies can also be sorted or paginated. - Admin API > Currencies [Update a Currency](https://nogj5unale.apifox.cn/api-177152319.md): Update a Currency's details. - Admin API > Customers [Create a Customer](https://nogj5unale.apifox.cn/api-177152320.md): Allow admins to create a customer. - Admin API > Customers [List Customers](https://nogj5unale.apifox.cn/api-177152321.md): Retrieve a list of Customers. The customers can be filtered by fields such as `q` or `groups`. The customers can also be paginated. - Admin API > Customers [Update a Customer](https://nogj5unale.apifox.cn/api-177152322.md): Update a Customer's details. - Admin API > Customers [Get a Customer](https://nogj5unale.apifox.cn/api-177152323.md): Retrieve the details of a customer. - Admin API > Customer Groups [Remove Customers from Group](https://nogj5unale.apifox.cn/api-177152324.md): Remove a list of customers from a customer group. This doesn't delete the customer, only the association between the customer and the customer group. - Admin API > Customer Groups [Add Customers to Group](https://nogj5unale.apifox.cn/api-177152325.md): Add a list of customers to a customer group. - Admin API > Customer Groups [List Customers](https://nogj5unale.apifox.cn/api-177152326.md): Retrieve a list of customers in a customer group. The customers can be filtered by the `q` field. The customers can also be paginated. - Admin API > Customer Groups [Create a Customer Group](https://nogj5unale.apifox.cn/api-177152327.md): Creates a Customer Group. - Admin API > Customer Groups [List Customer Groups](https://nogj5unale.apifox.cn/api-177152328.md): Retrieve a list of customer groups. The customer groups can be filtered by fields such as `name` or `id. The customer groups can also be sorted or paginated. - Admin API > Customer Groups [Get a Customer Group](https://nogj5unale.apifox.cn/api-177152329.md): Retrieve a Customer Group by its ID. You can expand the customer group's relations or select the fields that should be returned. - Admin API > Customer Groups [Delete a Customer Group](https://nogj5unale.apifox.cn/api-177152330.md): Delete a customer group. This doesn't delete the customers associated with the customer group. - Admin API > Customer Groups [Update a Customer Group](https://nogj5unale.apifox.cn/api-177152331.md): Update a Customer Group's details. - Admin API > Discounts [Create a Condition](https://nogj5unale.apifox.cn/api-177152332.md): Create a Discount Condition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided, based on the type of discount condition. For example, if the discount condition's type is `products`, the `products` field should be provided in the request body. - Admin API > Discounts [Create a Discount](https://nogj5unale.apifox.cn/api-177152333.md): Create a Discount with a given set of rules that defines how the Discount is applied. - Admin API > Discounts [List Discounts](https://nogj5unale.apifox.cn/api-177152334.md): Retrieve a list of Discounts. The discounts can be filtered by fields such as `rule` or `is_dynamic`. The discounts can also be paginated. - Admin API > Discounts [Get a Condition](https://nogj5unale.apifox.cn/api-177152335.md): Retrieve a Discount Condition's details. - Admin API > Discounts [Update a Condition](https://nogj5unale.apifox.cn/api-177152336.md): Update a Discount Condition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided, based on the type of discount condition. For example, if the discount condition's type is `products`, the `products` field should be provided in the request body. - Admin API > Discounts [Delete a Condition](https://nogj5unale.apifox.cn/api-177152337.md): Deletes a Discount Condition. This does not delete resources associated to the discount condition. - Admin API > Discounts [Create a Dynamic Code](https://nogj5unale.apifox.cn/api-177152338.md): Create a dynamic unique code that can map to a parent Discount. This is useful if you want to automatically generate codes with the same rules and conditions. - Admin API > Discounts [Remove Batch Resources](https://nogj5unale.apifox.cn/api-177152339.md): Remove a batch of resources from a discount condition. This will only remove the association between the resource and the discount condition, but not the resource itself. - Admin API > Discounts [Add Batch Resources](https://nogj5unale.apifox.cn/api-177152340.md): Add a batch of resources to a discount condition. The type of resource depends on the type of discount condition. For example, if the discount condition's type is `products`, the resources being added should be products. - Admin API > Discounts [Get Discount by Code](https://nogj5unale.apifox.cn/api-177152341.md): Retrieve a Discount's details by its discount code - Admin API > Discounts [Delete a Dynamic Code](https://nogj5unale.apifox.cn/api-177152342.md): Delete a dynamic code from a Discount. - Admin API > Discounts [Add Region to Discount](https://nogj5unale.apifox.cn/api-177152343.md): Add a Region to the list of Regions a Discount can be used in. - Admin API > Discounts [Remove Region](https://nogj5unale.apifox.cn/api-177152344.md): Remove a Region from the list of Regions that a Discount can be used in. This does not delete a region, only the association between it and the discount. - Admin API > Discounts [Delete a Discount](https://nogj5unale.apifox.cn/api-177152345.md): Delete a Discount. Deleting the discount will make it unavailable for customers to use. - Admin API > Discounts [Update a Discount](https://nogj5unale.apifox.cn/api-177152346.md): Update a Discount with a given set of rules that define how the Discount is applied. - Admin API > Discounts [Get a Discount](https://nogj5unale.apifox.cn/api-177152347.md): Retrieves a Discount - Admin API > Draft Orders [Create a Line Item](https://nogj5unale.apifox.cn/api-177152348.md): Create a Line Item in the Draft Order. - Admin API > Draft Orders [Delete a Line Item](https://nogj5unale.apifox.cn/api-177152349.md): Deletes a Line Item from a Draft Order. - Admin API > Draft Orders [Update a Line Item](https://nogj5unale.apifox.cn/api-177152350.md): Update a Line Item in a Draft Order - Admin API > Draft Orders [Update a Draft Order](https://nogj5unale.apifox.cn/api-177152351.md): Update a Draft Order's details. - Admin API > Draft Orders [Delete a Draft Order](https://nogj5unale.apifox.cn/api-177152352.md): Delete a Draft Order - Admin API > Draft Orders [Get a Draft Order](https://nogj5unale.apifox.cn/api-177152353.md): Retrieve a Draft Order's details. - Admin API > Draft Orders [Create a Draft Order](https://nogj5unale.apifox.cn/api-177152354.md): Create a Draft Order. A draft order is not transformed into an order until payment is captured. - Admin API > Draft Orders [List Draft Orders](https://nogj5unale.apifox.cn/api-177152355.md): Retrieve an list of Draft Orders. The draft orders can be filtered by fields such as `q`. The draft orders can also paginated. - Admin API > Draft Orders [Mark Paid](https://nogj5unale.apifox.cn/api-177152356.md): Capture the draft order's payment. This will also set the draft order's status to `completed` and create an Order from the draft order. The payment is captured through Medusa's system payment, which is manual payment that isn't integrated with any third-party payment provider. It is assumed that the payment capturing is handled manually by the admin. - Admin API > Gift Cards [Create a Gift Card](https://nogj5unale.apifox.cn/api-177152357.md): Create a Gift Card that can redeemed by its unique code. The Gift Card is only valid within 1 region. - Admin API > Gift Cards [List Gift Cards](https://nogj5unale.apifox.cn/api-177152358.md): Retrieve a list of Gift Cards. The gift cards can be filtered by fields such as `q`. The gift cards can also paginated. - Admin API > Gift Cards [Delete a Gift Card](https://nogj5unale.apifox.cn/api-177152359.md): Delete a Gift Card. Once deleted, it can't be used by customers. - Admin API > Gift Cards [Get a Gift Card](https://nogj5unale.apifox.cn/api-177152360.md): Retrieve a Gift Card's details. - Admin API > Gift Cards [Update a Gift Card](https://nogj5unale.apifox.cn/api-177152361.md): Update a Gift Card's details. - Admin API > Inventory Items [Create an Inventory Item](https://nogj5unale.apifox.cn/api-177152362.md): Create an Inventory Item for a product variant. - Admin API > Inventory Items [List Inventory Items](https://nogj5unale.apifox.cn/api-177152363.md): Retrieve a list of inventory items. The inventory items can be filtered by fields such as `q` or `location_id`. The inventory items can also be paginated. - Admin API > Inventory Items [List Inventory Level](https://nogj5unale.apifox.cn/api-177152364.md): Retrieve a list of inventory levels of an inventory item. The inventory levels can be filtered by fields such as `location_id`. The inventory levels can also be paginated. - Admin API > Inventory Items [Create an Location Level](https://nogj5unale.apifox.cn/api-177152365.md): Create an Location Level for a given Inventory Item. - Admin API > Inventory Items [Update an Inventory Item](https://nogj5unale.apifox.cn/api-177152366.md): Update an Inventory Item's details. - Admin API > Inventory Items [Get an Inventory Item](https://nogj5unale.apifox.cn/api-177152367.md): Retrieve an Inventory Item's details. - Admin API > Inventory Items [Delete an Inventory Item](https://nogj5unale.apifox.cn/api-177152368.md): Delete an Inventory Item. This does not delete the associated product variant. - Admin API > Inventory Items [Update a Location Level](https://nogj5unale.apifox.cn/api-177152369.md): Update a Location Level's details for a given Inventory Item. - Admin API > Inventory Items [Delete a Location Level](https://nogj5unale.apifox.cn/api-177152370.md): Delete a location level of an Inventory Item. - Admin API > Invites [Lists Invites](https://nogj5unale.apifox.cn/api-177152371.md): Retrieve a list of invites. - Admin API > Invites [Create an Invite](https://nogj5unale.apifox.cn/api-177152372.md): Create an Invite. This will generate a token associated with the invite and trigger an `invite.created` event. If you have a Notification Provider installed that handles this event, a notification should be sent to the email associated with the invite to allow them to accept the invite. - Admin API > Invites [Delete an Invite](https://nogj5unale.apifox.cn/api-177152373.md): Delete an Invite. Only invites that weren't accepted can be deleted. - Admin API > Invites [Accept an Invite](https://nogj5unale.apifox.cn/api-177152374.md): Accept an Invite. This will also delete the invite and create a new user that can log in and perform admin functionalities. The user will have the email associated with the invite, and the password provided in the request body. - Admin API > Invites [Resend an Invite](https://nogj5unale.apifox.cn/api-177152375.md): Resend an Invite. This renews the expiry date by 7 days and generates a new token for the invite. It also triggers the `invite.created` event, so if you have a Notification Provider installed that handles this event, a notification should be sent to the email associated with the invite to allow them to accept the invite. - Admin API > Notes [List Notes](https://nogj5unale.apifox.cn/api-177152376.md): Retrieve a list of notes. The notes can be filtered by fields such as `resource_id`. The notes can also be paginated. - Admin API > Notes [Create a Note](https://nogj5unale.apifox.cn/api-177152377.md): Create a Note which can be associated with any resource. - Admin API > Notes [Get a Note](https://nogj5unale.apifox.cn/api-177152378.md): Retrieve a note's details. - Admin API > Notes [Delete a Note](https://nogj5unale.apifox.cn/api-177152379.md): Delete a Note. - Admin API > Notes [Update a Note](https://nogj5unale.apifox.cn/api-177152380.md): Update a Note's details.' - Admin API > Notifications [Resend Notification](https://nogj5unale.apifox.cn/api-177152381.md): Resend a previously sent notifications, with the same data but optionally to a different address. - Admin API > Notifications [List Notifications](https://nogj5unale.apifox.cn/api-177152382.md): Retrieve a list of notifications. The notifications can be filtered by fields such as `event_name` or `resource_type`. The notifications can also be paginated. - Admin API > Orders [Create a Reservation](https://nogj5unale.apifox.cn/api-177152383.md): Create a Reservation for a line item at a specified location, optionally for a partial quantity. - Admin API > Orders [Cancel Claim's Fulfillment](https://nogj5unale.apifox.cn/api-177152384.md): Cancel a claim's fulfillment and change its status. - Admin API > Orders [Ship a Claim's Fulfillment](https://nogj5unale.apifox.cn/api-177152385.md): Mark a claim's fulfillment as shipped. This changes the claim's fulfillment status to either `shipped` or `partially_shipped`, depending on whether all the items were shipped. - Admin API > Orders [Cancel Swap's Fulfilmment](https://nogj5unale.apifox.cn/api-177152386.md): Cancel a swap's fulfillment and change its status. - Admin API > Orders [Get Order Reservations](https://nogj5unale.apifox.cn/api-177152387.md): Retrieve the list of reservations of an Order - Admin API > Orders [Add a Shipping Method](https://nogj5unale.apifox.cn/api-177152388.md): Adds a Shipping Method to an Order. If another Shipping Method exists with the same Shipping Profile, the previous Shipping Method will be replaced. - Admin API > Orders [Create a Refund](https://nogj5unale.apifox.cn/api-177152389.md): Refund an amount for an order. The amount must be less than or equal the `refundable_amount` of the order. - Admin API > Orders [Get an Order](https://nogj5unale.apifox.cn/api-177152390.md): Retrieve an Order's details. - Admin API > Orders [Update an Order](https://nogj5unale.apifox.cn/api-177152391.md): Update and order's details. - Admin API > Orders [Create a Fulfillment](https://nogj5unale.apifox.cn/api-177152392.md): Create a Fulfillment of an Order using the fulfillment provider. - Admin API > Orders [Cancel a Swap](https://nogj5unale.apifox.cn/api-177152393.md): Cancel a Swap and change its status. - Admin API > Orders [List Orders](https://nogj5unale.apifox.cn/api-177152394.md): Retrieve a list of Orders. The orders can be filtered by fields such as `status` or `display_id`. The order can also be paginated. - Admin API > Orders [Create a Swap](https://nogj5unale.apifox.cn/api-177152395.md): Create a Swap. This includes creating a return that is associated with the swap. - Admin API > Orders [Complete an Order](https://nogj5unale.apifox.cn/api-177152396.md): Complete an Order and change its status. A canceled order can't be completed. - Admin API > Orders [Create a Swap Fulfillment](https://nogj5unale.apifox.cn/api-177152397.md): Create a Fulfillment for a Swap. - Admin API > Orders [Cancel a Claim](https://nogj5unale.apifox.cn/api-177152398.md): Cancel a Claim and change its status. A claim can't be canceled if it has a refund, if its fulfillments haven't been canceled, of if its associated return hasn't been canceled. - Admin API > Orders [Process a Swap Payment](https://nogj5unale.apifox.cn/api-177152399.md): Process a swap's payment either by refunding or issuing a payment. This depends on the `difference_due` of the swap. If `difference_due` is negative, the amount is refunded. If `difference_due` is positive, the amount is captured. - Admin API > Orders [Ship a Fulfillment](https://nogj5unale.apifox.cn/api-177152400.md): Mark a fulfillment as shipped. This changes the order's fulfillment status to either `shipped` or `partially_shipped`, depending on whether all the items were shipped. - Admin API > Orders [Capture an Order's Payments](https://nogj5unale.apifox.cn/api-177152401.md): Capture all the Payments associated with an Order. The payment of canceled orders can't be captured. - Admin API > Orders [Archive Order](https://nogj5unale.apifox.cn/api-177152402.md): Archive an order and change its status. - Admin API > Orders [Update a Claim](https://nogj5unale.apifox.cn/api-177152403.md): Update a Claim's details. - Admin API > Orders [Request a Return](https://nogj5unale.apifox.cn/api-177152404.md): Request and create a Return for items in an order. If the return shipping method is specified, it will be automatically fulfilled. - Admin API > Orders [Create a Claim Fulfillment](https://nogj5unale.apifox.cn/api-177152405.md): Create a Fulfillment for a Claim. - Admin API > Orders [Ship a Swap's Fulfillment](https://nogj5unale.apifox.cn/api-177152406.md): RMark a swap's fulfillment as shipped. This changes the swap's fulfillment status to either `shipped` or `partially_shipped`, depending on whether all the items were shipped. - Admin API > Orders [Cancel a Fulfilmment](https://nogj5unale.apifox.cn/api-177152407.md): Cancel an order's fulfillment and change its status. - Admin API > Orders [Create a Claim](https://nogj5unale.apifox.cn/api-177152408.md): Create a Claim for an order. If a return shipping method is specified, a return will also be created and associated with the claim. If the claim's type is `refund`, the refund is processed as well. - Admin API > Orders [Cancel an Order](https://nogj5unale.apifox.cn/api-177152409.md): Cancel an order and change its status. This will also cancel any associated Fulfillments and Payments, and it may fail if the Payment or Fulfillment Provider is unable to cancel the Payment/Fulfillment. - Admin API > Order Edits [Delete a Line Item Change](https://nogj5unale.apifox.cn/api-177152410.md): Delete a line item change that indicates the addition, deletion, or update of a line item in the original order. - Admin API > Order Edits [Add a Line Item](https://nogj5unale.apifox.cn/api-177152411.md): Create a line item change in the order edit that indicates adding an item in the original order. The item will not be added to the original order until the order edit is confirmed. - Admin API > Order Edits [Upsert Line Item Change](https://nogj5unale.apifox.cn/api-177152412.md): Create or update a line item change in the order edit that indicates addition, deletion, or update of a line item into an original order. Line item changes are only reflected on the original order after the order edit is confirmed. - Admin API > Order Edits [Delete Line Item](https://nogj5unale.apifox.cn/api-177152413.md): Create a line item change in the order edit that indicates deleting an item in the original order. The item in the original order will not be deleted until the order edit is confirmed. - Admin API > Order Edits [Cancel an Order Edit](https://nogj5unale.apifox.cn/api-177152414.md): Cancel an OrderEdit. - Admin API > Order Edits [Delete an Order Edit](https://nogj5unale.apifox.cn/api-177152415.md): Delete an Order Edit. Only order edits that have the status `created` can be deleted. - Admin API > Order Edits [Get an Order Edit](https://nogj5unale.apifox.cn/api-177152416.md): Retrieve an Order Edit's details. - Admin API > Order Edits [Update an Order Edit](https://nogj5unale.apifox.cn/api-177152417.md): Updates an Order Edit's details. - Admin API > Order Edits [Request Confirmation](https://nogj5unale.apifox.cn/api-177152418.md): Request customer confirmation of an Order Edit. This would emit the event `order-edit.requested` which Notification Providers listen to and send a notification to the customer about the order edit. - Admin API > Order Edits [Create an OrderEdit](https://nogj5unale.apifox.cn/api-177152419.md): Create an Order Edit. - Admin API > Order Edits [List Order Edits](https://nogj5unale.apifox.cn/api-177152420.md): Retrieve a list of order edits. The order edits can be filtered by fields such as `q` or `order_id`. The order edits can also be paginated. - Admin API > Order Edits [Confirm an OrderEdit](https://nogj5unale.apifox.cn/api-177152421.md): Confirm an Order Edit. This will reflect the changes in the order edit on the associated order. - Admin API > Payments [Capture a Payment](https://nogj5unale.apifox.cn/api-177152422.md): Capture a Payment. - Admin API > Payments [Get Payment details](https://nogj5unale.apifox.cn/api-177152423.md): Retrieve a Payment's details. - Admin API > Payments [Refund Payment](https://nogj5unale.apifox.cn/api-177152424.md): Refund a payment. The payment must be captured first. - Admin API > Payment Collections [Delete a Payment Collection](https://nogj5unale.apifox.cn/api-177152425.md): Delete a Payment Collection. Only payment collections with the statuses `canceled` or `not_paid` can be deleted. - Admin API > Payment Collections [Get a Payment Collection](https://nogj5unale.apifox.cn/api-177152426.md): Retrieve a Payment Collection's details. - Admin API > Payment Collections [Update Payment Collection](https://nogj5unale.apifox.cn/api-177152427.md): Update a Payment Collection's details. - Admin API > Payment Collections [Mark Authorized](https://nogj5unale.apifox.cn/api-177152428.md): Set the status of a Payment Collection as `authorized`. This will also change the `authorized_amount` of the payment collection. - Admin API > Product Collections [Add Products to Collection](https://nogj5unale.apifox.cn/api-177152429.md): Add products to a product collection. - Admin API > Product Collections [Remove Products from Collection](https://nogj5unale.apifox.cn/api-177152430.md): Remove a list of products from a collection. This would not delete the product, only the association between the product and the collection. - Admin API > Product Collections [Get a Collection](https://nogj5unale.apifox.cn/api-177152431.md): Retrieve a Product Collection by its ID. The products associated with it are expanded and returned as well. - Admin API > Product Collections [Update a Collection](https://nogj5unale.apifox.cn/api-177152432.md): Update a Product Collection's details. - Admin API > Product Collections [Delete a Collection](https://nogj5unale.apifox.cn/api-177152433.md): Delete a Product Collection. This does not delete associated products. - Admin API > Product Collections [List Collections](https://nogj5unale.apifox.cn/api-177152434.md): Retrieve a list of Product Collection. The product collections can be filtered by fields such as `handle` or `title`. The collections can also be sorted or paginated. - Admin API > Product Collections [Create a Collection](https://nogj5unale.apifox.cn/api-177152435.md): Create a Product Collection. - Admin API > Product Tags [List Product Tags](https://nogj5unale.apifox.cn/api-177152436.md): Retrieve a list of product tags. The product tags can be filtered by fields such as `q` or `value`. The product tags can also be sorted or paginated. - Admin API > Product Types [List Product Types](https://nogj5unale.apifox.cn/api-177152437.md): Retrieve a list of product types. The product types can be filtered by fields such as `q` or `value`. The product types can also be sorted or paginated. - Admin API > Product Variants [Get Variant's Inventory](https://nogj5unale.apifox.cn/api-177152438.md): Retrieve the available inventory of a Product Variant. - Admin API > Product Variants [List Product Variants](https://nogj5unale.apifox.cn/api-177152439.md): Retrieve a list of Product Variants. The product variant can be filtered by fields such as `id` or `title`. The product variant can also be paginated. - Admin API > Product Variants [Get a Product variant](https://nogj5unale.apifox.cn/api-177152440.md): Retrieve a product variant's details. - Admin API > Price Lists [Delete a Product's Prices](https://nogj5unale.apifox.cn/api-177152441.md): Delete all the prices related to a specific product in a price list. - Admin API > Price Lists [List Products](https://nogj5unale.apifox.cn/api-177152442.md): Retrieve a price list's products. The products can be filtered by fields such as `q` or `status`. The products can also be sorted or paginated. - Admin API > Price Lists [Delete a Variant's Prices](https://nogj5unale.apifox.cn/api-177152443.md): Delete all the prices related to a specific variant in a price list - Admin API > Price Lists [Get a Price List](https://nogj5unale.apifox.cn/api-177152444.md): Retrieve a Price List's details. - Admin API > Price Lists [Update a Price List](https://nogj5unale.apifox.cn/api-177152445.md): Update a Price List's details. - Admin API > Price Lists [Delete a Price List](https://nogj5unale.apifox.cn/api-177152446.md): Delete a Price List and its associated prices. - Admin API > Price Lists [Add or Update Prices](https://nogj5unale.apifox.cn/api-177152447.md): Add or update a list of prices in a Price List - Admin API > Price Lists [Delete Prices](https://nogj5unale.apifox.cn/api-177152448.md): Delete a list of prices in a Price List - Admin API > Price Lists [Create a Price List](https://nogj5unale.apifox.cn/api-177152449.md): Create a Price List. - Admin API > Price Lists [List Price Lists](https://nogj5unale.apifox.cn/api-177152450.md): Retrieve a list of price lists. The price lists can be filtered by fields such as `q` or `status`. The price lists can also be sorted or paginated. - Admin API > Products [List Product Types](https://nogj5unale.apifox.cn/api-177152451.md): Retrieve a list of Product Types. - Admin API > Products [List Tags Usage Number](https://nogj5unale.apifox.cn/api-177152452.md): Retrieve a list of Product Tags with how many times each is used in products. - Admin API > Products [List a Product's Variants](https://nogj5unale.apifox.cn/api-177152453.md): Retrieve a list of Product Variants associated with a Product. The variants can be paginated. - Admin API > Products [Create a Product Variant](https://nogj5unale.apifox.cn/api-177152454.md): Create a Product Variant associated with a Product. Each product variant must have a unique combination of Product Option values. - Admin API > Products [Update a Product Variant](https://nogj5unale.apifox.cn/api-177152455.md): Update a Product Variant's details. - Admin API > Products [Delete a Product Variant](https://nogj5unale.apifox.cn/api-177152456.md): Delete a Product Variant. - Admin API > Products [Add a Product Option](https://nogj5unale.apifox.cn/api-177152457.md): Add a Product Option to a Product. - Admin API > Products [Set Metadata](https://nogj5unale.apifox.cn/api-177152458.md): Set the metadata of a Product. It can be any key-value pair, which allows adding custom data to a product. - Admin API > Products [Delete a Product Option](https://nogj5unale.apifox.cn/api-177152459.md): Delete a Product Option. If there are product variants that use this product option, they must be deleted before deleting the product option. - Admin API > Products [Update a Product Option](https://nogj5unale.apifox.cn/api-177152460.md): Update a Product Option's details. - Admin API > Product Categories [Create a Product Category](https://nogj5unale.apifox.cn/api-177152461.md): Create a Product Category. - Admin API > Product Categories [List Product Categories](https://nogj5unale.apifox.cn/api-177152462.md): Retrieve a list of product categories. The product categories can be filtered by fields such as `q` or `handle`. The product categories can also be paginated. - Admin API > Product Categories [Update a Product Category](https://nogj5unale.apifox.cn/api-177152463.md): Updates a Product Category. - Admin API > Product Categories [Delete a Product Category](https://nogj5unale.apifox.cn/api-177152464.md): Delete a Product Category. This does not delete associated products. - Admin API > Product Categories [Get a Product Category](https://nogj5unale.apifox.cn/api-177152465.md): Retrieve a Product Category's details. - Admin API > Product Categories [Add Products to a Category](https://nogj5unale.apifox.cn/api-177152466.md): Add a list of products to a product category. - Admin API > Product Categories [Remove Products from Category](https://nogj5unale.apifox.cn/api-177152467.md): Remove a list of products from a product category. - Admin API > Publishable Api Keys [List Sales Channels](https://nogj5unale.apifox.cn/api-177152468.md): List the sales channels associated with a publishable API key. The sales channels can be filtered by fields such as `q`. - Admin API > Publishable Api Keys [Delete Publishable API Key](https://nogj5unale.apifox.cn/api-177152469.md): Delete a Publishable API Key. Associated resources, such as sales channels, are not deleted. - Admin API > Publishable Api Keys [Get a Publishable API Key](https://nogj5unale.apifox.cn/api-177152470.md): Retrieve a publishable API key's details. - Admin API > Publishable Api Keys [Revoke a Publishable API Key](https://nogj5unale.apifox.cn/api-177152471.md): Revoke a Publishable API Key. Revoking the publishable API Key can't be undone, and the key can't be used in future requests. - Admin API > Publishable Api Keys [Remove Sales Channels](https://nogj5unale.apifox.cn/api-177152472.md): Remove a list of sales channels from a publishable API key. This doesn't delete the sales channels and only removes the association between them and the publishable API key. - Admin API > Publishable Api Keys [Add Sales Channels](https://nogj5unale.apifox.cn/api-177152473.md): Assign a list of sales channels to a publishable API key. - Admin API > Publishable Api Keys [Update Publishable API Key](https://nogj5unale.apifox.cn/api-177152474.md): Update a Publishable API Key's details. - Admin API > Publishable Api Keys [List Publishable API keys](https://nogj5unale.apifox.cn/api-177152475.md): Retrieve a list of publishable API keys. The publishable API keys can be filtered by fields such as `q`. The publishable API keys can also be paginated. - Admin API > Publishable Api Keys [Create Publishable API Key](https://nogj5unale.apifox.cn/api-177152476.md): Creates a Publishable API Key. - Admin API > Reservations [Delete a Reservation](https://nogj5unale.apifox.cn/api-177152477.md): Delete a Reservation. Associated resources, such as the line item, will not be deleted. - Admin API > Reservations [Update a Reservation](https://nogj5unale.apifox.cn/api-177152478.md): Update a Reservation's details.' - Admin API > Reservations [Get a Reservation](https://nogj5unale.apifox.cn/api-177152479.md): Retrieve a reservation's details.' - Admin API > Reservations [Create a Reservation](https://nogj5unale.apifox.cn/api-177152480.md): Create a Reservation which can be associated with any resource, such as an order's line item. - Admin API > Reservations [List Reservations](https://nogj5unale.apifox.cn/api-177152481.md): Retrieve a list of Reservations. The reservations can be filtered by fields such as `location_id` or `quantity`. The reservations can also be paginated. - Admin API > Regions [List Fulfillment Options](https://nogj5unale.apifox.cn/api-177152482.md): Retrieve a list of fulfillment options available in a Region. - Admin API > Regions [Add Country](https://nogj5unale.apifox.cn/api-177152483.md): Add a Country to the list of Countries in a Region - Admin API > Regions [Remove Fulfillment Provider](https://nogj5unale.apifox.cn/api-177152484.md): Remove a Fulfillment Provider from a Region. The fulfillment provider will still be available for usage in other regions. - Admin API > Regions [Remove Payment Provider](https://nogj5unale.apifox.cn/api-177152485.md): Remove a Payment Provider from a Region. The payment provider will still be available for usage in other regions. - Admin API > Regions [Add Payment Provider](https://nogj5unale.apifox.cn/api-177152486.md): Add a Payment Provider to the list of payment providers in a Region. - Admin API > Regions [Delete a Region](https://nogj5unale.apifox.cn/api-177152487.md): Delete a Region. Associated resources, such as providers or currencies are not deleted. Associated tax rates are deleted. - Admin API > Regions [Update a Region](https://nogj5unale.apifox.cn/api-177152488.md): Update a Region's details. - Admin API > Regions [Get a Region](https://nogj5unale.apifox.cn/api-177152489.md): Retrieve a Region's details. - Admin API > Regions [List Regions](https://nogj5unale.apifox.cn/api-177152490.md): Retrieve a list of Regions. The regions can be filtered by fields such as `created_at`. The regions can also be paginated - Admin API > Regions [Create a Region](https://nogj5unale.apifox.cn/api-177152491.md): Create a Region. - Admin API > Regions [Add Fulfillment Provider](https://nogj5unale.apifox.cn/api-177152492.md): Add a Fulfillment Provider to the list of fulfullment providers in a Region. - Admin API > Regions [Remove Country](https://nogj5unale.apifox.cn/api-177152493.md): Remove a Country from the list of Countries in a Region. The country will still be available in the system, and it can be used in other regions. - Admin API > Return Reasons [Get a Return Reason](https://nogj5unale.apifox.cn/api-177152494.md): Retrieve a Return Reason's details. - Admin API > Return Reasons [Delete a Return Reason](https://nogj5unale.apifox.cn/api-177152495.md): Delete a return reason. - Admin API > Return Reasons [Update a Return Reason](https://nogj5unale.apifox.cn/api-177152496.md): Update a Return Reason's details. - Admin API > Return Reasons [List Return Reasons](https://nogj5unale.apifox.cn/api-177152497.md): Retrieve a list of Return Reasons. - Admin API > Return Reasons [Create a Return Reason](https://nogj5unale.apifox.cn/api-177152498.md): Create a Return Reason. - Admin API > Returns [Receive a Return](https://nogj5unale.apifox.cn/api-177152499.md): Mark a Return as received. This also updates the status of associated order, claim, or swap accordingly. - Admin API > Returns [List Returns](https://nogj5unale.apifox.cn/api-177152500.md): Retrieve a list of Returns. The returns can be paginated. - Admin API > Returns [Cancel a Return](https://nogj5unale.apifox.cn/api-177152501.md): Registers a Return as canceled. The return can be associated with an order, claim, or swap. - Admin API > Sales Channels [Remove Stock Location from Sales Channels.](https://nogj5unale.apifox.cn/api-177152502.md): Remove a stock location from a Sales Channel. This only removes the association between the stock location and the sales channel. It does not delete the stock location. - Admin API > Sales Channels [Associate a Stock Location](https://nogj5unale.apifox.cn/api-177152503.md): Associate a stock location with a Sales Channel. - Admin API > Sales Channels [Get a Sales Channel](https://nogj5unale.apifox.cn/api-177152504.md): Retrieve a sales channel's details. - Admin API > Sales Channels [Delete a Sales Channel](https://nogj5unale.apifox.cn/api-177152505.md): Delete a sales channel. Associated products, stock locations, and other resources are not deleted. - Admin API > Sales Channels [Update a Sales Channel](https://nogj5unale.apifox.cn/api-177152506.md): Update a Sales Channel's details. - Admin API > Sales Channels [Remove Products from Sales Channel](https://nogj5unale.apifox.cn/api-177152507.md): Remove a list of products from a sales channel. This does not delete the product. It only removes the association between the product and the sales channel. - Admin API > Sales Channels [Add Products to Sales Channel](https://nogj5unale.apifox.cn/api-177152508.md): Add a list of products to a sales channel. - Admin API > Sales Channels [Create a Sales Channel](https://nogj5unale.apifox.cn/api-177152509.md): Create a Sales Channel. - Admin API > Sales Channels [List Sales Channels](https://nogj5unale.apifox.cn/api-177152510.md): Retrieve a list of sales channels. The sales channels can be filtered by fields such as `q` or `name`. The sales channels can also be sorted or paginated. - Admin API > Shipping Options [Update Shipping Option](https://nogj5unale.apifox.cn/api-177152511.md): Update a Shipping Option's details. - Admin API > Shipping Options [Get a Shipping Option](https://nogj5unale.apifox.cn/api-177152512.md): Retrieve a Shipping Option's details. - Admin API > Shipping Options [Delete Shipping Option](https://nogj5unale.apifox.cn/api-177152513.md): Delete a Shipping Option. Once deleted, it can't be used when creating orders or returns. - Admin API > Shipping Options [List Shipping Options](https://nogj5unale.apifox.cn/api-177152514.md): Retrieve a list of Shipping Options. The shipping options can be filtered by fields such as `region_id` or `is_return`. - Admin API > Shipping Options [Create Shipping Option](https://nogj5unale.apifox.cn/api-177152515.md): Create a Shipping Option. - Admin API > Shipping Profiles [List Shipping Profiles](https://nogj5unale.apifox.cn/api-177152516.md): Retrieve a list of Shipping Profiles. - Admin API > Shipping Profiles [Create a Shipping Profile](https://nogj5unale.apifox.cn/api-177152517.md): Create a Shipping Profile. - Admin API > Shipping Profiles [Delete a Shipping Profile](https://nogj5unale.apifox.cn/api-177152518.md): Delete a Shipping Profile. Associated shipping options are deleted as well. - Admin API > Shipping Profiles [Update a Shipping Profile](https://nogj5unale.apifox.cn/api-177152519.md): Update a Shipping Profile's details. - Admin API > Shipping Profiles [Get a Shipping Profile](https://nogj5unale.apifox.cn/api-177152520.md): Retrieve a Shipping Profile's details. - Admin API > Stock Locations [Get a Stock Location](https://nogj5unale.apifox.cn/api-177152521.md): Retrieve a Stock Location's details. - Admin API > Stock Locations [Update a Stock Location](https://nogj5unale.apifox.cn/api-177152522.md): Update a Stock Location's details. - Admin API > Stock Locations [Delete a Stock Location](https://nogj5unale.apifox.cn/api-177152523.md): Delete a Stock Location. - Admin API > Stock Locations [List Stock Locations](https://nogj5unale.apifox.cn/api-177152524.md): Retrieve a list of stock locations. The stock locations can be filtered by fields such as `name` or `created_at`. The stock locations can also be sorted or paginated. - Admin API > Stock Locations [Create a Stock Location](https://nogj5unale.apifox.cn/api-177152525.md): Create a Stock Location. - Admin API > Store [List Payment Providers](https://nogj5unale.apifox.cn/api-177152526.md): Retrieve a list of available Payment Providers in a store. - Admin API > Store [Add a Currency Code](https://nogj5unale.apifox.cn/api-177152527.md): Add a Currency Code to the available currencies in a store. This does not create new currencies, as currencies are defined within the Medusa backend. To create a currency, you can create a migration that inserts the currency into the database. - Admin API > Store [Remove a Currency](https://nogj5unale.apifox.cn/api-177152528.md): Remove a Currency Code from the available currencies in a store. This does not completely delete the currency and it can be added again later to the store. - Admin API > Store [List Tax Providers](https://nogj5unale.apifox.cn/api-177152529.md): Retrieve a list of available Tax Providers in a store. - Admin API > Store [Update Store Details](https://nogj5unale.apifox.cn/api-177152530.md): Update the Store's details. - Admin API > Store [Get Store details](https://nogj5unale.apifox.cn/api-177152531.md): Retrieve the Store's details. - Admin API > Swaps [Get a Swap](https://nogj5unale.apifox.cn/api-177152532.md): Retrieve a Swap's details. - Admin API > Swaps [List Swaps](https://nogj5unale.apifox.cn/api-177152533.md): Retrieve a list of Swaps. The swaps can be paginated. - Admin API > Uploads [Upload Files](https://nogj5unale.apifox.cn/api-177152534.md): Upload at least one file to a public bucket or storage. The file upload is handled by the file service installed on the Medusa backend. - Admin API > Uploads [Delete an Uploaded File](https://nogj5unale.apifox.cn/api-177152535.md): Delete an uploaded file from storage. The file is deleted using the installed file service on the Medusa backend. - Admin API > Uploads [Get a File's Download URL](https://nogj5unale.apifox.cn/api-177152536.md): Create and retrieve a presigned or public download URL for a file. The URL creation is handled by the file service installed on the Medusa backend. - Admin API > Uploads [Protected File Upload](https://nogj5unale.apifox.cn/api-177152537.md): Upload at least one file to an ACL or a non-public bucket. The file upload is handled by the file service installed on the Medusa backend. - Admin API > Tax Rates [Add to Shipping Options](https://nogj5unale.apifox.cn/api-177152538.md): Associates a Tax Rate with a list of Shipping Options. - Admin API > Tax Rates [Remove Shipping Options from Rate](https://nogj5unale.apifox.cn/api-177152539.md): Remove shipping options from a tax rate. This only removes the association between the shipping options and the tax rate. It does not delete the shipping options. - Admin API > Tax Rates [Create a Tax Rate](https://nogj5unale.apifox.cn/api-177152541.md): Create a Tax Rate. - Admin API > Tax Rates [List Tax Rates](https://nogj5unale.apifox.cn/api-177152542.md): Retrieve a list of Tax Rates. The tax rates can be filtered by fields such as `name` or `rate`. The tax rates can also be paginated. - Admin API > Tax Rates [Add to Products](https://nogj5unale.apifox.cn/api-177152543.md): Associates a Tax Rate with a list of Products. - Admin API > Tax Rates [Remove Products from Rate](https://nogj5unale.apifox.cn/api-177152544.md): Remove products from a tax rate. This only removes the association between the products and the tax rate. It does not delete the products. - Admin API > Tax Rates [Delete a Tax Rate](https://nogj5unale.apifox.cn/api-177152545.md): Delete a Tax Rate. Resources associated with the tax rate, such as products or product types, are not deleted. - Admin API > Tax Rates [Get a Tax Rate](https://nogj5unale.apifox.cn/api-177152546.md): Retrieve a Tax Rate's details. - Admin API > Tax Rates [Update a Tax Rate](https://nogj5unale.apifox.cn/api-177152547.md): Update a Tax Rate's details. - Admin API > Tax Rates [Add to Product Types](https://nogj5unale.apifox.cn/api-177152548.md): Associates a Tax Rate with a list of Product Types - Admin API > Tax Rates [Remove Product Types from Rate](https://nogj5unale.apifox.cn/api-177152549.md): Remove product types from a tax rate. This only removes the association between the product types and the tax rate. It does not delete the product types. - Admin API > Users [Reset Password](https://nogj5unale.apifox.cn/api-177152550.md): Reset the password of an admin User using their reset password token. A user must request to reset their password first before attempting to reset their password with this request. - Admin API > Users [Request Password Reset](https://nogj5unale.apifox.cn/api-177152551.md): Generate a password token for an admin user with a given email. - Admin API > Users [Get a User](https://nogj5unale.apifox.cn/api-177152552.md): Retrieve an admin user's details. - Admin API > Users [Delete a User](https://nogj5unale.apifox.cn/api-177152553.md): Delete a User. Once deleted, the user will not be able to authenticate or perform admin functionalities. - Admin API > Users [Update a User](https://nogj5unale.apifox.cn/api-177152554.md): Update an admin user's details. - Admin API > Users [Create a User](https://nogj5unale.apifox.cn/api-177152555.md): Create an admin User. The user has the same privileges as all admin users, and will be able to authenticate and perform admin functionalities right after creation. - Admin API > Users [List Users](https://nogj5unale.apifox.cn/api-177152556.md): Retrieve all admin users. - 【Demo】Products [检索产品列表](https://nogj5unale.apifox.cn/api-177152557.md): 检索产品列表。产品可以通过“q”或“status”等字段进行筛选。产品也可以进行排序或分页。 - 【Demo】Products [创建新产品](https://nogj5unale.apifox.cn/api-177152558.md): 创建新产品。如果“is_giftcard”字段设置为“true”,则此端点也可用于创建礼品卡。 - 【Demo】Products [删除产品](https://nogj5unale.apifox.cn/api-177152559.md): 删除产品及其相关的产品变体和选项。 - 【Demo】Products [更新产品信息](https://nogj5unale.apifox.cn/api-177152560.md): 更新产品的详细信息。 - 【Demo】Products [检索产品详情](https://nogj5unale.apifox.cn/api-177152561.md): 检索产品的详细信息。