Skip to content

Latest commit

 

History

History
445 lines (321 loc) · 13.4 KB

StoreGroupsApi.md

File metadata and controls

445 lines (321 loc) · 13.4 KB

StoreGroupsApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
assignStoresToStoreGroup POST /api/v1.0/{appId}/storegroups/{storeGroupId}/assignStores
createStoreGroup POST /api/v1.0/{appNameId}/storegroups
getStoreGroup GET /api/v1.0/storegroups/{storeGroupId}
getStoreGroups GET /api/v1.0/{appNameId}/storegroups
getStoreGroupsExtended GET /api/v1.0/{appNameId}/storegroups/extended
removeStoreGroup DELETE /api/v1.0/storegroups/{storeGroupId}
setCustomerMessages POST /api/v1.0/storegroups/{storeGroupId}/CustomerMessages
updateStoreGroup POST /api/v1.0/storegroups/{storeGroupId}

assignStoresToStoreGroup

assignStoresToStoreGroup(appId, storeGroupId, storeIds)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StoreGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StoreGroupsApi apiInstance = new StoreGroupsApi();
String appId = "appId_example"; // String | 
Integer storeGroupId = 56; // Integer | 
List<Integer> storeIds = Arrays.asList(new List<Integer>()); // List<Integer> | 
try {
    apiInstance.assignStoresToStoreGroup(appId, storeGroupId, storeIds);
} catch (ApiException e) {
    System.err.println("Exception when calling StoreGroupsApi#assignStoresToStoreGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeGroupId Integer
storeIds List<Integer>

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

createStoreGroup

RestApiResultStoreGroup createStoreGroup(appNameId, storeGroup)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StoreGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StoreGroupsApi apiInstance = new StoreGroupsApi();
String appNameId = "appNameId_example"; // String | 
StoreGroupBase storeGroup = new StoreGroupBase(); // StoreGroupBase | 
try {
    RestApiResultStoreGroup result = apiInstance.createStoreGroup(appNameId, storeGroup);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoreGroupsApi#createStoreGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appNameId String
storeGroup StoreGroupBase

Return type

RestApiResultStoreGroup

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

getStoreGroup

RestApiResultStoreGroup getStoreGroup(storeGroupId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StoreGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StoreGroupsApi apiInstance = new StoreGroupsApi();
Integer storeGroupId = 56; // Integer | 
try {
    RestApiResultStoreGroup result = apiInstance.getStoreGroup(storeGroupId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoreGroupsApi#getStoreGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
storeGroupId Integer

Return type

RestApiResultStoreGroup

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getStoreGroups

RestApiPaginationResultStoreGroup getStoreGroups(appNameId, searchQuery, page, limit)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StoreGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StoreGroupsApi apiInstance = new StoreGroupsApi();
String appNameId = "appNameId_example"; // String | 
String searchQuery = "searchQuery_example"; // String | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
try {
    RestApiPaginationResultStoreGroup result = apiInstance.getStoreGroups(appNameId, searchQuery, page, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoreGroupsApi#getStoreGroups");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appNameId String
searchQuery String [optional]
page Integer [optional]
limit Integer [optional]

Return type

RestApiPaginationResultStoreGroup

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getStoreGroupsExtended

RestApiPaginationResultStoreGroupExtended getStoreGroupsExtended(appNameId, searchQuery, page, limit, groupingRadius)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StoreGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StoreGroupsApi apiInstance = new StoreGroupsApi();
String appNameId = "appNameId_example"; // String | 
String searchQuery = "searchQuery_example"; // String | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
Integer groupingRadius = 56; // Integer | 
try {
    RestApiPaginationResultStoreGroupExtended result = apiInstance.getStoreGroupsExtended(appNameId, searchQuery, page, limit, groupingRadius);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoreGroupsApi#getStoreGroupsExtended");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appNameId String
searchQuery String [optional]
page Integer [optional]
limit Integer [optional]
groupingRadius Integer [optional]

Return type

RestApiPaginationResultStoreGroupExtended

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

removeStoreGroup

removeStoreGroup(storeGroupId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StoreGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StoreGroupsApi apiInstance = new StoreGroupsApi();
Integer storeGroupId = 56; // Integer | 
try {
    apiInstance.removeStoreGroup(storeGroupId);
} catch (ApiException e) {
    System.err.println("Exception when calling StoreGroupsApi#removeStoreGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
storeGroupId Integer

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

setCustomerMessages

setCustomerMessages(storeGroupId, customerMessages)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StoreGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StoreGroupsApi apiInstance = new StoreGroupsApi();
Integer storeGroupId = 56; // Integer | 
CustomerMessages customerMessages = new CustomerMessages(); // CustomerMessages | 
try {
    apiInstance.setCustomerMessages(storeGroupId, customerMessages);
} catch (ApiException e) {
    System.err.println("Exception when calling StoreGroupsApi#setCustomerMessages");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
storeGroupId Integer
customerMessages CustomerMessages

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

updateStoreGroup

RestApiResultStoreGroupBase updateStoreGroup(storeGroupId, storeGroup)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StoreGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StoreGroupsApi apiInstance = new StoreGroupsApi();
Integer storeGroupId = 56; // Integer | 
StoreGroupBase storeGroup = new StoreGroupBase(); // StoreGroupBase | 
try {
    RestApiResultStoreGroupBase result = apiInstance.updateStoreGroup(storeGroupId, storeGroup);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StoreGroupsApi#updateStoreGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
storeGroupId Integer
storeGroup StoreGroupBase

Return type

RestApiResultStoreGroupBase

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml