Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token.

Bearer Auth

Body

Response

Documentation

GitHub

Community

Newsletter

StateSet API Docs

StateSet One API Reference

StateSet ReSponse API Reference

StateSet Cloud API Reference

StateSet Commerce API Reference

Dashboard

Support

Hold Order

Introduction

Development

Getting started with the Stateset Returns API

Returns Quickstart

Getting started with the Stateset Warranty API

Warranties Quickstart

Getting started with the Customers and Subscriptions API

Subscriptions Quickstart

Getting started with the Stateset Manufacturing and Production API

Manufacturing Quickstart

Getting started with the Stateset Inventory API

Inventory Quickstart

ReSponse CX Quickstart

Getting started with ReSponse CX Knowledge Base

Knowledge Base Quickstart

RAG Quickstart

Agents Quickstart

Getting started with ReSponse CX Attributes

Attributes Quickstart

Rules Quickstart

Getting started with ReSponse CX Examples

Examples Quickstart

Getting started with ReSponse CX Schedules

Schedules Quickstart

Getting started with ReSponse CX Functions

Functions Quickstart

Getting started with the Shopify Embeddings

Shopify Product Quickstart

Getting started with ReSponse CX Vision API

Vision Quickstart

Voice Quickstart

Getting started with the StateSet Network

StateSet Network Quickstart

Getting started with Orders on the Stateset Commerce Network

StateSet Orders Quickstart

Getting started with Contracts on the StateSet Network

StateSet Contracts Quickstart

Authentication

Overview

Building modern web apps with the React Server Components (RSC) framework

Web Framework

Building modern web workflows with the Temporal framework

Workflow Framework

Building event driven applications with the Stateset API

Event Driven APIs

Feature Overview of the Stateset One Platform

Features

Overview of the Stateset One Platform Reporting

Reporting

Authenticating with the Stateset ReSponse API

Models supported by the Stateset ReSponse API

Models

Get up and running with StateSet Cloud and ReSponse in a few minutes.

StateSet Cloud and ReSponse Quickstart

List Agents

Get Agent

Create Agent

Update Agent

List Embeddings

Get Embeddings

Create Embedding

Update Embedding

Delete Embedding

This endpoint retrieves a response from the agent.

Retrieve Response

This endpoint creates a new response from the agent

Create Response

List Messages

Get Messages

Create Message

Update Message

This endpoint deletes an existing message.

Delete Message

List Rules

Get Rule

Create Rule

Update Rule

Delete Rule

List Attributes

Get Attribute

Create Attribute

Update Attribute

Delete Attribute

List Examples

Get Example

Create Example

Update Example

Delete Example

List Functions

Get Function

Create Function

Update Function

Delete Function

List Schedules

Get Schedule

Create Schedule

Update Schedule

Delete Schedule

List Function Parameters

This endpoint gets a new function parameter

Get Function Parameter

This endpoint creates a new function parameter

Create Function Parameter

This endpoint updates a new function parameter

Update Function Parameter

This endpoint deletes a function parameter

Delete Function Parameter

List Channel Threads

Get Channel Threads

This endpoint creates a new channel thread

Create Channel Thread

Update Channel Thread

This endpoint deletes an existing thread.

Delete Channel Thread

This endpoint gets or creates a new user.

List Users

Get User

Create User

Update User

Delete User

Overview of the Stateset Commerce Network

Create Invoice

Pay Invoice

Void Invoice

Approve Loan

Cancel Loan

Liquidate Loan

RePay Loan

Get Order

Create Order

Fulfill Order

Cancel Order

Return Order

This endpoint processes a refund for an order.

Refund Order

This endpoint releases an order from hold.

Release Order

Ship Order

This endpoint marks an order as delivered.

Deliver Order

This endpoint initiates a dispute for an order.

Dispute Order

This endpoint creates a new purchase order

Request Purchase Order

This endpoint cancels a new purchase order

Cancel Purchase Order

This endpoint completes a new purchase order

Complete Purchase Order

This endpoint finances a new purchase order

Finance Purchase Order

List Customers

This endpoint gets or creates a new customer.

Get Customer

Create Customer

This endpoint updates an existing customer.

Update Customer

This endpoint deletes an existing customer.

Delete Customer

List Returns

Retrieve Return

Create Return

This endpoint updates an existing return.

Update Return

This endpoint deletes an existing return.

Delete Return

Close Return

Approve Return

Reject Return

ReOpen Return

This endpoint refunds an existing return.

Refund Return

Cancel Return

This endpoint gets or creates a new return line item.

Get Return Line Item

This endpoint creates a new return line item.

Create Return Line Item

This endpoint updates an existing return line item.

Update Return Line Item

This endpoint deletes an existing return line item.

Delete Return Line Item

List Warranty

This endpoint gets or creates a new warranty.

Get Warranty

Create Warranty

This endpoint updates an existing warranty.

StateSet Commerce API Reference

Invoices

Loans

Orders

Purchase Orders

Hold Order

Body

Response

StateSet Commerce API Reference

Invoices

Loans

Orders

Purchase Orders

​Body

​Response

Body

Response