developers.billgang.com
Open in
urlscan Pro
34.132.239.214
Public Scan
URL:
https://developers.billgang.com/
Submission: On July 10 via automatic, source certstream-suspicious — Scanned from CA
Submission: On July 10 via automatic, source certstream-suspicious — Scanned from CA
Form analysis
1 forms found in the DOM<form data-v-983db964="" data-v-146c2c6e="" data-v-3bb0413b="" class="card-form">
<div data-v-f7b202a1="" data-v-146c2c6e="" class="card-form-input"><label data-v-f7b202a1="" for="security-scheme-Authorization">Header API </label><input data-v-f7b202a1="" placeholder="Token" id="security-scheme-Authorization" autocomplete="off"
data-1p-ignore="" spellcheck="false" type="password"><button data-v-f7b202a1=""
class="scalar-icon-button grid aspect-square cursor-pointer rounded size-10 p-3 scalar-button-ghost bg-transparent text-fore-3 active:text-fore-2 hocus:text-fore-2 password-mask scalar-component password-mask" type="button"><svg
xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 14 14" class="scalar-icon size-full scalar-component">
<path fill="currentColor" fill-rule="evenodd"
d="M2.933 3.491C4.056 2.681 5.456 2 7 2s2.944.682 4.067 1.491c1.128.812 2.02 1.784 2.56 2.437l.005.005c.241.3.368.681.368 1.067s-.127.766-.368 1.067l-.005.005c-.54.653-1.432 1.625-2.56 2.437C9.944 11.32 8.544 12 7 12s-2.944-.682-4.067-1.49C1.805 9.696.913 8.724.373 8.071l-.005-.005A1.7 1.7 0 0 1 0 7c0-.386.127-.766.368-1.067l.005-.005c.54-.653 1.432-1.625 2.56-2.437M7 9.25a2.25 2.25 0 1 0 0-4.5 2.25 2.25 0 0 0 0 4.5"
clip-rule="evenodd"></path>
</svg><span class="sr-only">Show Password</span></button></div>
</form>
Text Content
API Reference Search⌃k * Toggle group AFFILIATES * Toggle group ANALYTICS * Toggle group VISIT ANALYTICS * Toggle group POSTS * Toggle group AUDIT LOGS * Toggle group PRODUCTS * Toggle group CATEGORIES * Toggle group CHARGES * Toggle group COUPONS * Toggle group CUSTOMERS * Toggle group DEVELOPER SETTINGS * Toggle group FAQS * Toggle group FRAUD RULES * Toggle group GROUPS * Toggle group IMAGES * Toggle group INTEGRATION SETTINGS * Toggle group LISTINGS * Toggle group ORDERS * Toggle group ORDERS WEBHOOKS * Toggle group PAYMENTS SETTINGS * Toggle group REVIEWS * Toggle group CUSTOMER REWARDS * Toggle group SETTINGS * Toggle group WAREHOUSES * Toggle group TICKETS * Toggle group USER * Toggle group WEBHOOKS * Toggle group WEBHOOK LOGS * Toggle group MODELS Dark Mode v1 OAS 3.0.1 BILLGANG.API Download OpenAPI Spec Base URL https://pg-api.billgang.com API Key (Bearer) Header API Show Password Client Libraries Shell Ruby Node.js PHP Python Libcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP v1HTTP v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession More cURL Shell AFFILIATES # COPY LINK TO "AFFILIATES" Endpoints GET/v1/dash/shops/{shopId}/affiliates RETRIEVES A LIST OF AFFILIATES FOR A GIVEN SHOP. # COPY LINK TO "RETRIEVES A LIST OF AFFILIATES FOR A GIVEN SHOP." Path Parameters * shopId required string uuid The ID of the shop. Query Parameters * searchString string Optional search string to filter affiliates by email or ID. * orderBy string Optional parameter to order affiliates by specific fields (revenueGenerated, totalReferrals, balanceAwarded). * PageNumber integer int32 Signed 32-bit integers (commonly used integer type). * PageSize integer int32 Signed 32-bit integers (commonly used integer type). Responses * 200 Success * 400 Balance not setup GET/v1/dash/shops/{shopId}/affiliates Shell cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP v1HTTP v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession curl --request GET \ --url https://pg-api.billgang.com/v1/dash/shops/__SHOPID__/affiliates \ --header 'Authorization: YOUR_TOKEN' Test Request 200400 Show Schema { "data": [ { "customerId": 1, "customerEmail": "…", "referralSystem": { "revenueGeneratedUsd": 1, "totalReferrals": 1, "totalPaidReferrals": 1, "balanceAwarded": 1, "referralCode": "…", "isDisabled": true } } ], "message": "…", "errors": [ "…" ] } Success ANALYTICS # COPY LINK TO "ANALYTICS" Endpoints GET/v1/dash/shops/{shopId}/analytics/sales-chartsGET/v1/dash/shops/{shopId}/analytics/recent-actionsGET/v1/dash/shops/{shopId}/analytics/reviews-tickets-chartsGET/v1/dash/shops/{shopId}/analytics/top-products-charts Show More VISIT ANALYTICS # COPY LINK TO "VISIT ANALYTICS" Endpoints GET/v1/dash/shops/{shopId}/analytics/visitsGET/v1/dash/shops/{shopId}/analytics/conversion-rates Show More POSTS # COPY LINK TO "POSTS" Endpoints GET/v1/dash/shops/{shopId}/announcementsPOST/v1/dash/shops/{shopId}/announcementsGET/v1/dash/shops/{shopId}/announcements/{id}PUT/v1/dash/shops/{shopId}/announcements/{announcementId}DELETE/v1/dash/shops/{shopId}/announcements/{announcementId} Show More AUDIT LOGS # COPY LINK TO "AUDIT LOGS" Endpoints GET/v1/dash/shops/{shopId}/audit-logsGET/v1/dash/shops/{shopId}/audit-logs/{auditLogId} Show More PRODUCTS # COPY LINK TO "PRODUCTS" Endpoints POST/v1/dash/shops/{shopId}/products/bulk-update/custom-fieldsPOST/v1/dash/shops/{shopId}/products/bulk-update/gatewaysPOST/v1/dash/shops/{shopId}/products/bulk-update/customer-notePOST/v1/dash/shops/{shopId}/products/bulk-update/visibilityPOST/v1/dash/shops/{shopId}/products/bulk-update/discord-integrationPOST/v1/dash/shops/{shopId}/products/bulk-update/deleteGET/v1/dash/shops/{shopId}/productsPOST/v1/dash/shops/{shopId}/productsPUT/v1/dash/shops/{shopId}/products/{productId}GET/v1/dash/shops/{shopId}/products/{productId}DELETE/v1/dash/shops/{shopId}/products/{productId} Show More CATEGORIES # COPY LINK TO "CATEGORIES" Endpoints GET/v1/dash/shops/{shopId}/categoriesPOST/v1/dash/shops/{shopId}/categoriesGET/v1/dash/shops/{shopId}/categories/{id}PUT/v1/dash/shops/{shopId}/categories/{categoryId}DELETE/v1/dash/shops/{shopId}/categories/{categoryId} Show More CHARGES # COPY LINK TO "CHARGES" Endpoints GET/v1/dash/shops/{shopId}/chargesGET/v1/dash/shops/{shopId}/charges/{id}POST/v1/dash/shops/{shopId}/charges/{id}/mark-as-paid Show More COUPONS # COPY LINK TO "COUPONS" Endpoints GET/v1/dash/shops/{shopId}/couponsPOST/v1/dash/shops/{shopId}/couponsGET/v1/dash/shops/{shopId}/coupons/{id}PUT/v1/dash/shops/{shopId}/coupons/{couponId}DELETE/v1/dash/shops/{shopId}/coupons/{couponId} Show More CUSTOMERS # COPY LINK TO "CUSTOMERS" Endpoints GET/v1/dash/shops/{shopId}/customers/statsGET/v1/dash/shops/{shopId}/customersGET/v1/dash/shops/{shopId}/customers/{id}PUT/v1/dash/shops/{shopId}/customers/{id}PUT/v1/dash/shops/{shopId}/customers/{id}/notePOST/v1/dash/shops/{shopId}/customers/{id}/balance/add Show More DEVELOPER SETTINGS # COPY LINK TO "DEVELOPER SETTINGS" Endpoints GET/v1/dash/shops/{shopId}/settings/developers/webhooksPOST/v1/dash/shops/{shopId}/settings/developers/webhooksPOST/v1/dash/shops/{shopId}/settings/developers/webhooks/reset-secretDELETE/v1/dash/shops/{shopId}/settings/developers/webhooks/{webhookId} Show More FAQS # COPY LINK TO "FAQS" Endpoints GET/v1/dash/shops/{shopId}/faqsPOST/v1/dash/shops/{shopId}/faqsGET/v1/dash/shops/{shopId}/faqs/{id}PUT/v1/dash/shops/{shopId}/faqs/{faqId}DELETE/v1/dash/shops/{shopId}/faqs/{faqId} Show More FRAUD RULES # COPY LINK TO "FRAUD RULES" Endpoints GET/v1/dash/shops/{shopId}/fraud/rulesPOST/v1/dash/shops/{shopId}/fraud/rulesDELETE/v1/dash/shops/{shopId}/fraud/rules/{fraudRuleId} Show More GROUPS # COPY LINK TO "GROUPS" Endpoints GET/v1/dash/shops/{shopId}/groupsPOST/v1/dash/shops/{shopId}/groupsPUT/v1/dash/shops/{shopId}/groups/{groupId}GET/v1/dash/shops/{shopId}/groups/{groupId}DELETE/v1/dash/shops/{shopId}/groups/{groupId} Show More IMAGES # COPY LINK TO "IMAGES" Endpoints GET/v1/dash/shops/{shopId}/imagesPOST/v1/dash/shops/{shopId}/imagesDELETE/v1/dash/shops/{shopId}/images/{imageId} Show More INTEGRATION SETTINGS # COPY LINK TO "INTEGRATION SETTINGS" Endpoints GET/v1/dash/shops/{shopId}/settings/integrationsPUT/v1/dash/shops/{shopId}/settings/integrations/trustpilot Show More LISTINGS # COPY LINK TO "LISTINGS" Endpoints GET/v1/dash/shops/{shopId}/listings RETRIEVES A LIST OF LISTINGS FOR A GIVEN SHOP. # COPY LINK TO "RETRIEVES A LIST OF LISTINGS FOR A GIVEN SHOP." Path Parameters * shopId required string uuid The ID of the shop. Query Parameters * typeFilter allOf Optional filter to select listings by type. Show Child Attributes Responses * 200 Success GET/v1/dash/shops/{shopId}/listings Shell cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP v1HTTP v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession curl --request GET \ --url https://pg-api.billgang.com/v1/dash/shops/__SHOPID__/listings \ --header 'Authorization: YOUR_TOKEN' Test Request 200 Show Schema { "data": [ { "id": 1, "name": "…", "position": 1, "imageCfId": "…" } ], "message": "…", "errors": [ "…" ] } Success ORDERS # COPY LINK TO "ORDERS" Endpoints GET/v1/dash/shops/{shopId}/ordersGET/v1/dash/shops/{shopId}/orders/{id}POST/v1/dash/shops/{shopId}/orders/{orderId}/part-orders/{partOrderId}/replacePOST/v1/dash/shops/{shopId}/orders/{id}/resendPOST/v1/dash/shops/{shopId}/orders/{id}/refund Show More ORDERS WEBHOOKS # COPY LINK TO "ORDERS WEBHOOKS" Endpoints GET/v1/dash/shops/{shopId}/orders/{orderId}/webhook-logs RETRIEVES WEBHOOK LOGS FOR A SPECIFIC ORDER IN A GIVEN SHOP. # COPY LINK TO "RETRIEVES WEBHOOK LOGS FOR A SPECIFIC ORDER IN A GIVEN SHOP." Path Parameters * shopId required string uuid The ID of the shop. * orderId required string uuid The ID of the order. Responses * 200 Success * 404 If the order is not found GET/v1/dash/shops/{shopId}/orders/{orderId}/webhook-logs Shell cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP v1HTTP v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession curl --request GET \ --url https://pg-api.billgang.com/v1/dash/shops/__SHOPID__/orders/__ORDERID__/webhook-logs \ --header 'Authorization: YOUR_TOKEN' Test Request 200404 Show Schema { "data": [ { "url": "…", "event": "…", "status": "SUCCESS", "createdAt": "…", "externalMessageId": "…", "externalEndpointId": "…" } ], "message": "…", "errors": [ "…" ] } Success PAYMENTS SETTINGS # COPY LINK TO "PAYMENTS SETTINGS" Endpoints GET/v1/dash/shops/{shopId}/settings/payments/available-paymentsGET/v1/dash/shops/{shopId}/settings/paymentsPUT/v1/dash/shops/{shopId}/settings/payments/{gatewayName}PUT/v1/dash/shops/{shopId}/settings/payments/balancePUT/v1/dash/shops/{shopId}/settings/payments/balance/rewardsGET/v1/dash/shops/{shopId}/settings/payments/balance/rewards Show More REVIEWS # COPY LINK TO "REVIEWS" Endpoints GET/v1/dash/shops/{shopId}/reviews/statsGET/v1/dash/shops/{shopId}/reviewsGET/v1/dash/shops/{shopId}/reviews/{id}POST/v1/dash/shops/{shopId}/reviews/{id}/answerPOST/v1/dash/shops/{shopId}/reviews/{id}/appeal Show More CUSTOMER REWARDS # COPY LINK TO "CUSTOMER REWARDS" Endpoints GET/v1/dash/shops/{shopId}/rewardsPOST/v1/dash/shops/{shopId}/rewardsPUT/v1/dash/shops/{shopId}/rewards/{rewardRuleId}PUT/v1/dash/shops/{shopId}/rewards/referral-system Show More SETTINGS # COPY LINK TO "SETTINGS" Endpoints GET/v1/dash/shops/{shopId}/settings/companyPUT/v1/dash/shops/{shopId}/settings/subdomainPUT/v1/dash/shops/{shopId}/settings/namePUT/v1/dash/shops/{shopId}/settings/company-infoPUT/v1/dash/shops/{shopId}/settings/website-settingsPUT/v1/dash/shops/{shopId}/settings/timezone-and-currencyPUT/v1/dash/shops/{shopId}/settings/automated-reviewsPUT/v1/dash/shops/{shopId}/settings/post-purchase-requestPUT/v1/dash/shops/{shopId}/settings/customer-accountsPUT/v1/dash/shops/{shopId}/settings/legal/terms-of-servicePUT/v1/dash/shops/{shopId}/settings/legal/refund-policyPUT/v1/dash/shops/{shopId}/settings/legal/privacy-policyGET/v1/dash/shops/{shopId}/settings/legalPOST/v1/dash/shops/{shopId}/settings/logo Show More WAREHOUSES # COPY LINK TO "WAREHOUSES" Endpoints GET/v1/dash/shops/{shopId}/warehousesPOST/v1/dash/shops/{shopId}/warehousesGET/v1/dash/shops/{shopId}/warehouses/{warehouseId}PUT/v1/dash/shops/{shopId}/warehouses/{warehouseId}DELETE/v1/dash/shops/{shopId}/warehouses/{warehouseId}GET/v1/dash/shops/{shopId}/warehouses/{warehouseId}/stockGET/v1/dash/shops/{shopId}/warehouses/{warehouseId}/stock/rawPOST/v1/dash/shops/{shopId}/warehouses/{warehouseId}/add-stockPOST/v1/dash/shops/{shopId}/warehouses/{warehouseId}/edit-stockPOST/v1/dash/shops/{shopId}/warehouses/{warehouseId}/delete-stock Show More TICKETS # COPY LINK TO "TICKETS" Endpoints GET/v1/dash/shops/{shopId}/ticketsGET/v1/dash/shops/{shopId}/tickets/{id}POST/v1/dash/shops/{shopId}/tickets/{ticketId}/answerPOST/v1/dash/shops/{shopId}/tickets/{ticketId}/close Show More USER # COPY LINK TO "USER" Endpoints GET/v1/dash/user RETRIEVES USER INFORMATION. # COPY LINK TO "RETRIEVES USER INFORMATION." Responses * 200 Success GET/v1/dash/user Shell cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP v1HTTP v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession curl --request GET \ --url https://pg-api.billgang.com/v1/dash/user \ --header 'Authorization: YOUR_TOKEN' Test Request 200 Show Schema { "data": { "id": 1, "email": "…", "isEmailVerified": true, "shops": [ { "id": "…", "name": "…", "logoImage": "…", "currency": "…", "domain": "…", "permissions": [ null ] } ], "subscription": { "id": 1, "name": "…", "expiresAt": "…", "isTrial": true, "perks": {} }, "isTfaEnabled": true }, "message": "…", "errors": [ "…" ] } Success WEBHOOKS # COPY LINK TO "WEBHOOKS" Endpoints GET/v1/dash/shops/{shopId}/external/webhooks/{externalMessageId}/{externalEndpointId} RETRIEVES WEBHOOK LOGS FOR A GIVEN SHOP, MESSAGE, AND ENDPOINT. # COPY LINK TO "RETRIEVES WEBHOOK LOGS FOR A GIVEN SHOP, MESSAGE, AND ENDPOINT." Path Parameters * shopId required string uuid The ID of the shop. * externalMessageId required string The ID of the external message. * externalEndpointId required string The ID of the external endpoint. Responses * 200 Success GET/v1/dash/shops/{shopId}/external/webhooks/{externalMessageId}/{externalEndpointId} Shell cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP v1HTTP v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession curl --request GET \ --url https://pg-api.billgang.com/v1/dash/shops/__SHOPID__/external/webhooks/__EXTERNALMESSAGEID__/__EXTERNALENDPOINTID__ \ --header 'Authorization: YOUR_TOKEN' Test Request 200 Show Schema { "data": { "url": "…", "event": "…", "payloadJson": "…", "status": "SUCCESS", "createdAt": "…", "nextAttempt": "…", "externalMessageId": "…", "externalEndpointId": "…", "attempts": [ { "id": "…", "responseStatusCode": 1, "responseBody": "…", "createdAt": "…", "triggerType": {}, "status": {} } ] }, "message": "…", "errors": [ "…" ] } Success WEBHOOK LOGS # COPY LINK TO "WEBHOOK LOGS" Endpoints GET/v1/dash/shops/{shopId}/webhooks/logs RETRIEVES WEBHOOK LOGS FOR A GIVEN SHOP. # COPY LINK TO "RETRIEVES WEBHOOK LOGS FOR A GIVEN SHOP." Path Parameters * shopId required string uuid The ID of the shop. Query Parameters * iterator string Optional iterator for pagination. * limit integer int32 The maximum number of logs to retrieve. Responses * 200 Success GET/v1/dash/shops/{shopId}/webhooks/logs Shell cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP v1HTTP v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession curl --request GET \ --url https://pg-api.billgang.com/v1/dash/shops/__SHOPID__/webhooks/logs \ --header 'Authorization: YOUR_TOKEN' Test Request 200 Show Schema { "data": [ { "event": "…", "createdAt": "…", "channels": [ "…" ], "endpoints": [ { "url": "…", "status": {}, "externalEndpointId": "…", "nextAttempt": "…" } ], "externalMessageId": "…" } ], "message": "…", "errors": [ "…" ] } Success ADDBALANCEREQUEST # COPY LINK TO "ADDBALANCEREQUEST" {} AddBalanceRequest amount required number double min: -10000 max: 10000 ADDSTOCKTOWAREHOUSEREQUEST # COPY LINK TO "ADDSTOCKTOWAREHOUSEREQUEST" {} AddStockToWarehouseRequest serials required array string[] removePreviouslySoldSerials required boolean defaultDelimiter string | nullable ADDSTOCKTOWAREHOUSERESPONSE # COPY LINK TO "ADDSTOCKTOWAREHOUSERESPONSE" {} AddStockToWarehouseResponse previouslySoldSerials required array object[] {} object addedSerials required array object[] {} object isPreviouslySoldSerialsAdded required boolean Show More