Skip to content

Latest commit

 

History

History
157 lines (91 loc) · 3.92 KB

BridgeApi.md

File metadata and controls

157 lines (91 loc) · 3.92 KB

.BridgeApi

All URIs are relative to https://api.api2cart.com/v1.1

Method HTTP request Description
bridgeDelete POST /bridge.delete.json bridge.delete
bridgeDownload GET /bridge.download.file bridge.download
bridgeUpdate POST /bridge.update.json bridge.update

bridgeDelete

AttributeValueDelete200Response bridgeDelete()

Delete bridge from the store.

Example

import { createConfiguration, BridgeApi } from '';

const configuration = createConfiguration();
const apiInstance = new BridgeApi(configuration);

const request = {};

const data = await apiInstance.bridgeDelete(request);
console.log('API called successfully. Returned data:', data);

Parameters

This endpoint does not need any parameter.

Return type

AttributeValueDelete200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridgeDownload

HttpFile bridgeDownload()

Download bridge for store.
Please note that the method would not work if you call it from Swagger UI.

Example

import { createConfiguration, BridgeApi } from '';
import type { BridgeApiBridgeDownloadRequest } from '';

const configuration = createConfiguration();
const apiInstance = new BridgeApi(configuration);

const request: BridgeApiBridgeDownloadRequest = {
    // Identifies if there is a necessity to download whitelabel bridge. (optional)
  whitelabel: true,
};

const data = await apiInstance.bridgeDownload(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
whitelabel [boolean] Identifies if there is a necessity to download whitelabel bridge. (optional) defaults to false

Return type

HttpFile

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/zip

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridgeUpdate

AttributeUpdate200Response bridgeUpdate()

Update bridge in the store.

Example

import { createConfiguration, BridgeApi } from '';

const configuration = createConfiguration();
const apiInstance = new BridgeApi(configuration);

const request = {};

const data = await apiInstance.bridgeUpdate(request);
console.log('API called successfully. Returned data:', data);

Parameters

This endpoint does not need any parameter.

Return type

AttributeUpdate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]