v12.11.0

V2 Staging API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.

Servers

https://v2-staging.tscheckout.comCurrent host

---

IntegrationsHubspot

Endpoints to interact with Hubspot integration

Operations

GET/api/v2/internal/hubspot/process/{token}GET/api/v2/internal/hubspot/reconcile/{token}GET/api/v2/integrations/hubspot/statusPOST/api/v2/integrations/hubspot/syncPOST/api/v2/integrations/hubspot/processPOST/api/v2/integrations/hubspot/reconcilePOST/api/v2/integrations/hubspot/historical-exportGET/api/v2/integrations/hubspotPATCH/api/v2/integrations/hubspot

---

Process pending HubSpot jobs from cron

GET

/api/v2/internal/hubspot/process/{token}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

token*

Internal cron token

Type

string

Required

Responses

Worker result

GET

/api/v2/internal/hubspot/process/{token}

Playground

Authorization

bearerAuth

Variables

Key

Value

token*

Samples

---

Run daily HubSpot reconciliation from cron

GET

/api/v2/internal/hubspot/reconcile/{token}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

token*

Internal cron token

Type

string

Required

Responses

Reconciliation result

GET

/api/v2/internal/hubspot/reconcile/{token}

Playground

Authorization

bearerAuth

Variables

Key

Value

token*

Samples

---

Get HubSpot synchronization status

GET

/api/v2/integrations/hubspot/status

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

HubSpot synchronization status

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/integrations/hubspot/status

Playground

Authorization

bearerAuth

Samples

---

Queue an order or ticket for HubSpot synchronization

POST

/api/v2/integrations/hubspot/sync

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Synchronization queued

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/integrations/hubspot/sync

Playground

Authorization

bearerAuth

Body

Samples

---

Process pending HubSpot synchronization jobs

POST

/api/v2/integrations/hubspot/process

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Worker result

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/integrations/hubspot/process

Playground

Authorization

bearerAuth

Body

Samples

---

Queue changed tickets for HubSpot reconciliation

POST

/api/v2/integrations/hubspot/reconcile

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Reconciliation queued

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/integrations/hubspot/reconcile

Playground

Authorization

bearerAuth

Body

Samples

---

Export one event as a HubSpot-ready CSV

POST

/api/v2/integrations/hubspot/historical-export

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

HubSpot-ready CSV with validation_errors column

Content-Type

text/csv

POST

/api/v2/integrations/hubspot/historical-export

Playground

Authorization

bearerAuth

Body

Samples

---

Get Hubspot settings

GET

/api/v2/integrations/hubspot

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Hubspot settings

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/integrations/hubspot

Playground

Authorization

bearerAuth

Samples

---

Update Hubspot settings

PATCH

/api/v2/integrations/hubspot

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Settings updated successfully

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/integrations/hubspot

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI