ResourcesDiscoverCartApi

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

Method	HTTP request	Description
getV2ResourcesDiscoverCartView	GET /v2/resources/discover/cart/view	View the user's cart items
postV2ResourcesDiscoverCartAdd	POST /v2/resources/discover/cart/add	Add items to a user's cart
postV2ResourcesDiscoverCartCheckout	POST /v2/resources/discover/cart/checkout	Initiate a checkout of a user's cart
postV2ResourcesDiscoverCartCouponAdd	POST /v2/resources/discover/cart/coupon/add	Add a coupon to the user's cart
postV2ResourcesDiscoverCartCouponRemove	POST /v2/resources/discover/cart/coupon/remove	Remove a coupon from the user's cart
postV2ResourcesDiscoverCartRemove	POST /v2/resources/discover/cart/remove	Remove an item from the user's cart

getV2ResourcesDiscoverCartView

GetV2ResourcesDiscoverCartView200Response getV2ResourcesDiscoverCartView()

View the user's cart items

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.ResourcesDiscoverCartApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    ResourcesDiscoverCartApi apiInstance = new ResourcesDiscoverCartApi(defaultClient);
    try {
      GetV2ResourcesDiscoverCartView200Response result = apiInstance.getV2ResourcesDiscoverCartView();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesDiscoverCartApi#getV2ResourcesDiscoverCartView");
      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

GetV2ResourcesDiscoverCartView200Response

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

postV2ResourcesDiscoverCartAdd

PostV2ResourcesDiscoverCartAdd2XXResponse postV2ResourcesDiscoverCartAdd(postV2ResourcesDiscoverCartAddRequest)

Add items to a user's cart

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.ResourcesDiscoverCartApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    ResourcesDiscoverCartApi apiInstance = new ResourcesDiscoverCartApi(defaultClient);
    PostV2ResourcesDiscoverCartAddRequest postV2ResourcesDiscoverCartAddRequest = new PostV2ResourcesDiscoverCartAddRequest(); // PostV2ResourcesDiscoverCartAddRequest | A list of content to add to the user's cart. The outer list is keyed by the content type and the inner list are the content IDs.    For instance, if adding a resource with the ID 555, the body becomes:  ```json  {\"add\": {\"resource\": [555]}}  ```
    try {
      PostV2ResourcesDiscoverCartAdd2XXResponse result = apiInstance.postV2ResourcesDiscoverCartAdd(postV2ResourcesDiscoverCartAddRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesDiscoverCartApi#postV2ResourcesDiscoverCartAdd");
      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
postV2ResourcesDiscoverCartAddRequest	PostV2ResourcesDiscoverCartAddRequest	A list of content to add to the user's cart. The outer list is keyed by the content type and the inner list are the content IDs. For instance, if adding a resource with the ID 555, the body becomes: ```json {"add": {"resource": [555]}} ```	[optional]

Return type

PostV2ResourcesDiscoverCartAdd2XXResponse

Authorization

oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
2XX	Success	-

postV2ResourcesDiscoverCartCheckout

PostV2ResourcesDiscoverCartCheckout200Response postV2ResourcesDiscoverCartCheckout(body)

Initiate a checkout of a user's cart

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.ResourcesDiscoverCartApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    ResourcesDiscoverCartApi apiInstance = new ResourcesDiscoverCartApi(defaultClient);
    Object body = null; // Object | 
    try {
      PostV2ResourcesDiscoverCartCheckout200Response result = apiInstance.postV2ResourcesDiscoverCartCheckout(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesDiscoverCartApi#postV2ResourcesDiscoverCartCheckout");
      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
body	Object		[optional]

Return type

PostV2ResourcesDiscoverCartCheckout200Response

Authorization

oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

postV2ResourcesDiscoverCartCouponAdd

PostV2ResourcesDiscoverCartCouponAdd200Response postV2ResourcesDiscoverCartCouponAdd(postV2ResourcesDiscoverCartCouponAddRequest)

Add a coupon to the user's cart

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.ResourcesDiscoverCartApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    ResourcesDiscoverCartApi apiInstance = new ResourcesDiscoverCartApi(defaultClient);
    PostV2ResourcesDiscoverCartCouponAddRequest postV2ResourcesDiscoverCartCouponAddRequest = new PostV2ResourcesDiscoverCartCouponAddRequest(); // PostV2ResourcesDiscoverCartCouponAddRequest | 
    try {
      PostV2ResourcesDiscoverCartCouponAdd200Response result = apiInstance.postV2ResourcesDiscoverCartCouponAdd(postV2ResourcesDiscoverCartCouponAddRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesDiscoverCartApi#postV2ResourcesDiscoverCartCouponAdd");
      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
postV2ResourcesDiscoverCartCouponAddRequest	PostV2ResourcesDiscoverCartCouponAddRequest		[optional]

Return type

PostV2ResourcesDiscoverCartCouponAdd200Response

Authorization

oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

postV2ResourcesDiscoverCartCouponRemove

PostV2ResourcesDiscoverCartCouponRemove200Response postV2ResourcesDiscoverCartCouponRemove(postV2ResourcesDiscoverCartCouponRemoveRequest)

Remove a coupon from the user's cart

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.ResourcesDiscoverCartApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    ResourcesDiscoverCartApi apiInstance = new ResourcesDiscoverCartApi(defaultClient);
    PostV2ResourcesDiscoverCartCouponRemoveRequest postV2ResourcesDiscoverCartCouponRemoveRequest = new PostV2ResourcesDiscoverCartCouponRemoveRequest(); // PostV2ResourcesDiscoverCartCouponRemoveRequest | 
    try {
      PostV2ResourcesDiscoverCartCouponRemove200Response result = apiInstance.postV2ResourcesDiscoverCartCouponRemove(postV2ResourcesDiscoverCartCouponRemoveRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesDiscoverCartApi#postV2ResourcesDiscoverCartCouponRemove");
      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
postV2ResourcesDiscoverCartCouponRemoveRequest	PostV2ResourcesDiscoverCartCouponRemoveRequest		[optional]

Return type

PostV2ResourcesDiscoverCartCouponRemove200Response

Authorization

oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

postV2ResourcesDiscoverCartRemove

PostV2ResourcesDiscoverCartRemove200Response postV2ResourcesDiscoverCartRemove(postV2ResourcesDiscoverCartRemoveRequest)

Remove an item from the user's cart

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.ResourcesDiscoverCartApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    ResourcesDiscoverCartApi apiInstance = new ResourcesDiscoverCartApi(defaultClient);
    PostV2ResourcesDiscoverCartRemoveRequest postV2ResourcesDiscoverCartRemoveRequest = new PostV2ResourcesDiscoverCartRemoveRequest(); // PostV2ResourcesDiscoverCartRemoveRequest | 
    try {
      PostV2ResourcesDiscoverCartRemove200Response result = apiInstance.postV2ResourcesDiscoverCartRemove(postV2ResourcesDiscoverCartRemoveRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ResourcesDiscoverCartApi#postV2ResourcesDiscoverCartRemove");
      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
postV2ResourcesDiscoverCartRemoveRequest	PostV2ResourcesDiscoverCartRemoveRequest		[optional]

Return type

PostV2ResourcesDiscoverCartRemove200Response

Authorization

oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

FilesExpand file tree

ResourcesDiscoverCartApi.md

Latest commit

History

ResourcesDiscoverCartApi.md

File metadata and controls

ResourcesDiscoverCartApi

getV2ResourcesDiscoverCartView

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postV2ResourcesDiscoverCartAdd

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postV2ResourcesDiscoverCartCheckout

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postV2ResourcesDiscoverCartCouponAdd

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postV2ResourcesDiscoverCartCouponRemove

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postV2ResourcesDiscoverCartRemove

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details