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'
This is the documentation for version v1
of the API. Last update on Nov 29, 2022.
https://dev.sellpass.io
JWT Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the text input below.
Example: 'Bearer 12345abcdef'
Get public information about shop: listings, statistics, etc.
curl \
-X GET https://dev.sellpass.io/v2/public/shops/{shopId}/main \
-H "Authorization: $API_KEY"
{
"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"
}
curl \
-X GET https://dev.sellpass.io/v2/public/shops/{shopId}/listings \
-H "Authorization: $API_KEY"
{
"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"
}
curl \
-X GET https://dev.sellpass.io/v2/public/shops/{shopId}/listings/{listingPath} \
-H "Authorization: $API_KEY"
{
"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"
}
curl \
-X GET https://dev.sellpass.io/v2/public/shops/{shopId}/feedbacks \
-H "Authorization: $API_KEY"
{
"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"
}
curl \
-X GET https://dev.sellpass.io/v2/public/shops/{shopId}/announcements/{announcementPath} \
-H "Authorization: $API_KEY"
{
"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"
}
curl \
-X GET https://dev.sellpass.io/v2/public/shops/{shopId}/faqs \
-H "Authorization: $API_KEY"
{
"data": {
"faqs": [
{
"id": 42,
"question": "string",
"answer": "string",
"position": 42
}
]
},
"message": "string",
"errors": [
"string"
],
"log": "string"
}
Manage announcements
curl \
-X GET https://dev.sellpass.io/self/{shopId}/announcements \
-H "Authorization: $API_KEY"
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"}'
{
"title": "string",
"shortDescription": "string",
"description": "string",
"unlisted": true,
"private": true,
"buttonText": "string",
"buttonLink": "string"
}
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"}'
{
"title": "string",
"shortDescription": "string",
"description": "string",
"unlisted": true,
"private": true,
"buttonText": "string",
"buttonLink": "string"
}
curl \
-X DELETE https://dev.sellpass.io/self/{shopId}/announcements/{announcementId} \
-H "Authorization: $API_KEY"
Manage blacklists
curl \
-X GET https://dev.sellpass.io/self/{shopId}/blacklist \
-H "Authorization: $API_KEY"
"
Ip = 0
Email = 1
Country = 2
"
Values are 0
, 1
, or 2
.
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}'
{
"data": "string",
"note": "string",
"type": 0,
"customerForShopId": 42
}
curl \
-X GET https://dev.sellpass.io/self/{shopId}/blacklist/{blockedItemId} \
-H "Authorization: $API_KEY"
"
Ip = 0
Email = 1
Country = 2
"
Values are 0
, 1
, or 2
.
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}'
{
"data": "string",
"note": "string",
"type": 0,
"customerForShopId": 42
}
curl \
-X DELETE https://dev.sellpass.io/self/{shopId}/blacklist/{blockedItemId} \
-H "Authorization: $API_KEY"
Manage categories
curl \
-X GET https://dev.sellpass.io/self/{shopId}/categories \
-H "Authorization: $API_KEY"
curl \
-X POST https://dev.sellpass.io/self/{shopId}/categories \
-H "Authorization: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","listingIds":[42]}'
{
"name": "string",
"listingIds": [
42
]
}
curl \
-X GET https://dev.sellpass.io/self/{shopId}/categories/{categoryId} \
-H "Authorization: $API_KEY"
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]}'
{
"name": "string",
"listingIds": [
42
]
}
curl \
-X DELETE https://dev.sellpass.io/self/{shopId}/categories/{categoryId} \
-H "Authorization: $API_KEY"
Manage coupons
curl \
-X GET https://dev.sellpass.io/self/{shopId}/coupons \
-H "Authorization: $API_KEY"
"
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
.
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}'
{
"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
}
curl \
-X GET https://dev.sellpass.io/self/{shopId}/coupons/{couponId} \
-H "Authorization: $API_KEY"
"
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
.
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}'
{
"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
}
curl \
-X DELETE https://dev.sellpass.io/self/{shopId}/coupons/{couponId} \
-H "Authorization: $API_KEY"
Manage shop customization
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"}'
{
"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"
}
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"}'
{
"crispKey": "string",
"googleAnalyticsKey": "string",
"hotjarKey": "string",
"intercomKey": "string"
}
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}'
{
"title": "string",
"description": "string",
"buttonText": "string",
"disableButton": true,
"disableTitle": true,
"disableDescription": true
}
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"
{
"file": "@file"
}
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"}'
{
"metaTitle": "string",
"metaDescription": "string"
}
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"
{
"file": "@file"
}
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"
{
"file": "@file"
}
curl \
-X POST https://dev.sellpass.io/self/{shopId}/customization/logo \
-H "Authorization: $API_KEY" \
-H "Content-Type: multipart/form-data" \
-F "file=@file"
{
"file": "@file"
}
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"}]}'
{
"socialLinks": [
{
"platform": 0,
"link": "string"
}
]
}
curl \
-X GET https://dev.sellpass.io/self/{shopId}/customization \
-H "Authorization: $API_KEY"
Manage shop dashboard
curl \
-X GET https://dev.sellpass.io/self/{shopId}/dashboard/general \
-H "Authorization: $API_KEY"
Manage shop design settings
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"}'
{
"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"
}
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}'
{
"title": "string",
"description": "string",
"buttonText": "string",
"disableButton": true,
"disableTitle": true,
"disableDescription": true
}
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"
{
"file": "@file"
}
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"
{
"file": "@file"
}
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"}]}'
{
"socialLinks": [
{
"platform": 0,
"link": "string"
}
]
}
Manage faqs
curl \
-X GET https://dev.sellpass.io/self/{shopId}/faqs \
-H "Authorization: $API_KEY"
curl \
-X POST https://dev.sellpass.io/self/{shopId}/faqs \
-H "Authorization: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"question":"string","answer":"string"}'
{
"question": "string",
"answer": "string"
}
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"}'
{
"question": "string",
"answer": "string"
}
curl \
-X DELETE https://dev.sellpass.io/self/{shopId}/faqs/{faqId} \
-H "Authorization: $API_KEY"
Manage feedbacks
curl \
-X GET https://dev.sellpass.io/self/{shopId}/feedbacks \
-H "Authorization: $API_KEY"
curl \
-X GET https://dev.sellpass.io/self/{shopId}/feedbacks/appeals \
-H "Authorization: $API_KEY"
curl \
-X GET https://dev.sellpass.io/self/{shopId}/feedbacks/{feedbackId} \
-H "Authorization: $API_KEY"
curl \
-X POST https://dev.sellpass.io/self/{shopId}/feedbacks/{feedbackId}/answer \
-H "Authorization: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"answer":"string"}'
{
"answer": "string"
}
Values are 0
, 1
, 2
, 3
, or 4
.
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"}'
{
"reason": 0,
"description": "string"
}
Manage groups
curl \
-X GET https://dev.sellpass.io/self/{shopId}/groups \
-H "Authorization: $API_KEY"
Values are 0
or 1
.
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}'
{
"title": "string",
"description": "string",
"productIds": [
42
],
"priority": 42,
"type": 0,
"main": true
}
curl \
-X GET https://dev.sellpass.io/self/{shopId}/groups/{groupId} \
-H "Authorization: $API_KEY"
Values are 0
or 1
.
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}'
{
"title": "string",
"description": "string",
"productIds": [
42
],
"priority": 42,
"type": 0,
"main": true
}
curl \
-X DELETE https://dev.sellpass.io/self/{shopId}/groups/{groupId} \
-H "Authorization: $API_KEY"
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"
{
"file": "@file"
}
Manage Orders
curl \
-X GET https://dev.sellpass.io/self/{shopId}/invoices \
-H "Authorization: $API_KEY"
curl \
-X GET https://dev.sellpass.io/self/{shopId}/invoices/{invoiceId} \
-H "Authorization: $API_KEY"
curl \
-X POST https://dev.sellpass.io/self/{shopId}/invoices/{invoiceId}/resend \
-H "Authorization: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"email":"string"}'
{
"email": "string"
}
Minimum value is 1
, maximum value is 2147483647
.
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}'
{
"partInvoiceId": 42,
"quantity": 42
}
curl \
-X POST https://dev.sellpass.io/self/{shopId}/invoices/{invoiceId}/process \
-H "Authorization: $API_KEY"
Manage listings
curl \
-X GET https://dev.sellpass.io/self/{shopId}/listings \
-H "Authorization: $API_KEY"
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}]}'
{
"listings": [
{
"listingId": 42,
"position": 42
}
]
}
Manage V2 products
curl \
-X GET https://dev.sellpass.io/self/{shopId}/products \
-H "Authorization: $API_KEY"
curl \
-X DELETE https://dev.sellpass.io/self/{shopId}/products/{productId} \
-H "Authorization: $API_KEY"
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}]}'
{
"productIds": [
42
],
"customFields": [
{
"id": 42,
"type": 1,
"name": "string",
"required": true,
"valueString": "string",
"placeholder": "string",
"regex": "string",
"valueInt": 42,
"valueBool": true
}
]
}
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"}'
{
"productIds": [
42
],
"note": "string"
}
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}'
{
"productIds": [
42
],
"unlisted": true,
"private": true,
"onHold": true
}
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"]}}'
{
"productIds": [
42
],
"discordSocialConnectSettings": {
"enabled": true,
"required": true,
"guildId": "string",
"roleIds": [
"string"
]
}
}
curl \
-X POST https://dev.sellpass.io/self/{shopId}/products/bulk/delete \
-H "Authorization: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"productIds":[42]}'
{
"productIds": [
42
]
}
Manage shops
curl \
-X GET https://dev.sellpass.io/self/shops \
-H "Authorization: $API_KEY"
curl \
-X POST https://dev.sellpass.io/self/shops \
-H "Authorization: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'
{
"name": "string"
}
Manage tickets
curl \
-X GET https://dev.sellpass.io/self/{shopId}/tickets \
-H "Authorization: $API_KEY"
curl \
-X GET https://dev.sellpass.io/self/{shopId}/tickets/{ticketId} \
-H "Authorization: $API_KEY"
curl \
-X POST https://dev.sellpass.io/self/{shopId}/tickets/{ticketId}/message \
-H "Authorization: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"content":"string"}'
{
"content": "string"
}
curl \
-X POST https://dev.sellpass.io/self/{shopId}/tickets/{ticketId}/close \
-H "Authorization: $API_KEY"
Manage V2 products
curl \
-X GET https://dev.sellpass.io/self/{shopId}/v2/products \
-H "Authorization: $API_KEY"
Title of the product
Short Description of the product
Description of the product
At least 1 variant is required
Path/Slug of the product
Is product unlisted
Is product private
Is product on hold
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}'
{
"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
}
{
"data": 42,
"message": "string",
"errors": [
"string"
],
"log": "string"
}
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"
{
"file": "@file"
}
{
"message": "string",
"errors": [
"string"
],
"log": "string"
}
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"
{
"file": "@file"
}
{
"message": "string",
"errors": [
"string"
],
"log": "string"
}
curl \
-X GET https://dev.sellpass.io/self/{shopId}/v2/products/{productId} \
-H "Authorization: $API_KEY"
Title of the product
Short Description of the product
Description of the product
At least 1 variant is required
Path/Slug of the product
Is product unlisted
Is product private
Is product on hold