# Headless Commerce ## Docs - [Create Category](https://docs.headlesscommerce.io/api-reference/admin--categories/create-category.md) - [Delete Category](https://docs.headlesscommerce.io/api-reference/admin--categories/delete-category.md) - [List Categories (Tree)](https://docs.headlesscommerce.io/api-reference/admin--categories/list-categories-tree.md) - [Update Category](https://docs.headlesscommerce.io/api-reference/admin--categories/update-category.md) - [Create Collection](https://docs.headlesscommerce.io/api-reference/admin--collections/create-collection.md) - [Delete Collection](https://docs.headlesscommerce.io/api-reference/admin--collections/delete-collection.md) - [List Collections](https://docs.headlesscommerce.io/api-reference/admin--collections/list-collections.md) - [Update Collection](https://docs.headlesscommerce.io/api-reference/admin--collections/update-collection.md) - [Export Orders as CSV](https://docs.headlesscommerce.io/api-reference/admin--csv/export-orders-as-csv.md): Exports all orders as a CSV file. - [Export Products as CSV](https://docs.headlesscommerce.io/api-reference/admin--csv/export-products-as-csv.md): Exports all products and their variants as a CSV file. - [Import Products from CSV](https://docs.headlesscommerce.io/api-reference/admin--csv/import-products-from-csv.md): Bulk-creates products from a CSV file. - [Create Customer](https://docs.headlesscommerce.io/api-reference/admin--customers/create-customer.md) - [Delete Customer (Anonymize)](https://docs.headlesscommerce.io/api-reference/admin--customers/delete-customer-anonymize.md): For GDPR and other data deletion requests. Anonymizes customer PII (name, email, phone, address) and sets status to disabled. Existing order data is retained, but personally identifiable information is masked. - [Get Customer](https://docs.headlesscommerce.io/api-reference/admin--customers/get-customer.md) - [Issue Customer Token (for Storefront Auth)](https://docs.headlesscommerce.io/api-reference/admin--customers/issue-customer-token-for-storefront-auth.md): Called from the store backend (sk_* key) to issue a customer token. The frontend passes this token via the X-Customer-Token header to access /storefront/customers/me, /storefront/orders, etc. - [List Customers](https://docs.headlesscommerce.io/api-reference/admin--customers/list-customers.md) - [Update Customer](https://docs.headlesscommerce.io/api-reference/admin--customers/update-customer.md) - [Get Dashboard Stats](https://docs.headlesscommerce.io/api-reference/admin--dashboard/get-dashboard-stats.md) - [Create Discount](https://docs.headlesscommerce.io/api-reference/admin--discounts/create-discount.md) - [Delete Discount](https://docs.headlesscommerce.io/api-reference/admin--discounts/delete-discount.md) - [Get Discount](https://docs.headlesscommerce.io/api-reference/admin--discounts/get-discount.md) - [List Discounts](https://docs.headlesscommerce.io/api-reference/admin--discounts/list-discounts.md) - [Update Discount](https://docs.headlesscommerce.io/api-reference/admin--discounts/update-discount.md) - [Create Fulfillment](https://docs.headlesscommerce.io/api-reference/admin--fulfillments/create-fulfillment.md) - [Deliver Fulfillment (shipped → delivered)](https://docs.headlesscommerce.io/api-reference/admin--fulfillments/deliver-fulfillment-shipped-→-delivered.md) - [Ship Fulfillment (pending → shipped)](https://docs.headlesscommerce.io/api-reference/admin--fulfillments/ship-fulfillment-pending-→-shipped.md) - [Update Fulfillment (Tracking, etc.)](https://docs.headlesscommerce.io/api-reference/admin--fulfillments/update-fulfillment-tracking-etc.md) - [Adjust Inventory Quantity](https://docs.headlesscommerce.io/api-reference/admin--inventory/adjust-inventory-quantity.md) - [Get Inventory Item](https://docs.headlesscommerce.io/api-reference/admin--inventory/get-inventory-item.md) - [List Inventory](https://docs.headlesscommerce.io/api-reference/admin--inventory/list-inventory.md) - [Update Inventory Settings (track, backorder, safety_stock)](https://docs.headlesscommerce.io/api-reference/admin--inventory/update-inventory-settings-track-backorder-safety_stock.md) - [Get Log Detail](https://docs.headlesscommerce.io/api-reference/admin--logs/get-log-detail.md) - [List API Logs](https://docs.headlesscommerce.io/api-reference/admin--logs/list-api-logs.md) - [Cancel Order](https://docs.headlesscommerce.io/api-reference/admin--orders/cancel-order.md) - [Complete Order (processing → completed)](https://docs.headlesscommerce.io/api-reference/admin--orders/complete-order-processing-→-completed.md): Transitions the order status to completed. Only orders in processing status can be transitioned. - [Complete Payment (pending → completed)](https://docs.headlesscommerce.io/api-reference/admin--orders/complete-payment-pending-→-completed.md) - [Confirm Order (pending → confirmed)](https://docs.headlesscommerce.io/api-reference/admin--orders/confirm-order-pending-→-confirmed.md) - [Create Manual Order](https://docs.headlesscommerce.io/api-reference/admin--orders/create-manual-order.md) - [Create Manual Payment](https://docs.headlesscommerce.io/api-reference/admin--orders/create-manual-payment.md): Records a manual payment such as bank transfer. Set provider to "manual" and confirm via the complete endpoint after verification. - [Create Refund](https://docs.headlesscommerce.io/api-reference/admin--orders/create-refund.md) - [Get Order](https://docs.headlesscommerce.io/api-reference/admin--orders/get-order.md) - [List Orders](https://docs.headlesscommerce.io/api-reference/admin--orders/list-orders.md) - [Process Order (confirmed → processing)](https://docs.headlesscommerce.io/api-reference/admin--orders/process-order-confirmed-→-processing.md): Transitions the order status to processing. Only orders in confirmed status can be transitioned. - [Update Order (Shipping Address, Notes, etc.)](https://docs.headlesscommerce.io/api-reference/admin--orders/update-order-shipping-address-notes-etc.md) - [Add Bundle Item](https://docs.headlesscommerce.io/api-reference/admin--products/add-bundle-item.md) - [Add Product Image](https://docs.headlesscommerce.io/api-reference/admin--products/add-product-image.md): Registers an image URL. For file uploads, use the separate Media API. - [Create Product](https://docs.headlesscommerce.io/api-reference/admin--products/create-product.md) - [Delete Product](https://docs.headlesscommerce.io/api-reference/admin--products/delete-product.md) - [Delete Product Image](https://docs.headlesscommerce.io/api-reference/admin--products/delete-product-image.md) - [Get Product](https://docs.headlesscommerce.io/api-reference/admin--products/get-product.md) - [List Bundle Items](https://docs.headlesscommerce.io/api-reference/admin--products/list-bundle-items.md): Lists the component items of a bundle product (type=bundle). - [List Products](https://docs.headlesscommerce.io/api-reference/admin--products/list-products.md) - [Remove Bundle Item](https://docs.headlesscommerce.io/api-reference/admin--products/remove-bundle-item.md) - [Update Product](https://docs.headlesscommerce.io/api-reference/admin--products/update-product.md) - [Add Locale](https://docs.headlesscommerce.io/api-reference/admin--regions/add-locale.md) - [Create Region](https://docs.headlesscommerce.io/api-reference/admin--regions/create-region.md) - [Delete Locale](https://docs.headlesscommerce.io/api-reference/admin--regions/delete-locale.md) - [Delete Region](https://docs.headlesscommerce.io/api-reference/admin--regions/delete-region.md) - [Delete Translation](https://docs.headlesscommerce.io/api-reference/admin--regions/delete-translation.md) - [Get Region](https://docs.headlesscommerce.io/api-reference/admin--regions/get-region.md) - [Get Translations](https://docs.headlesscommerce.io/api-reference/admin--regions/get-translations.md) - [List Currency Rates](https://docs.headlesscommerce.io/api-reference/admin--regions/list-currency-rates.md) - [List Locales](https://docs.headlesscommerce.io/api-reference/admin--regions/list-locales.md) - [List Region Prices](https://docs.headlesscommerce.io/api-reference/admin--regions/list-region-prices.md) - [List Regions](https://docs.headlesscommerce.io/api-reference/admin--regions/list-regions.md) - [Set Currency Rates](https://docs.headlesscommerce.io/api-reference/admin--regions/set-currency-rates.md) - [Set Region Prices](https://docs.headlesscommerce.io/api-reference/admin--regions/set-region-prices.md) - [Set Translations](https://docs.headlesscommerce.io/api-reference/admin--regions/set-translations.md) - [Update Region](https://docs.headlesscommerce.io/api-reference/admin--regions/update-region.md) - [Approve Return](https://docs.headlesscommerce.io/api-reference/admin--returns/approve-return.md) - [Cancel Return](https://docs.headlesscommerce.io/api-reference/admin--returns/cancel-return.md) - [Complete Return](https://docs.headlesscommerce.io/api-reference/admin--returns/complete-return.md): Completes the return. If the return type is refund, a refund is automatically created. - [Create Return (Admin)](https://docs.headlesscommerce.io/api-reference/admin--returns/create-return-admin.md) - [Get Return](https://docs.headlesscommerce.io/api-reference/admin--returns/get-return.md) - [List Returns](https://docs.headlesscommerce.io/api-reference/admin--returns/list-returns.md) - [Receive Return](https://docs.headlesscommerce.io/api-reference/admin--returns/receive-return.md) - [Reject Return](https://docs.headlesscommerce.io/api-reference/admin--returns/reject-return.md) - [Create API Key](https://docs.headlesscommerce.io/api-reference/admin--settings/create-api-key.md): The original key is returned only once in the response. After that, only the masked value is available. - [Delete API Key](https://docs.headlesscommerce.io/api-reference/admin--settings/delete-api-key.md) - [Get Organization](https://docs.headlesscommerce.io/api-reference/admin--settings/get-organization.md) - [Invite Member](https://docs.headlesscommerce.io/api-reference/admin--settings/invite-member.md) - [List API Keys](https://docs.headlesscommerce.io/api-reference/admin--settings/list-api-keys.md) - [List Members](https://docs.headlesscommerce.io/api-reference/admin--settings/list-members.md) - [Remove Member](https://docs.headlesscommerce.io/api-reference/admin--settings/remove-member.md) - [Rotate API Key (Revoke Old + Issue New)](https://docs.headlesscommerce.io/api-reference/admin--settings/rotate-api-key-revoke-old-+-issue-new.md) - [Update Member Role](https://docs.headlesscommerce.io/api-reference/admin--settings/update-member-role.md) - [Update Organization](https://docs.headlesscommerce.io/api-reference/admin--settings/update-organization.md) - [Create Shipping Method](https://docs.headlesscommerce.io/api-reference/admin--shipping-methods/create-shipping-method.md) - [Delete Shipping Method](https://docs.headlesscommerce.io/api-reference/admin--shipping-methods/delete-shipping-method.md) - [List Shipping Methods](https://docs.headlesscommerce.io/api-reference/admin--shipping-methods/list-shipping-methods.md) - [Update Shipping Method](https://docs.headlesscommerce.io/api-reference/admin--shipping-methods/update-shipping-method.md) - [Get Store Settings](https://docs.headlesscommerce.io/api-reference/admin--store/get-store-settings.md) - [Update Store Settings](https://docs.headlesscommerce.io/api-reference/admin--store/update-store-settings.md) - [Get Upload URL](https://docs.headlesscommerce.io/api-reference/admin--uploads/get-upload-url.md): Issues an S3 Presigned URL for direct client-side uploads. - [Create Variant](https://docs.headlesscommerce.io/api-reference/admin--variants/create-variant.md) - [Delete Variant](https://docs.headlesscommerce.io/api-reference/admin--variants/delete-variant.md) - [List Variants](https://docs.headlesscommerce.io/api-reference/admin--variants/list-variants.md) - [Update Variant](https://docs.headlesscommerce.io/api-reference/admin--variants/update-variant.md) - [Create Webhook](https://docs.headlesscommerce.io/api-reference/admin--webhooks/create-webhook.md) - [Delete Webhook](https://docs.headlesscommerce.io/api-reference/admin--webhooks/delete-webhook.md) - [List Webhooks](https://docs.headlesscommerce.io/api-reference/admin--webhooks/list-webhooks.md) - [Send Test Webhook](https://docs.headlesscommerce.io/api-reference/admin--webhooks/send-test-webhook.md): Tests webhook integration in a development environment. Sends a sample payload with the specified event type. - [Update Webhook](https://docs.headlesscommerce.io/api-reference/admin--webhooks/update-webhook.md) - [Request Password Reset](https://docs.headlesscommerce.io/api-reference/auth/request-password-reset.md): Sends a password reset email to the dashboard user. Always returns a success message regardless of whether the email exists (prevents enumeration). The reset link expires in 1 hour. - [Reset Password](https://docs.headlesscommerce.io/api-reference/auth/reset-password.md): Completes the password reset flow using the token from the email link. - [API Reference](https://docs.headlesscommerce.io/api-reference/introduction.md): Complete reference for the Headless Commerce REST API - [Authorization Endpoint](https://docs.headlesscommerce.io/api-reference/oauth/authorization-endpoint.md): Starts the OAuth 2.1 Authorization Code flow with PKCE. - [Dynamic Client Registration](https://docs.headlesscommerce.io/api-reference/oauth/dynamic-client-registration.md): Register an OAuth client dynamically per [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591). - [OAuth Authorization Server Metadata](https://docs.headlesscommerce.io/api-reference/oauth/oauth-authorization-server-metadata.md): Returns OAuth 2.0 Authorization Server Metadata per [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). - [Token Endpoint](https://docs.headlesscommerce.io/api-reference/oauth/token-endpoint.md): Exchanges an authorization code for tokens, or refreshes an existing token. - [Add Item to Cart](https://docs.headlesscommerce.io/api-reference/storefront--cart/add-item-to-cart.md): If the same variant already exists in the cart, quantities are merged (upsert). Example: existing quantity 2 + added quantity 3 = total quantity 5 - [Apply Discount Code](https://docs.headlesscommerce.io/api-reference/storefront--cart/apply-discount-code.md) - [Checkout (Cart to Order + Payment)](https://docs.headlesscommerce.io/api-reference/storefront--cart/checkout-cart-to-order-+-payment.md): Converts a cart into an order and initiates payment. The response includes provider-specific payment data depending on `payment_method`: - **stripe** — `payment` object with `client_secret` and `payment_intent_id` for Stripe.js - **tosspayments** — `toss_payment` object with order info for TossPayme… - [Create Cart](https://docs.headlesscommerce.io/api-reference/storefront--cart/create-cart.md): Guest carts are identified by session_id (a client-generated UUID). Logged-in customers pass customer_id along with the X-Customer-Token header. If a guest omits session_id, the cart can only be identified by Cart ID. - [Get Cart by Session ID](https://docs.headlesscommerce.io/api-reference/storefront--cart/get-cart-by-session-id.md): Retrieves a guest user's cart by session_id. Used to restore an existing cart on page refresh or tab revisit. Only returns carts with active status. - [Get Cart (with Price Calculation)](https://docs.headlesscommerce.io/api-reference/storefront--cart/get-cart-with-price-calculation.md) - [Merge Guest Cart to Customer](https://docs.headlesscommerce.io/api-reference/storefront--cart/merge-guest-cart-to-customer.md): Merges a guest cart (identified by session_id) into the logged-in customer's cart. If the customer has an existing cart, items are combined; otherwise, ownership is transferred. - [Remove Discount Code](https://docs.headlesscommerce.io/api-reference/storefront--cart/remove-discount-code.md) - [Remove Item from Cart](https://docs.headlesscommerce.io/api-reference/storefront--cart/remove-item-from-cart.md) - [Update Cart (Address, Shipping, etc.)](https://docs.headlesscommerce.io/api-reference/storefront--cart/update-cart-address-shipping-etc.md) - [Update Item Quantity](https://docs.headlesscommerce.io/api-reference/storefront--cart/update-item-quantity.md) - [Customer Login](https://docs.headlesscommerce.io/api-reference/storefront--customer-auth/customer-login.md) - [Customer Register](https://docs.headlesscommerce.io/api-reference/storefront--customer-auth/customer-register.md) - [Forgot Password](https://docs.headlesscommerce.io/api-reference/storefront--customer-auth/forgot-password.md): Sends a password reset link to the registered email. For security, always returns 200 regardless of whether the email exists. - [Reset Password](https://docs.headlesscommerce.io/api-reference/storefront--customer-auth/reset-password.md) - [Add Address](https://docs.headlesscommerce.io/api-reference/storefront--customers/add-address.md) - [Delete Address](https://docs.headlesscommerce.io/api-reference/storefront--customers/delete-address.md) - [Get My Profile](https://docs.headlesscommerce.io/api-reference/storefront--customers/get-my-profile.md) - [List My Addresses](https://docs.headlesscommerce.io/api-reference/storefront--customers/list-my-addresses.md) - [Update Address](https://docs.headlesscommerce.io/api-reference/storefront--customers/update-address.md) - [Update My Profile](https://docs.headlesscommerce.io/api-reference/storefront--customers/update-my-profile.md) - [Get Order](https://docs.headlesscommerce.io/api-reference/storefront--orders/get-order.md) - [List My Orders](https://docs.headlesscommerce.io/api-reference/storefront--orders/list-my-orders.md) - [Lookup Guest Order (Order Number + Email)](https://docs.headlesscommerce.io/api-reference/storefront--orders/lookup-guest-order-order-number-+-email.md): Look up an order without a Customer Token. Both the order number and the email entered at checkout must match. For guest customers to check their order status. - [Confirm Payment (TossPayments)](https://docs.headlesscommerce.io/api-reference/storefront--payments/confirm-payment-tosspayments.md): Server-side payment confirmation after client-side TossPayments SDK approval. - [Get Category by Slug](https://docs.headlesscommerce.io/api-reference/storefront--products/get-category-by-slug.md): For SEO-friendly URLs. Retrieves category details by slug. - [Get Collection by Slug](https://docs.headlesscommerce.io/api-reference/storefront--products/get-collection-by-slug.md): For SEO-friendly URLs. Retrieves collection details by slug. - [Get Collection with Products](https://docs.headlesscommerce.io/api-reference/storefront--products/get-collection-with-products.md) - [Get Product](https://docs.headlesscommerce.io/api-reference/storefront--products/get-product.md) - [Get Product by Slug](https://docs.headlesscommerce.io/api-reference/storefront--products/get-product-by-slug.md): For SEO-friendly URLs. Retrieves product details by slug. - [List Categories (Tree)](https://docs.headlesscommerce.io/api-reference/storefront--products/list-categories-tree.md) - [List Collections](https://docs.headlesscommerce.io/api-reference/storefront--products/list-collections.md) - [List Products](https://docs.headlesscommerce.io/api-reference/storefront--products/list-products.md): Returns only products with active status. - [Cancel My Return](https://docs.headlesscommerce.io/api-reference/storefront--returns/cancel-my-return.md) - [Get My Return](https://docs.headlesscommerce.io/api-reference/storefront--returns/get-my-return.md) - [List My Returns](https://docs.headlesscommerce.io/api-reference/storefront--returns/list-my-returns.md) - [Request Return](https://docs.headlesscommerce.io/api-reference/storefront--returns/request-return.md) - [List Available Shipping Methods](https://docs.headlesscommerce.io/api-reference/storefront--shipping/list-available-shipping-methods.md) - [Customer Authentication](https://docs.headlesscommerce.io/authentication.md): JWT tokens, guest carts, and customer identity for Storefront API - [Company](https://docs.headlesscommerce.io/company.md): Business information and legal notices - [Error Handling](https://docs.headlesscommerce.io/errors.md): API error codes and how to handle them - [Recipes](https://docs.headlesscommerce.io/guides/recipes.md): Common patterns and code examples for Headless Commerce - [Stripe Integration](https://docs.headlesscommerce.io/guides/stripe-integration.md): Set up Stripe payments with Headless Commerce - [TossPayments Integration](https://docs.headlesscommerce.io/guides/tosspayments-integration.md): Set up TossPayments for Korean payment methods - [Introduction](https://docs.headlesscommerce.io/introduction.md): Headless Commerce — A complete REST API for products, carts, checkout, and order management. Build any storefront with any framework. - [Acceptable Use Policy](https://docs.headlesscommerce.io/legal/acceptable-use-policy.md): Rules and guidelines for using the Headless Commerce platform - [Data Processing Agreement](https://docs.headlesscommerce.io/legal/data-processing-agreement.md): Agreement governing how Headless Commerce processes data on behalf of Merchants - [Privacy Policy](https://docs.headlesscommerce.io/legal/privacy-policy.md): How Headless Commerce collects, uses, and protects your data - [Storefront Privacy Policy Template](https://docs.headlesscommerce.io/legal/storefront-privacy-template.md): A customizable privacy policy template for merchants to use in their storefronts - [Storefront Terms of Sale Template](https://docs.headlesscommerce.io/legal/storefront-terms-template.md): A customizable terms of sale template for merchants to use in their storefronts - [Terms of Service](https://docs.headlesscommerce.io/legal/terms-of-service.md): Terms governing your use of the Headless Commerce platform - [Pagination](https://docs.headlesscommerce.io/pagination.md): Navigate large collections with cursor-based pagination - [Pricing](https://docs.headlesscommerce.io/pricing.md): Transparent pricing with zero transaction fees - [SDKs](https://docs.headlesscommerce.io/sdks.md): Official TypeScript and Python clients for the Headless Commerce API - [Security](https://docs.headlesscommerce.io/security.md): How we protect your data and your customers' data - [MCP Server](https://docs.headlesscommerce.io/tools/mcp.md): Connect AI agents to your Headless Commerce store - [Webhooks](https://docs.headlesscommerce.io/webhooks.md): Receive real-time event notifications and process them reliably ## OpenAPI Specs - [openapi](https://docs.headlesscommerce.io/openapi.yaml) - [openapi.ko](https://docs.headlesscommerce.io/openapi.ko.yaml)