Seller

Add an overview of the Seller API here. This block is preserved across regenerations.

Endpoints

GET /api/v1/seller/sessions

List sell sessions for the tenant

get

https://peakcommerce.app/api/v1https://sandbox.peakcommerce.app/api/v1

/seller/sessions

Authorizations

ApiKeyAuthBearerAuth

X-API-KeystringRequired

Scoped API key. Scopes: read, commerce, admin.

Responses

200

List of sell sessions

401

API key missing or invalid

application/json

get/seller/sessions

HTTPcURLJavaScriptPython

GET /api/v1/seller/sessions HTTP/1.1
Host: peakcommerce.app
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Notes, examples, or caveats for GET /seller/sessions go here.

POST /api/v1/seller/sessions

Open a sell session for a buyer agent

post

https://peakcommerce.app/api/v1https://sandbox.peakcommerce.app/api/v1

/seller/sessions

Authorizations

ApiKeyAuthBearerAuth

X-API-KeystringRequired

Scoped API key. Scopes: read, commerce, admin.

Body

application/json

counterpartystringOptional

Label for the buyer agent's principal (audit)

sessionKeystringOptional

titlestringOptional

Responses

201

Sell session created

No content

401

API key missing or invalid

application/json

403

Insufficient scope (commerce required)

application/json

post/seller/sessions

HTTPcURLJavaScriptPython

POST /api/v1/seller/sessions HTTP/1.1
Host: peakcommerce.app
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "counterparty": "text",
  "sessionKey": "text",
  "title": "text"
}

No content

Notes, examples, or caveats for POST /seller/sessions go here.

GET /api/v1/seller/sessions/{id}/messages

Replay a sell session's turns

get

https://peakcommerce.app/api/v1https://sandbox.peakcommerce.app/api/v1

/seller/sessions/{id}/messages

Authorizations

ApiKeyAuthBearerAuth

X-API-KeystringRequired

Scoped API key. Scopes: read, commerce, admin.

Path parameters

idstringRequired

Sell session UUID

Responses

200

Ordered list of buyer and seller turns

No content

404

Sell session not found

application/json

get/seller/sessions/{id}/messages

HTTPcURLJavaScriptPython

GET /api/v1/seller/sessions/{id}/messages HTTP/1.1
Host: peakcommerce.app
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Notes, examples, or caveats for GET /seller/sessions/{id}/messages go here.

POST /api/v1/seller/sessions/{id}/messages

Send a buyer message and run one seller turn

post

https://peakcommerce.app/api/v1https://sandbox.peakcommerce.app/api/v1

/seller/sessions/{id}/messages

Authorizations

ApiKeyAuthBearerAuth

X-API-KeystringRequired

Scoped API key. Scopes: read, commerce, admin.

Path parameters

idstringRequired

Sell session UUID

Body

application/json

messagestringRequired

The buyer agent's message

merchantNamestringOptional

catalogSummarystringOptional

requiredToClosestringOptional

allowCommitbooleanOptional

When false, the seller quotes/builds but does not commit

Responses

200

Seller reply with executed tool calls and token usage

No content

404

Sell session not found

application/json

503

Seller agent unavailable (no model key configured)

application/json

post/seller/sessions/{id}/messages

HTTPcURLJavaScriptPython

POST /api/v1/seller/sessions/{id}/messages HTTP/1.1
Host: peakcommerce.app
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "message": "text",
  "merchantName": "text",
  "catalogSummary": "text",
  "requiredToClose": "text",
  "allowCommit": true
}

No content

Notes, examples, or caveats for POST /seller/sessions/{id}/messages go here.