# Commerce Engine Docs: API Reference Admin API

> Official documentation for Commerce Engine - The modern headless commerce platform for building scalable e-commerce solutions.

## Admin API

### Admin

#### Analytics

- [Retrieve analytics chart data](https://www.commercengine.io/docs/admin/api-reference/analytics/retrieve-analytics-chart-data.md): Runs the chart query for the given `chart_type` and returns `content.stats`. Row shape varies by chart; `business_name` appears on `top_customers` rows only.
- [Dynamic query](https://www.commercengine.io/docs/admin/api-reference/analytics/dynamic-query.md): Retrive analytics data as per dynamic query passed.
- [Retrieve an event detail](https://www.commercengine.io/docs/admin/api-reference/analytics/retrieve-an-event-detail.md): Retrieve an event detail.
- [Raw query](https://www.commercengine.io/docs/admin/api-reference/analytics/raw-query.md): Retrive data as per raw query passed.
- [List analytics sessions](https://www.commercengine.io/docs/admin/api-reference/analytics/list-analytics-sessions.md): Lists analytics sessions. Optionally filter by `user_id`. Returns paginated session objects.
- [Retrieve a analytics session](https://www.commercengine.io/docs/admin/api-reference/analytics/retrieve-a-analytics-session.md): Retrieves a session and its paginated activity list.

#### Catalog

- [List all attribute sets](https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-attribute-sets.md): list all attribute sets
- [Create attribute set](https://www.commercengine.io/docs/admin/api-reference/catalog/create-attribute-set.md): create attribute set
- [Retrieve attribute set](https://www.commercengine.io/docs/admin/api-reference/catalog/retrieve-attribute-set.md): retrieve attribute set
- [Update attribute set](https://www.commercengine.io/docs/admin/api-reference/catalog/update-attribute-set.md): update attribute set
- [Delete attribute set](https://www.commercengine.io/docs/admin/api-reference/catalog/delete-attribute-set.md): delete attribute set
- [List all attributes](https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-attributes.md): list all attributes
- [Create attribute](https://www.commercengine.io/docs/admin/api-reference/catalog/create-attribute.md): create attribute
- [Retrieve attribute](https://www.commercengine.io/docs/admin/api-reference/catalog/retrieve-attribute.md): retrieve attribute
- [Update attribute](https://www.commercengine.io/docs/admin/api-reference/catalog/update-attribute.md): update attribute
- [Delete attribute](https://www.commercengine.io/docs/admin/api-reference/catalog/delete-attribute.md): delete attribute
- [List all categories](https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-categories.md): list all categories
- [Create category](https://www.commercengine.io/docs/admin/api-reference/catalog/create-category.md): create new category
- [Retrieve category](https://www.commercengine.io/docs/admin/api-reference/catalog/retrieve-category.md): retrieve category
- [Update category](https://www.commercengine.io/docs/admin/api-reference/catalog/update-category.md): update category
- [Delete category](https://www.commercengine.io/docs/admin/api-reference/catalog/delete-category.md): delete category
- [Retrieve category attributes](https://www.commercengine.io/docs/admin/api-reference/catalog/retrieve-category-attributes.md): retrieve category attributes
- [Create or update category attributes](https://www.commercengine.io/docs/admin/api-reference/catalog/create-or-update-category-attributes.md): create or update category attributes
- [Retrive data sync detail](https://www.commercengine.io/docs/admin/api-reference/catalog/retrive-data-sync-detail.md): Retrive data sync detail
- [Create request for data syncing](https://www.commercengine.io/docs/admin/api-reference/catalog/create-request-for-data-syncing.md): Create request for data syncing
- [Retrive item sync detail](https://www.commercengine.io/docs/admin/api-reference/catalog/retrive-item-sync-detail.md): Retrive item sync detail
- [List all item sync activity](https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-item-sync-activity.md): List all item sync activity
- [List catalog jobs](https://www.commercengine.io/docs/admin/api-reference/catalog/list-catalog-jobs.md): List catalog jobs
- [Create catalog job](https://www.commercengine.io/docs/admin/api-reference/catalog/create-catalog-job.md): Create a new catalog job for bulk product import or marketplace sync.
- [Get catalog job](https://www.commercengine.io/docs/admin/api-reference/catalog/get-catalog-job.md): Get catalog job
- [List all marketplace listings](https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-marketplace-listings.md): List all marketplace listings
- [Create or update marketplace listing](https://www.commercengine.io/docs/admin/api-reference/catalog/create-or-update-marketplace-listing.md): Create or update marketplace listing
- [List products on marketplace](https://www.commercengine.io/docs/admin/api-reference/catalog/list-products-on-marketplace.md): List products on marketplace
- [Remove marketplace listing](https://www.commercengine.io/docs/admin/api-reference/catalog/remove-marketplace-listing.md): Remove marketplace listing
- [Sync product on marketplace](https://www.commercengine.io/docs/admin/api-reference/catalog/sync-product-on-marketplace.md): Sync product on marketplace
- [Unlist products on marketplace](https://www.commercengine.io/docs/admin/api-reference/catalog/unlist-products-on-marketplace.md): Unlist products on marketplace
- [List all products](https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-products.md): list all products
- [Create product](https://www.commercengine.io/docs/admin/api-reference/catalog/create-product.md): This endpoint allows you to create a draft product by specifying its name and type. The product is created in its preliminary stage. All additional product details, including descriptions, pricing, and images, etc, can be updated using the Update Product API endpoint.
- [List all products channels](https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-products-channels.md): List all products associated with channels.
- [Add products channels](https://www.commercengine.io/docs/admin/api-reference/catalog/add-products-channels.md): Add channels to the specified products. Status of product/variant are linked to the channels. When channels are added or removed, the status of the product/variant is auto updated. Only storefront type channels are supported. Marketplace channels are added/removed from the marketplace list/unlist en…
- [Bulk delete products](https://www.commercengine.io/docs/admin/api-reference/catalog/bulk-delete-products.md): Deleting multiple products in single request.
- [Bulk update products](https://www.commercengine.io/docs/admin/api-reference/catalog/bulk-update-products.md): Update specific fields of multiple products in single request.
- [Check inventory](https://www.commercengine.io/docs/admin/api-reference/catalog/check-inventory.md): Retrieve products and variants inventory as per product ids and variant ids provided. To be used in S2S API call only.
- [Stock in products or variants](https://www.commercengine.io/docs/admin/api-reference/catalog/stock-in-products-or-variants.md): Marks the provided products/variants as in stock for storefront availability.
- [Stock out products or variants](https://www.commercengine.io/docs/admin/api-reference/catalog/stock-out-products-or-variants.md): Marks the provided products/variants as out of stock for storefront availability.
- [Retrieve product details](https://www.commercengine.io/docs/admin/api-reference/catalog/retrieve-product-details.md): Retrieve product details
- [Update product details](https://www.commercengine.io/docs/admin/api-reference/catalog/update-product-details.md): This API endpoint allows for partial updates to product details, enabling you to modify specific attributes like pricing, descriptions, images, promotions, subscriptions, and more, without altering the entire product record. To optimize performance, please include only the fields that need updating.…
- [Delete product](https://www.commercengine.io/docs/admin/api-reference/catalog/delete-product.md): Delete product
- [Retrieve product inventory](https://www.commercengine.io/docs/admin/api-reference/catalog/retrieve-product-inventory.md): Retrieve product inventory
- [Update Product Inventory](https://www.commercengine.io/docs/admin/api-reference/catalog/update-product-inventory.md): Update product inventory
- [List all inventory activities](https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-inventory-activities.md): List all inventory activities
- [Create inventory activity](https://www.commercengine.io/docs/admin/api-reference/catalog/create-inventory-activity.md): Create inventory activity
- [List all shipper boxes](https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-shipper-boxes.md): List all shipper boxes
- [List all product variants](https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-product-variants.md): List all product variants
- [Create variant](https://www.commercengine.io/docs/admin/api-reference/catalog/create-variant.md): Create variant
- [Update variants in bulk](https://www.commercengine.io/docs/admin/api-reference/catalog/update-variants-in-bulk.md): Update shipping and packaging details of multiple variants.
- [Update a variant](https://www.commercengine.io/docs/admin/api-reference/catalog/update-a-variant.md): Update a variant
- [Delete a variant](https://www.commercengine.io/docs/admin/api-reference/catalog/delete-a-variant.md): Delete a variant
- [List product reviews](https://www.commercengine.io/docs/admin/api-reference/catalog/list-product-reviews.md): List product reviews
- [Retrieve product review](https://www.commercengine.io/docs/admin/api-reference/catalog/retrieve-product-review.md): Retrieve product review
- [Update product review](https://www.commercengine.io/docs/admin/api-reference/catalog/update-product-review.md): Update product review
- [Delete product review](https://www.commercengine.io/docs/admin/api-reference/catalog/delete-product-review.md): Delete product review
- [List all SKUs](https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-skus.md): List all SKUs

#### Filter Options

- [List all catalog filter options](https://www.commercengine.io/docs/admin/api-reference/filter-options/list-all-catalog-filter-options.md): List all filter options for catalog listing data.
- [List all customers filter options](https://www.commercengine.io/docs/admin/api-reference/filter-options/list-all-customers-filter-options.md): List all filter options for customers listing data.
- [List all marketplace filter options](https://www.commercengine.io/docs/admin/api-reference/filter-options/list-all-marketplace-filter-options.md): List all filter options for marketplace listing data.
- [List all media filter options](https://www.commercengine.io/docs/admin/api-reference/filter-options/list-all-media-filter-options.md): List all filter options for media listing data.
- [List all offer filter options](https://www.commercengine.io/docs/admin/api-reference/filter-options/list-all-offer-filter-options.md): List all filter options for offer listing data.
- [List all orders filter options](https://www.commercengine.io/docs/admin/api-reference/filter-options/list-all-orders-filter-options.md): List all filter options for orders listing data.
- [List all pos filter options](https://www.commercengine.io/docs/admin/api-reference/filter-options/list-all-pos-filter-options.md): List all filter options for pos listing data.
- [List all shipping filter options](https://www.commercengine.io/docs/admin/api-reference/filter-options/list-all-shipping-filter-options.md): List all filter options for shipping listing data.
- [List all store filter options](https://www.commercengine.io/docs/admin/api-reference/filter-options/list-all-store-filter-options.md): List all filter options for store listing data.
- [List all webhooks filter options](https://www.commercengine.io/docs/admin/api-reference/filter-options/list-all-webhooks-filter-options.md): List all filter options for webhooks listing data.

#### Inventories

- [List all inventories](https://www.commercengine.io/docs/admin/api-reference/inventories/list-all-inventories.md): List all inventories
- [List all inventories activities](https://www.commercengine.io/docs/admin/api-reference/inventories/list-all-inventories-activities.md): Lists all inventory related activities of stock movements. This provides a comprehensive audit trail of inventory operations such as receiving, reservations, adjustments, transfers, and sales.
- [Retrieve inventory detail](https://www.commercengine.io/docs/admin/api-reference/inventories/retrieve-inventory-detail.md): Retrieves inventory details for a specific product, product variant, or lot/batch based on the parameters provided.

#### Marketplace Catalog

- [List all products](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/list-all-products.md): list all products
- [List all products channels](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/list-all-products-channels.md): List all products associated with channels.
- [Add products channels](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/add-products-channels.md): Add channels to the specified products.
- [Check inventory](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/check-inventory.md): Retrieve products and variants inventory as per product ids and variant ids provided. To be used in S2S API call only.
- [Publish products](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/publish-products.md): Publish products
- [Stock in products or variants](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/stock-in-products-or-variants.md): Marks the provided products/variants as in stock for storefront availability.
- [Stock out products or variants](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/stock-out-products-or-variants.md): Marks the provided products/variants as out of stock for storefront availability.
- [Unpublish products](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/unpublish-products.md): Unpublish products
- [Retrieve product details](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/retrieve-product-details.md): Retrieve product details
- [Retrieve product inventory](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/retrieve-product-inventory.md): Retrieve product inventory
- [Update Product Inventory](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/update-product-inventory.md): Update product inventory
- [List all inventory activities](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/list-all-inventory-activities.md): List all inventory activities
- [Create inventory activity](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/create-inventory-activity.md): Create inventory activity
- [List all product variants](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/list-all-product-variants.md): List all product variants
- [List product reviews](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/list-product-reviews.md): List product reviews
- [Retrieve product review](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/retrieve-product-review.md): Retrieve product review
- [Update product review](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/update-product-review.md): Update product review
- [Retrieve a variant details](https://www.commercengine.io/docs/admin/api-reference/marketplace-catalog/retrieve-a-variant-details.md): Retrieve a product variant details

#### Metrics

- [Retrieve product analytics stats](https://www.commercengine.io/docs/admin/api-reference/metrics/retrieve-product-analytics-stats.md): Retrieve product analytics stats
- [Retrieve customers stats](https://www.commercengine.io/docs/admin/api-reference/metrics/retrieve-customers-stats.md): Retrieve customers stats
- [Retrieve coupons stats](https://www.commercengine.io/docs/admin/api-reference/metrics/retrieve-coupons-stats.md): Retrieve coupons stats
- [Retrieve orders stats](https://www.commercengine.io/docs/admin/api-reference/metrics/retrieve-orders-stats.md): Retrieve orders stats
- [List all top selling products](https://www.commercengine.io/docs/admin/api-reference/metrics/list-all-top-selling-products.md): List all top selling products
- [Retrieve payments stats](https://www.commercengine.io/docs/admin/api-reference/metrics/retrieve-payments-stats.md): Retrieve payments stats
- [Retrieve seller payout stats](https://www.commercengine.io/docs/admin/api-reference/metrics/retrieve-seller-payout-stats.md): Retrieves seller payout amounts and invoice volumes bucketed by payout state. Returns a `SellerPayoutStats` object per interval in `stats`, plus a `lifetime_stats` roll-up across all time.
- [Retrieve shipments stats](https://www.commercengine.io/docs/admin/api-reference/metrics/retrieve-shipments-stats.md): Retrieve shipments stats
- [Retrieve webhook stats](https://www.commercengine.io/docs/admin/api-reference/metrics/retrieve-webhook-stats.md): Retrieve webhook stats

#### Customers

- [List all customers](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-customers.md): List all customers
- [Create customer](https://www.commercengine.io/docs/admin/api-reference/customers/create-customer.md): Creates a customer and returns the created `Customer` object. Set `customer_group_id` to place the customer in a Customer Group, which drives group-specific pricing and promotions.
- [List all attributes](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-attributes.md): List all attributes
- [Create an attribute](https://www.commercengine.io/docs/admin/api-reference/customers/create-an-attribute.md): Create an attribute
- [Retrieve attribute detail](https://www.commercengine.io/docs/admin/api-reference/customers/retrieve-attribute-detail.md): Retrieve attribute detail
- [Update an attribute](https://www.commercengine.io/docs/admin/api-reference/customers/update-an-attribute.md): Update an attribute
- [Delete an attribute](https://www.commercengine.io/docs/admin/api-reference/customers/delete-an-attribute.md): Delete an attribute
- [Set credit line eligibility](https://www.commercengine.io/docs/admin/api-reference/customers/set-credit-line-eligibility.md): Bulk-provisions approved spending limits for multiple customers, making each eligible to create a mandate.
- [List all loyalty members](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-loyalty-members.md): List all loyalty members
- [Change loyalty tier](https://www.commercengine.io/docs/admin/api-reference/customers/change-loyalty-tier.md): Change loyalty tier for customers
- [List all loyalty program](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-loyalty-program.md): List all loyalty program
- [Create loyalty program](https://www.commercengine.io/docs/admin/api-reference/customers/create-loyalty-program.md): Creates a new loyalty program with default status set to `draft`. Only one loyalty program can be in `draft` status at a time. To schedule a loyalty program for future, provide a future datetime value in `starts_at`. Use the activate endpoint to make it active or scheduled. Returns the created `Loya…
- [Retrieve loyalty program detail](https://www.commercengine.io/docs/admin/api-reference/customers/retrieve-loyalty-program-detail.md): Retrieve loyalty program detail
- [Update loyalty program detail](https://www.commercengine.io/docs/admin/api-reference/customers/update-loyalty-program-detail.md): Update loyalty program detail
- [Delete loyalty program](https://www.commercengine.io/docs/admin/api-reference/customers/delete-loyalty-program.md): Delete loyalty program
- [Activate loyalty program](https://www.commercengine.io/docs/admin/api-reference/customers/activate-loyalty-program.md): Activates or schedules the loyalty program, setting its status to `active` or `scheduled`. Only one loyalty program can be `active` at a time, and only one can be `scheduled` at a time. Can only be used when the current status is `draft` or `inactive`. Returns the updated `LoyaltyProgram` object.
- [Deactivate loyalty program](https://www.commercengine.io/docs/admin/api-reference/customers/deactivate-loyalty-program.md): Deactivates the loyalty program, setting its status to `inactive`. Can only be used when the current status is `active`, `scheduled`, or `paused`. Returns the updated `LoyaltyProgram` object.
- [Pause loyalty program](https://www.commercengine.io/docs/admin/api-reference/customers/pause-loyalty-program.md): Pauses the loyalty program, setting its status to `paused`. Can only be used when the current status is `active` or `paused`. Returns the updated `LoyaltyProgram` object.
- [Resume loyalty program](https://www.commercengine.io/docs/admin/api-reference/customers/resume-loyalty-program.md): Resumes a paused loyalty program, setting its status to `active`. Can only be used when the current status is `paused`. Returns the updated `LoyaltyProgram` object.
- [List all visitors](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-visitors.md): List all visitors
- [Retrieve visitor detail](https://www.commercengine.io/docs/admin/api-reference/customers/retrieve-visitor-detail.md): Retrieve visitor detail
- [List all activities](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-activities.md): List all activities
- [List all visitor attributes](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-visitor-attributes.md): List all visitor attributes
- [Create an attribute](https://www.commercengine.io/docs/admin/api-reference/customers/create-an-attribute-1.md): Create an attribute
- [Update visitor attribute](https://www.commercengine.io/docs/admin/api-reference/customers/update-visitor-attribute.md): Update visitor attribute
- [Delete visitor attribute](https://www.commercengine.io/docs/admin/api-reference/customers/delete-visitor-attribute.md): Delete visitor attribute
- [Get customer credit balance](https://www.commercengine.io/docs/admin/api-reference/customers/get-customer-credit-balance.md): Retrieves a customer's bank-transfer credit balance. Returns a `CustomerCreditBalance` with `received_amount`, `settled_amount`, and spendable `balance_amount`.
- [Get credit line balance](https://www.commercengine.io/docs/admin/api-reference/customers/get-credit-line-balance.md): Retrieves the `CustomerCreditLineBalance` for a customer.
- [List mandate debit schedules](https://www.commercengine.io/docs/admin/api-reference/customers/list-mandate-debit-schedules.md): Retrieves the paginated list of `MandateDebitSchedule` entries for a customer across all mandates. Each entry represents a queued, executed, retried, or cancelled mandate-based debit attempt. Use optional `mandate_id` and `status` query parameters to narrow results.
- [List all mandates](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-mandates.md): Retrieves the paginated list of `CustomerMandate` entries for a customer. Use the optional `status` query parameter to filter by mandate lifecycle state.
- [Get mandate](https://www.commercengine.io/docs/admin/api-reference/customers/get-mandate.md): Retrieve a mandate for a given customer.
- [List mandate activity](https://www.commercengine.io/docs/admin/api-reference/customers/list-mandate-activity.md): Retrieves the paginated audit trail of lifecycle actions for a mandate — activation, pause, resume, revoke, and provider sync events. Each entry is a `MandateActivity` recording who performed the action, the outcome, and optional context in `details`.
- [List mandate logs](https://www.commercengine.io/docs/admin/api-reference/customers/list-mandate-logs.md): Retrieves the paginated request/response logs from the mandate provider for a given mandate. Use the optional `debit_schedule_id` query parameter to filter to a specific debit attempt.
- [Pause mandate](https://www.commercengine.io/docs/admin/api-reference/customers/pause-mandate.md): Pause a mandate for a given customer.
- [Resume mandate](https://www.commercengine.io/docs/admin/api-reference/customers/resume-mandate.md): Resume a paused mandate for a given customer.
- [Revoke mandate](https://www.commercengine.io/docs/admin/api-reference/customers/revoke-mandate.md): Revoke a mandate for a given customer.
- [Retrieve customer detail](https://www.commercengine.io/docs/admin/api-reference/customers/retrieve-customer-detail.md): Retrieves the full `CustomerDetail` object, including `business`, `segments`, `addresses`, `banking`, `loyalty`, `notification_preferences`, and the assigned `customer_group_id`.
- [Update customer](https://www.commercengine.io/docs/admin/api-reference/customers/update-customer.md): Updates a customer's profile and returns the updated `CustomerDetail` object. Change `customer_group_id` to move the customer to a different Customer Group, which drives group-specific pricing and promotions.
- [List all activities](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-activities-1.md): List all activities
- [List all addresses](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-addresses.md): List all addresses
- [Create address](https://www.commercengine.io/docs/admin/api-reference/customers/create-address.md): Create address
- [Update address detail](https://www.commercengine.io/docs/admin/api-reference/customers/update-address-detail.md): Update address detail
- [Delete address](https://www.commercengine.io/docs/admin/api-reference/customers/delete-address.md): Delete address
- [List all customer attributes](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-customer-attributes.md): List all customer attributes
- [Create an attribute](https://www.commercengine.io/docs/admin/api-reference/customers/create-an-attribute-2.md): Create an attribute
- [Update customer attribute](https://www.commercengine.io/docs/admin/api-reference/customers/update-customer-attribute.md): Update customer attribute
- [Delete customer attribute](https://www.commercengine.io/docs/admin/api-reference/customers/delete-customer-attribute.md): Delete customer attribute
- [Get authorized sellers for customer](https://www.commercengine.io/docs/admin/api-reference/customers/get-authorized-sellers-for-customer.md): Get authorized sellers for customer
- [Authorize a seller for a customer](https://www.commercengine.io/docs/admin/api-reference/customers/authorize-a-seller-for-a-customer.md): Authorizes a seller for a customer. Use this for private sellers the customer can buy from.
- [Unauthorize a seller for a customer](https://www.commercengine.io/docs/admin/api-reference/customers/unauthorize-a-seller-for-a-customer.md): Removes a seller from the customer's authorized seller list.
- [List all bank accounts](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-bank-accounts.md): List all bank accounts
- [Create a bank account](https://www.commercengine.io/docs/admin/api-reference/customers/create-a-bank-account.md): Add a new bank account for a customer. Returns the created `CustomerBankAccount` object.
- [Retrieve bank account detail](https://www.commercengine.io/docs/admin/api-reference/customers/retrieve-bank-account-detail.md): Retrieve bank account detail
- [Update a bank account](https://www.commercengine.io/docs/admin/api-reference/customers/update-a-bank-account.md): Update an existing bank account for a customer. Outbound accounts support full updates; inbound accounts can only update `is_default`. Returns the updated `CustomerBankAccount` object.
- [Delete bank account](https://www.commercengine.io/docs/admin/api-reference/customers/delete-bank-account.md): Delete bank account
- [List all documents](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-documents.md): List all documents
- [Create document](https://www.commercengine.io/docs/admin/api-reference/customers/create-document.md): Create document
- [Retrieve document detail](https://www.commercengine.io/docs/admin/api-reference/customers/retrieve-document-detail.md): Retrieve document detail
- [Update document detail](https://www.commercengine.io/docs/admin/api-reference/customers/update-document-detail.md): Update document detail
- [Delete document](https://www.commercengine.io/docs/admin/api-reference/customers/delete-document.md): Delete document
- [List all loyalty point activities](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-loyalty-point-activities.md): List all loyalty point activities
- [Create loyalty point activity](https://www.commercengine.io/docs/admin/api-reference/customers/create-loyalty-point-activity.md): Create loyalty point activity
- [List all loyalty tier activities](https://www.commercengine.io/docs/admin/api-reference/customers/list-all-loyalty-tier-activities.md): List all loyalty tier activities
- [Retrieve notification preferences](https://www.commercengine.io/docs/admin/api-reference/customers/retrieve-notification-preferences.md): Retrieve notification preferences
- [Update notification preferences](https://www.commercengine.io/docs/admin/api-reference/customers/update-notification-preferences.md): Update notification preferences
- [List customer users](https://www.commercengine.io/docs/admin/api-reference/customers/list-customer-users.md): Retrieves the users linked to a customer. Returns `CustomerUser` objects with pagination metadata.
- [Activate a customer user](https://www.commercengine.io/docs/admin/api-reference/customers/activate-a-customer-user.md): Activates a user linked to the customer. Returns the updated `CustomerUser` object.
- [Deactivate a customer user](https://www.commercengine.io/docs/admin/api-reference/customers/deactivate-a-customer-user.md): Deactivates a user linked to the customer. Returns the updated `CustomerUser` object.

#### Segments

- [List all segments](https://www.commercengine.io/docs/admin/api-reference/segments/list-all-segments.md): List all segments
- [Create a segment](https://www.commercengine.io/docs/admin/api-reference/segments/create-a-segment.md): Create a segment. In case of dynamic segment, conditions field should accept only the json format specified. Proper validation message should be returned in case different jsob object is provided.
- [Retrieve segment detail](https://www.commercengine.io/docs/admin/api-reference/segments/retrieve-segment-detail.md): Retrieve segment detail
- [Update segment detail](https://www.commercengine.io/docs/admin/api-reference/segments/update-segment-detail.md): Update segment detail
- [Delete segment](https://www.commercengine.io/docs/admin/api-reference/segments/delete-segment.md): Delete segment if not used in anywhere.
- [Create ad-audience](https://www.commercengine.io/docs/admin/api-reference/segments/create-ad-audience.md): Create Ad-audience
- [Retrieve ad-audience detail](https://www.commercengine.io/docs/admin/api-reference/segments/retrieve-ad-audience-detail.md): Retrieve ad-audience detail
- [Update ad-audience detail](https://www.commercengine.io/docs/admin/api-reference/segments/update-ad-audience-detail.md): Update ad-audience detail
- [Delete ad-audience](https://www.commercengine.io/docs/admin/api-reference/segments/delete-ad-audience.md): Delete ad-audience
- [List all ad-audience sync hisory](https://www.commercengine.io/docs/admin/api-reference/segments/list-all-ad-audience-sync-hisory.md): List all ad-audience sync hisory
- [List all segment members](https://www.commercengine.io/docs/admin/api-reference/segments/list-all-segment-members.md): List all segment members. Data will be fetched from clickhouse database, using raw sql written on clickhouse db tables by matching segment dynamic conditions or matching user id of manual segment.
- [Add segment members](https://www.commercengine.io/docs/admin/api-reference/segments/add-segment-members.md): Add segment members in manual segment type.
- [Delete segment members](https://www.commercengine.io/docs/admin/api-reference/segments/delete-segment-members.md): Delete segment members in manual segment type.
- [Retrieve members metrics](https://www.commercengine.io/docs/admin/api-reference/segments/retrieve-members-metrics.md): Retrieve members metrics. Data should be retrieved from clickhouse database using raw sql.

#### Marketplace

- [Get marketplace category attributes](https://www.commercengine.io/docs/admin/api-reference/marketplace/get-marketplace-category-attributes.md): Get marketplace attributes for a specific category
- [Create or update marketplace category attributes](https://www.commercengine.io/docs/admin/api-reference/marketplace/create-or-update-marketplace-category-attributes.md): Create or update marketplace attributes for a specific category
- [Get marketplace categories schema](https://www.commercengine.io/docs/admin/api-reference/marketplace/get-marketplace-categories-schema.md): Get marketplace categories schema
- [Create or update marketplace categories schema](https://www.commercengine.io/docs/admin/api-reference/marketplace/create-or-update-marketplace-categories-schema.md): Create or update marketplace categories schema
- [Retrieve marketplace config](https://www.commercengine.io/docs/admin/api-reference/marketplace/retrieve-marketplace-config.md): Retrieve marketplace config

#### Media Gallery

- [List all files](https://www.commercengine.io/docs/admin/api-reference/media-gallery/list-all-files.md): List all files
- [Delete multiple files](https://www.commercengine.io/docs/admin/api-reference/media-gallery/delete-multiple-files.md): Delete multiple files
- [Move multiple files](https://www.commercengine.io/docs/admin/api-reference/media-gallery/move-multiple-files.md): Move multiple files
- [Update upload complete status](https://www.commercengine.io/docs/admin/api-reference/media-gallery/update-upload-complete-status.md): Update upload complete status
- [Create upload request](https://www.commercengine.io/docs/admin/api-reference/media-gallery/create-upload-request.md): Create upload request
- [Retrieve file detail](https://www.commercengine.io/docs/admin/api-reference/media-gallery/retrieve-file-detail.md): Retrieve file detail
- [Update file detail](https://www.commercengine.io/docs/admin/api-reference/media-gallery/update-file-detail.md): Update file detail
- [Delete file](https://www.commercengine.io/docs/admin/api-reference/media-gallery/delete-file.md): Delete file
- [List all folders](https://www.commercengine.io/docs/admin/api-reference/media-gallery/list-all-folders.md): List all folders
- [Create a folder](https://www.commercengine.io/docs/admin/api-reference/media-gallery/create-a-folder.md): Create a folder
- [Retrieve folder detail](https://www.commercengine.io/docs/admin/api-reference/media-gallery/retrieve-folder-detail.md): Retrieve folder detail
- [Update folder detail](https://www.commercengine.io/docs/admin/api-reference/media-gallery/update-folder-detail.md): Update folder detail
- [Delete folder](https://www.commercengine.io/docs/admin/api-reference/media-gallery/delete-folder.md): Delete folder

#### Coupons & promotions

- [List all coupons](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/list-all-coupons.md): List all coupons
- [Create coupon](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/create-coupon.md): Create coupon
- [Retrieve a coupon](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/retrieve-a-coupon.md): Returns a complete `CouponDetail` object for the coupon, including eligibility, redemption limits, and type-specific `details`.
- [Update coupon](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/update-coupon.md): Update coupon
- [Delete a coupon](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/delete-a-coupon.md): Delete a coupon
- [List all coupon codes](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/list-all-coupon-codes.md): List all coupon codes.
- [Add coupon code](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/add-coupon-code.md): Add coupon code
- [Delete coupon codes](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/delete-coupon-codes.md): Deletes one or more codes from a coupon. Codes that have already been redeemed cannot be deleted; the request fails with the `codes-in-use` error code and returns the offending codes in `errors.coupon_code`.
- [List all coupon customers](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/list-all-coupon-customers.md): List all customers who used the specified coupon at least once.
- [List all coupon orders](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/list-all-coupon-orders.md): List all coupon orders
- [List promotions](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/list-promotions.md): Returns a paginated array of full `Promotion` objects.
- [Create promotion](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/create-promotion.md): Create promotion
- [Retrieve a promotion](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/retrieve-a-promotion.md): Returns a complete `PromotionDetail` object, including eligibility, redemption limits, and type-specific `details`.
- [Update promotion](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/update-promotion.md): Update promotion
- [Delete Promotion](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/delete-promotion.md): Delete specific promotion
- [List customers who used a promotion](https://www.commercengine.io/docs/admin/api-reference/coupons-&-promotions/list-customers-who-used-a-promotion.md): Returns customers who redeemed the promotion at least once, with pagination.

#### Orders

- [List all orders](https://www.commercengine.io/docs/admin/api-reference/orders/list-all-orders.md): List all orders
- [List all abandoned carts](https://www.commercengine.io/docs/admin/api-reference/orders/list-all-abandoned-carts.md): List all abandoned carts
- [List all invoices](https://www.commercengine.io/docs/admin/api-reference/orders/list-all-invoices.md): Retrieves a paginated list of tax invoices across all orders. Returns an array of `InvoiceList` objects, each carrying tax-exclusive and tax-inclusive totals plus a GST `tax_summary`. One invoice is raised per shipment, so a multi-shipment order appears as multiple rows. Use `/orders/{order_number}/…
- [List all products purchase count](https://www.commercengine.io/docs/admin/api-reference/orders/list-all-products-purchase-count.md): List all products purchase count
- [Estimate refund for a shipment or order](https://www.commercengine.io/docs/admin/api-reference/orders/estimate-refund-for-a-shipment-or-order.md): Calculates the refund amount and breakdown for an order or a specific shipment before a cancellation is initiated. Returns an `OrderRefundEstimate` describing the total refundable amount, its split across the original payment modes/methods, the recommended and available refund modes, and any refunds…
- [List all subscriptions](https://www.commercengine.io/docs/admin/api-reference/orders/list-all-subscriptions.md): List all subscriptions
- [Retrieve a subscription details](https://www.commercengine.io/docs/admin/api-reference/orders/retrieve-a-subscription-details.md): Retrieve a subscription details
- [List all subscription customers](https://www.commercengine.io/docs/admin/api-reference/orders/list-all-subscription-customers.md): List all subscription customers
- [Retrieve order details](https://www.commercengine.io/docs/admin/api-reference/orders/retrieve-order-details.md): Retrieve order details
- [Update order details](https://www.commercengine.io/docs/admin/api-reference/orders/update-order-details.md): Update order details
- [Accept order](https://www.commercengine.io/docs/admin/api-reference/orders/accept-order.md): Accept order
- [List all order activity](https://www.commercengine.io/docs/admin/api-reference/orders/list-all-order-activity.md): List all order activity
- [Create order activity](https://www.commercengine.io/docs/admin/api-reference/orders/create-order-activity.md): Create order activity
- [Cancel an order](https://www.commercengine.io/docs/admin/api-reference/orders/cancel-an-order.md): Cancels an order and initiates a refund for any captured payment. Returns the updated `OrderDetail` object.
- [Check inventory](https://www.commercengine.io/docs/admin/api-reference/orders/check-inventory.md): Verifies stock availability for an order's unscheduled or store_rejected shipment before it is scheduled.
- [Retrieve order invoice](https://www.commercengine.io/docs/admin/api-reference/orders/retrieve-order-invoice.md): Retrieve order invoice
- [Retrieve order receipt](https://www.commercengine.io/docs/admin/api-reference/orders/retrieve-order-receipt.md): Retrieves a printable receipt for a specific order using the order number. This endpoint returns either structured JSON data or a formatted PDF, suitable for customer presentation. Response format (JSON or PDF) is determined by an optional query parameter (e.g. format=pdf or format=json).
- [Retrieve order shipments](https://www.commercengine.io/docs/admin/api-reference/orders/retrieve-order-shipments.md): Retrieve order shipments
- [Verify order payment](https://www.commercengine.io/docs/admin/api-reference/orders/verify-order-payment.md): Verify order payment

#### Payments

- [List all payments](https://www.commercengine.io/docs/admin/api-reference/payments/list-all-payments.md): List all payments
- [Create Payment](https://www.commercengine.io/docs/admin/api-reference/payments/create-payment.md): Create Payment
- [Refund payment](https://www.commercengine.io/docs/admin/api-reference/payments/refund-payment.md): Refund payment
- [Retrieve payment details](https://www.commercengine.io/docs/admin/api-reference/payments/retrieve-payment-details.md): Retrieve payment details
- [Cancel Payment](https://www.commercengine.io/docs/admin/api-reference/payments/cancel-payment.md): Cancel Payment

#### Payouts

- [List seller payout config](https://www.commercengine.io/docs/admin/api-reference/payouts/list-seller-payout-config.md): List the seller payout configurations for the marketplace store. Each `SellerPayoutConfig` holds the commission, hold period, and payout inclusion rules applied to a single seller.
- [Create or update seller payout config](https://www.commercengine.io/docs/admin/api-reference/payouts/create-or-update-seller-payout-config.md): Create the seller payout configuration for the marketplace store, or update the existing configuration.
- [Retrieve seller payout config](https://www.commercengine.io/docs/admin/api-reference/payouts/retrieve-seller-payout-config.md): Retrieve a single seller payout configuration by its `ulid`. Returns the full `SellerPayoutConfig` object, including the `seller_detail` of the seller it applies to.
- [List seller payout invoices](https://www.commercengine.io/docs/admin/api-reference/payouts/list-seller-payout-invoices.md): Retrieves a paginated list of seller invoices tracked by the payout pipeline. Each `SellerPayoutInvoice` carries the order and shipment it settles, the `SellerPayoutCharge` deductions applied to it, and its `payout_batch_id` once batched. Read `status` to tell where an invoice sits: `eligible` invoi…
- [Create seller payout adjustment](https://www.commercengine.io/docs/admin/api-reference/payouts/create-seller-payout-adjustment.md): Create a credit or debit adjustment for a seller. The adjustment is created in pending status and may be picked up by the next payout batch.
- [List seller payout batches](https://www.commercengine.io/docs/admin/api-reference/payouts/list-seller-payout-batches.md): Retrieves a paginated list of payout batches. Each entry is a `SellerPayoutBatch` summary carrying the `OrderPayment` transfers made against it, but without invoices or adjustments; retrieve a batch by `id` for the expanded `SellerPayoutBatchDetail`.
- [Create seller payout batch](https://www.commercengine.io/docs/admin/api-reference/payouts/create-seller-payout-batch.md): Manually create a scheduled seller payout batch from selected pending payout invoices.
- [List seller payout batch activities](https://www.commercengine.io/docs/admin/api-reference/payouts/list-seller-payout-batch-activities.md): Retrieves a paginated audit trail of events recorded while payout batches are processed. Each `SellerPayoutBatchActivity` names the `batch_id` it belongs to and, for gateway-facing events, captures the request and response exchanged with the payout provider. Use it to diagnose batches stuck in `proc…
- [Retrieve a seller payout batch](https://www.commercengine.io/docs/admin/api-reference/payouts/retrieve-a-seller-payout-batch.md): Retrieves a single payout batch. Returns a `SellerPayoutBatchDetail` object: the batch totals plus the full `SellerPayoutInvoice` list it settles and any `SellerPayoutAdjustment` records applied to it.
- [Update a seller payout batch](https://www.commercengine.io/docs/admin/api-reference/payouts/update-a-seller-payout-batch.md): Switches how a batch will be settled by updating its `payment_option`. Move a batch to `manual` to take it out of automated processing and pay the seller yourself, then record the transfer with the manual-payment endpoint; move it back to `auto` to let the connected payout provider settle it. Return…
- [Pay a seller payout batch early](https://www.commercengine.io/docs/admin/api-reference/payouts/pay-a-seller-payout-batch-early.md): Triggers the transfer for a `scheduled` batch straight away instead of waiting for its `scheduled_at` run. Available while `pay-early` is listed in the batch's `allowed_actions`. The transfer is processed asynchronously, so poll `GET /orders/payouts/invoices/batches/{id}` for the outcome and read `p…
- [Cancel a seller payout batch](https://www.commercengine.io/docs/admin/api-reference/payouts/cancel-a-seller-payout-batch.md): Cancels a payout batch before it is transferred and releases the invoices it was holding. Only `scheduled` and `on_hold` batches can be cancelled; once a batch has been transferred it is immutable. Use `reassign_batch` to choose whether those invoices are regrouped into a new batch immediately or re…
- [Hold a seller payout batch](https://www.commercengine.io/docs/admin/api-reference/payouts/hold-a-seller-payout-batch.md): Puts a payout batch on hold so the next transfer run skips it. `status` moves to `on_hold` and the batch stays out of settlement until it is unheld. Use this to stop a scheduled payout without cancelling the batch or releasing its invoices. Returns the updated `SellerPayoutBatch`.
- [Record a manual payment for a payout batch](https://www.commercengine.io/docs/admin/api-reference/payouts/record-a-manual-payment-for-a-payout-batch.md): Records a payout that was transferred to the seller outside the platform, for example a bank transfer made from your own banking portal. Use this when the store `payout` configuration is `manual`, or when an `auto` batch had to be settled by hand. Marks the batch as paid and returns the updated `Sel…
- [Unhold a seller payout batch](https://www.commercengine.io/docs/admin/api-reference/payouts/unhold-a-seller-payout-batch.md): Releases a held payout batch back into the payout pipeline so the next transfer run can pick it up. Returns the updated `SellerPayoutBatch`.
- [Create seller payout charge](https://www.commercengine.io/docs/admin/api-reference/payouts/create-seller-payout-charge.md): Create an admin-applied charge against a pending seller payout invoice.
- [Hold seller payout invoices](https://www.commercengine.io/docs/admin/api-reference/payouts/hold-seller-payout-invoices.md): Put one or more seller payout invoices on hold and rebalance any affected scheduled payout batch.
- [Unhold seller payout invoices](https://www.commercengine.io/docs/admin/api-reference/payouts/unhold-seller-payout-invoices.md): Move one or more held seller payout invoices back to pending status.

#### POS

- [List all POS devices](https://www.commercengine.io/docs/admin/api-reference/pos/list-all-pos-devices.md): List all POS devices
- [Create POS device](https://www.commercengine.io/docs/admin/api-reference/pos/create-pos-device.md): Create POS device
- [Retrieve POS device detail](https://www.commercengine.io/docs/admin/api-reference/pos/retrieve-pos-device-detail.md): Retrieve POS device detail
- [Update POS device](https://www.commercengine.io/docs/admin/api-reference/pos/update-pos-device.md): Update POS device
- [Delete POS device](https://www.commercengine.io/docs/admin/api-reference/pos/delete-pos-device.md): Delete POS device
- [Generate POS device Pairing Code](https://www.commercengine.io/docs/admin/api-reference/pos/generate-pos-device-pairing-code.md): Generates a new verification code for pairing the specified POS device. This code is used to securely link the device with the system during the pairing process.
- [Revoke POS device](https://www.commercengine.io/docs/admin/api-reference/pos/revoke-pos-device.md): Disables the specified POS device, revoking its access to the system. This action updates the device’s status to disabled, preventing it from performing any operations or connecting to the POS network.
- [List all POS permissions](https://www.commercengine.io/docs/admin/api-reference/pos/list-all-pos-permissions.md): List all POS permissions
- [List all POS roles](https://www.commercengine.io/docs/admin/api-reference/pos/list-all-pos-roles.md): List all POS roles
- [Create POS role](https://www.commercengine.io/docs/admin/api-reference/pos/create-pos-role.md): Create POS role
- [Retrieve POS role](https://www.commercengine.io/docs/admin/api-reference/pos/retrieve-pos-role.md): Retrieve POS role
- [Update POS role](https://www.commercengine.io/docs/admin/api-reference/pos/update-pos-role.md): Update POS role
- [Delete POS role](https://www.commercengine.io/docs/admin/api-reference/pos/delete-pos-role.md): Delete POS role
- [List all POS users](https://www.commercengine.io/docs/admin/api-reference/pos/list-all-pos-users.md): List all POS users
- [Create POS user](https://www.commercengine.io/docs/admin/api-reference/pos/create-pos-user.md): Create POS user
- [Retrieve POS user](https://www.commercengine.io/docs/admin/api-reference/pos/retrieve-pos-user.md): Retrieve POS user
- [Update POS user](https://www.commercengine.io/docs/admin/api-reference/pos/update-pos-user.md): Update POS user
- [Delete POS user](https://www.commercengine.io/docs/admin/api-reference/pos/delete-pos-user.md): Delete POS user

#### Shipping

- [Courier Serviceability](https://www.commercengine.io/docs/admin/api-reference/shipping/courier-serviceability.md): Check Courier Serviceability
- [List all shipments](https://www.commercengine.io/docs/admin/api-reference/shipping/list-all-shipments.md): List all shipments
- [Create shipment](https://www.commercengine.io/docs/admin/api-reference/shipping/create-shipment.md): Create shipment
- [Update shipments in bulk](https://www.commercengine.io/docs/admin/api-reference/shipping/update-shipments-in-bulk.md): Update shipments in bulk
- [Merge shipments](https://www.commercengine.io/docs/admin/api-reference/shipping/merge-shipments.md): Merges multiple `unscheduled` shipments of an order into one. Items from every shipment listed in `target_shipments` are moved into `source_shipment`, and the emptied target shipments are discarded. Only shipments in the `unscheduled` status can be merged. Returns the reference number of the survivi…
- [Pack items](https://www.commercengine.io/docs/admin/api-reference/shipping/pack-items.md): Generate auto packing details
- [Refund shortfall](https://www.commercengine.io/docs/admin/api-reference/shipping/refund-shortfall.md): Refund shortfall
- [Wait for inventory](https://www.commercengine.io/docs/admin/api-reference/shipping/wait-for-inventory.md): Wait for inventory
- [Retrieve shipment detail](https://www.commercengine.io/docs/admin/api-reference/shipping/retrieve-shipment-detail.md): Retrieve shipment detail
- [Retrieve shipment activities](https://www.commercengine.io/docs/admin/api-reference/shipping/retrieve-shipment-activities.md): Retrieve shipment activities
- [Approve shipment](https://www.commercengine.io/docs/admin/api-reference/shipping/approve-shipment.md): Approves a shipment that is pending store review. Returns an updated `ShipmentDetail`.
- [Cancel shipment](https://www.commercengine.io/docs/admin/api-reference/shipping/cancel-shipment.md): Cancels a shipment. Use the `cancel` payload to mark the shipment as unscheduled so it can be re-shipped via another carrier or a manual method. Use the `cancel-and-refund` payload to cancel and simultaneously initiate a refund to the original payment instrument or a customer bank account.
- [Download invoice](https://www.commercengine.io/docs/admin/api-reference/shipping/download-invoice.md): Download invoice
- [Download shipping label](https://www.commercengine.io/docs/admin/api-reference/shipping/download-shipping-label.md): Download shipping label
- [Retrieve shipment invoice](https://www.commercengine.io/docs/admin/api-reference/shipping/retrieve-shipment-invoice.md): Retrieve shipment invoice
- [Update shipment detail](https://www.commercengine.io/docs/admin/api-reference/shipping/update-shipment-detail.md): Update shipment detail
- [Retrieve packing detail](https://www.commercengine.io/docs/admin/api-reference/shipping/retrieve-packing-detail.md): Retrieve packing detail
- [Reject shipment](https://www.commercengine.io/docs/admin/api-reference/shipping/reject-shipment.md): Rejects a shipment that is pending store review. Returns an updated `ShipmentDetail`.
- [Create a replacement shipment](https://www.commercengine.io/docs/admin/api-reference/shipping/create-a-replacement-shipment.md): Creates a replacement shipment against an existing shipment. Use the `manual` payload to dispatch outside an integrated carrier, or the `auto` payload to fulfill through an integrated carrier with system-managed packing and rates.
- [Tracking Shipment](https://www.commercengine.io/docs/admin/api-reference/shipping/tracking-shipment.md): Tracking Shipment

#### Store

- [List available payment options](https://www.commercengine.io/docs/admin/api-reference/store/list-available-payment-options.md): Returns a unified list of manual payment methods and connected payment service providers (`service_type` `payment`, `service_sub_type` `credit-line`). Use for credit-line configuration, payout configuration, and checkout option selection.
- [List all available shipping options](https://www.commercengine.io/docs/admin/api-reference/store/list-all-available-shipping-options.md): List all available shipping options
- [Retrieve store config](https://www.commercengine.io/docs/admin/api-reference/store/retrieve-store-config.md): Retrieve store config
- [Update store config](https://www.commercengine.io/docs/admin/api-reference/store/update-store-config.md): Update store config
- [List all countries](https://www.commercengine.io/docs/admin/api-reference/store/list-all-countries.md): List all countries
- [List all pincodes](https://www.commercengine.io/docs/admin/api-reference/store/list-all-pincodes.md): List all pincodes
- [List all states](https://www.commercengine.io/docs/admin/api-reference/store/list-all-states.md): List all states
- [List all customer groups](https://www.commercengine.io/docs/admin/api-reference/store/list-all-customer-groups.md): List all customer groups
- [Create customer group](https://www.commercengine.io/docs/admin/api-reference/store/create-customer-group.md): Create customer group
- [Update customer group](https://www.commercengine.io/docs/admin/api-reference/store/update-customer-group.md): Update customer group
- [Delete customer group](https://www.commercengine.io/docs/admin/api-reference/store/delete-customer-group.md): Delete customer group
- [List all download jobs](https://www.commercengine.io/docs/admin/api-reference/store/list-all-download-jobs.md): List all download jobs
- [Create download request](https://www.commercengine.io/docs/admin/api-reference/store/create-download-request.md): Create download request
- [List all kyc documents](https://www.commercengine.io/docs/admin/api-reference/store/list-all-kyc-documents.md): List all kyc documents
- [Create kyc document](https://www.commercengine.io/docs/admin/api-reference/store/create-kyc-document.md): Create kyc document
- [Update kyc document](https://www.commercengine.io/docs/admin/api-reference/store/update-kyc-document.md): Update kyc document
- [Delete kyc document](https://www.commercengine.io/docs/admin/api-reference/store/delete-kyc-document.md): Delete kyc document
- [List all manual payment methods](https://www.commercengine.io/docs/admin/api-reference/store/list-all-manual-payment-methods.md): List all manual payment methods
- [Create manual payment method](https://www.commercengine.io/docs/admin/api-reference/store/create-manual-payment-method.md): Create manual payment method
- [Retrieve manual payment method detail](https://www.commercengine.io/docs/admin/api-reference/store/retrieve-manual-payment-method-detail.md): Retrieve manual payment method detail
- [Update manual payment method detail](https://www.commercengine.io/docs/admin/api-reference/store/update-manual-payment-method-detail.md): Update manual payment method detail
- [Delete manual payment method](https://www.commercengine.io/docs/admin/api-reference/store/delete-manual-payment-method.md): Delete manual payment method
- [List all manual shipping methods](https://www.commercengine.io/docs/admin/api-reference/store/list-all-manual-shipping-methods.md): List all manual shipping methods
- [Create manual shipping method](https://www.commercengine.io/docs/admin/api-reference/store/create-manual-shipping-method.md): Create manual shipping method
- [Retrieve manual shipping method detail](https://www.commercengine.io/docs/admin/api-reference/store/retrieve-manual-shipping-method-detail.md): Retrieve manual shipping method detail
- [Update manual shipping method detail](https://www.commercengine.io/docs/admin/api-reference/store/update-manual-shipping-method-detail.md): Update manual shipping method detail
- [Delete manual shipping method](https://www.commercengine.io/docs/admin/api-reference/store/delete-manual-shipping-method.md): Delete manual shipping method
- [Global search across Customers, Orders, and Products](https://www.commercengine.io/docs/admin/api-reference/store/global-search-across-customers-orders-and-products.md): Search across Customers, Orders, and Products using Meilisearch. Each `content.results[]` entry is a `GlobalSearchResult`. Read `indexUid` to interpret `hits`: customer index entries are `GlobalSearchCustomerHit`, order index entries are `GlobalSearchOrder`, product index entries are `GlobalSearchPr…
- [List all service providers](https://www.commercengine.io/docs/admin/api-reference/store/list-all-service-providers.md): List all service providers
- [Configure a service provider](https://www.commercengine.io/docs/admin/api-reference/store/configure-a-service-provider.md): Configure a service provider.
- [Update service provider config](https://www.commercengine.io/docs/admin/api-reference/store/update-service-provider-config.md): Update service provider config
- [Delete service provider config](https://www.commercengine.io/docs/admin/api-reference/store/delete-service-provider-config.md): Delete service provider config
- [Test service provider config](https://www.commercengine.io/docs/admin/api-reference/store/test-service-provider-config.md): Test service provider config
- [List all shipping boxes](https://www.commercengine.io/docs/admin/api-reference/store/list-all-shipping-boxes.md): List all shipping boxes
- [Create shipping box](https://www.commercengine.io/docs/admin/api-reference/store/create-shipping-box.md): Create shipping box
- [Retrieve shipping box detail](https://www.commercengine.io/docs/admin/api-reference/store/retrieve-shipping-box-detail.md): Retrieve shipping box detail
- [Update shipping box detail](https://www.commercengine.io/docs/admin/api-reference/store/update-shipping-box-detail.md): Update shipping box detail
- [Delete shipping box](https://www.commercengine.io/docs/admin/api-reference/store/delete-shipping-box.md): Delete shipping box
- [Retrieve shipping cost policy](https://www.commercengine.io/docs/admin/api-reference/store/retrieve-shipping-cost-policy.md): Returns the shipping cost policy rules
- [Create shipping cost policy](https://www.commercengine.io/docs/admin/api-reference/store/create-shipping-cost-policy.md): Create shipping cost policy
- [Add shipping options](https://www.commercengine.io/docs/admin/api-reference/store/add-shipping-options.md): Add shipping options for specified warehouse and shipping zone.
- [Remove shipping options](https://www.commercengine.io/docs/admin/api-reference/store/remove-shipping-options.md): Remove shipping options for specified warehouse and shipping zone.
- [List all shipping zones](https://www.commercengine.io/docs/admin/api-reference/store/list-all-shipping-zones.md): List all shipping zones
- [Create a shipping zone](https://www.commercengine.io/docs/admin/api-reference/store/create-a-shipping-zone.md): Create a shipping zone
- [Retrieve shipping zone detail](https://www.commercengine.io/docs/admin/api-reference/store/retrieve-shipping-zone-detail.md): Retrieve shipping zone detail
- [Update shipping zone detail](https://www.commercengine.io/docs/admin/api-reference/store/update-shipping-zone-detail.md): Update shipping zone detail
- [Delete shipping zone](https://www.commercengine.io/docs/admin/api-reference/store/delete-shipping-zone.md): Delete shipping zone
- [List all templates](https://www.commercengine.io/docs/admin/api-reference/store/list-all-templates.md): List all templates
- [Create template](https://www.commercengine.io/docs/admin/api-reference/store/create-template.md): Create template
- [Retrieve template detail](https://www.commercengine.io/docs/admin/api-reference/store/retrieve-template-detail.md): Retrieve template detail
- [Update template detail](https://www.commercengine.io/docs/admin/api-reference/store/update-template-detail.md): Update template detail
- [Delete template](https://www.commercengine.io/docs/admin/api-reference/store/delete-template.md): Delete template
- [List all warehouses](https://www.commercengine.io/docs/admin/api-reference/store/list-all-warehouses.md): List all warehouses
- [Create a warehouse](https://www.commercengine.io/docs/admin/api-reference/store/create-a-warehouse.md): Create a warehouse
- [Retrieve warehouse detail](https://www.commercengine.io/docs/admin/api-reference/store/retrieve-warehouse-detail.md): Retrieve warehouse detail
- [Update warehouse detail](https://www.commercengine.io/docs/admin/api-reference/store/update-warehouse-detail.md): Update warehouse detail
- [Delete warehouse](https://www.commercengine.io/docs/admin/api-reference/store/delete-warehouse.md): Delete warehouse

#### SSE

- [Retrieve global state](https://www.commercengine.io/docs/admin/api-reference/sse/retrieve-global-state.md): Opens a server-sent events stream that pushes store configuration changes. Each event's `data` field carries a JSON-encoded payload with the event name and the updated `StoreConfig` object.
- [Retrieve live events](https://www.commercengine.io/docs/admin/api-reference/sse/retrieve-live-events.md): Opens a server-sent events stream of live storefront activity. Each event's `data` field carries a JSON-encoded `AnalyticsEvent` object.

#### Webhooks

- [List Webhooks](https://www.commercengine.io/docs/admin/api-reference/webhooks/list-webhooks.md): List of all webhooks
- [Create Webhook](https://www.commercengine.io/docs/admin/api-reference/webhooks/create-webhook.md): Create a new webhook for the store. The response returns the newly created webhook configuration.
- [List All Deliveries Log](https://www.commercengine.io/docs/admin/api-reference/webhooks/list-all-deliveries-log.md): Paginated list of delivery attempts made across all webhooks. Supports optional filtering by `webhook_id` and `event_id`.
- [Get Delivery Log Detail](https://www.commercengine.io/docs/admin/api-reference/webhooks/get-delivery-log-detail.md): Get Delivery Log Detail
- [List all event types](https://www.commercengine.io/docs/admin/api-reference/webhooks/list-all-event-types.md): List all event types
- [List All Events](https://www.commercengine.io/docs/admin/api-reference/webhooks/list-all-events.md): List all events.
- [Get Event Details](https://www.commercengine.io/docs/admin/api-reference/webhooks/get-event-details.md): Fetch the original event payload and metadata, including all related delivery attempts.
- [Get Webhook Details](https://www.commercengine.io/docs/admin/api-reference/webhooks/get-webhook-details.md): Retrieve details of a single webhook by its ID.
- [Update Webhook](https://www.commercengine.io/docs/admin/api-reference/webhooks/update-webhook.md): Update an existing webhook by replacing all fields.
- [Delete Webhook](https://www.commercengine.io/docs/admin/api-reference/webhooks/delete-webhook.md): Permanently delete a webhook by its ID.
- [Retry Webhook Delivery](https://www.commercengine.io/docs/admin/api-reference/webhooks/retry-webhook-delivery.md): Manually retry a specific delivery log by re-sending the same payload to the configured webhook endpoint.
- [Replay Event to Webhook](https://www.commercengine.io/docs/admin/api-reference/webhooks/replay-event-to-webhook.md): Replay an existing event to a specific webhook. This triggers a new delivery with a fresh delivery_id.
- [Rotate Webhook Secret](https://www.commercengine.io/docs/admin/api-reference/webhooks/rotate-webhook-secret.md): Rotate the webhook's HMAC secret. The new secret is returned once and used to sign future webhook requests.
- [Send Test Webhook](https://www.commercengine.io/docs/admin/api-reference/webhooks/send-test-webhook.md): Sends a test webhook to the configured callback URL. You may optionally provide a test payload.

## OpenAPI Specs

- [ce-admin](https://openapi.commercengine.io/ce-admin.json)