### GET /v1/dash/shops/{shopId}/faqs Source: https://developers.billgang.com/api-reference Retrieves a list of FAQs for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/faqs ### Description Retrieves a list of FAQs for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/faqs ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (array) - A list of FAQ objects. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/settings/integrations Source: https://developers.billgang.com/api-reference Retrieves the integration settings for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/settings/integrations ### Description Retrieves the integration settings for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/settings/integrations ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (object) - Contains integration settings. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/listings Source: https://developers.billgang.com/api-reference Retrieves a list of listings for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/listings ### Description Retrieves a list of listings for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/listings ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. #### Query Parameters - **typeFilter** (string) - Optional - Filter to select listings by type. ### Response #### Success Response (200) - **data** (array) - A list of listing objects. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ### Request Example ```json { "example": "request body" } ``` ### Response Example ```json { "data": [ { "id": 1, "name": "…", "position": 1, "imageCfId": "…" } ], "message": "…", "errors": [ "…" ] } ``` ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/reviews Source: https://developers.billgang.com/api-reference Retrieves a list of reviews for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/reviews ### Description Retrieves a list of reviews for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/reviews ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (array) - A list of review objects. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/images Source: https://developers.billgang.com/api-reference Retrieves a list of images for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/images ### Description Retrieves a list of images for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/images ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (array) - A list of image objects. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/settings/developers/webhooks Source: https://developers.billgang.com/api-reference Retrieves the developer webhook settings for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/settings/developers/webhooks ### Description Retrieves the developer webhook settings for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/settings/developers/webhooks ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (object) - Contains webhook settings. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/reviews/stats Source: https://developers.billgang.com/api-reference Retrieves statistics for reviews for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/reviews/stats ### Description Retrieves statistics for reviews for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/reviews/stats ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (object) - Contains review statistics. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/faqs/{id} Source: https://developers.billgang.com/api-reference Retrieves a specific FAQ by its ID for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/faqs/{id} ### Description Retrieves a specific FAQ by its ID for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/faqs/{id} ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **id** (string) - Required - The ID of the FAQ. ### Response #### Success Response (200) - **data** (object) - The FAQ object. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/settings/legal Source: https://developers.billgang.com/api-reference Retrieves legal settings for a specific shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/settings/legal ### Description Retrieves legal settings for a specific shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/settings/legal ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ``` -------------------------------- ### Get Shop Listings Source: https://developers.billgang.com/api-reference Retrieves a list of listings for a given shop. Requires shop ID and an authorization token. ```curl curl --request GET \ --url https://pg-api.billgang.com/v1/dash/shops/__SHOPID__/listings \ --header 'Authorization: YOUR_TOKEN' ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/reviews/{id} Source: https://developers.billgang.com/api-reference Retrieves a specific review by its ID for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/reviews/{id} ### Description Retrieves a specific review by its ID for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/reviews/{id} ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **id** (string) - Required - The ID of the review. ### Response #### Success Response (200) - **data** (object) - The review object. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/groups Source: https://developers.billgang.com/api-reference Retrieves a list of groups for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/groups ### Description Retrieves a list of groups for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/groups ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (array) - A list of group objects. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/orders Source: https://developers.billgang.com/api-reference Retrieves a list of orders for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/orders ### Description Retrieves a list of orders for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/orders ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (array) - A list of order objects. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/warehouses Source: https://developers.billgang.com/api-reference Retrieves a list of warehouses for a specific shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/warehouses ### Description Retrieves a list of warehouses for a specific shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/warehouses ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/webhooks/logs Source: https://developers.billgang.com/api-reference Retrieves webhook logs for a specific shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/webhooks/logs ### Description Retrieves webhook logs for a specific shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/webhooks/logs ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ``` -------------------------------- ### GET /v1/dash/user Source: https://developers.billgang.com/api-reference Retrieves user information, including details about their shops, subscription, and security settings. ```APIDOC ## GET /v1/dash/user ### Description Retrieves user information. ### Method GET ### Endpoint /v1/dash/user ### Parameters #### Path Parameters None #### Query Parameters None ### Request Example ```curl curl --request GET \ --url https://pg-api.billgang.com/v1/dash/user \ --header 'Authorization: YOUR_TOKEN' ``` ### Response #### Success Response (200) - **data** (object) - Contains user-specific data including ID, email, shop details, subscription information, and TFA status. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred during the request. #### Response Example ```json { "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": [ "…" ] } ``` ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/fraud/rules Source: https://developers.billgang.com/api-reference Retrieves a list of fraud rules for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/fraud/rules ### Description Retrieves a list of fraud rules for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/fraud/rules ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (array) - A list of fraud rule objects. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/settings/payments/available-payments Source: https://developers.billgang.com/api-reference Retrieves a list of available payment methods for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/settings/payments/available-payments ### Description Retrieves a list of available payment methods for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/settings/payments/available-payments ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (array) - A list of available payment method objects. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/tickets Source: https://developers.billgang.com/api-reference Retrieves a list of tickets for a specific shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/tickets ### Description Retrieves a list of tickets for a specific shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/tickets ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/settings/company Source: https://developers.billgang.com/api-reference Retrieves company settings for a specific shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/settings/company ### Description Retrieves company settings for a specific shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/settings/company ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/affiliates Source: https://developers.billgang.com/api-reference Retrieves a list of affiliates for a given shop. Supports filtering by search string, ordering by specific fields, and pagination. ```APIDOC ## GET /v1/dash/shops/{shopId}/affiliates ### Description Retrieves a list of affiliates for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/affiliates ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. #### Query Parameters - **searchString** (string) - Optional - Optional search string to filter affiliates by email or ID. - **orderBy** (string) - Optional - Optional parameter to order affiliates by specific fields (revenueGenerated, totalReferrals, balanceAwarded). - **PageNumber** (integer) - Optional - Signed 32-bit integers (commonly used integer type). - **PageSize** (integer) - Optional - Signed 32-bit integers (commonly used integer type). ### Request Example ```json { "data": [ { "customerId": 1, "customerEmail": "…", "referralSystem": { "revenueGeneratedUsd": 1, "totalReferrals": 1, "totalPaidReferrals": 1, "balanceAwarded": 1, "referralCode": "…", "isDisabled": true } } ], "message": "…", "errors": [ "…" ] } ``` ### Response #### Success Response (200) - **data** (array) - List of affiliates. - **message** (string) - API response message. - **errors** (array) - List of errors. #### Response Example ```json { "data": [ { "customerId": 1, "customerEmail": "…", "referralSystem": { "revenueGeneratedUsd": 1, "totalReferrals": 1, "totalPaidReferrals": 1, "balanceAwarded": 1, "referralCode": "…", "isDisabled": true } } ], "message": "…", "errors": [ "…" ] } ``` ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/settings/payments Source: https://developers.billgang.com/api-reference Retrieves the current payment settings for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/settings/payments ### Description Retrieves the current payment settings for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/settings/payments ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (object) - Contains the current payment settings. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/webhooks/logs Source: https://developers.billgang.com/api-reference Retrieves webhook logs for a given shop. Supports pagination with an optional iterator and limit. ```APIDOC ## GET /v1/dash/shops/{shopId}/webhooks/logs ### Description Retrieves webhook logs for a given shop. Supports pagination with an optional iterator and limit. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/webhooks/logs ### Parameters #### Path Parameters - **shopId** (string uuid) - Required - The ID of the shop. #### Query Parameters - **iterator** (string) - Optional - Iterator for pagination. - **limit** (integer int32) - Optional - The maximum number of logs to retrieve. ### Request Example ``` https://pg-api.billgang.com/v1/dash/shops/__SHOPID__/webhooks/logs ``` ### Response #### Success Response (200) - **data** (array) - Contains webhook log entries. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. #### Response Example ```json { "data": [ { "event": "…", "createdAt": "…", "channels": [ "…" ], "endpoints": [ { "url": "…", "status": {}, "externalEndpointId": "…", "nextAttempt": "…" } ], "externalMessageId": "…" } ], "message": "…", "errors": [ "…" ] } ``` ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/rewards Source: https://developers.billgang.com/api-reference Retrieves a list of customer rewards for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/rewards ### Description Retrieves a list of customer rewards for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/rewards ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (array) - A list of customer reward objects. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/warehouses/{warehouseId} Source: https://developers.billgang.com/api-reference Retrieves details of a specific warehouse for a shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/warehouses/{warehouseId} ### Description Retrieves details of a specific warehouse for a shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/warehouses/{warehouseId} ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **warehouseId** (string) - Required - The ID of the warehouse. ``` -------------------------------- ### Get Order Webhook Logs Source: https://developers.billgang.com/api-reference Retrieves webhook logs for a specific order within a given shop. Requires shop ID and order ID. Returns success or not found status. ```curl curl --request GET \ --url https://pg-api.billgang.com/v1/dash/shops/__SHOPID__/orders/__ORDERID__/webhook-logs \ --header 'Authorization: YOUR_TOKEN' ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/warehouses/{warehouseId}/stock Source: https://developers.billgang.com/api-reference Retrieves stock information for a specific warehouse. ```APIDOC ## GET /v1/dash/shops/{shopId}/warehouses/{warehouseId}/stock ### Description Retrieves stock information for a specific warehouse. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/warehouses/{warehouseId}/stock ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **warehouseId** (string) - Required - The ID of the warehouse. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/orders/{id} Source: https://developers.billgang.com/api-reference Retrieves a specific order by its ID for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/orders/{id} ### Description Retrieves a specific order by its ID for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/orders/{id} ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **id** (string) - Required - The ID of the order. ### Response #### Success Response (200) - **data** (object) - The order object. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/warehouses/{warehouseId}/stock/raw Source: https://developers.billgang.com/api-reference Retrieves raw stock data for a specific warehouse. ```APIDOC ## GET /v1/dash/shops/{shopId}/warehouses/{warehouseId}/stock/raw ### Description Retrieves raw stock data for a specific warehouse. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/warehouses/{warehouseId}/stock/raw ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **warehouseId** (string) - Required - The ID of the warehouse. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/orders/{orderId}/webhook-logs Source: https://developers.billgang.com/api-reference Retrieves webhook logs for a specific order in a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/orders/{orderId}/webhook-logs ### Description Retrieves webhook logs for a specific order in a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/orders/{orderId}/webhook-logs ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **orderId** (string) - Required - The ID of the order. ### Response #### Success Response (200) - **data** (array) - A list of webhook log objects. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. #### Error Response (404) - **message** (string) - A message indicating that the order was not found. - **errors** (array) - A list of errors, if any occurred. ### Response Example ```json { "data": [ { "url": "…", "event": "…", "status": "SUCCESS", "createdAt": "…", "externalMessageId": "…", "externalEndpointId": "…" } ], "message": "…", "errors": [ "…" ] } ``` ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/tickets/{id} Source: https://developers.billgang.com/api-reference Retrieves details of a specific ticket for a shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/tickets/{id} ### Description Retrieves details of a specific ticket for a shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/tickets/{id} ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **id** (string) - Required - The ID of the ticket. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/settings/payments/balance/rewards Source: https://developers.billgang.com/api-reference Retrieves the balance rewards settings for payments for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/settings/payments/balance/rewards ### Description Retrieves the balance rewards settings for payments for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/settings/payments/balance/rewards ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Response #### Success Response (200) - **data** (object) - Contains the balance rewards settings. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/groups/{groupId} Source: https://developers.billgang.com/api-reference Retrieves a specific group by its ID for a given shop. ```APIDOC ## GET /v1/dash/shops/{shopId}/groups/{groupId} ### Description Retrieves a specific group by its ID for a given shop. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/groups/{groupId} ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **groupId** (string) - Required - The ID of the group. ### Response #### Success Response (200) - **data** (object) - The group object. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### GET /v1/dash/shops/{shopId}/external/webhooks/{externalMessageId}/{externalEndpointId} Source: https://developers.billgang.com/api-reference Retrieves webhook logs for a given shop, message, and endpoint. ```APIDOC ## GET /v1/dash/shops/{shopId}/external/webhooks/{externalMessageId}/{externalEndpointId} ### Description Retrieves webhook logs for a given shop, message, and endpoint. ### Method GET ### Endpoint /v1/dash/shops/{shopId}/external/webhooks/{externalMessageId}/{externalEndpointId} ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **externalMessageId** (string) - Required - The ID of the external message. - **externalEndpointId** (string) - Required - The ID of the external endpoint. ### Request Example ```curl curl --request GET \ --url https://pg-api.billgang.com/v1/dash/shops/__SHOPID__/external/webhooks/__EXTERNALMESSAGEID__/__EXTERNALENDPOINTID__ \ --header 'Authorization: YOUR_TOKEN' ``` ### Response #### Success Response (200) - **data** (object) - Contains webhook log details including URL, event, payload, status, timestamps, and attempt history. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred during the request. #### Response Example ```json { "data": { "url": "…", "event": "…", "payloadJson": "…", "status": "SUCCESS", "createdAt": "…", "nextAttempt": "…", "externalMessageId": "…", "externalEndpointId": "…", "attempts": [ { "id": "…", "responseStatusCode": 1, "responseBody": "…", "createdAt": "…", "triggerType": {}, "status": {} } ] }, "message": "…", "errors": [ "…" ] } ``` ``` -------------------------------- ### POST /v1/dash/shops/{shopId}/faqs Source: https://developers.billgang.com/api-reference Creates a new FAQ for a given shop. ```APIDOC ## POST /v1/dash/shops/{shopId}/faqs ### Description Creates a new FAQ for a given shop. ### Method POST ### Endpoint /v1/dash/shops/{shopId}/faqs ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Request Body - **question** (string) - Required - The question for the FAQ. - **answer** (string) - Required - The answer to the FAQ. ### Response #### Success Response (200) - **data** (object) - The created FAQ object. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### POST /v1/dash/shops/{shopId}/settings/developers/webhooks Source: https://developers.billgang.com/api-reference Creates or updates developer webhook settings for a given shop. ```APIDOC ## POST /v1/dash/shops/{shopId}/settings/developers/webhooks ### Description Creates or updates developer webhook settings for a given shop. ### Method POST ### Endpoint /v1/dash/shops/{shopId}/settings/developers/webhooks ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Request Body - **url** (string) - Required - The URL for the webhook. - **secret** (string) - Optional - The secret for the webhook. ### Response #### Success Response (200) - **data** (object) - Contains the updated webhook settings. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### PUT /v1/dash/shops/{shopId}/faqs/{faqId} Source: https://developers.billgang.com/api-reference Updates an existing FAQ by its ID for a given shop. ```APIDOC ## PUT /v1/dash/shops/{shopId}/faqs/{faqId} ### Description Updates an existing FAQ by its ID for a given shop. ### Method PUT ### Endpoint /v1/dash/shops/{shopId}/faqs/{faqId} ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **faqId** (string) - Required - The ID of the FAQ to update. ### Request Body - **question** (string) - Optional - The updated question for the FAQ. - **answer** (string) - Optional - The updated answer to the FAQ. ### Response #### Success Response (200) - **data** (object) - The updated FAQ object. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### Retrieve Shop Affiliates Source: https://developers.billgang.com/api-reference Use this cURL command to retrieve a list of affiliates for a specific shop. Ensure you replace `__SHOPID__` with the actual shop ID and `YOUR_TOKEN` with your API token. ```curl curl --request GET \ --url https://pg-api.billgang.com/v1/dash/shops/__SHOPID__/affiliates \ --header 'Authorization: YOUR_TOKEN' ``` -------------------------------- ### POST /v1/dash/shops/{shopId}/images Source: https://developers.billgang.com/api-reference Uploads a new image for a given shop. ```APIDOC ## POST /v1/dash/shops/{shopId}/images ### Description Uploads a new image for a given shop. ### Method POST ### Endpoint /v1/dash/shops/{shopId}/images ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Request Body - **file** (file) - Required - The image file to upload. ### Response #### Success Response (200) - **data** (object) - The uploaded image object, including its ID and URL. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### POST /v1/dash/shops/{shopId}/warehouses Source: https://developers.billgang.com/api-reference Creates a new warehouse for a specific shop. ```APIDOC ## POST /v1/dash/shops/{shopId}/warehouses ### Description Creates a new warehouse for a specific shop. ### Method POST ### Endpoint /v1/dash/shops/{shopId}/warehouses ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ``` -------------------------------- ### POST /v1/dash/shops/{shopId}/reviews/{id}/answer Source: https://developers.billgang.com/api-reference Answers a specific review for a given shop. ```APIDOC ## POST /v1/dash/shops/{shopId}/reviews/{id}/answer ### Description Answers a specific review for a given shop. ### Method POST ### Endpoint /v1/dash/shops/{shopId}/reviews/{id}/answer ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **id** (string) - Required - The ID of the review to answer. ### Request Body - **answer** (string) - Required - The answer to the review. ### Response #### Success Response (200) - **data** (object) - The updated review object with the answer. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### POST /v1/dash/shops/{shopId}/groups Source: https://developers.billgang.com/api-reference Creates a new group for a given shop. ```APIDOC ## POST /v1/dash/shops/{shopId}/groups ### Description Creates a new group for a given shop. ### Method POST ### Endpoint /v1/dash/shops/{shopId}/groups ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Request Body - **name** (string) - Required - The name of the group. ### Response #### Success Response (200) - **data** (object) - The created group object. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### PUT /v1/dash/shops/{shopId}/settings/integrations/trustpilot Source: https://developers.billgang.com/api-reference Updates the Trustpilot integration settings for a given shop. ```APIDOC ## PUT /v1/dash/shops/{shopId}/settings/integrations/trustpilot ### Description Updates the Trustpilot integration settings for a given shop. ### Method PUT ### Endpoint /v1/dash/shops/{shopId}/settings/integrations/trustpilot ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Request Body - **apiKey** (string) - Required - The API key for Trustpilot. - **apiSecret** (string) - Required - The API secret for Trustpilot. ### Response #### Success Response (200) - **data** (object) - Contains the updated Trustpilot integration settings. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### PUT /v1/dash/shops/{shopId}/settings/website-settings Source: https://developers.billgang.com/api-reference Updates the website settings for a specific shop. ```APIDOC ## PUT /v1/dash/shops/{shopId}/settings/website-settings ### Description Updates the website settings for a specific shop. ### Method PUT ### Endpoint /v1/dash/shops/{shopId}/settings/website-settings ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ``` -------------------------------- ### POST /v1/dash/shops/{shopId}/rewards Source: https://developers.billgang.com/api-reference Creates a new customer reward for a given shop. ```APIDOC ## POST /v1/dash/shops/{shopId}/rewards ### Description Creates a new customer reward for a given shop. ### Method POST ### Endpoint /v1/dash/shops/{shopId}/rewards ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Request Body - **name** (string) - Required - The name of the reward. - **points** (integer) - Required - The number of points required for the reward. - **description** (string) - Optional - A description of the reward. ### Response #### Success Response (200) - **data** (object) - The created customer reward object. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### Retrieve User Information Source: https://developers.billgang.com/api-reference Use this endpoint to fetch details about the authenticated user. Ensure you include your API token in the Authorization header. ```curl curl --request GET \ --url https://pg-api.billgang.com/v1/dash/user \ --header 'Authorization: YOUR_TOKEN' ``` -------------------------------- ### PUT /v1/dash/shops/{shopId}/settings/payments/{gatewayName} Source: https://developers.billgang.com/api-reference Updates the payment settings for a specific gateway for a given shop. ```APIDOC ## PUT /v1/dash/shops/{shopId}/settings/payments/{gatewayName} ### Description Updates the payment settings for a specific gateway for a given shop. ### Method PUT ### Endpoint /v1/dash/shops/{shopId}/settings/payments/{gatewayName} ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **gatewayName** (string) - Required - The name of the payment gateway to update. ### Request Body - **settings** (object) - Required - The new settings for the payment gateway. ### Response #### Success Response (200) - **data** (object) - Contains the updated payment settings. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### POST /v1/dash/shops/{shopId}/settings/logo Source: https://developers.billgang.com/api-reference Uploads a logo for a specific shop. ```APIDOC ## POST /v1/dash/shops/{shopId}/settings/logo ### Description Uploads a logo for a specific shop. ### Method POST ### Endpoint /v1/dash/shops/{shopId}/settings/logo ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ``` -------------------------------- ### POST /v1/dash/shops/{shopId}/warehouses/{warehouseId}/add-stock Source: https://developers.billgang.com/api-reference Adds stock to a specific warehouse. ```APIDOC ## POST /v1/dash/shops/{shopId}/warehouses/{warehouseId}/add-stock ### Description Adds stock to a specific warehouse. ### Method POST ### Endpoint /v1/dash/shops/{shopId}/warehouses/{warehouseId}/add-stock ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **warehouseId** (string) - Required - The ID of the warehouse. ``` -------------------------------- ### POST /v1/dash/shops/{shopId}/reviews/{id}/appeal Source: https://developers.billgang.com/api-reference Appeals a specific review for a given shop. ```APIDOC ## POST /v1/dash/shops/{shopId}/reviews/{id}/appeal ### Description Appeals a specific review for a given shop. ### Method POST ### Endpoint /v1/dash/shops/{shopId}/reviews/{id}/appeal ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. - **id** (string) - Required - The ID of the review to appeal. ### Request Body - **reason** (string) - Required - The reason for the appeal. ### Response #### Success Response (200) - **data** (object) - The updated review object with the appeal status. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### PUT /v1/dash/shops/{shopId}/rewards/referral-system Source: https://developers.billgang.com/api-reference Updates the referral system settings for customer rewards for a given shop. ```APIDOC ## PUT /v1/dash/shops/{shopId}/rewards/referral-system ### Description Updates the referral system settings for customer rewards for a given shop. ### Method PUT ### Endpoint /v1/dash/shops/{shopId}/rewards/referral-system ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ### Request Body - **referralSettings** (object) - Required - The new referral system settings. ### Response #### Success Response (200) - **data** (object) - Contains the updated referral system settings. - **message** (string) - A message indicating the status of the request. - **errors** (array) - A list of errors, if any occurred. ``` -------------------------------- ### PUT /v1/dash/shops/{shopId}/settings/subdomain Source: https://developers.billgang.com/api-reference Updates the subdomain setting for a specific shop. ```APIDOC ## PUT /v1/dash/shops/{shopId}/settings/subdomain ### Description Updates the subdomain setting for a specific shop. ### Method PUT ### Endpoint /v1/dash/shops/{shopId}/settings/subdomain ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ``` -------------------------------- ### Retrieve Webhook Logs Source: https://developers.billgang.com/api-reference Fetches webhook logs for a specific shop, message, and endpoint. Replace placeholders with actual IDs and your API token. ```curl curl --request GET \ --url https://pg-api.billgang.com/v1/dash/shops/__SHOPID__/external/webhooks/__EXTERNALMESSAGEID__/__EXTERNALENDPOINTID__ \ --header 'Authorization: YOUR_TOKEN' ``` -------------------------------- ### PUT /v1/dash/shops/{shopId}/settings/post-purchase-request Source: https://developers.billgang.com/api-reference Updates the post-purchase request settings for a specific shop. ```APIDOC ## PUT /v1/dash/shops/{shopId}/settings/post-purchase-request ### Description Updates the post-purchase request settings for a specific shop. ### Method PUT ### Endpoint /v1/dash/shops/{shopId}/settings/post-purchase-request ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ``` -------------------------------- ### PUT /v1/dash/shops/{shopId}/settings/timezone-and-currency Source: https://developers.billgang.com/api-reference Updates the timezone and currency settings for a specific shop. ```APIDOC ## PUT /v1/dash/shops/{shopId}/settings/timezone-and-currency ### Description Updates the timezone and currency settings for a specific shop. ### Method PUT ### Endpoint /v1/dash/shops/{shopId}/settings/timezone-and-currency ### Parameters #### Path Parameters - **shopId** (string) - Required - The ID of the shop. ```