All URIs are relative to https://dev-ocs-cm.develop.orckestra.cloud/api
Method | HTTP request | Description |
---|---|---|
ExportOrderSchemaRequestordersschemaexportPost | POST /integration/orders/schema/export | Export order schema to a file that will be stored in the blob - {ExportOrderSchemaRequest} |
ExportProductPricesRequestproductsScopeIdpricesexportPost | POST /integration/products/{ScopeId}/prices/export | Exports a set of product prices - {ExportProductPricesRequest} |
ExportProductsRequestproductsScopeIdexportPost | POST /integration/products/{ScopeId}/export | Export Metadatas, Products, Prices, Categories and RelationShips - {ExportProductsRequest} |
ExportProfileSchemaRequestprofilesschemaexportPost | POST /integration/profiles/schema/export | Export the profile system schema - {ExportProfileSchemaRequest} |
ExportProfilesRequestprofilesexportPost | POST /integration/profiles/export | Export the profile system data - {ExportProfilesRequest} |
ImportInventoryItemsRequestinventoryItemsimportPost | POST /integration/inventoryItems/import | Import inventory items from a set of files - {ImportInventoryItemsRequest} |
ImportOrderSchemaRequestordersschemaimportPost | POST /integration/orders/schema/import | Import order schema from file - {ImportOrderSchemaRequest} |
ImportOrdersRequestordersimportPost | POST /integration/orders/import | Import Orders and their's sub-elements : Payments Shipments, LineItems, Taxes, Addresses, Order history, Notes, Additional fees, Discounts and coupons - {ImportOrdersRequest} |
ImportProductsPricesRequestproductsScopeIdpricesimportPost | POST /integration/products/{ScopeId}/prices/import | Requests that a products prices import be started asynchronously. - {ImportProductsPricesRequest} |
ImportProductsRequestproductsScopeIdimportPost | POST /integration/products/{ScopeId}/import | Import Metadatas, Products, Prices, Categories and RelationShips - {ImportProductsRequest} |
ImportProfileSchemaRequestprofilesschemaimportPost | POST /integration/profiles/schema/import | Import the profile system schema - {ImportProfileSchemaRequest} |
ImportProfilesRequestprofilesimportPost | POST /integration/profiles/import | Import/Sync the profile system data - {ImportProfilesRequest} |
TaskInfo ExportOrderSchemaRequestordersschemaexportPost (string accept, ExportOrderSchemaRequest body = null)
Export order schema to a file that will be stored in the blob - {ExportOrderSchemaRequest}
Export order schema to a file that will be stored in the blob
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ExportOrderSchemaRequestordersschemaexportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var body = new ExportOrderSchemaRequest(); // ExportOrderSchemaRequest | (optional)
try
{
// Export order schema to a file that will be stored in the blob - {ExportOrderSchemaRequest}
TaskInfo result = apiInstance.ExportOrderSchemaRequestordersschemaexportPost(accept, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ExportOrderSchemaRequestordersschemaexportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
body | ExportOrderSchemaRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
401 | You must be authenticated to use this request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List<ProductPriceExportInfo> ExportProductPricesRequestproductsScopeIdpricesexportPost (string accept, string scopeId, ExportProductPricesRequest body = null)
Exports a set of product prices - {ExportProductPricesRequest}
Exports a set of product prices
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ExportProductPricesRequestproductsScopeIdpricesexportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var scopeId = scopeId_example; // string | The id of the requested scope
var body = new ExportProductPricesRequest(); // ExportProductPricesRequest | (optional)
try
{
// Exports a set of product prices - {ExportProductPricesRequest}
List<ProductPriceExportInfo> result = apiInstance.ExportProductPricesRequestproductsScopeIdpricesexportPost(accept, scopeId, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ExportProductPricesRequestproductsScopeIdpricesexportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
scopeId | string | The id of the requested scope | |
body | ExportProductPricesRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInfo ExportProductsRequestproductsScopeIdexportPost (string accept, string scopeId, ExportProductsRequest body = null)
Export Metadatas, Products, Prices, Categories and RelationShips - {ExportProductsRequest}
Export Metadatas, Products, Prices, Categories and RelationShips
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ExportProductsRequestproductsScopeIdexportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var scopeId = scopeId_example; // string | The scope.
var body = new ExportProductsRequest(); // ExportProductsRequest | (optional)
try
{
// Export Metadatas, Products, Prices, Categories and RelationShips - {ExportProductsRequest}
TaskInfo result = apiInstance.ExportProductsRequestproductsScopeIdexportPost(accept, scopeId, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ExportProductsRequestproductsScopeIdexportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
scopeId | string | The scope. | |
body | ExportProductsRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
401 | You must be authenticated to use this request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInfo ExportProfileSchemaRequestprofilesschemaexportPost (string accept, ExportProfileSchemaRequest body = null)
Export the profile system schema - {ExportProfileSchemaRequest}
Export the profile system schema. Return the task information for the started durable task.
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ExportProfileSchemaRequestprofilesschemaexportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var body = new ExportProfileSchemaRequest(); // ExportProfileSchemaRequest | (optional)
try
{
// Export the profile system schema - {ExportProfileSchemaRequest}
TaskInfo result = apiInstance.ExportProfileSchemaRequestprofilesschemaexportPost(accept, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ExportProfileSchemaRequestprofilesschemaexportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
body | ExportProfileSchemaRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInfo ExportProfilesRequestprofilesexportPost (string accept, ExportProfilesRequest body = null)
Export the profile system data - {ExportProfilesRequest}
Export the profile system data. Return the task information for the started durable task.
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ExportProfilesRequestprofilesexportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var body = new ExportProfilesRequest(); // ExportProfilesRequest | (optional)
try
{
// Export the profile system data - {ExportProfilesRequest}
TaskInfo result = apiInstance.ExportProfilesRequestprofilesexportPost(accept, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ExportProfilesRequestprofilesexportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
body | ExportProfilesRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
401 | You must be authenticated to use this request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInfo ImportInventoryItemsRequestinventoryItemsimportPost (string accept, ImportInventoryItemsRequest body = null)
Import inventory items from a set of files - {ImportInventoryItemsRequest}
Import inventory items from a set of files
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ImportInventoryItemsRequestinventoryItemsimportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var body = new ImportInventoryItemsRequest(); // ImportInventoryItemsRequest | (optional)
try
{
// Import inventory items from a set of files - {ImportInventoryItemsRequest}
TaskInfo result = apiInstance.ImportInventoryItemsRequestinventoryItemsimportPost(accept, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ImportInventoryItemsRequestinventoryItemsimportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
body | ImportInventoryItemsRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
401 | You must be authenticated to use this request | - |
404 | The task could not be launched. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInfo ImportOrderSchemaRequestordersschemaimportPost (string accept, ImportOrderSchemaRequest body = null)
Import order schema from file - {ImportOrderSchemaRequest}
Import order schema from file.
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ImportOrderSchemaRequestordersschemaimportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var body = new ImportOrderSchemaRequest(); // ImportOrderSchemaRequest | (optional)
try
{
// Import order schema from file - {ImportOrderSchemaRequest}
TaskInfo result = apiInstance.ImportOrderSchemaRequestordersschemaimportPost(accept, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ImportOrderSchemaRequestordersschemaimportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
body | ImportOrderSchemaRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
401 | You must be authenticated to use this request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInfo ImportOrdersRequestordersimportPost (string accept, ImportOrdersRequest body = null)
Import Orders and their's sub-elements : Payments Shipments, LineItems, Taxes, Addresses, Order history, Notes, Additional fees, Discounts and coupons - {ImportOrdersRequest}
Import Orders and their's sub-elements : Payments Shipments, LineItems, Taxes, Addresses, Order history, Notes, Additional fees, Discounts and coupons
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ImportOrdersRequestordersimportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var body = new ImportOrdersRequest(); // ImportOrdersRequest | (optional)
try
{
// Import Orders and their's sub-elements : Payments Shipments, LineItems, Taxes, Addresses, Order history, Notes, Additional fees, Discounts and coupons - {ImportOrdersRequest}
TaskInfo result = apiInstance.ImportOrdersRequestordersimportPost(accept, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ImportOrdersRequestordersimportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
body | ImportOrdersRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
401 | You must be authenticated to use this request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInfo ImportProductsPricesRequestproductsScopeIdpricesimportPost (string accept, string scopeId, ImportProductsPricesRequest body = null)
Requests that a products prices import be started asynchronously. - {ImportProductsPricesRequest}
Requests that a products prices import be started asynchronously for a given scope using the data available in the blob storage at the provided path.
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ImportProductsPricesRequestproductsScopeIdpricesimportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var scopeId = scopeId_example; // string | The scope.
var body = new ImportProductsPricesRequest(); // ImportProductsPricesRequest | (optional)
try
{
// Requests that a products prices import be started asynchronously. - {ImportProductsPricesRequest}
TaskInfo result = apiInstance.ImportProductsPricesRequestproductsScopeIdpricesimportPost(accept, scopeId, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ImportProductsPricesRequestproductsScopeIdpricesimportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
scopeId | string | The scope. | |
body | ImportProductsPricesRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
401 | You must be authenticated to use this request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInfo ImportProductsRequestproductsScopeIdimportPost (string accept, string scopeId, ImportProductsRequest body = null)
Import Metadatas, Products, Prices, Categories and RelationShips - {ImportProductsRequest}
Import Metadatas, Products, Prices, Categories and RelationShips
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ImportProductsRequestproductsScopeIdimportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var scopeId = scopeId_example; // string | The scope.
var body = new ImportProductsRequest(); // ImportProductsRequest | (optional)
try
{
// Import Metadatas, Products, Prices, Categories and RelationShips - {ImportProductsRequest}
TaskInfo result = apiInstance.ImportProductsRequestproductsScopeIdimportPost(accept, scopeId, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ImportProductsRequestproductsScopeIdimportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
scopeId | string | The scope. | |
body | ImportProductsRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
401 | You must be authenticated to use this request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInfo ImportProfileSchemaRequestprofilesschemaimportPost (string accept, ImportProfileSchemaRequest body = null)
Import the profile system schema - {ImportProfileSchemaRequest}
Import the profile system schema. Return the task information for the started durable task.
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ImportProfileSchemaRequestprofilesschemaimportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var body = new ImportProfileSchemaRequest(); // ImportProfileSchemaRequest | (optional)
try
{
// Import the profile system schema - {ImportProfileSchemaRequest}
TaskInfo result = apiInstance.ImportProfileSchemaRequestprofilesschemaimportPost(accept, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ImportProfileSchemaRequestprofilesschemaimportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
body | ImportProfileSchemaRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInfo ImportProfilesRequestprofilesimportPost (string accept, ImportProfilesRequest body = null)
Import/Sync the profile system data - {ImportProfilesRequest}
Import/Delete/Sync the profile system data. A result file containing all success and failures will be sent to the blob. The task will always be set as RunToCompletion by design. To see the status please check the property ErrorsInFiles in the task result or the result zip file in the blob. Restictions: - Files must be in the root of the zip - Only one import header by entity: Could not set different columns on the same profile in the same import zip - Only one delete header by entity: Could not perform a delete on the same profile with different keys. Cannot set some with ChildrenOnly and other not. - Importing an entity with extra will delete all related extra that have an import header - Delete files doesn't apply on extra Return the task information for the started durable task.
using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;
namespace Example
{
public class ImportProfilesRequestprofilesimportPostExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
var apiInstance = new IntegrationApi(config);
var accept = accept_example; // string | Accept Header
var body = new ImportProfilesRequest(); // ImportProfilesRequest | (optional)
try
{
// Import/Sync the profile system data - {ImportProfilesRequest}
TaskInfo result = apiInstance.ImportProfilesRequestprofilesimportPost(accept, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling IntegrationApi.ImportProfilesRequestprofilesimportPost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
accept | string | Accept Header | |
body | ImportProfilesRequest | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
401 | You must be authenticated to use this request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]