SellPass.WebApi
v1

This is the documentation for version v1 of the API. Last update on Nov 29, 2022.

Base URL

https://dev.sellpass.io

Authentication

Bearer (http_api_key)

JWT Authorization header using the Bearer scheme.

Enter 'Bearer' [space] and then your token in the text input below.

Example: 'Bearer 12345abcdef'

PublicPageInfo

Get public information about shop: listings, statistics, etc.

Get all the needed information for main page of the shop

GET /v2/public/shops/{shopId}/main

Path parameters

shopId integer(int64) Required

Responses

• 200 object

Page Info
- data object
  shop object
  
  title string | null
  
  description string | null
  
  buttonText string | null
  
  disableButton boolean
  
  disableTitle boolean
  
  disableDescription boolean
  
  statistics object
  
  rating number(float)
  
  totalFeedbacks integer(int64)
  
  totalProductsSold integer(int64)
  
  customersCount integer(int64)
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  feedbacks array[object] | null
  
  rating integer(int32) | null
  
  comment string | null
  
  sellerReply string | null
  
  createdAt string(date-time) | null
  
  updatedAt string(date-time) | null
  
  Additional properties are NOT allowed
  
  announcements array[object] | null
  
  id integer(int64)
  
  path string | null
  
  title string | null
  
  shortDescription string | null
  
  buttonText string | null
  
  buttonLink string | null
  
  createdAt string(date-time)
  
  Additional properties are NOT allowed
  
  listings array[object] | null
  
  id integer(int64)
  
  path string | null
  
  searchWordsMeta string | null
  
  position integer(int32)
  
  minPriceDetails object
  
  amount number(double)
  
  currency string | null
  
  Additional properties are NOT allowed
  
  seo object
  
  metaTitle string | null
  
  metaDescription string | null
  
  metaCfImageId string | null
  
  Additional properties are NOT allowed
  
  visibility integer(int32)
  
  "
  Public = 0
  Private = 1
  Unlisted = 2
  "
  
  Values are 0, 1, or 2.
  
  type integer(int32)
  
  "
  Products = 0
  Groups = 1
  Categories = 3
  "
  
  Values are 0, 1, or 3.
  
  product object
  
  id integer(int64)
  
  title string | null
  
  shortDescription string | null
  
  thumbnailCfImageId string | null
  
  statistics object
  
  rating number(float)
  
  totalFeedbacks integer(int64)
  
  totalProductsSold integer(int64)
  
  customersCount integer(int64)
  
  Additional properties are NOT allowed
  
  groupId integer(int64) | null
  
  isInstantDelivery boolean
  
  isInStock boolean
  
  onHold boolean
  
  unlisted boolean
  
  private boolean
  
  Additional properties are NOT allowed
  
  group object
  
  id integer(int64)
  
  title string | null
  
  description string | null
  
  cfImageId string | null
  
  listings array[object] | null
  
  Additional properties are NOT allowed
  
  type integer(int32)
  
  Values are 0 or 1.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  categories array[object] | null
  
  id integer(int64)
  
  name string | null
  
  listingIds array[integer(int64)] | null
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- message string | null
- errors array[string] | null
- log string | null
- Additional properties are NOT allowed
• 404

Shop Not Found

GET /v2/public/shops/{shopId}/main

curl \
 -X GET https://dev.sellpass.io/v2/public/shops/{shopId}/main \
 -H "Authorization: $API_KEY"

Response example (200)

{
  "data": {
    "shop": {
      "title": "string",
      "description": "string",
      "buttonText": "string",
      "disableButton": true,
      "disableTitle": true,
      "disableDescription": true,
      "statistics": {
        "rating": 42.0,
        "totalFeedbacks": 42,
        "totalProductsSold": 42,
        "customersCount": 42
      }
    },
    "feedbacks": [
      {
        "rating": 42,
        "comment": "string",
        "sellerReply": "string",
        "createdAt": "2023-05-04T09:42:00+00:00",
        "updatedAt": "2023-05-04T09:42:00+00:00"
      }
    ],
    "announcements": [
      {
        "id": 42,
        "path": "string",
        "title": "string",
        "shortDescription": "string",
        "buttonText": "string",
        "buttonLink": "string",
        "createdAt": "2023-05-04T09:42:00+00:00"
      }
    ],
    "listings": [
      {
        "id": 42,
        "path": "string",
        "searchWordsMeta": "string",
        "position": 42,
        "minPriceDetails": {
          "amount": 42.0,
          "currency": "string"
        },
        "seo": {
          "metaTitle": "string",
          "metaDescription": "string",
          "metaCfImageId": "string"
        },
        "visibility": 0,
        "type": 0,
        "product": {
          "id": 42,
          "title": "string",
          "shortDescription": "string",
          "thumbnailCfImageId": "string",
          "statistics": {
            "rating": 42.0,
            "totalFeedbacks": 42,
            "totalProductsSold": 42,
            "customersCount": 42
          },
          "groupId": 42,
          "isInstantDelivery": true,
          "isInStock": true,
          "onHold": true,
          "unlisted": true,
          "private": true
        },
        "group": {
          "id": 42,
          "title": "string",
          "description": "string",
          "cfImageId": "string",
          "listings": [
            {}
          ],
          "type": 0
        }
      }
    ],
    "categories": [
      {
        "id": 42,
        "name": "string",
        "listingIds": [
          42
        ]
      }
    ]
  },
  "message": "string",
  "errors": [
    "string"
  ],
  "log": "string"
}

Get all the needed information for products page of the shop

GET /v2/public/shops/{shopId}/listings

Path parameters

shopId integer(int64) Required

Responses

• 200 object

Page Info
- data object
  mainDetails object
  
  id integer(int64)
  
  name string | null
  
  discordOauthUrl string | null
  
  shopPopUp string | null
  
  shopTerms string | null
  
  onHold boolean
  
  enableFaq boolean
  
  subscriptionName string | null
  
  seoDetails object
  
  id integer(int64)
  
  favIconUrl string | null
  
  metaTitle string | null
  
  metaDescription string | null
  
  metaImageCfId string | null
  
  Additional properties are NOT allowed
  
  defaultDiscordSettings object
  
  enabled boolean
  
  required boolean
  
  Additional properties are NOT allowed
  
  design object
  
  cfImageId string | null
  
  title string | null
  
  description string | null
  
  buttonText string | null
  
  disableButton boolean
  
  disableTitle boolean
  
  disableDescription boolean
  
  backgroundCfImageId string | null
  
  backgroundColor string | null
  
  primaryColor string | null
  
  primaryColorAccent string | null
  
  secondaryColor string | null
  
  primaryTextColor string | null
  
  secondaryTextColor string | null
  
  disableShadows boolean
  
  disableSupport boolean
  
  isMainPageVisible boolean
  
  fontLink string | null
  
  darkMode boolean
  
  disableBusinessName boolean
  
  disableSearchBar boolean
  
  centerProductTitle boolean
  
  disableBusinessLogo boolean
  
  disableReviews boolean
  
  disableProductsSold boolean
  
  hideOutOfStockProducts boolean
  
  googleAnalyticsKey string | null
  
  crispChatKey string | null
  
  Additional properties are NOT allowed
  
  socialLinks array[object] | null
  
  platform integer(int32)
  
  Values are 0, 1, 2, 3, 4, 5, 6, 7, or 8.
  
  link string | null
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  listings array[object] | null
  
  id integer(int64)
  
  path string | null
  
  searchWordsMeta string | null
  
  position integer(int32)
  
  minPriceDetails object
  
  amount number(double)
  
  currency string | null
  
  Additional properties are NOT allowed
  
  seo object
  
  metaTitle string | null
  
  metaDescription string | null
  
  metaCfImageId string | null
  
  Additional properties are NOT allowed
  
  visibility integer(int32)
  
  "
  Public = 0
  Private = 1
  Unlisted = 2
  "
  
  Values are 0, 1, or 2.
  
  type integer(int32)
  
  "
  Products = 0
  Groups = 1
  Categories = 3
  "
  
  Values are 0, 1, or 3.
  
  product object
  
  id integer(int64)
  
  title string | null
  
  shortDescription string | null
  
  thumbnailCfImageId string | null
  
  statistics object
  
  rating number(float)
  
  totalFeedbacks integer(int64)
  
  totalProductsSold integer(int64)
  
  customersCount integer(int64)
  
  Additional properties are NOT allowed
  
  groupId integer(int64) | null
  
  isInstantDelivery boolean
  
  isInStock boolean
  
  onHold boolean
  
  unlisted boolean
  
  private boolean
  
  Additional properties are NOT allowed
  
  group object
  
  id integer(int64)
  
  title string | null
  
  description string | null
  
  cfImageId string | null
  
  listings array[object] | null
  
  Additional properties are NOT allowed
  
  type integer(int32)
  
  Values are 0 or 1.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  categories array[object] | null
  
  id integer(int64)
  
  name string | null
  
  listingIds array[integer(int64)] | null
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- message string | null
- errors array[string] | null
- log string | null
- Additional properties are NOT allowed
• 404

Shop Not Found

GET /v2/public/shops/{shopId}/listings

curl \
 -X GET https://dev.sellpass.io/v2/public/shops/{shopId}/listings \
 -H "Authorization: $API_KEY"

Response example (200)

{
  "data": {
    "mainDetails": {
      "id": 42,
      "name": "string",
      "discordOauthUrl": "string",
      "shopPopUp": "string",
      "shopTerms": "string",
      "onHold": true,
      "enableFaq": true,
      "subscriptionName": "string",
      "seoDetails": {
        "id": 42,
        "favIconUrl": "string",
        "metaTitle": "string",
        "metaDescription": "string",
        "metaImageCfId": "string"
      },
      "defaultDiscordSettings": {
        "enabled": true,
        "required": true
      },
      "design": {
        "cfImageId": "string",
        "title": "string",
        "description": "string",
        "buttonText": "string",
        "disableButton": true,
        "disableTitle": true,
        "disableDescription": true,
        "backgroundCfImageId": "string",
        "backgroundColor": "string",
        "primaryColor": "string",
        "primaryColorAccent": "string",
        "secondaryColor": "string",
        "primaryTextColor": "string",
        "secondaryTextColor": "string",
        "disableShadows": true,
        "disableSupport": true,
        "isMainPageVisible": true,
        "fontLink": "string",
        "darkMode": true,
        "disableBusinessName": true,
        "disableSearchBar": true,
        "centerProductTitle": true,
        "disableBusinessLogo": true,
        "disableReviews": true,
        "disableProductsSold": true,
        "hideOutOfStockProducts": true,
        "googleAnalyticsKey": "string",
        "crispChatKey": "string"
      },
      "socialLinks": [
        {
          "platform": 0,
          "link": "string"
        }
      ]
    },
    "listings": [
      {
        "id": 42,
        "path": "string",
        "searchWordsMeta": "string",
        "position": 42,
        "minPriceDetails": {
          "amount": 42.0,
          "currency": "string"
        },
        "seo": {
          "metaTitle": "string",
          "metaDescription": "string",
          "metaCfImageId": "string"
        },
        "visibility": 0,
        "type": 0,
        "product": {
          "id": 42,
          "title": "string",
          "shortDescription": "string",
          "thumbnailCfImageId": "string",
          "statistics": {
            "rating": 42.0,
            "totalFeedbacks": 42,
            "totalProductsSold": 42,
            "customersCount": 42
          },
          "groupId": 42,
          "isInstantDelivery": true,
          "isInStock": true,
          "onHold": true,
          "unlisted": true,
          "private": true
        },
        "group": {
          "id": 42,
          "title": "string",
          "description": "string",
          "cfImageId": "string",
          "listings": [
            {}
          ],
          "type": 0
        }
      }
    ],
    "categories": [
      {
        "id": 42,
        "name": "string",
        "listingIds": [
          42
        ]
      }
    ]
  },
  "message": "string",
  "errors": [
    "string"
  ],
  "log": "string"
}

Get all the needed information for product page of the shop

GET /v2/public/shops/{shopId}/listings/{listingPath}

Path parameters

shopId integer(int64) Required
listingPath string Required

Responses

• 200 object

Page Info
- data object
  listing object
  
  id integer(int64)
  
  path string | null
  
  searchWordsMeta string | null
  
  position integer(int32)
  
  minPriceDetails object
  
  amount number(double)
  
  currency string | null
  
  Additional properties are NOT allowed
  
  seo object
  
  metaTitle string | null
  
  metaDescription string | null
  
  metaCfImageId string | null
  
  Additional properties are NOT allowed
  
  visibility integer(int32)
  
  "
  Public = 0
  Private = 1
  Unlisted = 2
  "
  
  Values are 0, 1, or 2.
  
  type integer(int32)
  
  "
  Products = 0
  Groups = 1
  Categories = 3
  "
  
  Values are 0, 1, or 3.
  
  product object
  
  id integer(int64)
  
  title string | null
  
  description string | null
  
  shortDescription string | null
  
  thumbnailCfImageId string | null
  
  statistics object
  
  rating number(float)
  
  totalFeedbacks integer(int64)
  
  totalProductsSold integer(int64)
  
  customersCount integer(int64)
  
  Additional properties are NOT allowed
  
  variants array[object] | null
  
  id integer(int64)
  
  title string | null
  
  priceDetails object
  
  amount number(double)
  
  currency string | null
  
  Additional properties are NOT allowed
  
  productType integer(int32)
  
  "
  Serials = 0
  Dynamic = 2
  Service = 3
  If you choose serials, you need to provide only asSerials property
  If you choose dynamic, you need to provide only asDynamic property
  If you choose service, you need to provide only asService property"
  
  Values are 0, 2, or 3.
  
  asDynamic object
  
  stock integer(int32) | null
  
  minAmount integer(int32) | null
  
  maxAmount integer(int32) | null
  
  Additional properties are NOT allowed
  
  asSerials object
  
  stock integer(int32)
  
  minAmount integer(int32) | null
  
  maxAmount integer(int32) | null
  
  Additional properties are NOT allowed
  
  asService object
  
  stock integer(int32) | null
  
  minAmount integer(int32) | null
  
  maxAmount integer(int32) | null
  
  Additional properties are NOT allowed
  
  gateways array[object] | null
  
  gateway integer(int32)
  
  "
  The list of supported payment gateways.
  CoinbaseCommerce = 0
  Stripe = 1
  PayPal = 2
  CashApp = 3
  PayPalFf = 4
  VirtualPayments = 5
  "
  
  Values are 0, 1, 2, 3, 4, or 5.
  
  rules object
  
  blockVpn boolean
  
  Additional properties are NOT allowed
  
  price object
  
  amount number(double)
  
  currency string | null
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  customFields array[object] | null
  
  id integer(int64)
  
  type integer(int32) Required
  
  Values are 1, 2, 3, 4, or 5.
  
  name string Required
  
  required boolean Required
  
  valueString string | null
  
  placeholder string | null
  
  regex string | null
  
  valueInt integer(int32) | null
  
  valueBool boolean | null
  
  Additional properties are NOT allowed
  
  warranty object
  
  id integer(int64)
  
  text string | null
  
  durationSeconds integer(int32) | null
  
  Additional properties are NOT allowed
  
  discordSocialConnectSettings object
  
  enabled boolean
  
  required boolean
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  groupId integer(int64) | null
  
  onHold boolean
  
  unlisted boolean
  
  private boolean
  
  Additional properties are NOT allowed
  
  group object
  
  id integer(int64)
  
  title string | null
  
  description string | null
  
  cfImageId string | null
  
  listings array[object] | null
  
  Additional properties are NOT allowed
  
  type integer(int32)
  
  Values are 0 or 1.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  feedbacks array[object] | null
  
  rating integer(int32) | null
  
  comment string | null
  
  sellerReply string | null
  
  createdAt string(date-time) | null
  
  updatedAt string(date-time) | null
  
  Additional properties are NOT allowed
  
  mainDetails object
  
  id integer(int64)
  
  name string | null
  
  discordOauthUrl string | null
  
  shopPopUp string | null
  
  shopTerms string | null
  
  onHold boolean
  
  enableFaq boolean
  
  subscriptionName string | null
  
  seoDetails object
  
  id integer(int64)
  
  favIconUrl string | null
  
  metaTitle string | null
  
  metaDescription string | null
  
  metaImageCfId string | null
  
  Additional properties are NOT allowed
  
  defaultDiscordSettings object
  
  enabled boolean
  
  required boolean
  
  Additional properties are NOT allowed
  
  design object
  
  cfImageId string | null
  
  title string | null
  
  description string | null
  
  buttonText string | null
  
  disableButton boolean
  
  disableTitle boolean
  
  disableDescription boolean
  
  backgroundCfImageId string | null
  
  backgroundColor string | null
  
  primaryColor string | null
  
  primaryColorAccent string | null
  
  secondaryColor string | null
  
  primaryTextColor string | null
  
  secondaryTextColor string | null
  
  disableShadows boolean
  
  disableSupport boolean
  
  isMainPageVisible boolean
  
  fontLink string | null
  
  darkMode boolean
  
  disableBusinessName boolean
  
  disableSearchBar boolean
  
  centerProductTitle boolean
  
  disableBusinessLogo boolean
  
  disableReviews boolean
  
  disableProductsSold boolean
  
  hideOutOfStockProducts boolean
  
  googleAnalyticsKey string | null
  
  crispChatKey string | null
  
  Additional properties are NOT allowed
  
  socialLinks array[object] | null
  
  platform integer(int32)
  
  Values are 0, 1, 2, 3, 4, 5, 6, 7, or 8.
  
  link string | null
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- message string | null
- errors array[string] | null
- log string | null
- Additional properties are NOT allowed
• 404

Shop Not Found

GET /v2/public/shops/{shopId}/listings/{listingPath}

curl \
 -X GET https://dev.sellpass.io/v2/public/shops/{shopId}/listings/{listingPath} \
 -H "Authorization: $API_KEY"

Response example (200)

{
  "data": {
    "listing": {
      "id": 42,
      "path": "string",
      "searchWordsMeta": "string",
      "position": 42,
      "minPriceDetails": {
        "amount": 42.0,
        "currency": "string"
      },
      "seo": {
        "metaTitle": "string",
        "metaDescription": "string",
        "metaCfImageId": "string"
      },
      "visibility": 0,
      "type": 0,
      "product": {
        "id": 42,
        "title": "string",
        "description": "string",
        "shortDescription": "string",
        "thumbnailCfImageId": "string",
        "statistics": {
          "rating": 42.0,
          "totalFeedbacks": 42,
          "totalProductsSold": 42,
          "customersCount": 42
        },
        "variants": [
          {
            "id": 42,
            "title": "string",
            "priceDetails": {
              "amount": 42.0,
              "currency": "string"
            },
            "productType": 0,
            "asDynamic": {
              "stock": 42,
              "minAmount": 42,
              "maxAmount": 42
            },
            "asSerials": {
              "stock": 42,
              "minAmount": 42,
              "maxAmount": 42
            },
            "asService": {
              "stock": 42,
              "minAmount": 42,
              "maxAmount": 42
            },
            "gateways": [
              {
                "gateway": 0,
                "rules": {
                  "blockVpn": true
                },
                "price": {
                  "amount": 42.0,
                  "currency": "string"
                }
              }
            ],
            "customFields": [
              {
                "id": 42,
                "type": 1,
                "name": "string",
                "required": true,
                "valueString": "string",
                "placeholder": "string",
                "regex": "string",
                "valueInt": 42,
                "valueBool": true
              }
            ],
            "warranty": {
              "id": 42,
              "text": "string",
              "durationSeconds": 42
            },
            "discordSocialConnectSettings": {
              "enabled": true,
              "required": true
            }
          }
        ],
        "groupId": 42,
        "onHold": true,
        "unlisted": true,
        "private": true
      },
      "group": {
        "id": 42,
        "title": "string",
        "description": "string",
        "cfImageId": "string",
        "listings": [
          {}
        ],
        "type": 0
      }
    },
    "feedbacks": [
      {
        "rating": 42,
        "comment": "string",
        "sellerReply": "string",
        "createdAt": "2023-05-04T09:42:00+00:00",
        "updatedAt": "2023-05-04T09:42:00+00:00"
      }
    ],
    "mainDetails": {
      "id": 42,
      "name": "string",
      "discordOauthUrl": "string",
      "shopPopUp": "string",
      "shopTerms": "string",
      "onHold": true,
      "enableFaq": true,
      "subscriptionName": "string",
      "seoDetails": {
        "id": 42,
        "favIconUrl": "string",
        "metaTitle": "string",
        "metaDescription": "string",
        "metaImageCfId": "string"
      },
      "defaultDiscordSettings": {
        "enabled": true,
        "required": true
      },
      "design": {
        "cfImageId": "string",
        "title": "string",
        "description": "string",
        "buttonText": "string",
        "disableButton": true,
        "disableTitle": true,
        "disableDescription": true,
        "backgroundCfImageId": "string",
        "backgroundColor": "string",
        "primaryColor": "string",
        "primaryColorAccent": "string",
        "secondaryColor": "string",
        "primaryTextColor": "string",
        "secondaryTextColor": "string",
        "disableShadows": true,
        "disableSupport": true,
        "isMainPageVisible": true,
        "fontLink": "string",
        "darkMode": true,
        "disableBusinessName": true,
        "disableSearchBar": true,
        "centerProductTitle": true,
        "disableBusinessLogo": true,
        "disableReviews": true,
        "disableProductsSold": true,
        "hideOutOfStockProducts": true,
        "googleAnalyticsKey": "string",
        "crispChatKey": "string"
      },
      "socialLinks": [
        {
          "platform": 0,
          "link": "string"
        }
      ]
    }
  },
  "message": "string",
  "errors": [
    "string"
  ],
  "log": "string"
}

Get all the needed information for feedbacks page of the shop

GET /v2/public/shops/{shopId}/feedbacks

Path parameters

shopId integer(int32) Required

Responses

• 200 object

Page Info
- data object
  feedbacks array[object] | null
  
  rating integer(int32) | null
  
  comment string | null
  
  sellerReply string | null
  
  createdAt string(date-time) | null
  
  updatedAt string(date-time) | null
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- message string | null
- errors array[string] | null
- log string | null
- Additional properties are NOT allowed
• 404

Shop Not Found

GET /v2/public/shops/{shopId}/feedbacks

curl \
 -X GET https://dev.sellpass.io/v2/public/shops/{shopId}/feedbacks \
 -H "Authorization: $API_KEY"

Response example (200)

{
  "data": {
    "feedbacks": [
      {
        "rating": 42,
        "comment": "string",
        "sellerReply": "string",
        "createdAt": "2023-05-04T09:42:00+00:00",
        "updatedAt": "2023-05-04T09:42:00+00:00"
      }
    ]
  },
  "message": "string",
  "errors": [
    "string"
  ],
  "log": "string"
}

Get all the needed information for announcement page of the shop

GET /v2/public/shops/{shopId}/announcements/{announcementPath}

Path parameters

shopId integer(int64) Required
announcementPath string Required

Responses

• 200 object

Page Info
- data object
  id integer(int64)
  
  path string | null
  
  title string | null
  
  shortDescription string | null
  
  description string | null
  
  buttonText string | null
  
  buttonLink string | null
  
  createdAt string(date-time)
  
  Additional properties are NOT allowed
- message string | null
- errors array[string] | null
- log string | null
- Additional properties are NOT allowed
• 404

Shop Not Found

GET /v2/public/shops/{shopId}/announcements/{announcementPath}

curl \
 -X GET https://dev.sellpass.io/v2/public/shops/{shopId}/announcements/{announcementPath} \
 -H "Authorization: $API_KEY"

Response example (200)

{
  "data": {
    "id": 42,
    "path": "string",
    "title": "string",
    "shortDescription": "string",
    "description": "string",
    "buttonText": "string",
    "buttonLink": "string",
    "createdAt": "2023-05-04T09:42:00+00:00"
  },
  "message": "string",
  "errors": [
    "string"
  ],
  "log": "string"
}

Get all the needed information for faqs page of the shop

GET /v2/public/shops/{shopId}/faqs

Path parameters

shopId integer(int64) Required

Responses

• 200 object

Page Info
- data object
  faqs array[object] | null
  
  id integer(int64)
  
  question string | null
  
  answer string | null
  
  position integer(int64)
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- message string | null
- errors array[string] | null
- log string | null
- Additional properties are NOT allowed
• 404

Shop Not Found

GET /v2/public/shops/{shopId}/faqs

curl \
 -X GET https://dev.sellpass.io/v2/public/shops/{shopId}/faqs \
 -H "Authorization: $API_KEY"

Response example (200)

{
  "data": {
    "faqs": [
      {
        "id": 42,
        "question": "string",
        "answer": "string",
        "position": 42
      }
    ]
  },
  "message": "string",
  "errors": [
    "string"
  ],
  "log": "string"
}

Announcements

Manage announcements

Get all

GET /self/{shopId}/announcements

Path parameters

shopId integer(int32) Required

Query parameters

PageNumber integer(int32)
PageSize integer(int32)
searchString string

Responses

• 200

All Announcements

GET /self/{shopId}/announcements

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/announcements \
 -H "Authorization: $API_KEY"

Create Announcement

POST /self/{shopId}/announcements

Path parameters

shopId integer(int32) Required

Body

title string Required
shortDescription string Required
description string Required
unlisted boolean Required
private boolean Required
buttonText string | null
buttonLink string | null
Additional properties are NOT allowed

Responses

• 200

Announcement created

POST /self/{shopId}/announcements

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/announcements \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"title":"string","shortDescription":"string","description":"string","unlisted":true,"private":true,"buttonText":"string","buttonLink":"string"}'

Request example

{
  "title": "string",
  "shortDescription": "string",
  "description": "string",
  "unlisted": true,
  "private": true,
  "buttonText": "string",
  "buttonLink": "string"
}

Edit Announcement

PUT /self/{shopId}/announcements/{announcementId}

Path parameters

shopId integer(int32) Required
announcementId integer(int64) Required

Body

title string Required
shortDescription string Required
description string Required
unlisted boolean Required
private boolean Required
buttonText string | null
buttonLink string | null
Additional properties are NOT allowed

Responses

• 200

Announcement edited

PUT /self/{shopId}/announcements/{announcementId}

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/announcements/{announcementId} \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"title":"string","shortDescription":"string","description":"string","unlisted":true,"private":true,"buttonText":"string","buttonLink":"string"}'

Request example

{
  "title": "string",
  "shortDescription": "string",
  "description": "string",
  "unlisted": true,
  "private": true,
  "buttonText": "string",
  "buttonLink": "string"
}

Delete Announcement

DELETE /self/{shopId}/announcements/{announcementId}

Path parameters

shopId integer(int32) Required
announcementId integer(int64) Required

Responses

• 200

Announcement deleted

DELETE /self/{shopId}/announcements/{announcementId}

curl \
 -X DELETE https://dev.sellpass.io/self/{shopId}/announcements/{announcementId} \
 -H "Authorization: $API_KEY"

Blacklist

Manage blacklists

Get All

GET /self/{shopId}/blacklist

Path parameters

shopId integer(int32) Required

Query parameters

PageNumber integer(int32)
PageSize integer(int32)
searchString string

Responses

• 200

Full blacklist

GET /self/{shopId}/blacklist

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/blacklist \
 -H "Authorization: $API_KEY"

Create Blocked Item

POST /self/{shopId}/blacklist

Path parameters

shopId integer(int32) Required

Body

data string | null
note string | null
type integer(int32)

"
Ip = 0
Email = 1
Country = 2
"

Values are 0, 1, or 2.
customerForShopId integer(int64) | null
Additional properties are NOT allowed

Responses

• 200

Blocked item created

POST /self/{shopId}/blacklist

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/blacklist \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"data":"string","note":"string","type":0,"customerForShopId":42}'

Request example

{
  "data": "string",
  "note": "string",
  "type": 0,
  "customerForShopId": 42
}

Get Blocked Item

GET /self/{shopId}/blacklist/{blockedItemId}

Path parameters

shopId integer(int32) Required
blockedItemId integer(int64) Required

Responses

• 200

Blocked item

GET /self/{shopId}/blacklist/{blockedItemId}

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/blacklist/{blockedItemId} \
 -H "Authorization: $API_KEY"

Edit Blocked Item

PUT /self/{shopId}/blacklist/{blockedItemId}

Path parameters

shopId integer(int32) Required
blockedItemId integer(int64) Required

Body

data string | null
note string | null
type integer(int32)

"
Ip = 0
Email = 1
Country = 2
"

Values are 0, 1, or 2.
customerForShopId integer(int64) | null
Additional properties are NOT allowed

Responses

• 200

Blocked item edited

PUT /self/{shopId}/blacklist/{blockedItemId}

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/blacklist/{blockedItemId} \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"data":"string","note":"string","type":0,"customerForShopId":42}'

Request example

{
  "data": "string",
  "note": "string",
  "type": 0,
  "customerForShopId": 42
}

Delete Blocked Item

DELETE /self/{shopId}/blacklist/{blockedItemId}

Path parameters

shopId integer(int32) Required
blockedItemId integer(int64) Required

Responses

• 200

Blocked item deleted

DELETE /self/{shopId}/blacklist/{blockedItemId}

curl \
 -X DELETE https://dev.sellpass.io/self/{shopId}/blacklist/{blockedItemId} \
 -H "Authorization: $API_KEY"

Coupons

Manage coupons

Get All

GET /self/{shopId}/coupons

Path parameters

shopId integer(int32) Required

Query parameters

PageNumber integer(int32)
PageSize integer(int32)
searchString string

Responses

• 200

All coupons

GET /self/{shopId}/coupons

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/coupons \
 -H "Authorization: $API_KEY"

Create Coupon

POST /self/{shopId}/coupons

Path parameters

shopId integer(int32) Required

Body

name string Required
note string | null
discount number(double) Required
isFixed boolean Required
startDate string(date-time) | null
endDate string(date-time) | null
restrictToProducts array[integer(int64)] | null
restrictToGateways array[integer(int32)] | null

"
The list of supported payment gateways.
CoinbaseCommerce = 0
Stripe = 1
PayPal = 2
CashApp = 3
PayPalFf = 4
VirtualPayments = 5
"

Values are 0, 1, 2, 3, 4, or 5.
maxUses integer(int32) | null
Additional properties are NOT allowed

Responses

• 200

Coupon created

POST /self/{shopId}/coupons

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/coupons \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"name":"string","note":"string","discount":42.0,"isFixed":true,"startDate":"2023-05-04T09:42:00+00:00","endDate":"2023-05-04T09:42:00+00:00","restrictToProducts":[42],"restrictToGateways":[0],"maxUses":42}'

Request example

{
  "name": "string",
  "note": "string",
  "discount": 42.0,
  "isFixed": true,
  "startDate": "2023-05-04T09:42:00+00:00",
  "endDate": "2023-05-04T09:42:00+00:00",
  "restrictToProducts": [
    42
  ],
  "restrictToGateways": [
    0
  ],
  "maxUses": 42
}

Get Coupon

GET /self/{shopId}/coupons/{couponId}

Path parameters

shopId integer(int32) Required
couponId integer(int64) Required

Responses

• 200

Coupon

GET /self/{shopId}/coupons/{couponId}

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/coupons/{couponId} \
 -H "Authorization: $API_KEY"

Edit Coupon

PUT /self/{shopId}/coupons/{couponId}

Path parameters

shopId integer(int32) Required
couponId integer(int64) Required

Body

name string Required
note string | null
discount number(double) Required
isFixed boolean Required
startDate string(date-time) | null
endDate string(date-time) | null
restrictToProducts array[integer(int64)] | null
restrictToGateways array[integer(int32)] | null

"
The list of supported payment gateways.
CoinbaseCommerce = 0
Stripe = 1
PayPal = 2
CashApp = 3
PayPalFf = 4
VirtualPayments = 5
"

Values are 0, 1, 2, 3, 4, or 5.
maxUses integer(int32) | null
Additional properties are NOT allowed

Responses

• 200

Coupon edited

PUT /self/{shopId}/coupons/{couponId}

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/coupons/{couponId} \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"name":"string","note":"string","discount":42.0,"isFixed":true,"startDate":"2023-05-04T09:42:00+00:00","endDate":"2023-05-04T09:42:00+00:00","restrictToProducts":[42],"restrictToGateways":[0],"maxUses":42}'

Request example

{
  "name": "string",
  "note": "string",
  "discount": 42.0,
  "isFixed": true,
  "startDate": "2023-05-04T09:42:00+00:00",
  "endDate": "2023-05-04T09:42:00+00:00",
  "restrictToProducts": [
    42
  ],
  "restrictToGateways": [
    0
  ],
  "maxUses": 42
}

Delete Coupon

DELETE /self/{shopId}/coupons/{couponId}

Path parameters

shopId integer(int32) Required
couponId integer(int64) Required

Responses

• 200

Coupon deleted

DELETE /self/{shopId}/coupons/{couponId}

curl \
 -X DELETE https://dev.sellpass.io/self/{shopId}/coupons/{couponId} \
 -H "Authorization: $API_KEY"

Customization

Manage shop customization

PUT /self/{shopId}/customization/design

Path parameters

shopId integer(int32) Required

Body

primaryColor string Required
primaryColorAccent string | null
backgroundColor string Required
secondaryColor string Required
primaryTextColor string Required
secondaryTextColor string Required
darkMode boolean Required
disableBusinessName boolean Required
disableSearchBar boolean Required
centerProductTitle boolean Required
disableBusinessLogo boolean Required
disableReviews boolean Required
disableProductsSold boolean Required
hideOutOfStockProducts boolean Required
disableShadows boolean | null
disableSupport boolean | null
fontLink string | null
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/customization/design

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/customization/design \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"primaryColor":"string","primaryColorAccent":"string","backgroundColor":"string","secondaryColor":"string","primaryTextColor":"string","secondaryTextColor":"string","darkMode":true,"disableBusinessName":true,"disableSearchBar":true,"centerProductTitle":true,"disableBusinessLogo":true,"disableReviews":true,"disableProductsSold":true,"hideOutOfStockProducts":true,"disableShadows":true,"disableSupport":true,"fontLink":"string"}'

Request example

{
  "primaryColor": "string",
  "primaryColorAccent": "string",
  "backgroundColor": "string",
  "secondaryColor": "string",
  "primaryTextColor": "string",
  "secondaryTextColor": "string",
  "darkMode": true,
  "disableBusinessName": true,
  "disableSearchBar": true,
  "centerProductTitle": true,
  "disableBusinessLogo": true,
  "disableReviews": true,
  "disableProductsSold": true,
  "hideOutOfStockProducts": true,
  "disableShadows": true,
  "disableSupport": true,
  "fontLink": "string"
}

PUT /self/{shopId}/customization/widgets

Path parameters

shopId integer(int32) Required

Body

crispKey string | null
googleAnalyticsKey string | null
hotjarKey string | null
intercomKey string | null
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/customization/widgets

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/customization/widgets \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"crispKey":"string","googleAnalyticsKey":"string","hotjarKey":"string","intercomKey":"string"}'

Request example

{
  "crispKey": "string",
  "googleAnalyticsKey": "string",
  "hotjarKey": "string",
  "intercomKey": "string"
}

PUT /self/{shopId}/customization/storefront

Path parameters

shopId integer(int32) Required

Body

title string | null
description string | null
buttonText string | null
disableButton boolean
disableTitle boolean
disableDescription boolean
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/customization/storefront

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/customization/storefront \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"title":"string","description":"string","buttonText":"string","disableButton":true,"disableTitle":true,"disableDescription":true}'

Request example

{
  "title": "string",
  "description": "string",
  "buttonText": "string",
  "disableButton": true,
  "disableTitle": true,
  "disableDescription": true
}

POST /self/{shopId}/customization/storefront/background

Path parameters

shopId integer(int32) Required

Body

file string(binary)

Responses

• 200

Success

POST /self/{shopId}/customization/storefront/background

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/customization/storefront/background \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: multipart/form-data" \
 -F "file=@file"

Request example

{
  "file": "@file"
}

PUT /self/{shopId}/customization/seo

Path parameters

shopId integer(int32) Required

Body

Responses

• 200

Success

PUT /self/{shopId}/customization/seo

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/customization/seo \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"metaTitle":"string","metaDescription":"string"}'

Request example

{
  "metaTitle": "string",
  "metaDescription": "string"
}

POST /self/{shopId}/customization/seo/image

Path parameters

shopId integer(int32) Required

Body

file string(binary)

Responses

• 200

Success

POST /self/{shopId}/customization/seo/image

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/customization/seo/image \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: multipart/form-data" \
 -F "file=@file"

Request example

{
  "file": "@file"
}

POST /self/{shopId}/customization/seo/favicon

Path parameters

shopId integer(int32) Required

Body

file string(binary)

Responses

• 200

Success

POST /self/{shopId}/customization/seo/favicon

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/customization/seo/favicon \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: multipart/form-data" \
 -F "file=@file"

Request example

{
  "file": "@file"
}

POST /self/{shopId}/customization/logo

Path parameters

shopId integer(int32) Required

Body

file string(binary)

Responses

• 200

Success

POST /self/{shopId}/customization/logo

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/customization/logo \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: multipart/form-data" \
 -F "file=@file"

Request example

{
  "file": "@file"
}

PUT /self/{shopId}/customization/links

Path parameters

shopId integer(int32) Required

Body

socialLinks array[object] Required
- platform integer(int32)
  
  Values are 0, 1, 2, 3, 4, 5, 6, 7, or 8.
- link string | null
- Additional properties are NOT allowed
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/customization/links

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/customization/links \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"socialLinks":[{"platform":0,"link":"string"}]}'

Request example

{
  "socialLinks": [
    {
      "platform": 0,
      "link": "string"
    }
  ]
}

GET /self/{shopId}/customization

Path parameters

shopId integer(int32) Required

Responses

• 200

Success

GET /self/{shopId}/customization

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/customization \
 -H "Authorization: $API_KEY"

Dashboard

Manage shop dashboard

GET /self/{shopId}/dashboard/general

Path parameters

shopId integer(int32) Required

Query parameters

fromDate string(date-time)
toDate string(date-time)

Responses

• 200

Success

GET /self/{shopId}/dashboard/general

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/dashboard/general \
 -H "Authorization: $API_KEY"

DesignShopSettings

Manage shop design settings

PUT /self/{shopId}/settings/design

Path parameters

shopId integer(int32) Required

Body

primaryColor string Required
primaryColorAccent string | null
backgroundColor string Required
secondaryColor string Required
primaryTextColor string Required
secondaryTextColor string Required
darkMode boolean Required
disableBusinessName boolean Required
disableSearchBar boolean Required
centerProductTitle boolean Required
disableBusinessLogo boolean Required
disableReviews boolean Required
disableProductsSold boolean Required
hideOutOfStockProducts boolean Required
disableShadows boolean | null
disableSupport boolean | null
fontLink string | null
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/settings/design

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/settings/design \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"primaryColor":"string","primaryColorAccent":"string","backgroundColor":"string","secondaryColor":"string","primaryTextColor":"string","secondaryTextColor":"string","darkMode":true,"disableBusinessName":true,"disableSearchBar":true,"centerProductTitle":true,"disableBusinessLogo":true,"disableReviews":true,"disableProductsSold":true,"hideOutOfStockProducts":true,"disableShadows":true,"disableSupport":true,"fontLink":"string"}'

Request example

{
  "primaryColor": "string",
  "primaryColorAccent": "string",
  "backgroundColor": "string",
  "secondaryColor": "string",
  "primaryTextColor": "string",
  "secondaryTextColor": "string",
  "darkMode": true,
  "disableBusinessName": true,
  "disableSearchBar": true,
  "centerProductTitle": true,
  "disableBusinessLogo": true,
  "disableReviews": true,
  "disableProductsSold": true,
  "hideOutOfStockProducts": true,
  "disableShadows": true,
  "disableSupport": true,
  "fontLink": "string"
}

PUT /self/{shopId}/settings/design/storefront

Path parameters

shopId integer(int32) Required

Body

title string | null
description string | null
buttonText string | null
disableButton boolean
disableTitle boolean
disableDescription boolean
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/settings/design/storefront

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/settings/design/storefront \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"title":"string","description":"string","buttonText":"string","disableButton":true,"disableTitle":true,"disableDescription":true}'

Request example

{
  "title": "string",
  "description": "string",
  "buttonText": "string",
  "disableButton": true,
  "disableTitle": true,
  "disableDescription": true
}

POST /self/{shopId}/settings/design/storefront/logo

Path parameters

shopId integer(int32) Required

Body

file string(binary)

Responses

• 200

Success

POST /self/{shopId}/settings/design/storefront/logo

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/settings/design/storefront/logo \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: multipart/form-data" \
 -F "file=@file"

Request example

{
  "file": "@file"
}

POST /self/{shopId}/settings/design/logo

Path parameters

shopId integer(int32) Required

Body

file string(binary)

Responses

• 200

Success

POST /self/{shopId}/settings/design/logo

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/settings/design/logo \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: multipart/form-data" \
 -F "file=@file"

Request example

{
  "file": "@file"
}

PUT /self/{shopId}/settings/design/links

Path parameters

shopId integer(int32) Required

Body

socialLinks array[object] Required
- platform integer(int32)
  
  Values are 0, 1, 2, 3, 4, 5, 6, 7, or 8.
- link string | null
- Additional properties are NOT allowed
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/settings/design/links

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/settings/design/links \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"socialLinks":[{"platform":0,"link":"string"}]}'

Request example

{
  "socialLinks": [
    {
      "platform": 0,
      "link": "string"
    }
  ]
}

Faqs

Manage faqs

GET /self/{shopId}/faqs

Path parameters

shopId integer(int32) Required

Query parameters

PageNumber integer(int32)
PageSize integer(int32)
searchString string

Responses

• 200

Success

GET /self/{shopId}/faqs

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/faqs \
 -H "Authorization: $API_KEY"

POST /self/{shopId}/faqs

Path parameters

shopId integer(int32) Required

Body

question string Required
answer string Required
Additional properties are NOT allowed

Responses

• 200

Success

POST /self/{shopId}/faqs

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/faqs \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"question":"string","answer":"string"}'

Request example

{
  "question": "string",
  "answer": "string"
}

PUT /self/{shopId}/faqs/{faqId}

Path parameters

shopId integer(int32) Required
faqId integer(int64) Required

Body

question string Required
answer string Required
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/faqs/{faqId}

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/faqs/{faqId} \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"question":"string","answer":"string"}'

Request example

{
  "question": "string",
  "answer": "string"
}

DELETE /self/{shopId}/faqs/{faqId}

Path parameters

shopId integer(int32) Required
faqId integer(int64) Required

Responses

• 200

Success

DELETE /self/{shopId}/faqs/{faqId}

curl \
 -X DELETE https://dev.sellpass.io/self/{shopId}/faqs/{faqId} \
 -H "Authorization: $API_KEY"

Feedbacks

Manage feedbacks

GET /self/{shopId}/feedbacks

Path parameters

shopId integer(int32) Required

Query parameters

PageNumber integer(int32)
PageSize integer(int32)
searchString string

Responses

• 200

Success

GET /self/{shopId}/feedbacks

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/feedbacks \
 -H "Authorization: $API_KEY"

GET /self/{shopId}/feedbacks/appeals

Path parameters

shopId integer(int32) Required

Query parameters

PageNumber integer(int32)
PageSize integer(int32)
searchString string

Responses

• 200

Success

GET /self/{shopId}/feedbacks/appeals

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/feedbacks/appeals \
 -H "Authorization: $API_KEY"

GET /self/{shopId}/feedbacks/{feedbackId}

Path parameters

shopId integer(int32) Required
feedbackId integer(int64) Required

Responses

• 200

Success

GET /self/{shopId}/feedbacks/{feedbackId}

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/feedbacks/{feedbackId} \
 -H "Authorization: $API_KEY"

POST /self/{shopId}/feedbacks/{feedbackId}/answer

Path parameters

shopId integer(int32) Required
feedbackId integer(int64) Required

Body

answer string Required
Additional properties are NOT allowed

Responses

• 200

Success

POST /self/{shopId}/feedbacks/{feedbackId}/answer

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/feedbacks/{feedbackId}/answer \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"answer":"string"}'

Request example

{
  "answer": "string"
}

POST /self/{shopId}/feedbacks/{feedbackId}/appeal

Path parameters

shopId integer(int32) Required
feedbackId integer(int64) Required

Body

reason integer(int32) Required

Values are 0, 1, 2, 3, or 4.
description string Required
Additional properties are NOT allowed

Responses

• 200

Success

POST /self/{shopId}/feedbacks/{feedbackId}/appeal

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/feedbacks/{feedbackId}/appeal \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"reason":0,"description":"string"}'

Request example

{
  "reason": 0,
  "description": "string"
}

Groups

Manage groups

GET /self/{shopId}/groups

Path parameters

shopId integer(int32) Required

Query parameters

PageNumber integer(int32)
PageSize integer(int32)
searchString string

Responses

• 200

Success

GET /self/{shopId}/groups

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/groups \
 -H "Authorization: $API_KEY"

POST /self/{shopId}/groups

Path parameters

shopId integer(int32) Required

Body

title string Required
description string | null
productIds array[integer(int64)] Required
priority integer(int32) Required
type integer(int32) Required

Values are 0 or 1.
main boolean | null
Additional properties are NOT allowed

Responses

• 200

Success

POST /self/{shopId}/groups

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/groups \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"title":"string","description":"string","productIds":[42],"priority":42,"type":0,"main":true}'

Request example

{
  "title": "string",
  "description": "string",
  "productIds": [
    42
  ],
  "priority": 42,
  "type": 0,
  "main": true
}

GET /self/{shopId}/groups/{groupId}

Path parameters

shopId integer(int32) Required
groupId integer(int64) Required

Responses

• 200

Success

GET /self/{shopId}/groups/{groupId}

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/groups/{groupId} \
 -H "Authorization: $API_KEY"

PUT /self/{shopId}/groups/{groupId}

Path parameters

shopId integer(int32) Required
groupId integer(int64) Required

Body

title string Required
description string | null
productIds array[integer(int64)] Required
priority integer(int32) Required
type integer(int32) Required

Values are 0 or 1.
main boolean | null
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/groups/{groupId}

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/groups/{groupId} \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"title":"string","description":"string","productIds":[42],"priority":42,"type":0,"main":true}'

Request example

{
  "title": "string",
  "description": "string",
  "productIds": [
    42
  ],
  "priority": 42,
  "type": 0,
  "main": true
}

DELETE /self/{shopId}/groups/{groupId}

Path parameters

shopId integer(int32) Required
groupId integer(int64) Required

Responses

• 200

Success

DELETE /self/{shopId}/groups/{groupId}

curl \
 -X DELETE https://dev.sellpass.io/self/{shopId}/groups/{groupId} \
 -H "Authorization: $API_KEY"

POST /self/{shopId}/groups/{groupId}/thumbnail

Path parameters

shopId integer(int32) Required
groupId integer(int64) Required

Body

file string(binary)

Responses

• 200

Success

POST /self/{shopId}/groups/{groupId}/thumbnail

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/groups/{groupId}/thumbnail \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: multipart/form-data" \
 -F "file=@file"

Request example

{
  "file": "@file"
}

Orders

Manage Orders

Get all invoices

GET /self/{shopId}/invoices

Path parameters

shopId integer(int32) Required

Query parameters

PageNumber integer(int32)
PageSize integer(int32)
searchString string

Responses

• 200

All invoices

GET /self/{shopId}/invoices

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/invoices \
 -H "Authorization: $API_KEY"

Get invoice

GET /self/{shopId}/invoices/{invoiceId}

Path parameters

shopId integer(int32) Required
invoiceId string Required

Responses

• 200

Info about the invoice

GET /self/{shopId}/invoices/{invoiceId}

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/invoices/{invoiceId} \
 -H "Authorization: $API_KEY"

Resend email to customer

POST /self/{shopId}/invoices/{invoiceId}/resend

Path parameters

shopId integer(int32) Required
invoiceId string Required

Body

email string | null
Additional properties are NOT allowed

Responses

• 200

Resent

POST /self/{shopId}/invoices/{invoiceId}/resend

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/invoices/{invoiceId}/resend \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"email":"string"}'

Request example

{
  "email": "string"
}

Replace invoice

POST /self/{shopId}/invoices/{invoiceId}/replacement

Path parameters

shopId integer(int32) Required
invoiceId string Required

Body

partInvoiceId integer(int64) Required
quantity integer(int32)

Minimum value is 1, maximum value is 2147483647.
Additional properties are NOT allowed

Responses

• 200

Replacement done

POST /self/{shopId}/invoices/{invoiceId}/replacement

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/invoices/{invoiceId}/replacement \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"partInvoiceId":42,"quantity":42}'

Request example

{
  "partInvoiceId": 42,
  "quantity": 42
}

Process invoice

POST /self/{shopId}/invoices/{invoiceId}/process

Path parameters

shopId integer(int32) Required
invoiceId string Required

Responses

• 200

Manually process the invoice

POST /self/{shopId}/invoices/{invoiceId}/process

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/invoices/{invoiceId}/process \
 -H "Authorization: $API_KEY"

Listings

Manage listings

GET /self/{shopId}/listings

Path parameters

shopId integer(int32) Required

Responses

• 200

Success

GET /self/{shopId}/listings

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/listings \
 -H "Authorization: $API_KEY"

PUT /self/{shopId}/listings/position

Path parameters

shopId integer(int32) Required

Body

listings array[object] | null
- listingId integer(int64)
- position integer(int32)
- Additional properties are NOT allowed
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/listings/position

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/listings/position \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"listings":[{"listingId":42,"position":42}]}'

Request example

{
  "listings": [
    {
      "listingId": 42,
      "position": 42
    }
  ]
}

Products

Manage V2 products

GET /self/{shopId}/products

Path parameters

shopId integer(int32) Required

Query parameters

PageNumber integer(int32)
PageSize integer(int32)
searchString string

Responses

• 200

Success

GET /self/{shopId}/products

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/products \
 -H "Authorization: $API_KEY"

DELETE /self/{shopId}/products/{productId}

Path parameters

shopId integer(int32) Required
productId integer(int64) Required

Responses

• 200

Success

DELETE /self/{shopId}/products/{productId}

curl \
 -X DELETE https://dev.sellpass.io/self/{shopId}/products/{productId} \
 -H "Authorization: $API_KEY"

PUT /self/{shopId}/products/bulk/update/custom-fields

Path parameters

shopId integer(int32) Required

Body

productIds array[integer(int64)] | null
customFields array[object] | null
- id integer(int64)
- type integer(int32) Required
  
  Values are 1, 2, 3, 4, or 5.
- name string Required
- required boolean Required
- valueString string | null
- placeholder string | null
- regex string | null
- valueInt integer(int32) | null
- valueBool boolean | null
- Additional properties are NOT allowed
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/products/bulk/update/custom-fields

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/products/bulk/update/custom-fields \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"productIds":[42],"customFields":[{"id":42,"type":1,"name":"string","required":true,"valueString":"string","placeholder":"string","regex":"string","valueInt":42,"valueBool":true}]}'

Request example

{
  "productIds": [
    42
  ],
  "customFields": [
    {
      "id": 42,
      "type": 1,
      "name": "string",
      "required": true,
      "valueString": "string",
      "placeholder": "string",
      "regex": "string",
      "valueInt": 42,
      "valueBool": true
    }
  ]
}

PUT /self/{shopId}/products/bulk/update/customer-note

Path parameters

shopId integer(int32) Required

Body

productIds array[integer(int64)] | null
note string | null
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/products/bulk/update/customer-note

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/products/bulk/update/customer-note \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"productIds":[42],"note":"string"}'

Request example

{
  "productIds": [
    42
  ],
  "note": "string"
}

PUT /self/{shopId}/products/bulk/update/visibility

Path parameters

shopId integer(int32) Required

Body

productIds array[integer(int64)] | null
unlisted boolean
private boolean
onHold boolean
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/products/bulk/update/visibility

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/products/bulk/update/visibility \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"productIds":[42],"unlisted":true,"private":true,"onHold":true}'

Request example

{
  "productIds": [
    42
  ],
  "unlisted": true,
  "private": true,
  "onHold": true
}

PUT /self/{shopId}/products/bulk/update/discord-integration

Path parameters

shopId integer(int32) Required

Body

productIds array[integer(int64)] | null
discordSocialConnectSettings object
- enabled boolean Required
- required boolean Required
- guildId string | null
- roleIds array[string] | null
- Additional properties are NOT allowed
Additional properties are NOT allowed

Responses

• 200

Success

PUT /self/{shopId}/products/bulk/update/discord-integration

curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/products/bulk/update/discord-integration \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"productIds":[42],"discordSocialConnectSettings":{"enabled":true,"required":true,"guildId":"string","roleIds":["string"]}}'

Request example

{
  "productIds": [
    42
  ],
  "discordSocialConnectSettings": {
    "enabled": true,
    "required": true,
    "guildId": "string",
    "roleIds": [
      "string"
    ]
  }
}

POST /self/{shopId}/products/bulk/delete

Path parameters

shopId integer(int32) Required

Body

productIds array[integer(int64)] | null
Additional properties are NOT allowed

Responses

• 200

Success

POST /self/{shopId}/products/bulk/delete

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/products/bulk/delete \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"productIds":[42]}'

Request example

{
  "productIds": [
    42
  ]
}

Shop

Manage shops

GET /self/shops

Responses

• 200

Success

GET /self/shops

curl \
 -X GET https://dev.sellpass.io/self/shops \
 -H "Authorization: $API_KEY"

POST /self/shops

Body

name string Required
Additional properties are NOT allowed

Responses

• 200

Success

POST /self/shops

curl \
 -X POST https://dev.sellpass.io/self/shops \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"name":"string"}'

Request example

{
  "name": "string"
}

Tickets

Manage tickets

GET /self/{shopId}/tickets

Path parameters

shopId integer(int32) Required

Query parameters

PageNumber integer(int32)
PageSize integer(int32)
searchString string

Responses

• 200

Success

GET /self/{shopId}/tickets

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/tickets \
 -H "Authorization: $API_KEY"

GET /self/{shopId}/tickets/{ticketId}

Path parameters

shopId integer(int32) Required
ticketId integer(int64) Required

Responses

• 200

Success

GET /self/{shopId}/tickets/{ticketId}

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/tickets/{ticketId} \
 -H "Authorization: $API_KEY"

POST /self/{shopId}/tickets/{ticketId}/message

Path parameters

shopId integer(int32) Required
ticketId integer(int64) Required

Body

content string Required
Additional properties are NOT allowed

Responses

• 200

Success

POST /self/{shopId}/tickets/{ticketId}/message

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/tickets/{ticketId}/message \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"content":"string"}'

Request example

{
  "content": "string"
}

POST /self/{shopId}/tickets/{ticketId}/close

Path parameters

shopId integer(int32) Required
ticketId integer(int64) Required

Responses

• 200

Success

POST /self/{shopId}/tickets/{ticketId}/close

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/tickets/{ticketId}/close \
 -H "Authorization: $API_KEY"

ProductsV2

Manage V2 products

Get products

GET /self/{shopId}/v2/products

Path parameters

shopId integer(int32) Required

Query parameters

PageNumber integer(int32)
PageSize integer(int32)
searchString string
orderBy string

Responses

• 200

All products

GET /self/{shopId}/v2/products

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/v2/products \
 -H "Authorization: $API_KEY"

Create a new product

POST /self/{shopId}/v2/products

Path parameters

shopId integer(int32) Required

Body

title string Required

Title of the product
shortDescription string | null

Short Description of the product
description string Required

Description of the product
variants array[object] Required

At least 1 variant is required
- id integer(int64) | null
  
  Pass it only if you are editing the existing variant
- title string | null
  
  Title of the variant
- description string | null
  
  Description of the variant
- priceDetails object
  amount number(double)
  
  currency string | null
  
  Additional properties are NOT allowed
- gateways array[object] | null
  
  Gateways available for this variant
  gateway integer(int32)
  
  "
  The list of supported payment gateways.
  CoinbaseCommerce = 0
  Stripe = 1
  PayPal = 2
  CashApp = 3
  PayPalFf = 4
  VirtualPayments = 5
  "
  
  Values are 0, 1, 2, 3, 4, or 5.
  
  rules object
  
  blockVpn boolean
  
  Additional properties are NOT allowed
  
  price object
  
  amount number(double)
  
  currency string | null
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- productType integer(int32)
  
  "
  Serials = 0
  Dynamic = 2
  Service = 3
  If you choose serials, you need to provide only asSerials property
  If you choose dynamic, you need to provide only asDynamic property
  If you choose service, you need to provide only asService property"
  
  Values are 0, 2, or 3.
- asDynamic object
  stock integer(int32) | null
  
  Minimum value is 0, maximum value is 2147483647.
  
  externalUrl string | null
  
  minAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  maxAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  Additional properties are NOT allowed
- asSerials object
  delimiter string | null
  
  serials string | null
  
  minAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  maxAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  removeDuplicates boolean
  
  Additional properties are NOT allowed
- asService object
  stock integer(int32) | null
  
  Minimum value is 0, maximum value is 2147483647.
  
  text string | null
  
  minAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  maxAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  Additional properties are NOT allowed
- customerNote string | null
  
  This note will be visible to customer after purchase
- redirectUrl string | null
  
  Customer will be redirected to this url after purchase
- customFields array[object] | null
  
  Custom fields of the variant
  id integer(int64)
  
  type integer(int32) Required
  
  Values are 1, 2, 3, 4, or 5.
  
  name string Required
  
  required boolean Required
  
  valueString string | null
  
  placeholder string | null
  
  regex string | null
  
  valueInt integer(int32) | null
  
  valueBool boolean | null
  
  Additional properties are NOT allowed
- warranty object
  text string | null
  
  Warranty of the product
  
  durationSeconds integer(int32)
  
  Duration of the warranty in seconds
  
  Additional properties are NOT allowed
- discordSocialConnectSettings object
  enabled boolean Required
  
  Is Discord social connect enabled
  
  required boolean Required
  
  Is Discord social connect required
  
  beforePurchaseRequireRoles object
  
  guildId string | null
  
  roleIds array[string] | null
  
  Additional properties are NOT allowed
  
  beforePurchaseServer object
  
  guildId string | null
  
  roleIds array[string] | null
  
  Additional properties are NOT allowed
  
  afterPurchaseServer object
  
  guildId string | null
  
  roleIds array[string] | null
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
path string Required

Path/Slug of the product
seo object Required
- metaTitle string | null
  
  Meta title of the product. If not provided, default shop seo settings will be used
- metaDescription string | null
  
  Meta description of the product. If not provided, default shop seo settings will be used
- Additional properties are NOT allowed
unlisted boolean Required

Is product unlisted
private boolean Required

Is product private
onHold boolean Required

Is product on hold
Additional properties are NOT allowed

Responses

• 200 object

Product created
- data integer(int64)
- message string | null
- errors array[string] | null
- log string | null
- Additional properties are NOT allowed

POST /self/{shopId}/v2/products

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/v2/products \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"title":"string","shortDescription":"string","description":"string","variants":[{"id":42,"title":"string","description":"string","priceDetails":{"amount":42.0,"currency":"string"},"gateways":[{"gateway":0,"rules":{"blockVpn":true},"price":{"amount":42.0,"currency":"string"}}],"productType":0,"asDynamic":{"stock":42,"externalUrl":"string","minAmount":42,"maxAmount":42},"asSerials":{"delimiter":"string","serials":"string","minAmount":42,"maxAmount":42,"removeDuplicates":true},"asService":{"stock":42,"text":"string","minAmount":42,"maxAmount":42},"customerNote":"string","redirectUrl":"string","customFields":[{"id":42,"type":1,"name":"string","required":true,"valueString":"string","placeholder":"string","regex":"string","valueInt":42,"valueBool":true}],"warranty":{"text":"string","durationSeconds":42},"discordSocialConnectSettings":{"enabled":true,"required":true,"beforePurchaseRequireRoles":{"guildId":"string","roleIds":["string"]},"beforePurchaseServer":{"guildId":"string","roleIds":["string"]},"afterPurchaseServer":{"guildId":"string","roleIds":["string"]}}}],"path":"string","seo":{"metaTitle":"string","metaDescription":"string"},"unlisted":true,"private":true,"onHold":true}'

Request example

{
  "title": "string",
  "shortDescription": "string",
  "description": "string",
  "variants": [
    {
      "id": 42,
      "title": "string",
      "description": "string",
      "priceDetails": {
        "amount": 42.0,
        "currency": "string"
      },
      "gateways": [
        {
          "gateway": 0,
          "rules": {
            "blockVpn": true
          },
          "price": {
            "amount": 42.0,
            "currency": "string"
          }
        }
      ],
      "productType": 0,
      "asDynamic": {
        "stock": 42,
        "externalUrl": "string",
        "minAmount": 42,
        "maxAmount": 42
      },
      "asSerials": {
        "delimiter": "string",
        "serials": "string",
        "minAmount": 42,
        "maxAmount": 42,
        "removeDuplicates": true
      },
      "asService": {
        "stock": 42,
        "text": "string",
        "minAmount": 42,
        "maxAmount": 42
      },
      "customerNote": "string",
      "redirectUrl": "string",
      "customFields": [
        {
          "id": 42,
          "type": 1,
          "name": "string",
          "required": true,
          "valueString": "string",
          "placeholder": "string",
          "regex": "string",
          "valueInt": 42,
          "valueBool": true
        }
      ],
      "warranty": {
        "text": "string",
        "durationSeconds": 42
      },
      "discordSocialConnectSettings": {
        "enabled": true,
        "required": true,
        "beforePurchaseRequireRoles": {
          "guildId": "string",
          "roleIds": [
            "string"
          ]
        },
        "beforePurchaseServer": {
          "guildId": "string",
          "roleIds": [
            "string"
          ]
        },
        "afterPurchaseServer": {
          "guildId": "string",
          "roleIds": [
            "string"
          ]
        }
      }
    }
  ],
  "path": "string",
  "seo": {
    "metaTitle": "string",
    "metaDescription": "string"
  },
  "unlisted": true,
  "private": true,
  "onHold": true
}

Response example (200)

{
  "data": 42,
  "message": "string",
  "errors": [
    "string"
  ],
  "log": "string"
}

Update product thumbnail

POST /self/{shopId}/v2/products/{productId}/thumbnail

Path parameters

shopId integer(int32) Required
productId integer(int64) Required

Body

file string(binary)

Responses

• 200 object

Product updated
- data
- message string | null
- errors array[string] | null
- log string | null
- Additional properties are NOT allowed

POST /self/{shopId}/v2/products/{productId}/thumbnail

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/v2/products/{productId}/thumbnail \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: multipart/form-data" \
 -F "file=@file"

Request example

{
  "file": "@file"
}

Response example (200)

{
  "message": "string",
  "errors": [
    "string"
  ],
  "log": "string"
}

Update seo image

POST /self/{shopId}/v2/products/{productId}/seo/image

Path parameters

shopId integer(int32) Required
productId integer(int64) Required

Body

file string(binary)

Responses

• 200 object

Product updated
- data
- message string | null
- errors array[string] | null
- log string | null
- Additional properties are NOT allowed

POST /self/{shopId}/v2/products/{productId}/seo/image

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/v2/products/{productId}/seo/image \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: multipart/form-data" \
 -F "file=@file"

Request example

{
  "file": "@file"
}

Response example (200)

{
  "message": "string",
  "errors": [
    "string"
  ],
  "log": "string"
}

Get product

GET /self/{shopId}/v2/products/{productId}

Path parameters

shopId integer(int32) Required
productId integer(int64) Required

Responses

• 200

Product

GET /self/{shopId}/v2/products/{productId}

curl \
 -X GET https://dev.sellpass.io/self/{shopId}/v2/products/{productId} \
 -H "Authorization: $API_KEY"

Update product

PUT /self/{shopId}/v2/products/{productId}

Path parameters

shopId integer(int32) Required
productId integer(int64) Required

Body

title string Required

Title of the product
shortDescription string | null

Short Description of the product
description string Required

Description of the product
variants array[object] Required

At least 1 variant is required
- id integer(int64) | null
  
  Pass it only if you are editing the existing variant
- title string | null
  
  Title of the variant
- description string | null
  
  Description of the variant
- priceDetails object
  amount number(double)
  
  currency string | null
  
  Additional properties are NOT allowed
- gateways array[object] | null
  
  Gateways available for this variant
  gateway integer(int32)
  
  "
  The list of supported payment gateways.
  CoinbaseCommerce = 0
  Stripe = 1
  PayPal = 2
  CashApp = 3
  PayPalFf = 4
  VirtualPayments = 5
  "
  
  Values are 0, 1, 2, 3, 4, or 5.
  
  rules object
  
  blockVpn boolean
  
  Additional properties are NOT allowed
  
  price object
  
  amount number(double)
  
  currency string | null
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- productType integer(int32)
  
  "
  Serials = 0
  Dynamic = 2
  Service = 3
  If you choose serials, you need to provide only asSerials property
  If you choose dynamic, you need to provide only asDynamic property
  If you choose service, you need to provide only asService property"
  
  Values are 0, 2, or 3.
- asDynamic object
  stock integer(int32) | null
  
  Minimum value is 0, maximum value is 2147483647.
  
  externalUrl string | null
  
  minAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  maxAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  Additional properties are NOT allowed
- asSerials object
  delimiter string | null
  
  serials string | null
  
  minAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  maxAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  removeDuplicates boolean
  
  Additional properties are NOT allowed
- asService object
  stock integer(int32) | null
  
  Minimum value is 0, maximum value is 2147483647.
  
  text string | null
  
  minAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  maxAmount integer(int32) | null
  
  Minimum value is 1, maximum value is 2147483647.
  
  Additional properties are NOT allowed
- customerNote string | null
  
  This note will be visible to customer after purchase
- redirectUrl string | null
  
  Customer will be redirected to this url after purchase
- customFields array[object] | null
  
  Custom fields of the variant
  id integer(int64)
  
  type integer(int32) Required
  
  Values are 1, 2, 3, 4, or 5.
  
  name string Required
  
  required boolean Required
  
  valueString string | null
  
  placeholder string | null
  
  regex string | null
  
  valueInt integer(int32) | null
  
  valueBool boolean | null
  
  Additional properties are NOT allowed
- warranty object
  text string | null
  
  Warranty of the product
  
  durationSeconds integer(int32)
  
  Duration of the warranty in seconds
  
  Additional properties are NOT allowed
- discordSocialConnectSettings object
  enabled boolean Required
  
  Is Discord social connect enabled
  
  required boolean Required
  
  Is Discord social connect required
  
  beforePurchaseRequireRoles object
  
  guildId string | null
  
  roleIds array[string] | null
  
  Additional properties are NOT allowed
  
  beforePurchaseServer object
  
  guildId string | null
  
  roleIds array[string] | null
  
  Additional properties are NOT allowed
  
  afterPurchaseServer object
  
  guildId string | null
  
  roleIds array[string] | null
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
path string Required

Path/Slug of the product
seo object Required
- metaTitle string | null
  
  Meta title of the product. If not provided, default shop seo settings will be used
- metaDescription string | null
  
  Meta description of the product. If not provided, default shop seo settings will be used
- Additional properties are NOT allowed
unlisted boolean Required

Is product unlisted
private boolean Required

Is product private
onHold boolean Required

Is product on hold
Additional properties are NOT allowed

Responses

• 200

Product updated

PUT /self/{shopId}/v2/products/{productId}

SellPass.WebApi v1

SellPass.WebApi
v1