Skip to content

CatalogGroupsApi.md

Latest commit

 

History

History
330 lines (224 loc) · 8.96 KB

CatalogGroupsApi.md

File metadata and controls

330 lines (224 loc) · 8.96 KB
Raw

Flipdish.CatalogGroupsApi

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

Method HTTP request Description
archiveGroup POST /api/v1.0/{appId}/catalog/groups/{catalogItemId}/archive Archive Catalog Group
createGroup POST /api/v1.0/{appId}/catalog/groups Create a Catalog Group
duplicateGroup POST /api/v1.0/{appId}/catalog/groups/{catalogItemId}/duplicate Duplicate Catalog Group
getGroupById GET /api/v1.0/{appId}/catalog/groups/{catalogItemId} Get group by Id
getGroups GET /api/v1.0/{appId}/catalog/groups Get paginated groups by app name id filtered by types
updateGroup POST /api/v1.0/{appId}/catalog/groups/{catalogItemId} Update Catalog Group

archiveGroup

archiveGroup(appId, catalogItemId)

Archive Catalog Group

[BETA - this endpoint is under development, do not use it in your production system]

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.CatalogGroupsApi();
let appId = "appId_example"; // String | 
let catalogItemId = "catalogItemId_example"; // String | 
apiInstance.archiveGroup(appId, catalogItemId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
appId String
catalogItemId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

createGroup

RestApiResultGroup createGroup(appId, createGroup)

Create a Catalog Group

[BETA - this endpoint is under development, do not use it in your production system]

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.CatalogGroupsApi();
let appId = "appId_example"; // String | 
let createGroup = new Flipdish.CreateGroup(); // CreateGroup | 
apiInstance.createGroup(appId, createGroup, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
createGroup CreateGroup

Return type

RestApiResultGroup

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, MinSelectCount, MaxSelectCount, Products, GroupType, Sku, Name, AutogenerateDisplayText, ImageFileName

duplicateGroup

duplicateGroup(appId, catalogItemId)

Duplicate Catalog Group

[BETA - this endpoint is under development, do not use it in your production system]

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.CatalogGroupsApi();
let appId = "appId_example"; // String | 
let catalogItemId = "catalogItemId_example"; // String | 
apiInstance.duplicateGroup(appId, catalogItemId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
appId String
catalogItemId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

getGroupById

Group getGroupById(appId, catalogItemId)

Get group by Id

[BETA - this endpoint is under development, do not use it in your production system]

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.CatalogGroupsApi();
let appId = "appId_example"; // String | 
let catalogItemId = "catalogItemId_example"; // String | 
apiInstance.getGroupById(appId, catalogItemId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
catalogItemId String

Return type

Group

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, CatalogGroupId, CatalogItemId, IsArchived, MinSelectCount, Products, GroupType, Sku, Name, AutogenerateDisplayText, ImageFileName

getGroups

RestApiPaginationResultGroup getGroups(appId, groupTypes, opts)

Get paginated groups by app name id filtered by types

[BETA - this endpoint is under development, do not use it in your production system]

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.CatalogGroupsApi();
let appId = "appId_example"; // String | 
let groupTypes = ["null"]; // [String] | 
let opts = {
  'searchTerm': "searchTerm_example", // String | 
  'page': 56, // Number | 
  'limit': 56 // Number | 
};
apiInstance.getGroups(appId, groupTypes, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
groupTypes [String]
searchTerm String [optional]
page Number [optional]
limit Number [optional]

Return type

RestApiPaginationResultGroup

Authorization

oauth2

HTTP request headers

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

updateGroup

updateGroup(appId, catalogItemId, updateGroup)

Update Catalog Group

[BETA - this endpoint is under development, do not use it in your production system]

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.CatalogGroupsApi();
let appId = "appId_example"; // String | 
let catalogItemId = "catalogItemId_example"; // String | 
let updateGroup = new Flipdish.UpdateGroup(); // UpdateGroup | 
apiInstance.updateGroup(appId, catalogItemId, updateGroup, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
appId String
catalogItemId String
updateGroup UpdateGroup

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