ResourcesCreatorApi

All URIs are relative to https://api.builtbybit.com

Method	HTTP request	Description
getV2ResourcesCreatorAddons	GET /v2/resources/creator/addons	Fetch a list of your resources' addons
getV2ResourcesCreatorBatch	GET /v2/resources/creator/batch	Fetch a list of your batches edits
getV2ResourcesCreatorBundles	GET /v2/resources/creator/bundles	Fetch a list of your bundles
getV2ResourcesCreatorBundlesEntries	GET /v2/resources/creator/bundles/entries	Fetch a list of your bundle entries
getV2ResourcesCreatorCoupons	GET /v2/resources/creator/coupons	Fetch a list of your coupons
getV2ResourcesCreatorCouponsEntries	GET /v2/resources/creator/coupons/entries	Fetch a list of your coupon entries
getV2ResourcesCreatorLicenses	GET /v2/resources/creator/licenses	Fetch a list of your resources' licenses
getV2ResourcesCreatorPurchases	GET /v2/resources/creator/purchases	Fetch a list of your resources' purchases
getV2ResourcesCreatorResources	GET /v2/resources/creator/resources	Fetch a list of your resources
getV2ResourcesCreatorReviews	GET /v2/resources/creator/reviews	Fetch a list of your resources' reviews
getV2ResourcesCreatorSaleEvents	GET /v2/resources/creator/sale-events	Fetch a list of your sale events
getV2ResourcesCreatorSaleEventsEntries	GET /v2/resources/creator/sale-events/entries	Fetch a list of your sale event entries
getV2ResourcesCreatorStores	GET /v2/resources/creator/stores	Fetch a list of your stores
getV2ResourcesCreatorUpdates	GET /v2/resources/creator/updates	Fetch a list of your resource's updates
getV2ResourcesCreatorVersions	GET /v2/resources/creator/versions	Fetch a list of your resources' versions
postV2ResourcesCreatorBatch	POST /v2/resources/creator/batch	Submit a new batch edit
postV2ResourcesCreatorCoupons	POST /v2/resources/creator/coupons	Create a new coupon
postV2ResourcesCreatorUpdate	POST /v2/resources/creator/update	Post a resource update

getV2ResourcesCreatorAddons

GetV2ResourcesCreatorAddons200Response getV2ResourcesCreatorAddons(resourceIds)

Fetch a list of your resources' addons

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List resourceIds = new List(); // List | A comma-separated list of resource IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorAddons200Response result = apiInstance.getV2ResourcesCreatorAddons(resourceIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorAddons");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
resourceIds	List	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorAddons200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorBatch

GetV2ResourcesCreatorBatch200Response getV2ResourcesCreatorBatch(batchIds)

Fetch a list of your batches edits

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List batchIds = new List(); // List | A comma-separated list of batch IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorBatch200Response result = apiInstance.getV2ResourcesCreatorBatch(batchIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorBatch");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
batchIds	List	A comma-separated list of batch IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorBatch200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorBundles

GetV2ResourcesCreatorBundles200Response getV2ResourcesCreatorBundles(bundleIds)

Fetch a list of your bundles

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List bundleIds = new List(); // List | A comma-separated list of bundle IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorBundles200Response result = apiInstance.getV2ResourcesCreatorBundles(bundleIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorBundles");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
bundleIds	List	A comma-separated list of bundle IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorBundles200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorBundlesEntries

GetV2ResourcesCreatorBundlesEntries200Response getV2ResourcesCreatorBundlesEntries(bundleIds)

Fetch a list of your bundle entries

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List bundleIds = new List(); // List | A comma-separated list of bundle IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorBundlesEntries200Response result = apiInstance.getV2ResourcesCreatorBundlesEntries(bundleIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorBundlesEntries");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
bundleIds	List	A comma-separated list of bundle IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorBundlesEntries200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorCoupons

GetV2ResourcesCreatorCoupons200Response getV2ResourcesCreatorCoupons(couponIds)

Fetch a list of your coupons

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List couponIds = new List(); // List | A comma-separated list of coupon IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorCoupons200Response result = apiInstance.getV2ResourcesCreatorCoupons(couponIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorCoupons");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
couponIds	List	A comma-separated list of coupon IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorCoupons200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorCouponsEntries

GetV2ResourcesCreatorCouponsEntries200Response getV2ResourcesCreatorCouponsEntries(couponIds)

Fetch a list of your coupon entries

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List couponIds = new List(); // List | A comma-separated list of coupon IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorCouponsEntries200Response result = apiInstance.getV2ResourcesCreatorCouponsEntries(couponIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorCouponsEntries");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
couponIds	List	A comma-separated list of coupon IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorCouponsEntries200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorLicenses

GetV2ResourcesCreatorLicenses200Response getV2ResourcesCreatorLicenses(resourceIds)

Fetch a list of your resources' licenses

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List resourceIds = new List(); // List | A comma-separated list of resource IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorLicenses200Response result = apiInstance.getV2ResourcesCreatorLicenses(resourceIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorLicenses");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
resourceIds	List	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorLicenses200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorPurchases

GetV2ResourcesCreatorPurchases200Response getV2ResourcesCreatorPurchases(resourceIds, buyerIds, externalTids)

Fetch a list of your resources' purchases

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List resourceIds = new List(); // List | A comma-separated list of resource IDs to filter on. No filter is applied if empty.
    List buyerIds = new List(); // List | A comma-separated list of buyer IDs to filter on. No filter is applied if empty
    List externalTids = new List(); // List | A comma-separated list of external transaction IDs (TIDs) to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorPurchases200Response result = apiInstance.getV2ResourcesCreatorPurchases(resourceIds, buyerIds, externalTids);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorPurchases");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
resourceIds	List	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]
buyerIds	List	A comma-separated list of buyer IDs to filter on. No filter is applied if empty	[optional]
externalTids	List	A comma-separated list of external transaction IDs (TIDs) to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorPurchases200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorResources

GetV2ResourcesCreatorResources200Response getV2ResourcesCreatorResources(resourceIds)

Fetch a list of your resources

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List resourceIds = new List(); // List | A comma-separated list of resource IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorResources200Response result = apiInstance.getV2ResourcesCreatorResources(resourceIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorResources");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
resourceIds	List	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorResources200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorReviews

GetV2ResourcesCreatorReviews200Response getV2ResourcesCreatorReviews(resourceIds)

Fetch a list of your resources' reviews

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List resourceIds = new List(); // List | A comma-separated list of resource IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorReviews200Response result = apiInstance.getV2ResourcesCreatorReviews(resourceIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorReviews");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
resourceIds	List	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorReviews200Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorSaleEvents

GetV2ResourcesCreatorSaleEvents200Response getV2ResourcesCreatorSaleEvents(saleEventIds)

Fetch a list of your sale events

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List saleEventIds = new List(); // List | A comma-separated list of sale event IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorSaleEvents200Response result = apiInstance.getV2ResourcesCreatorSaleEvents(saleEventIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorSaleEvents");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
saleEventIds	List	A comma-separated list of sale event IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorSaleEvents200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorSaleEventsEntries

GetV2ResourcesCreatorSaleEventsEntries200Response getV2ResourcesCreatorSaleEventsEntries(saleEventIds)

Fetch a list of your sale event entries

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List saleEventIds = new List(); // List | A comma-separated list of sale event IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorSaleEventsEntries200Response result = apiInstance.getV2ResourcesCreatorSaleEventsEntries(saleEventIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorSaleEventsEntries");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
saleEventIds	List	A comma-separated list of sale event IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorSaleEventsEntries200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorStores

GetV2ResourcesCreatorStores200Response getV2ResourcesCreatorStores()

Fetch a list of your stores

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    try {
      GetV2ResourcesCreatorStores200Response result = apiInstance.getV2ResourcesCreatorStores();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorStores");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

GetV2ResourcesCreatorStores200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorUpdates

GetV2ResourcesCreatorUpdates200Response getV2ResourcesCreatorUpdates(resourceIds)

Fetch a list of your resource's updates

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List resourceIds = new List(); // List | A comma-separated list of resource IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorUpdates200Response result = apiInstance.getV2ResourcesCreatorUpdates(resourceIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorUpdates");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
resourceIds	List	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorUpdates200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getV2ResourcesCreatorVersions

GetV2ResourcesCreatorVersions200Response getV2ResourcesCreatorVersions(resourceIds)

Fetch a list of your resources' versions

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    List resourceIds = new List(); // List | A comma-separated list of resource IDs to filter on. No filter is applied if empty.
    try {
      GetV2ResourcesCreatorVersions200Response result = apiInstance.getV2ResourcesCreatorVersions(resourceIds);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#getV2ResourcesCreatorVersions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
resourceIds	List	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

GetV2ResourcesCreatorVersions200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

postV2ResourcesCreatorBatch

PostV2ResourcesCreatorBatch200Response postV2ResourcesCreatorBatch(postV2ResourcesCreatorBatchRequest)

Submit a new batch edit

Batch edits will be processed in the background meaning a successful call to this endpoint does not guarantee that the edits have been completed. You will instead receive an identifier to a batch edit which you can then use to fetch the status of via the below endpoint. This is not an atomic operation meaning some resources may be edited successfully and others may not be due to an error. You may only batch edit resources you own currently.

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    PostV2ResourcesCreatorBatchRequest postV2ResourcesCreatorBatchRequest = new PostV2ResourcesCreatorBatchRequest(); // PostV2ResourcesCreatorBatchRequest | 
    try {
      PostV2ResourcesCreatorBatch200Response result = apiInstance.postV2ResourcesCreatorBatch(postV2ResourcesCreatorBatchRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#postV2ResourcesCreatorBatch");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
postV2ResourcesCreatorBatchRequest	PostV2ResourcesCreatorBatchRequest		[optional]

Return type

PostV2ResourcesCreatorBatch200Response

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

postV2ResourcesCreatorCoupons

PostV2ResourcesCreatorCoupons200Response postV2ResourcesCreatorCoupons(postV2ResourcesCreatorCouponsRequest)

Create a new coupon

This endpoint is currently limited to percent-based coupons with a maximum discount of 50%.

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    PostV2ResourcesCreatorCouponsRequest postV2ResourcesCreatorCouponsRequest = new PostV2ResourcesCreatorCouponsRequest(); // PostV2ResourcesCreatorCouponsRequest | 
    try {
      PostV2ResourcesCreatorCoupons200Response result = apiInstance.postV2ResourcesCreatorCoupons(postV2ResourcesCreatorCouponsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#postV2ResourcesCreatorCoupons");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
postV2ResourcesCreatorCouponsRequest	PostV2ResourcesCreatorCouponsRequest		[optional]

Return type

PostV2ResourcesCreatorCoupons200Response

Authorization

token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

postV2ResourcesCreatorUpdate

PostV2ResourcesCreatorUpdate200Response postV2ResourcesCreatorUpdate(postV2ResourcesCreatorUpdateRequest)

Post a resource update

Creates a new version for the resource and optionally posts a public update message. The uploaded file must be encoded using base64 as part of the JSON request body shown below. The request body (including the base64 encoded file data) cannot exceed 100MB. This roughly equates to a 67MB upload limit for the raw file when taking into account base64 encoding losses.

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ResourcesCreatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    ResourcesCreatorApi apiInstance = new ResourcesCreatorApi(defaultClient);
    PostV2ResourcesCreatorUpdateRequest postV2ResourcesCreatorUpdateRequest = new PostV2ResourcesCreatorUpdateRequest(); // PostV2ResourcesCreatorUpdateRequest | 
    try {
      PostV2ResourcesCreatorUpdate200Response result = apiInstance.postV2ResourcesCreatorUpdate(postV2ResourcesCreatorUpdateRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesCreatorApi#postV2ResourcesCreatorUpdate");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
postV2ResourcesCreatorUpdateRequest	PostV2ResourcesCreatorUpdateRequest		[optional]

Return type

PostV2ResourcesCreatorUpdate200Response

Authorization

token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

FilesExpand file tree

ResourcesCreatorApi.md

Latest commit

History

ResourcesCreatorApi.md

File metadata and controls

ResourcesCreatorApi

getV2ResourcesCreatorAddons

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getV2ResourcesCreatorBatch

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getV2ResourcesCreatorBundles

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getV2ResourcesCreatorBundlesEntries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getV2ResourcesCreatorCoupons

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getV2ResourcesCreatorCouponsEntries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getV2ResourcesCreatorLicenses

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getV2ResourcesCreatorPurchases

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getV2ResourcesCreatorResources

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getV2ResourcesCreatorReviews

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getV2ResourcesCreatorSaleEvents

Example

Parameters