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.

Path parameters

Responses

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"
}

Path parameters

Responses

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

Responses

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"
}

Path parameters

Responses

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

Responses

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"
}

Path parameters

Responses

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

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

Body

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

Body

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

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

Responses

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

Body

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

Responses

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

Body

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

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"

Categories

Manage categories

Get All

GET /self/{shopId}/categories

Path parameters

Responses

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

Create Category

POST /self/{shopId}/categories

Path parameters

Body

Responses

  • 200

    Category created

POST /self/{shopId}/categories
curl \
 -X POST https://dev.sellpass.io/self/{shopId}/categories \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"name":"string","listingIds":[42]}'
Request example
{
  "name": "string",
  "listingIds": [
    42
  ]
}

Get Category

GET /self/{shopId}/categories/{categoryId}

Path parameters

Responses

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

Edit Category

PUT /self/{shopId}/categories/{categoryId}

Path parameters

Body

Responses

  • 200

    Category edited

PUT /self/{shopId}/categories/{categoryId}
curl \
 -X PUT https://dev.sellpass.io/self/{shopId}/categories/{categoryId} \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"name":"string","listingIds":[42]}'
Request example
{
  "name": "string",
  "listingIds": [
    42
  ]
}

Delete Category

DELETE /self/{shopId}/categories/{categoryId}

Path parameters

Responses

  • 200

    Category deleted

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

Coupons

Manage coupons

Get All

GET /self/{shopId}/coupons

Path parameters

Responses

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

Body

Responses

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

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

Body

Responses

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

Responses

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

PUT /self/{shopId}/customization/design

Path parameters

Body

Responses

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

PUT /self/{shopId}/customization/widgets

Path parameters

Responses

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
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

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

Path parameters

Body

Responses

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
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

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

Path parameters

Body

Responses

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

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

Path parameters

Body

Responses

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"
}

GET /self/{shopId}/customization

GET /self/{shopId}/customization

Path parameters

Responses

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

GET /self/{shopId}/dashboard/general

Path parameters

Query parameters

Responses

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

PUT /self/{shopId}/settings/design

Path parameters

Body

Responses

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
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
}

Faqs

Manage faqs

GET /self/{shopId}/faqs

GET /self/{shopId}/faqs

Path parameters

Responses

GET /self/{shopId}/faqs
curl \
 -X GET https://dev.sellpass.io/self/{shopId}/faqs \
 -H "Authorization: $API_KEY"
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}

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

Path parameters

Responses

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}

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

Path parameters

Responses

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

GET /self/{shopId}/feedbacks

Path parameters

Responses

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

GET /self/{shopId}/feedbacks/appeals

GET /self/{shopId}/feedbacks/appeals

Path parameters

Responses

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}

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

Path parameters

Responses

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

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

Path parameters

Body

Responses

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

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

Path parameters

Body

Responses

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

GET /self/{shopId}/groups

Path parameters

Responses

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

POST /self/{shopId}/groups

POST /self/{shopId}/groups

Path parameters

Body

Responses

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}

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

Path parameters

Responses

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}

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

Path parameters

Body

Responses

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}

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

Path parameters

Responses

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

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

Path parameters

Body

Responses

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

Responses

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

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

Body

Responses

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

Body

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

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

GET /self/{shopId}/listings

Path parameters

Responses

GET /self/{shopId}/listings
curl \
 -X GET https://dev.sellpass.io/self/{shopId}/listings \
 -H "Authorization: $API_KEY"
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

GET /self/{shopId}/products

Path parameters

Responses

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

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

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

Path parameters

Responses

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

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

Path parameters

Body

Responses

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

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

Path parameters

Responses

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

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

Path parameters

Responses

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

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

Path parameters

Responses

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

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

Path parameters

Body

Responses

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

GET /self/shops

Responses

GET /self/shops
curl \
 -X GET https://dev.sellpass.io/self/shops \
 -H "Authorization: $API_KEY"
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

GET /self/{shopId}/tickets

Path parameters

Responses

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

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

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

Path parameters

Responses

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

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

Path parameters

Body

Responses

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

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

Path parameters

Responses

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

Responses

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

Body

Responses

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

Body

Responses

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

Body

Responses

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

Responses

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

Body

Responses

  • 200

    Product updated

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