Tickets

The number one way to communicate with your customers since 1984

PreviousProduct groups NextCoupons

Last updated 1 year ago

Was this helpful?

Get tickets

get

Gets the tickets in the store. Requires the Scopes.ViewTickets API key scope

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to get the tickets in

pageinteger · int32Required

The page to select when viewing the tickets

Query parameters

countinteger · int32Optional

The amount of tickets to display in one page

Responses

200

The object was successfully returned.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

get

GET /stores/{storeId}/tickets/{page} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "pages": 1,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T12:57:05.041Z",
      "subject": "text",
      "status": 0,
      "targetStore": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T12:57:05.041Z",
        "name": "text",
        "description": "text",
        "url": "text",
        "customDomain": "text",
        "termsOfService": "text",
        "copyright": "text",
        "privacyPolicy": "text",
        "preferredCurrency": "text",
        "isVerified": true,
        "featuredProduct": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-05-21T12:57:05.041Z",
          "name": "text",
          "description": "text",
          "tags": [
            "text"
          ],
          "imageNames": [
            "text"
          ],
          "cost": 1,
          "stock": 1,
          "amountSold": 1,
          "ignoreOutOfStock": true,
          "isPinned": true,
          "isDynamic": true,
          "rating": 1,
          "minimumQuantity": 1,
          "maximumQuantity": 1,
          "order": 1,
          "visibility": 0,
          "likes": 1,
          "customValueKeys": [
            "text"
          ],
          "store": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T12:57:05.041Z",
            "name": "text",
            "description": "text",
            "url": "text",
            "customDomain": "text",
            "termsOfService": "text",
            "copyright": "text",
            "privacyPolicy": "text",
            "preferredCurrency": "text",
            "isVerified": true,
            "featuredProduct": "[Circular Reference]",
            "visits": 1,
            "reviews": 1,
            "rating": 1,
            "resolvedTickets": 1,
            "productsSold": 1,
            "theme": {
              "properties": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            },
            "socialMediaAccounts": {
              "tikTok": "text",
              "youTube": "text",
              "twitter": "text",
              "facebook": "text",
              "discord": "text",
              "telegram": "text",
              "instagram": "text"
            },
            "profileImage": "text"
          }
        },
        "visits": 1,
        "reviews": 1,
        "rating": 1,
        "resolvedTickets": 1,
        "productsSold": 1,
        "theme": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "socialMediaAccounts": {
          "tikTok": "text",
          "youTube": "text",
          "twitter": "text",
          "facebook": "text",
          "discord": "text",
          "telegram": "text",
          "instagram": "text"
        },
        "profileImage": "text"
      },
      "owner": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T12:57:05.041Z",
        "emailAddress": "text",
        "linkedIntegrations": [
          "text"
        ]
      },
      "entries": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-05-21T12:57:05.041Z",
          "message": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Get ticket by ID

get

Gets a ticket by the ID in the given store and returns it. Requires the Scopes.ViewTickets permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to get the ticket from

ticketIdstring · uuidRequired

The ID of the ticket to get

Responses

200

The object was successfully returned.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

get

GET /stores/{storeId}/tickets/{ticketId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-05-21T12:57:05.041Z",
    "subject": "text",
    "status": 0,
    "targetStore": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T12:57:05.041Z",
      "name": "text",
      "description": "text",
      "url": "text",
      "customDomain": "text",
      "termsOfService": "text",
      "copyright": "text",
      "privacyPolicy": "text",
      "preferredCurrency": "text",
      "isVerified": true,
      "featuredProduct": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T12:57:05.041Z",
        "name": "text",
        "description": "text",
        "tags": [
          "text"
        ],
        "imageNames": [
          "text"
        ],
        "cost": 1,
        "stock": 1,
        "amountSold": 1,
        "ignoreOutOfStock": true,
        "isPinned": true,
        "isDynamic": true,
        "rating": 1,
        "minimumQuantity": 1,
        "maximumQuantity": 1,
        "order": 1,
        "visibility": 0,
        "likes": 1,
        "customValueKeys": [
          "text"
        ],
        "store": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-05-21T12:57:05.041Z",
          "name": "text",
          "description": "text",
          "url": "text",
          "customDomain": "text",
          "termsOfService": "text",
          "copyright": "text",
          "privacyPolicy": "text",
          "preferredCurrency": "text",
          "isVerified": true,
          "featuredProduct": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T12:57:05.041Z",
            "name": "text",
            "description": "text",
            "tags": [
              "text"
            ],
            "imageNames": [
              "text"
            ],
            "cost": 1,
            "stock": 1,
            "amountSold": 1,
            "ignoreOutOfStock": true,
            "isPinned": true,
            "isDynamic": true,
            "rating": 1,
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "visibility": 0,
            "likes": 1,
            "customValueKeys": [
              "text"
            ],
            "store": "[Circular Reference]"
          },
          "visits": 1,
          "reviews": 1,
          "rating": 1,
          "resolvedTickets": 1,
          "productsSold": 1,
          "theme": {
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          },
          "socialMediaAccounts": {
            "tikTok": "text",
            "youTube": "text",
            "twitter": "text",
            "facebook": "text",
            "discord": "text",
            "telegram": "text",
            "instagram": "text"
          },
          "profileImage": "text"
        }
      },
      "visits": 1,
      "reviews": 1,
      "rating": 1,
      "resolvedTickets": 1,
      "productsSold": 1,
      "theme": {
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "socialMediaAccounts": {
        "tikTok": "text",
        "youTube": "text",
        "twitter": "text",
        "facebook": "text",
        "discord": "text",
        "telegram": "text",
        "instagram": "text"
      },
      "profileImage": "text"
    },
    "owner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T12:57:05.041Z",
      "emailAddress": "text",
      "linkedIntegrations": [
        "text"
      ]
    },
    "entries": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T12:57:05.041Z",
        "message": "text",
        "name": "text"
      }
    ]
  }
}

Close ticket

delete

Closes the given ticket, requires the Scopes.DeleteTickets permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store the ticket belongs to

ticketIdstring · uuidRequired

The ID of the ticket to close

Responses

200

The object was successfully deleted.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

delete

DELETE /stores/{storeId}/tickets/{ticketId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "message": "text",
  "data": null
}

Add ticket reply

put

Adds a response/reply to the given ticket, requires the Scopes.UpdateTickets permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store the ticket belongs to

ticketIdstring · uuidRequired

The ID of the ticket to add the response to

Body

Form for creating a new ticket response

messagestring · min: 1 · max: 2048Required

The message/response to give in the ticket

Responses

200

The object was successfully created.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

put

PUT /stores/{storeId}/tickets/{ticketId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "message": "text"
}

{
  "success": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-05-21T12:57:05.041Z",
    "subject": "text",
    "status": 0,
    "targetStore": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T12:57:05.041Z",
      "name": "text",
      "description": "text",
      "url": "text",
      "customDomain": "text",
      "termsOfService": "text",
      "copyright": "text",
      "privacyPolicy": "text",
      "preferredCurrency": "text",
      "isVerified": true,
      "featuredProduct": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T12:57:05.041Z",
        "name": "text",
        "description": "text",
        "tags": [
          "text"
        ],
        "imageNames": [
          "text"
        ],
        "cost": 1,
        "stock": 1,
        "amountSold": 1,
        "ignoreOutOfStock": true,
        "isPinned": true,
        "isDynamic": true,
        "rating": 1,
        "minimumQuantity": 1,
        "maximumQuantity": 1,
        "order": 1,
        "visibility": 0,
        "likes": 1,
        "customValueKeys": [
          "text"
        ],
        "store": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-05-21T12:57:05.041Z",
          "name": "text",
          "description": "text",
          "url": "text",
          "customDomain": "text",
          "termsOfService": "text",
          "copyright": "text",
          "privacyPolicy": "text",
          "preferredCurrency": "text",
          "isVerified": true,
          "featuredProduct": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T12:57:05.041Z",
            "name": "text",
            "description": "text",
            "tags": [
              "text"
            ],
            "imageNames": [
              "text"
            ],
            "cost": 1,
            "stock": 1,
            "amountSold": 1,
            "ignoreOutOfStock": true,
            "isPinned": true,
            "isDynamic": true,
            "rating": 1,
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "visibility": 0,
            "likes": 1,
            "customValueKeys": [
              "text"
            ],
            "store": "[Circular Reference]"
          },
          "visits": 1,
          "reviews": 1,
          "rating": 1,
          "resolvedTickets": 1,
          "productsSold": 1,
          "theme": {
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          },
          "socialMediaAccounts": {
            "tikTok": "text",
            "youTube": "text",
            "twitter": "text",
            "facebook": "text",
            "discord": "text",
            "telegram": "text",
            "instagram": "text"
          },
          "profileImage": "text"
        }
      },
      "visits": 1,
      "reviews": 1,
      "rating": 1,
      "resolvedTickets": 1,
      "productsSold": 1,
      "theme": {
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "socialMediaAccounts": {
        "tikTok": "text",
        "youTube": "text",
        "twitter": "text",
        "facebook": "text",
        "discord": "text",
        "telegram": "text",
        "instagram": "text"
      },
      "profileImage": "text"
    },
    "owner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T12:57:05.041Z",
      "emailAddress": "text",
      "linkedIntegrations": [
        "text"
      ]
    },
    "entries": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T12:57:05.041Z",
        "message": "text",
        "name": "text"
      }
    ]
  }
}