Skip to content
Crossmart Docs

Overview

Crossmart API 0.0.0

Section titled “Crossmart API 0.0.0”

REST API of Crossmart, the open-source multichannel platform for sellers and their AI agents.

Information

Operations

Section titled “Operations”
GET
/api/v1/health
GET
/api/v1/me
DELETE
/api/v1/me
GET
/api/v1/workspaces/{workspaceId}
DELETE
/api/v1/workspaces/{workspaceId}
PATCH
/api/v1/workspaces/{workspaceId}
POST
/api/v1/organizations/{organizationId}/workspaces
GET
/api/v1/workspaces/{workspaceId}/members
DELETE
/api/v1/workspaces/{workspaceId}/members/{userId}
PATCH
/api/v1/workspaces/{workspaceId}/members/{userId}
DELETE
/api/v1/workspaces/{workspaceId}/membership
GET
/api/v1/workspaces/{workspaceId}/invitations
POST
/api/v1/workspaces/{workspaceId}/invitations
DELETE
/api/v1/workspaces/{workspaceId}/invitations/{invitationId}
POST
/api/v1/invitations/preview
POST
/api/v1/invitations/accept
GET
/api/v1/workspaces/{workspaceId}/roles
POST
/api/v1/workspaces/{workspaceId}/roles
PUT
/api/v1/workspaces/{workspaceId}/roles/{roleId}
DELETE
/api/v1/workspaces/{workspaceId}/roles/{roleId}
GET
/api/v1/workspaces/{workspaceId}/api-keys
POST
/api/v1/workspaces/{workspaceId}/api-keys
DELETE
/api/v1/workspaces/{workspaceId}/api-keys/{apiKeyId}
GET
/api/v1/api-key
GET
/api/v1/organizations/{organizationId}/subscription
GET
/api/v1/workspaces/{workspaceId}/products
POST
/api/v1/workspaces/{workspaceId}/products
GET
/api/v1/workspaces/{workspaceId}/products/{productId}
PUT
/api/v1/workspaces/{workspaceId}/products/{productId}
DELETE
/api/v1/workspaces/{workspaceId}/products/{productId}
POST
/api/v1/workspaces/{workspaceId}/product-bulk-actions
GET
/api/v1/workspaces/{workspaceId}/product-views
POST
/api/v1/workspaces/{workspaceId}/product-views
DELETE
/api/v1/workspaces/{workspaceId}/product-views/{viewId}
POST
/api/v1/workspaces/{workspaceId}/product-imports
GET
/api/v1/workspaces/{workspaceId}/import-jobs
GET
/api/v1/workspaces/{workspaceId}/import-jobs/{jobId}
POST
/api/v1/workspaces/{workspaceId}/media/product-images
GET
/api/v1/workspaces/{workspaceId}/catalog-stats
GET
/api/v1/workspaces/{workspaceId}/activity
GET
/api/v1/workspaces/{workspaceId}/products/{productId}/activity
GET
/api/v1/workspaces/{workspaceId}/inventory-items
POST
/api/v1/workspaces/{workspaceId}/inventory-items/{inventoryItemId}/adjustments
GET
/api/v1/workspaces/{workspaceId}/inventory-items/{inventoryItemId}/movements
GET
/api/v1/workspaces/{workspaceId}/channel-connections
POST
/api/v1/workspaces/{workspaceId}/channel-connections/authorizations
GET
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}
POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/disconnect
POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/imports
PUT
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/ebay/listing-defaults
POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/ebay/business-policies/opt-in
POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/ebay/business-policies/defaults
POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/ebay/business-policies/refresh
PUT
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/google-merchant/listing-setup
GET
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/products
PUT
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/pricing
POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/pricing/preview
PUT
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/product-selection
POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/product-selection/preview
POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/sync
GET
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/listings
POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/products/add
POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/products/remove
GET
/api/v1/workspaces/{workspaceId}/products/{productId}/channels
POST
/api/v1/workspaces/{workspaceId}/products/{productId}/channels/{connectionId}
DELETE
/api/v1/workspaces/{workspaceId}/products/{productId}/channels/{connectionId}
POST
/api/v1/workspaces/{workspaceId}/products/{productId}/channels/{connectionId}/retry
PUT
/api/v1/workspaces/{workspaceId}/products/{productId}/channels/{connectionId}/override
DELETE
/api/v1/workspaces/{workspaceId}/products/{productId}/channels/{connectionId}/override
GET
/api/v1/workspaces/{workspaceId}/products/{productId}/channels/{connectionId}/category-suggestions
PUT
/api/v1/workspaces/{workspaceId}/products/{productId}/channels/{connectionId}/category
GET
/api/v1/workspaces/{workspaceId}/products/{productId}/channels/{connectionId}/item-specifics
PUT
/api/v1/workspaces/{workspaceId}/products/{productId}/channels/{connectionId}/item-specifics
GET
/api/v1/workspaces/{workspaceId}/orders
GET
/api/v1/workspaces/{workspaceId}/orders/{orderId}
GET
/api/v1/workspaces/{workspaceId}/analytics/sales
GET
/api/v1/workspaces/{workspaceId}/analytics/inventory
GET
/api/v1/workspaces/{workspaceId}/suggestions
POST
/api/v1/workspaces/{workspaceId}/suggestions/bulk-approve
GET
/api/v1/workspaces/{workspaceId}/suggestions/{suggestionId}
POST
/api/v1/workspaces/{workspaceId}/suggestions/{suggestionId}/approve
POST
/api/v1/workspaces/{workspaceId}/suggestions/{suggestionId}/reject
GET
/api/v1/workspaces/{workspaceId}/ai/status
GET
/api/v1/workspaces/{workspaceId}/ai/usage
POST
/api/v1/workspaces/{workspaceId}/ai/content-generations
POST
/api/v1/workspaces/{workspaceId}/ai/content-drafts

Authentication

Section titled “Authentication”

api_key

Section titled “api_key”

Security scheme type: apiKey

Header parameter name: x-api-key

Section titled “cookie”

Security scheme type: apiKey

Cookie parameter name: better-auth.session_token