Skip to content

Based in the sample ASP.NET Core 5.0 reference application, powered by Microsoft, demonstrating a layered application architecture with monolithic deployment model this repository is a work in progress proof of concept integrating the Orckestra Commerce Cloud headless commerce services into the application and the Blazor admin

License

Notifications You must be signed in to change notification settings

Yaksa-ca/eShopOnWeb

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Yaksa.OrckestraCommerce.Client - the C# library for the Overture API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • SDK version: 1.0.0
  • Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen

Frameworks supported

  • .NET Core >=1.0
  • .NET Framework >=4.6
  • Mono/Xamarin >=vNext

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

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 Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
            var apiInstance = new AddressesApi(config);
            var accept = accept_example;  // string | Accept Header
            var addressId = addressId_example;  // string | The unique identifier of the address.

            try
            {
                // Retrieve an address using its Id - {GetAddressRequest}
                Address result = apiInstance.GetAddressRequestAddressIdGet(accept, addressId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AddressesApi.GetAddressRequestAddressIdGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://dev-ocs-cm.develop.orckestra.cloud/api

Class Method HTTP request Description
AddressesApi GetAddressRequestAddressIdGet GET /addresses/{AddressId} Retrieve an address using its Id - {GetAddressRequest}
AddressesApi GetAddressesByIdsRequestbyIdsIdsGet GET /addresses/byIds/{Ids} Retrieve a list of addresses by Ids - {GetAddressesByIdsRequest}
AddressesApi GetCustomerAddressRequestcustomerCustomerIdAddressIdGet GET /addresses/customer/{CustomerId}/{AddressId} Retrieve an address of a customer using its Id - {GetCustomerAddressRequest}
AddressesApi RemoveAddressRequestAddressIdDelete DELETE /addresses/{AddressId} Remove an address - {RemoveAddressRequest}
AddressesApi RemoveCustomerAddressRequestcustomerCustomerIdAddressIdDelete DELETE /addresses/customer/{CustomerId}/{AddressId} Remove an address of a customer - {RemoveCustomerAddressRequest}
AddressesApi UpdateAddressRequestAddressIdCreate PUT /addresses/{AddressId} Updates an address - {UpdateAddressRequest}
AddressesApi UpdateCustomerAddressRequestcustomerCustomerIdAddressIdCreate PUT /addresses/customer/{CustomerId}/{AddressId} Updates a customer address - {UpdateCustomerAddressRequest}
ApplicationsApi GetAllApplicationsRequestGet GET /applications/ Retrieve the full list of applications. - {GetAllApplicationsRequest}
ApplicationsApi SetApplicationVisibilityRequestApplicationIdvisibilityCreate PUT /applications/{ApplicationId}/visibility Set the application visibility. - {SetApplicationVisibilityRequest}
AuthenticationApi CustomerSignInRequestcustomersigninPost POST /authentication/customer/signin Sign in the customer with credentials - {CustomerSignInRequest}
AuthenticationApi FederationSignoutReplyRequestfedsignoutreplyGet GET /authentication/fedsignoutreply Returns a redirect to the provided returl url. - {FederationSignoutReplyRequest}
AuthenticationApi GetAuthenticationConfigurationconfigurationGet GET /authentication/configuration Get the authentication configuration. - {GetAuthenticationConfiguration}
AuthenticationApi GetAuthenticationStatusRequeststatusGet GET /authentication/status Get the authentication status. - {GetAuthenticationStatusRequest}
AuthenticationApi GetUserPermissionsRequestprofileGet GET /authentication/profile Get the user profile. - {GetUserPermissionsRequest}
AuthenticationApi SignInRequestsigninPost POST /authentication/signin Redirect the user from where he came from - {SignInRequest}
AuthenticationApi SignInWithCredentialsRequestsigninwithcredentialsPost POST /authentication/signinwithcredentials Sign in the user with credentials. - {SignInWithCredentialsRequest}
AuthenticationApi SignInWithIssuedTokenRequestsigninwithtokenPost POST /authentication/signinwithtoken Sign in the user with a received token. - {SignInWithIssuedTokenRequest}
AuthenticationApi SignInWithJWTRequestsigninwithjwtPost POST /authentication/signinwithjwt Sign in user with JWT token. Set authentication cookies and return the current user permissions. - {SignInWithJWTRequest}
AuthenticationApi SignOutRequestsignoutPost POST /authentication/signout Signout the user - {SignOutRequest}
AuthorizationsApi GetDirectAuthorizationsRequestdirectObjectsIdsPost POST /authorizations/direct/{ObjectsIds} Retrievet the direct authorizations - {GetDirectAuthorizationsRequest}
AuthorizationsApi GetEffectiveAuthorizationsRequestGetEffectiveAuthorizationsPost POST /authorizations/GetEffectiveAuthorizations Retrieve the effective authorizations - {GetEffectiveAuthorizationsRequest}
AuthorizationsApi GetMembershipSettingsRequestsettingsGet GET /authorizations/settings Retrieve the membership settings - {GetMembershipSettingsRequest}
AuthorizationsApi GetUserEffectiveAuthorizationsRequestUserNameGetEffectiveAuthorizationsGet GET /authorizations/{UserName}/GetEffectiveAuthorizations Retrieve the user effective authorizations - {GetUserEffectiveAuthorizationsRequest}
AuthorizationsApi GrantAuthorizationRequestRoleIdObjectIdPost POST /authorizations/{RoleId}/{ObjectId} Grant an authorization to an object (user or group for instance). - {GrantAuthorizationRequest}
AuthorizationsApi GrantAuthorizationsRequestObjectIdPost POST /authorizations/{ObjectId} Grant a list of authorization to an object (user or group for instance). - {GrantAuthorizationsRequest}
AuthorizationsApi RevokeAuthorizationRequestRoleIdObjectIdDelete DELETE /authorizations/{RoleId}/{ObjectId} Revoke an authorization to an object (user or group for instance). - {RevokeAuthorizationRequest}
AuthorizationsApi RevokeAuthorizationsRequestObjectIdDelete DELETE /authorizations/{ObjectId} Revoke a list of authorization to an object (user or group for instance). - {RevokeAuthorizationsRequest}
CampaignsApi AddOrUpdateCampaignRequestScopeIdCampaignIdfullCreate PUT /campaigns/{ScopeId}/{CampaignId}/full Add or update a campaign - {AddOrUpdateCampaignRequest}
CampaignsApi CancelCampaignRequestScopeIdIdcancelPost POST /campaigns/{ScopeId}/{Id}/cancel Cancel a Campaign - {CancelCampaignRequest}
CampaignsApi CopyCampaignRequestScopeIdFromCampaignIdcopyPost POST /campaigns/{ScopeId}/{FromCampaignId}/copy Copy a campaign - {CopyCampaignRequest}
CampaignsApi CreateCampaignRequestScopeIdPost POST /campaigns/{ScopeId} Create a campaign - {CreateCampaignRequest}
CampaignsApi CreatePromotionRequestScopeIdCampaignIdpromotionsPost POST /campaigns/{ScopeId}/{CampaignId}/promotions Add a promotion to an existing campaign - {CreatePromotionRequest}
CampaignsApi DeletePromotionRequestScopeIdCampaignIdpromotionsPromotionIdDelete DELETE /campaigns/{ScopeId}/{CampaignId}/promotions/{PromotionId} Delete the specified promotion - {DeletePromotionRequest}
CampaignsApi FindCampaignsRequestScopeIdfindPost POST /campaigns/{ScopeId}/find Search for campaigns. - {FindCampaignsRequest}
CampaignsApi GetCampaignPromotionsRequestScopeIdCampaignIdpromotionsGet GET /campaigns/{ScopeId}/{CampaignId}/promotions Retrieve the promotions of a campaign - {GetCampaignPromotionsRequest}
CampaignsApi GetCampaignRequestScopeIdCampaignIdGet GET /campaigns/{ScopeId}/{CampaignId} Retrieve a campaign - {GetCampaignRequest}
CampaignsApi GetCampaignsRequestScopeIdbyIdsCampaignIdsGet GET /campaigns/{ScopeId}/byIds/{CampaignIds} Retrieve a list of campaigns by ids - {GetCampaignsRequest}
CampaignsApi GetLiveCampaignsRequestScopeIdgetliveGet GET /campaigns/{ScopeId}/getlive Retrieve a list of live campaigns - {GetLiveCampaignsRequest}
CampaignsApi GetPromotionRequestScopeIdCampaignIdpromotionsPromotionIdGet GET /campaigns/{ScopeId}/{CampaignId}/promotions/{PromotionId} Retrieve a promotion - {GetPromotionRequest}
CampaignsApi GetPromotionSummariesRequestScopeIdCampaignIdpromotionssummariesGet GET /campaigns/{ScopeId}/{CampaignId}/promotions/summaries Retrieve the summaries of all promotions of a campaign - {GetPromotionSummariesRequest}
CampaignsApi PauseCampaignRequestScopeIdIdpausePost POST /campaigns/{ScopeId}/{Id}/pause Pause a Campaign - {PauseCampaignRequest}
CampaignsApi PublishCampaignRequestScopeIdIdpublishPost POST /campaigns/{ScopeId}/{Id}/publish Publish a Campaign - {PublishCampaignRequest}
CampaignsApi RejectCampaignRequestScopeIdIdrejectPost POST /campaigns/{ScopeId}/{Id}/reject Reject a Campaign - {RejectCampaignRequest}
CampaignsApi SubmitCampaignRequestScopeIdIdsubmitPost POST /campaigns/{ScopeId}/{Id}/submit Submit a Campaign - {SubmitCampaignRequest}
CampaignsApi UpdateCampaignRequestScopeIdIdCreate PUT /campaigns/{ScopeId}/{Id} Update a campaign - {UpdateCampaignRequest}
CampaignsApi UpdateCampaignStatusRequestScopeIdIdstatusCreate PUT /campaigns/{ScopeId}/{Id}/status Update the status of a campaign - {UpdateCampaignStatusRequest}
CampaignsApi UpdatePromotionRequestScopeIdCampaignIdpromotionsPromotionIdCreate PUT /campaigns/{ScopeId}/{CampaignId}/promotions/{PromotionId} Update an existing promotion - {UpdatePromotionRequest}
CartsApi AddCouponRequestScopeIdCustomerIdCartNamecouponsCouponCodePost POST /carts/{ScopeId}/{CustomerId}/{CartName}/coupons/{CouponCode} Add a coupon to a cart - {AddCouponRequest}
CartsApi AddLineItemInShipmentRequestScopeIdCustomerIdCartNameshipmentsShipmentIdlineItemsPost POST /carts/{ScopeId}/{CustomerId}/{CartName}/shipments/{ShipmentId}/lineItems Add a line item to a specified shipment of a cart - {AddLineItemInShipmentRequest}
CartsApi AddLineItemRequestScopeIdCustomerIdCartNamelineItemsPost POST /carts/{ScopeId}/{CustomerId}/{CartName}/lineItems Add a line item to the first shipment of a cart - {AddLineItemRequest}
CartsApi AddOrUpdateLineItemsInShipmentRequestScopeIdCustomerIdCartNameshipmentsShipmentIdlineItemsbatchPost POST /carts/{ScopeId}/{CustomerId}/{CartName}/shipments/{ShipmentId}/lineItems/batch Add or update multiple line items to a specific shipment of a cart - {AddOrUpdateLineItemsInShipmentRequest}
CartsApi AddOrUpdateLineItemsRequestScopeIdCustomerIdCartNamelineItemsbatchPost POST /carts/{ScopeId}/{CustomerId}/{CartName}/lineItems/batch Add or update multiple line items to the first shipment of a cart - {AddOrUpdateLineItemsRequest}
CartsApi AddPaymentRequestScopeIdCustomerIdCartNamepaymentsPost POST /carts/{ScopeId}/{CustomerId}/{CartName}/payments Add a payment in a cart - {AddPaymentRequest}
CartsApi AddShipmentRequestScopeIdCustomerIdCartNameshipmentsPost POST /carts/{ScopeId}/{CustomerId}/{CartName}/shipments Add a shipment to a cart - {AddShipmentRequest}
CartsApi AuthorizePaymentRequestScopeIdCustomerIdCartNamepaymentsPaymentIdauthorizePost POST /carts/{ScopeId}/{CustomerId}/{CartName}/payments/{PaymentId}/authorize Authorize the payment in a cart - {AuthorizePaymentRequest}
CartsApi ClearCartRequestScopeIdCustomerIdCartNameclearDelete DELETE /carts/{ScopeId}/{CustomerId}/{CartName}/clear Clears a cart by name - {ClearCartRequest}
CartsApi CompleteCheckoutRequestScopeIdCustomerIdCartNamecompleteCheckoutPost POST /carts/{ScopeId}/{CustomerId}/{CartName}/completeCheckout Complete the checkout of the cart - {CompleteCheckoutRequest}
CartsApi CopyCartToCustomerRequestScopeIdCustomerIdCartNamecopyToNewCustomerIdCreate PUT /carts/{ScopeId}/{CustomerId}/{CartName}/copyTo/{NewCustomerId} Copy an existing cart to another customer - {CopyCartToCustomerRequest}
CartsApi DeleteCartRequestScopeIdCustomerIdCartNameDelete DELETE /carts/{ScopeId}/{CustomerId}/{CartName} Delete a cart by name - {DeleteCartRequest}
CartsApi FindCartPaymentMethodsRequestScopeIdCustomerIdCartNamePaymentProviderNamepaymentMethodsPost POST /carts/{ScopeId}/{CustomerId}/{CartName}/{PaymentProviderName}/paymentMethods Retrieve the payment method available for a specific payment provider - {FindCartPaymentMethodsRequest}
CartsApi GetCartRequestScopeIdCustomerIdCartNameGet GET /carts/{ScopeId}/{CustomerId}/{CartName} Retrieve a cart - {GetCartRequest}
CartsApi GetCartStatesRequestScopeIdCustomerIdCartNamestatesGet GET /carts/{ScopeId}/{CustomerId}/{CartName}/states Retrieve the states of a cart, its shipments and its line items - {GetCartStatesRequest}
CartsApi GetCartSummaryRequestScopeIdCustomerIdCartNameSummaryGet GET /carts/{ScopeId}/{CustomerId}/{CartName}/Summary Retrieve the summary of a cart - {GetCartSummaryRequest}
CartsApi GetCartsByCustomerIdRequestScopeIdCustomerIdGet GET /carts/{ScopeId}/{CustomerId} Retrieves the list of carts belonging to a customer - {GetCartsByCustomerIdRequest}
CartsApi GetLineItemRequestScopeIdCustomerIdCartNamelineItemsIdGet GET /carts/{ScopeId}/{CustomerId}/{CartName}/lineItems/{Id} Get a line item of a cart - {GetLineItemRequest}
CartsApi GetLineItemsInCartRequestScopeIdCustomerIdCartNamelineItemsGet GET /carts/{ScopeId}/{CustomerId}/{CartName}/lineItems Get all the line items of a cart - {GetLineItemsInCartRequest}
CartsApi GetLineItemsInShipmentRequestScopeIdCustomerIdCartNameshipmentsShipmentIdlineItemsGet GET /carts/{ScopeId}/{CustomerId}/{CartName}/shipments/{ShipmentId}/lineItems Get all the line items of a shipment - {GetLineItemsInShipmentRequest}
CartsApi GetPaymentRequestScopeIdCustomerIdCartNamepaymentsIdGet GET /carts/{ScopeId}/{CustomerId}/{CartName}/payments/{Id} Get a payment of a cart - {GetPaymentRequest}
CartsApi GetPaymentsInCartRequestScopeIdCustomerIdCartNamepaymentsGet GET /carts/{ScopeId}/{CustomerId}/{CartName}/payments Get all the payments of a cart - {GetPaymentsInCartRequest}
CartsApi GetShipmentRequestScopeIdCustomerIdCartNameshipmentsIdGet GET /carts/{ScopeId}/{CustomerId}/{CartName}/shipments/{Id} Get a shipment of a cart - {GetShipmentRequest}
CartsApi InitializePaymentRequestScopeIdCustomerIdCartNamepaymentsPaymentIdinitializePost POST /carts/{ScopeId}/{CustomerId}/{CartName}/payments/{PaymentId}/initialize Initialize the payment in a cart - {InitializePaymentRequest}
CartsApi RefreshPaymentRequestScopeIdCustomerIdCartNamepaymentsPaymentIdrefreshPost POST /carts/{ScopeId}/{CustomerId}/{CartName}/payments/{PaymentId}/refresh Refresh the payment in a cart - {RefreshPaymentRequest}
CartsApi RemoveAllLineItemsRequestScopeIdCustomerIdCartNameremoveAllLineItemsDelete DELETE /carts/{ScopeId}/{CustomerId}/{CartName}/removeAllLineItems Remove all the line items from a cart - {RemoveAllLineItemsRequest}
CartsApi RemoveCouponRequestScopeIdCustomerIdCartNamecouponsCouponCodeDelete DELETE /carts/{ScopeId}/{CustomerId}/{CartName}/coupons/{CouponCode} Remove a coupon from a cart - {RemoveCouponRequest}
CartsApi RemoveLineItemRequestScopeIdCustomerIdCartNamelineItemsIdDelete DELETE /carts/{ScopeId}/{CustomerId}/{CartName}/lineItems/{Id} Remove a line item from a cart - {RemoveLineItemRequest}
CartsApi RemoveLineItemsInShipmentRequestScopeIdCustomerIdCartNameshipmentsShipmentIdlineItemsDelete DELETE /carts/{ScopeId}/{CustomerId}/{CartName}/shipments/{ShipmentId}/lineItems Remove all the line items from a shipment - {RemoveLineItemsInShipmentRequest}
CartsApi RemoveLineItemsRequestScopeIdCustomerIdCartNamelineItemsbatchDelete DELETE /carts/{ScopeId}/{CustomerId}/{CartName}/lineItems/batch Remove multiple line items from a cart - {RemoveLineItemsRequest}
CartsApi RemovePaymentRequestScopeIdCustomerIdCartNamepaymentsIdDelete DELETE /carts/{ScopeId}/{CustomerId}/{CartName}/payments/{Id} Removes a payment from a cart - {RemovePaymentRequest}
CartsApi RemoveShipmentRequestScopeIdCustomerIdCartNameshipmentsIdDelete DELETE /carts/{ScopeId}/{CustomerId}/{CartName}/shipments/{Id} Removes a shipment from a cart - {RemoveShipmentRequest}
CartsApi ReserveTimeSlotRequestScopeIdCustomerIdCartNameshipmentsShipmentIdTimeSlotIdPost POST /carts/{ScopeId}/{CustomerId}/{CartName}/shipments/{ShipmentId}/{TimeSlotId} Adds or renew a timeslot reservation for a cart - {ReserveTimeSlotRequest}
CartsApi SetAdjustmentRequestScopeIdCustomerIdCartNameshipmentsShipmentIdadjustmentCreate PUT /carts/{ScopeId}/{CustomerId}/{CartName}/shipments/{ShipmentId}/adjustment Set the adjustment of a shipment - {SetAdjustmentRequest}
CartsApi SettlePaymentRequestScopeIdCustomerIdCartNamepaymentsPaymentIdsettlePost POST /carts/{ScopeId}/{CustomerId}/{CartName}/payments/{PaymentId}/settle Settle the payment in a cart - {SettlePaymentRequest}
CartsApi UpdateBillingAddressRequestScopeIdCustomerIdCartNamepaymentsPaymentIdbillingAddressCreate PUT /carts/{ScopeId}/{CustomerId}/{CartName}/payments/{PaymentId}/billingAddress Update the billing address of a payment - {UpdateBillingAddressRequest}
CartsApi UpdateCartRequestScopeIdCustomerIdCartNameCreate PUT /carts/{ScopeId}/{CustomerId}/{CartName} Update the cart - {UpdateCartRequest}
CartsApi UpdateCustomerSummaryRequestScopeIdCustomerIdCartNamecustomerCreate PUT /carts/{ScopeId}/{CustomerId}/{CartName}/customer Update the customer summary of a cart - {UpdateCustomerSummaryRequest}
CartsApi UpdateLineItemRequestScopeIdCustomerIdCartNamelineItemsIdCreate PUT /carts/{ScopeId}/{CustomerId}/{CartName}/lineItems/{Id} Update a line item of a cart - {UpdateLineItemRequest}
CartsApi UpdatePaymentAmountRequestScopeIdCustomerIdCartNamepaymentsPaymentIdamountCreate PUT /carts/{ScopeId}/{CustomerId}/{CartName}/payments/{PaymentId}/amount Update the amount of a payment - {UpdatePaymentAmountRequest}
CartsApi UpdatePaymentMethodRequestScopeIdCustomerIdCartNamepaymentsPaymentIdmethodCreate PUT /carts/{ScopeId}/{CustomerId}/{CartName}/payments/{PaymentId}/method Update a payment method of a payment - {UpdatePaymentMethodRequest}
CartsApi UpdatePaymentRequestScopeIdCustomerIdCartNamepaymentsIdCreate PUT /carts/{ScopeId}/{CustomerId}/{CartName}/payments/{Id} Update a payment of a cart - {UpdatePaymentRequest}
CartsApi UpdateShipmentRequestScopeIdCustomerIdCartNameshipmentsIdCreate PUT /carts/{ScopeId}/{CustomerId}/{CartName}/shipments/{Id} Update a shipment of a cart - {UpdateShipmentRequest}
CartsApi VoidPaymentRequestScopeIdCustomerIdCartNamepaymentsPaymentIdvoidPost POST /carts/{ScopeId}/{CustomerId}/{CartName}/payments/{PaymentId}/void Void the payment in a cart - {VoidPaymentRequest}
CatalogsApi GetCatalogChildrenIdsRequestCatalogIdchildrenGet GET /catalogs/{CatalogId}/children Retrieve all catalog children for a catalog - {GetCatalogChildrenIdsRequest}
CatalogsApi GetCatalogRequestCatalogIdGet GET /catalogs/{CatalogId} Retrieve a catalog - {GetCatalogRequest}
CatalogsApi GetClosestCatalogLanguageRequestclosestlanguageCatalogIdLanguageGet GET /catalogs/closestlanguage/{CatalogId}/{Language} Retrieve the 'closest' language supported by a catalog from the requested language - {GetClosestCatalogLanguageRequest}
CatalogsApi GetUsedLanguagesRequestusedCulturesGet GET /catalogs/usedCultures Retrieve the list of cultures supported by product catalogs - {GetUsedLanguagesRequest}
CatalogsApi UpdateCatalogRequestCatalogIdCreate PUT /catalogs/{CatalogId} Update a catalog - {UpdateCatalogRequest}
CategoriesApi CreateCategoryRequestScopeIdPost POST /categories/{ScopeId} Create a category - {CreateCategoryRequest}
CategoriesApi DeleteCategoryRequestScopeIdCategoryIdDelete DELETE /categories/{ScopeId}/{CategoryId} Delete a category and related products - {DeleteCategoryRequest}
CategoriesApi DeleteCategoryV2Requestv2ScopeIdCategoryIdDelete DELETE /categories/v2/{ScopeId}/{CategoryId} Delete a category and related products - {DeleteCategoryV2Request}
CategoriesApi FindCategoryTreeNodesRequestScopeIdtreeNodesSearchTermsGet GET /categories/{ScopeId}/treeNodes/{SearchTerms} Find category tree nodes - {FindCategoryTreeNodesRequest}
CategoriesApi GetCategoriesContainingProductsByStatusRequestScopeIdcontainingProductsGet GET /categories/{ScopeId}/containingProducts Retrieve the ids of the categories that contain products in a given publication state - {GetCategoriesContainingProductsByStatusRequest}
CategoriesApi GetCategoriesRequestScopeIdGet GET /categories/{ScopeId} Retrieve the categories - {GetCategoriesRequest}
CategoriesApi GetCategoriesV2Requestv2ScopeIdGet GET /categories/v2/{ScopeId} Retrieve the categories - {GetCategoriesV2Request}
CategoriesApi GetCategoryChildrenRequestScopeIdCategoryIdchildrenGet GET /categories/{ScopeId}/{CategoryId}/children Retrieve the tree of child categories for a category - {GetCategoryChildrenRequest}
CategoriesApi GetCategoryChildrenV2Requestv2ScopeIdCategoryIdchildrenGet GET /categories/v2/{ScopeId}/{CategoryId}/children Retrieve the tree of child categories for a category - {GetCategoryChildrenV2Request}
CategoriesApi GetCategoryRelationshipsRequestScopeIdCategoryIdrelationshipsGet GET /categories/{ScopeId}/{CategoryId}/relationships Retrieve all relationships for a category - {GetCategoryRelationshipsRequest}
CategoriesApi GetCategoryRelationshipsV2Requestv2ScopeIdCategoryIdrelationshipsGet GET /categories/v2/{ScopeId}/{CategoryId}/relationships Retrieve all relationships for a category - {GetCategoryRelationshipsV2Request}
CategoriesApi GetCategoryRequestScopeIdCategoryIdGet GET /categories/{ScopeId}/{CategoryId} Retrieve a category - {GetCategoryRequest}
CategoriesApi GetCategoryTreeExistingItemByStateRequestScopeIdexistingGet GET /categories/{ScopeId}/existing Retrieve the category tree existing items of the specified parameters - {GetCategoryTreeExistingItemByStateRequest}
CategoriesApi GetCategoryTreeNodesForPathRequestScopeIdtreeNodesStartIdEndIdGet GET /categories/{ScopeId}/treeNodes/{StartId}/{EndId} Retrieve all nodes and their child nodes of a category tree node path - {GetCategoryTreeNodesForPathRequest}
CategoriesApi GetCategoryTreeNodesRequestScopeIdCategoryIdtreeNodesGet GET /categories/{ScopeId}/{CategoryId}/treeNodes Retrieve all the child nodes of a category node - {GetCategoryTreeNodesRequest}
CategoriesApi GetCategoryTreeNodesV2Requestv2ScopeIdCategoryIdtreeNodesGet GET /categories/v2/{ScopeId}/{CategoryId}/treeNodes Retrieve all the child nodes of a category node - {GetCategoryTreeNodesV2Request}
CategoriesApi GetCategoryV2Requestv2ScopeIdCategoryIdGet GET /categories/v2/{ScopeId}/{CategoryId} Retrieve a category - {GetCategoryV2Request}
CategoriesApi GetProductsByCategoryRequestScopeIdCategoryIdproductsGet GET /categories/{ScopeId}/{CategoryId}/products Retrieve products from a category - {GetProductsByCategoryRequest}
CategoriesApi GetProductsByCategoryV2Requestv2ScopeIdCategoryIdproductsGet GET /categories/v2/{ScopeId}/{CategoryId}/products Retrieve products from a category - {GetProductsByCategoryV2Request}
CategoriesApi UpdateCategoryRequestScopeIdCategoryIdPost POST /categories/{ScopeId}/{CategoryId} Update an existing category - {UpdateCategoryRequest}
CategoriesApi UpdateCategorySequenceRequestScopeIdCategoryIdchildrensequencePost POST /categories/{ScopeId}/{CategoryId}/children/sequence Update categories sequence - {UpdateCategorySequenceRequest}
CategoriesApi UpdateCategoryV2Requestv2ScopeIdCategoryIdCreate PUT /categories/v2/{ScopeId}/{CategoryId} Update an existing category - {UpdateCategoryV2Request}
CdmvApi AddMonerisPaymentMethodRequestmonerisCanadaVaultProfileScopeIdCustomerIdaddpaymentmethodPost POST /cdmv/monerisCanadaVaultProfile/{ScopeId}/{CustomerId}/addpaymentmethod Adds a new payment method for a customer - {AddMonerisPaymentMethodRequest}
CdmvApi AddOrUpdateProductAuthorizationsByUsernameRequestproductauthorizationsScopeIdbyUsernamePost POST /cdmv/productauthorizations/{ScopeId}/byUsername Add a new product authorizations or update if it already exists. - {AddOrUpdateProductAuthorizationsByUsernameRequest}
CdmvApi AddOrUpdateProductAuthorizationsRequestproductauthorizationsScopeIdCustomerIdPost POST /cdmv/productauthorizations/{ScopeId}/{CustomerId} Add a new product authorizations or update if it already exists. - {AddOrUpdateProductAuthorizationsRequest}
CdmvApi CDMVCreateCustomerRequestcustomerScopeIdPost POST /cdmv/customer/{ScopeId} Creates a customer - {CDMVCreateCustomerRequest}
CdmvApi CDMVSelfServiceAccountCreationRequestcustomerScopeIdselfServiceAccountCreationRequestPost POST /cdmv/customer/{ScopeId}/self-service-account-creation-request Sends an email to a customer to continue its account creation for a clinic - {CDMVSelfServiceAccountCreationRequest}
CdmvApi CDMVSelfServiceAccountCreationValidationRequestcustomerselfServiceAccountCreationRequestValidatePost POST /cdmv/customer/self-service-account-creation-request/Validate Validate an encrypted Token and return info - {CDMVSelfServiceAccountCreationValidationRequest}
CdmvApi ClinicProductInformationImportRequestdataexchangeproductsClinicCodeimportPost POST /cdmv/dataexchange/products/{ClinicCode}/import Import Metadatas, Products, Prices, Categories and RelationShips using a clinic code - {ClinicProductInformationImportRequest}
CdmvApi ConfirmShipmentRequestordersconfirmshipmentPost POST /cdmv/orders/confirmshipment Confirm that shipments have been shipped, either fully or partially - {ConfirmShipmentRequest}
CdmvApi DeactivateProductRequestproductsScopeIdProductIddeactivateCreate PUT /cdmv/products/{ScopeId}/{ProductId}/deactivate Dectivate a product in the provided dependant scope - {DeactivateProductRequest}
CdmvApi DeletePaymentMethodRequestcustomerScopeIdwalletDelete DELETE /cdmv/customer/{ScopeId}/wallet Deletes a payment method from the customer wallet - {DeletePaymentMethodRequest}
CdmvApi DeleteProductAuthorizationRequestproductauthorizationScopeIdIdDelete DELETE /cdmv/productauthorization/{ScopeId}/{Id} Delete an existing product authorization based on its Id - {DeleteProductAuthorizationRequest}
CdmvApi DocumentsRequestsolrAuthenticationTokenPost POST /cdmv/solr/{AuthenticationToken} Receives solr index documents to allow for custom index fields - {DocumentsRequest}
CdmvApi FindProductAuthorizationsByStatusRequestproductauthorizationsScopeIdfindbyStatusPost POST /cdmv/productauthorizations/{ScopeId}/find/byStatus Retrieves all product authorizations by status for a given scope - {FindProductAuthorizationsByStatusRequest}
CdmvApi FindStoresRequeststoresScopeIdfindPost POST /cdmv/stores/{ScopeId}/find Search for Stores based on search terms - {FindStoresRequest}
CdmvApi GetB2CSiteProfileRequestb2csiteprofileScopeIdCustomerIdGet GET /cdmv/b2csiteprofile/{ScopeId}/{CustomerId} Get the B2C site profile of a customer. - {GetB2CSiteProfileRequest}
CdmvApi GetClinicInfoForCustomerByUsernameRequestcustomerbyUsernameclinicGet GET /cdmv/customer/byUsername/clinic Returns information about the clinic a customer is associated to,using the customer's username to identify him. - {GetClinicInfoForCustomerByUsernameRequest}
CdmvApi GetClinicInfoForCustomerRequestcustomerCustomerIdclinicGet GET /cdmv/customer/{CustomerId}/clinic Returns information about the clinic a customer is associated to. - {GetClinicInfoForCustomerRequest}
CdmvApi GetClinicInfoRequestclinicClinicIdGet GET /cdmv/clinic/{ClinicId} Retrieves a clinic's information using its id - {GetClinicInfoRequest}
CdmvApi GetCustomerWalletRequestcustomerScopeIdwalletGet GET /cdmv/customer/{ScopeId}/wallet Gets a customer wallet - {GetCustomerWalletRequest}
CdmvApi GetCustomersKpiRequestcustomerskpiScopeIdGet GET /cdmv/customerskpi/{ScopeId} Get the list of Customer KPI. - {GetCustomersKpiRequest}
CdmvApi GetFeatureFlagsRequestfeatureflagsScopeIdGet GET /cdmv/featureflags/{ScopeId} Retrieves all feature flags that applies to a given scope applying scope inheritance. - {GetFeatureFlagsRequest}
CdmvApi GetMonerisCaptureSettingsRequestpaymentScopeIdmonerisPaymentProviderNamecaptureSettingsGet GET /cdmv/payment/{ScopeId}/moneris/{PaymentProviderName}/captureSettings Gets the payment capture settings for Moneris - {GetMonerisCaptureSettingsRequest}
CdmvApi GetPendingApprovalAccountsRequestb2csiteprofileScopeIdpendingaccountsGet GET /cdmv/b2csiteprofile/{ScopeId}/pendingaccounts Get the list of all B2C accounts waiting for approval. - {GetPendingApprovalAccountsRequest}
CdmvApi GetProductAuthorizationsByUsernameRequestproductauthorizationsScopeIdbyUsernameGet GET /cdmv/productauthorizations/{ScopeId}/byUsername Retrieves all product authorizations associated to a customer, identified by its username - {GetProductAuthorizationsByUsernameRequest}
CdmvApi GetProductAuthorizationsRequestproductauthorizationsScopeIdCustomerIdGet GET /cdmv/productauthorizations/{ScopeId}/{CustomerId} Retrieves all product authorizations associated to a customer - {GetProductAuthorizationsRequest}
CdmvApi InactiveProductsReportRequestreportsproductsScopeIdCultureNamedeactivatedGet GET /cdmv/reports/products/{ScopeId}/{CultureName}/deactivated Return CSV report for inactive products of each scope - {InactiveProductsReportRequest}
CdmvApi InviteNewCustomerRequestcustomerScopeIdinvitePost POST /cdmv/customer/{ScopeId}/invite Sends an email invitation to a new customer to create an account for a clinic - {InviteNewCustomerRequest}
CdmvApi InviteNewOrganizationalCustomerRequestcustomerScopeIdOrganizationIdinvitePost POST /cdmv/customer/{ScopeId}/{OrganizationId}/invite Sends an email invitation to a new customer to create an account associated with and organization - {InviteNewOrganizationalCustomerRequest}
CdmvApi InvoiceOrderToCDMVRequestordersinvoiceToCDMVPost POST /cdmv/orders/invoiceToCDMV Sends to CDMV the invoice for a given order - {InvoiceOrderToCDMVRequest}
CdmvApi RemoveActivationOverrideRequestproductsScopeIdProductIdremoveActivationOverrideDelete DELETE /cdmv/products/{ScopeId}/{ProductId}/removeActivationOverride Removed activation overrride in the provided dependant scope - {RemoveActivationOverrideRequest}
CdmvApi RemoveProductAuthorizationsByUsernameRequestproductauthorizationsScopeIdbyUsernameDelete DELETE /cdmv/productauthorizations/{ScopeId}/byUsername Remove product authorizations - {RemoveProductAuthorizationsByUsernameRequest}
CdmvApi RemoveProductAuthorizationsRequestproductauthorizationsScopeIdCustomerIdDelete DELETE /cdmv/productauthorizations/{ScopeId}/{CustomerId} Remove product authorizations - {RemoveProductAuthorizationsRequest}
CdmvApi UpdatePendingApprovalAccountRequestb2csiteprofileScopeIdpendingaccountsIdCreate PUT /cdmv/b2csiteprofile/{ScopeId}/pendingaccounts/{Id} Update a B2C site profile to complete the customer account approval. - {UpdatePendingApprovalAccountRequest}
CdmvApi UpdateProductAuthorizationRequestproductauthorizationScopeIdIdCreate PUT /cdmv/productauthorization/{ScopeId}/{Id} Update an existing product authorization based on its Id - {UpdateProductAuthorizationRequest}
CdmvApi UpdateShipmentTrackingRequestordersupdateShipmentTrackingPost POST /cdmv/orders/updateShipmentTracking Confirm shipments tracking information about an order when it is shipped or about to ship after CDMV shipment manifest - {UpdateShipmentTrackingRequest}
CdmvApi UpdateWalletCreditCardRequestcustomerScopeIdwalletPaymentMethodIdCreate PUT /cdmv/customer/{ScopeId}/wallet/{PaymentMethodId} Updates a credit card in the customer wallet - {UpdateWalletCreditCardRequest}
CdmvApi UpdateWalletDefaultCreditCardRequestcustomerScopeIdwalletdefaultPaymentMethodIdCreate PUT /cdmv/customer/{ScopeId}/wallet/default/{PaymentMethodId} Updates the default credit card in the customer wallet - {UpdateWalletDefaultCreditCardRequest}
CountriesApi AddCountryRequestPost POST /countries Adds a country - {AddCountryRequest}
CountriesApi GetCountriesRequestGet GET /countries Retrieve all countries - {GetCountriesRequest}
CountriesApi GetCountryRequestCountryIsoCodeGet GET /countries/{CountryIsoCode} Retrieve a country - {GetCountryRequest}
CountriesApi GetRegionsRequestCountryIsoCoderegionsGet GET /countries/{CountryIsoCode}/regions Retrieve all regions of a country - {GetRegionsRequest}
CountriesApi UpdateCountryAndRegionsRequestIsoCodeCreate PUT /countries/{IsoCode} Update a country and associated regions - {UpdateCountryAndRegionsRequest}
CouponsApi ConsumeCouponByCodeRequestconsumecodePost POST /coupons/consume/code Consume a coupon using its code - {ConsumeCouponByCodeRequest}
CouponsApi ConsumeCouponRequestconsumePost POST /coupons/consume Consume a coupon - {ConsumeCouponRequest}
CouponsApi DeleteCouponByCodeRequestdeletecodeDelete DELETE /coupons/delete/code Delete a coupon - {DeleteCouponByCodeRequest}
CouponsApi GetCouponRequestCouponCodeGet GET /coupons/{CouponCode} Retrieve a coupon using its coupon code - {GetCouponRequest}
CouponsApi GetCouponsRequestvalidatesCustomerIdPost POST /coupons/validates/{CustomerId} Validates a list of coupons for a customer - {GetCouponsRequest}
CouponsApi LiberateCouponRequestliberatePost POST /coupons/liberate Liberates a coupon - {LiberateCouponRequest}
CulturesApi GetAllCulturesRequestallGet GET /cultures/all Retrieve all cultures known to the system, including non supported - {GetAllCulturesRequest}
CulturesApi GetSupportedCulturesRequestGet GET /cultures Retrieve all supported cultures of the system - {GetSupportedCulturesRequest}
CulturesApi SetDefaultCultureRequestdefaultCreate PUT /cultures/default Sets the default culture for the system - {SetDefaultCultureRequest}
CulturesApi SetSupportedCulturesRequestCreate PUT /cultures Updates the list of supported cultures in the system - {SetSupportedCulturesRequest}
CustomProfilesApi AddAddressToCustomProfileRequestScopeIdEntityIdaddressesPost POST /customProfiles/{ScopeId}/{EntityId}/addresses Add an address to a custom profile's addresses - {AddAddressToCustomProfileRequest}
CustomProfilesApi AssociateEntityRequestScopeIdParentEntityTypeNameParentIdAttributeNameEntityIdPost POST /customProfiles/{ScopeId}/{ParentEntityTypeName}/{ParentId}/{AttributeName}/{EntityId} Associate two entities together - {AssociateEntityRequest}
CustomProfilesApi CreateCustomProfileRequestScopeIdEntityTypeNamePost POST /customProfiles/{ScopeId}/{EntityTypeName} Create a new custom profile - {CreateCustomProfileRequest}
CustomProfilesApi DeleteCustomProfileRequestScopeIdEntityTypeNameEntityIdDelete DELETE /customProfiles/{ScopeId}/{EntityTypeName}/{EntityId} Deletes a existing custom profile - {DeleteCustomProfileRequest}
CustomProfilesApi DisassociateEntityRequestScopeIdParentEntityTypeNameParentIdAttributeNameEntityIdDelete DELETE /customProfiles/{ScopeId}/{ParentEntityTypeName}/{ParentId}/{AttributeName}/{EntityId} Removes the association between two entities - {DisassociateEntityRequest}
CustomProfilesApi FindProfileInstancesRequestScopeIdEntityTypeNamefindPost POST /customProfiles/{ScopeId}/{EntityTypeName}/find Search for custom profiles based on search terms - {FindProfileInstancesRequest}
CustomProfilesApi GetAssociatedScopesRequestScopeIdEntityTypeNameEntityIdscopesGet GET /customProfiles/{ScopeId}/{EntityTypeName}/{EntityId}/scopes Retrieve the associated scopes - {GetAssociatedScopesRequest}
CustomProfilesApi GetProfileInstanceByNameRequestScopeIdEntityTypeNamebyNameNameGet GET /customProfiles/{ScopeId}/{EntityTypeName}/byName/{Name} Retrieve custom profile instance by type and name - {GetProfileInstanceByNameRequest}
CustomProfilesApi GetProfileInstanceRequestScopeIdEntityTypeNameEntityIdGet GET /customProfiles/{ScopeId}/{EntityTypeName}/{EntityId} Retrieve a custom profile instance by type and id - {GetProfileInstanceRequest}
CustomProfilesApi GetProfileInstancesRequestScopeIdEntityTypeNamebyIdsPost POST /customProfiles/{ScopeId}/{EntityTypeName}/byIds/ Retrieve custom profile instances by type and id - {GetProfileInstancesRequest}
CustomProfilesApi RemoveScopeAssociationRequestScopeIdEntityTypeNameEntityIdscopesDelete DELETE /customProfiles/{ScopeId}/{EntityTypeName}/{EntityId}/scopes Remove the association between a scope and a custom profile - {RemoveScopeAssociationRequest}
CustomProfilesApi UpdateCustomProfileRequestScopeIdEntityTypeNameEntityIdCreate PUT /customProfiles/{ScopeId}/{EntityTypeName}/{EntityId} Updates a custom profile - {UpdateCustomProfileRequest}
CustomProfilesApi UpdateScopeAssociationsRequestScopeIdEntityTypeNameEntityIdscopesCreate PUT /customProfiles/{ScopeId}/{EntityTypeName}/{EntityId}/scopes Adds/Updates the association between scopes and an entity - {UpdateScopeAssociationsRequest}
CustomersApi AddAddressToCustomerRequestScopeIdCustomerIdaddressesPost POST /customers/{ScopeId}/{CustomerId}/addresses Add an address to a customer's addresses - {AddAddressToCustomerRequest}
CustomersApi AddCustomerNoteRequestScopeIdCustomerIdnotesPost POST /customers/{ScopeId}/{CustomerId}/notes Add a note to a customer - {AddCustomerNoteRequest}
CustomersApi AddCustomerPaymentProfileRequestScopeIdCustomerIdPaymentProviderNamepaymentProfilePost POST /customers/{ScopeId}/{CustomerId}/{PaymentProviderName}/paymentProfile Add customer payment profile related to a specific payment provider - {AddCustomerPaymentProfileRequest}
CustomersApi AddOrUpdateCustomerAddressRequestCustomerIdaddressesAddressIdCreate PUT /customers/{CustomerId}/addresses/{AddressId} Add or updates a customer address - {AddOrUpdateCustomerAddressRequest}
CustomersApi AddOrganizationsToCustomerRequestScopeIdCustomerIdorganizationsPost POST /customers/{ScopeId}/{CustomerId}/organizations Add organizations to a customer - {AddOrganizationsToCustomerRequest}
CustomersApi AssociateCustomerEntityRequestCustomerIdcustomProfilesScopeIdAttributeNameEntityIdPost POST /customers/{CustomerId}/customProfiles/{ScopeId}/{AttributeName}/{EntityId} Associate a customer to an entity - {AssociateCustomerEntityRequest}
CustomersApi CreateCustomerRequestScopeIdPost POST /customers/{ScopeId} Create a customer - {CreateCustomerRequest}
CustomersApi DeleteCustomerPaymentMethodRequestScopeIdCustomerIdPaymentProviderNamepaymentMethodsPaymentMethodIdDelete DELETE /customers/{ScopeId}/{CustomerId}/{PaymentProviderName}/paymentMethods/{PaymentMethodId} Remove the PaymentMethod associated with a customer - {DeleteCustomerPaymentMethodRequest}
CustomersApi DisassociateCustomerEntityRequestCustomerIdcustomProfilesScopeIdAttributeNameEntityIdDelete DELETE /customers/{CustomerId}/customProfiles/{ScopeId}/{AttributeName}/{EntityId} Removes the association between a customer an entity - {DisassociateCustomerEntityRequest}
CustomersApi FindCustomersRequestScopeIdfindPost POST /customers/{ScopeId}/find Search for customers - {FindCustomersRequest}
CustomersApi GetCustomerAddressesRequestScopeIdCustomerIdaddressesGet GET /customers/{ScopeId}/{CustomerId}/addresses Retrieve the addresses of a customer - {GetCustomerAddressesRequest}
CustomersApi GetCustomerByUsernameRequestScopeIdbyUsernameUsernameGet GET /customers/{ScopeId}/byUsername/{Username} Retrieve a customer by user name - {GetCustomerByUsernameRequest}
CustomersApi GetCustomerFromPasswordTicketRequestbyTicketGet GET /customers/byTicket Retrieve the customer from a password reset ticket - {GetCustomerFromPasswordTicketRequest}
CustomersApi GetCustomerNotesRequestScopeIdCustomerIdnotesGet GET /customers/{ScopeId}/{CustomerId}/notes Get customer notes - {GetCustomerNotesRequest}
CustomersApi GetCustomerOrderHistoryRequestScopeIdCustomerIdordersGet GET /customers/{ScopeId}/{CustomerId}/orders Retrieve the order history of a customer - {GetCustomerOrderHistoryRequest}
CustomersApi GetCustomerOrganizationsRequestScopeIdCustomerIdorganizationsGet GET /customers/{ScopeId}/{CustomerId}/organizations Get customer organizations for a scope - {GetCustomerOrganizationsRequest}
CustomersApi GetCustomerPaymentMethodsRequestScopeIdCustomerIdPaymentProviderNamepaymentMethodsGet GET /customers/{ScopeId}/{CustomerId}/{PaymentProviderName}/paymentMethods Retrieve the Payment methods from a payment provider for a customer - {GetCustomerPaymentMethodsRequest}
CustomersApi GetCustomerPaymentProfileRequestScopeIdCustomerIdPaymentProviderNamepaymentProfileGet GET /customers/{ScopeId}/{CustomerId}/{PaymentProviderName}/paymentProfile Retrieve customer payment profile related to a specific payment provider - {GetCustomerPaymentProfileRequest}
CustomersApi GetCustomerPaymentProfilesRequestScopeIdCustomerIdpaymentProfilesGet GET /customers/{ScopeId}/{CustomerId}/paymentProfiles Get customer payment profiles for a scope - {GetCustomerPaymentProfilesRequest}
CustomersApi GetCustomerRequestScopeIdCustomerIdGet GET /customers/{ScopeId}/{CustomerId} Retrieve a customer - {GetCustomerRequest}
CustomersApi GetCustomerStoresRequestScopeIdCustomerIdstoresGet GET /customers/{ScopeId}/{CustomerId}/stores Retrieve the customer's stores - {GetCustomerStoresRequest}
CustomersApi RemoveOrganizationsToCustomerRequestScopeIdCustomerIdorganizationsDelete DELETE /customers/{ScopeId}/{CustomerId}/organizations Remove organizations from a customer - {RemoveOrganizationsToCustomerRequest}
CustomersApi SetDefaultCustomerPaymentMethodRequestScopeIdCustomerIdPaymentProviderNamepaymentMethodsPaymentMethodIddefaultCreate PUT /customers/{ScopeId}/{CustomerId}/{PaymentProviderName}/paymentMethods/{PaymentMethodId}/default Sets the default PaymentMethod for a customer profile - {SetDefaultCustomerPaymentMethodRequest}
CustomersApi UpdateCustomerPaymentProfileRequestScopeIdCustomerIdPaymentProviderNamepaymentProfileCreate PUT /customers/{ScopeId}/{CustomerId}/{PaymentProviderName}/paymentProfile Update a customer payment profile related to a specific payment provider - {UpdateCustomerPaymentProfileRequest}
CustomersApi UpdateCustomerRequestScopeIdCustomerIdCreate PUT /customers/{ScopeId}/{CustomerId} Updates a customer - {UpdateCustomerRequest}
CustomersApi UpdatePreferredStoreRequestScopeIdCustomerIdpreferredstoreCreate PUT /customers/{ScopeId}/{CustomerId}/preferred/store Updates the customer's preferred store - {UpdatePreferredStoreRequest}
DataexchangeApi ExportProductPriceRequestproductpricesScopeIdexportPost POST /dataexchange/productprices/{ScopeId}/export Export Product Prices of a priceList - {ExportProductPriceRequest}
DataexchangeApi ExportPromoCodesRequestpromotionsPromotionIdpromoCodesexportPost POST /dataexchange/promotions/{PromotionId}/promoCodes/export Export the promo codes of the promotion - {ExportPromoCodesRequest}
DataexchangeApi ImportProductPriceRequestproductpricesScopeIdimportPost POST /dataexchange/productprices/{ScopeId}/import Import a file Products and Product Prices of a priceList - {ImportProductPriceRequest}
DataexchangeApi ImportPromoCodesRequestpromotionsPromotionIdpromoCodesimportPost POST /dataexchange/promotions/{PromotionId}/promoCodes/import Import the promo codes for the promotion - {ImportPromoCodesRequest}
DataexchangeApi ProductInformationExportRequestproductsScopeIdexportPost POST /dataexchange/products/{ScopeId}/export Export Metadatas, Products, Prices, Categories and RelationShips - {ProductInformationExportRequest}
DataexchangeApi ProductInformationImportRequestproductsScopeIdimportPost POST /dataexchange/products/{ScopeId}/import Import Metadatas, Products, Prices, Categories and RelationShips - {ProductInformationImportRequest}
DataexchangeApi ProductInformationLegacyImportRequestproductsScopeIdlegacyimportPost POST /dataexchange/products/{ScopeId}/legacy/import Import Metadatas, Products, Prices, Categories and RelationShips - {ProductInformationLegacyImportRequest}
DiagnosticApi BasicDiagnosticRequestbasicGet GET /diagnostic/basic Check the latency - {BasicDiagnosticRequest}
DiagnosticApi GetCacheStatusRequestcachesGet GET /diagnostic/caches Get caches status - {GetCacheStatusRequest}
DiagnosticApi GetVersionInfoRequestversioninfoGet GET /diagnostic/versioninfo Return Orckestra Commerce Cloud platform Version Information - {GetVersionInfoRequest}
FulfillmentLocationsApi AddFulfillmentLocationTimeSlotRequestScopeIdFulfillmentLocationIdFulfillmentMethodTypeslotsPost POST /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/{FulfillmentMethodType}/slots/ Adds a time slot from a fulfillment location for a specific scope - {AddFulfillmentLocationTimeSlotRequest}
FulfillmentLocationsApi AddFulfillmentLocationTimeSlotReservationRequestScopeIdFulfillmentLocationIdreservationsSlotIdPost POST /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/reservations/{SlotId} Adds a time slot reservation for a specific time slot - {AddFulfillmentLocationTimeSlotReservationRequest}
FulfillmentLocationsApi AddFulfillmentLocationTimeSlotsRequestScopeIdFulfillmentLocationIdFulfillmentMethodTypeslotsseveralPost POST /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/{FulfillmentMethodType}/slots/several Adds a list of time slots from a fulfillment location for a specific scope - {AddFulfillmentLocationTimeSlotsRequest}
FulfillmentLocationsApi CalculateFulfillmentLocationsDelayRequestScopeIdcalculateDelayPost POST /fulfillmentLocations/{ScopeId}/calculateDelay Calculate the delay for a list of fulfillment locations - {CalculateFulfillmentLocationsDelayRequest}
FulfillmentLocationsApi CalculateScheduleAvailabilitySlotsRequestFulfillmentLocationIdFulfillmentTypePost POST /fulfillmentLocations/{FulfillmentLocationId}/{FulfillmentType} Combines a schedule and slot plan to calculate the availability of slots for the specified dates. - {CalculateScheduleAvailabilitySlotsRequest}
FulfillmentLocationsApi CheckAvailabilitySlotRequestforSlotFulfillmentLocationIdFulfillmentTypePost POST /fulfillmentLocations/forSlot/{FulfillmentLocationId}/{FulfillmentType} Checks the availability of a specific slot time on a specific date using the calculated schedule availability. - {CheckAvailabilitySlotRequest}
FulfillmentLocationsApi DeleteFulfillmentLocationTimeSlotRequestScopeIdFulfillmentLocationIdFulfillmentMethodTypeslotsSlotIdDelete DELETE /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/{FulfillmentMethodType}/slots/{SlotId} Deletes a time slot from a fulfillment location for a specific scope - {DeleteFulfillmentLocationTimeSlotRequest}
FulfillmentLocationsApi DeleteFulfillmentLocationTimeSlotReservationRequestScopeIdFulfillmentLocationIdreservationsbyIdSlotReservationIdDelete DELETE /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/reservations/byId/{SlotReservationId} Deletes a time slot reservation - {DeleteFulfillmentLocationTimeSlotReservationRequest}
FulfillmentLocationsApi DeleteFulfillmentLocationTimeSlotsRequestScopeIdFulfillmentLocationIdFulfillmentMethodTypeslotsDelete DELETE /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/{FulfillmentMethodType}/slots Deletes a time slot from a fulfillment location for a specific scope - {DeleteFulfillmentLocationTimeSlotsRequest}
FulfillmentLocationsApi FindFulfillmentLocationsRequestScopeIdfindPost POST /fulfillmentLocations/{ScopeId}/find Search for fulfillment locations - {FindFulfillmentLocationsRequest}
FulfillmentLocationsApi GetDeliveryFulfillmentLocationsByScopeRequestScopeIddeliveryGet GET /fulfillmentLocations/{ScopeId}/delivery Retrieve fulfillment locations supporting delivery as Fulfillment method for a specific scope - {GetDeliveryFulfillmentLocationsByScopeRequest}
FulfillmentLocationsApi GetFulfillmentAvailabilityRequestScopeIdavailabiltyPost POST /fulfillmentLocations/{ScopeId}/availabilty Get the availability of a fulfillment location depending on specific time for a specific scope - {GetFulfillmentAvailabilityRequest}
FulfillmentLocationsApi GetFulfillmentLocationByIdElapsedTimeRequestScopeIdFulfillmentLocationIdelapsedTimeGet GET /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/elapsedTime Retrieve an elapsed time based on fulfillment location schedules - {GetFulfillmentLocationByIdElapsedTimeRequest}
FulfillmentLocationsApi GetFulfillmentLocationByIdRequestScopeIdFulfillmentLocationIdGet GET /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId} Retrieve a fulfillment location for a specific scope - {GetFulfillmentLocationByIdRequest}
FulfillmentLocationsApi GetFulfillmentLocationTimeSlotByIdRequestScopeIdFulfillmentLocationIdFulfillmentMethodTypeslotsSlotIdGet GET /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/{FulfillmentMethodType}/slots/{SlotId} Retrieves a time slot from a fulfillment location for a specific scope - {GetFulfillmentLocationTimeSlotByIdRequest}
FulfillmentLocationsApi GetFulfillmentLocationTimeSlotReservationByIdRequestScopeIdFulfillmentLocationIdreservationsbyIdSlotReservationIdGet GET /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/reservations/byId/{SlotReservationId} Retrieves a time slot reservation - {GetFulfillmentLocationTimeSlotReservationByIdRequest}
FulfillmentLocationsApi GetFulfillmentLocationTimeSlotReservationsRequestScopeIdFulfillmentLocationIdreservationsSlotIdGet GET /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/reservations/{SlotId} Retrieves time slot reservations - {GetFulfillmentLocationTimeSlotReservationsRequest}
FulfillmentLocationsApi GetFulfillmentLocationTimeSlotsRequestScopeIdFulfillmentLocationIdFulfillmentMethodTypeslotsGet GET /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/{FulfillmentMethodType}/slots/ Retrieves time slots from a fulfillment location for a specific scope - {GetFulfillmentLocationTimeSlotsRequest}
FulfillmentLocationsApi GetFulfillmentLocationsByInventoryLocationIdsRequestScopeIdInventoryLocationIdsGet GET /fulfillmentLocations/{ScopeId}/{InventoryLocationIds} Retrieves a list of fulfillment locations for scpecific inventory locations identifiers - {GetFulfillmentLocationsByInventoryLocationIdsRequest}
FulfillmentLocationsApi GetFulfillmentLocationsByScopeRequestScopeIdGet GET /fulfillmentLocations/{ScopeId} Retrieve fulfillment locations for a specific scope - {GetFulfillmentLocationsByScopeRequest}
FulfillmentLocationsApi GetOperatingStatusRequestScopeIdFulfillmentLocationIdoperatingStatusGet GET /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/operatingStatus Retreive a specific store's OperatingStatus - {GetOperatingStatusRequest}
FulfillmentLocationsApi GetPickupFulfillmentLocationsByScopeRequestScopeIdpickupGet GET /fulfillmentLocations/{ScopeId}/pickup Retrieve fulfillment locations supporting pickup as shipping method for a specific scope - {GetPickupFulfillmentLocationsByScopeRequest}
FulfillmentLocationsApi GetScheduleRequestScopeIdFulfillmentLocationIdscheduleGet GET /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/schedule Retreive a specific store's Schedule - {GetScheduleRequest}
FulfillmentLocationsApi GetShippingFulfillmentLocationsByScopeRequestScopeIdshippingGet GET /fulfillmentLocations/{ScopeId}/shipping Retrieve fulfillment locations supporting shipping as shipping method for a specific scope - {GetShippingFulfillmentLocationsByScopeRequest}
FulfillmentLocationsApi ReserveAvailabilitySlotRequestreserveSlotFulfillmentLocationIdPost POST /fulfillmentLocations/reserveSlot/{FulfillmentLocationId} Reserves a fulfillment slot for the Shipment of an Order. (Not implemented in default provider) - {ReserveAvailabilitySlotRequest}
FulfillmentLocationsApi ResetFulfillmentLocationTimeSlotsRequestScopeIdFulfillmentLocationIdFulfillmentMethodTypeslotsresetCreate PUT /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/{FulfillmentMethodType}/slots/reset Delete all time slot from a fulfillment location for a specific scope and add the list of time slots - {ResetFulfillmentLocationTimeSlotsRequest}
FulfillmentLocationsApi SetFulfillmentLocationInventoryManagementRequestScopeIdFulfillmentLocationIdinventoryCreate PUT /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/inventory Updates the inventory informations for a specified fulfillment location. - {SetFulfillmentLocationInventoryManagementRequest}
FulfillmentLocationsApi UpdateFulfillmentLocationTimeSlotRequestScopeIdFulfillmentLocationIdFulfillmentMethodTypeslotsSlotIdCreate PUT /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/{FulfillmentMethodType}/slots/{SlotId} Updates a time slot from a fulfillment location for a specific scope - {UpdateFulfillmentLocationTimeSlotRequest}
FulfillmentLocationsApi UpdateFulfillmentLocationTimeSlotReservationRequestScopeIdFulfillmentLocationIdreservationsSlotReservationIdCreate PUT /fulfillmentLocations/{ScopeId}/{FulfillmentLocationId}/reservations/{SlotReservationId} Updates a time slot reservation - {UpdateFulfillmentLocationTimeSlotReservationRequest}
FulfillmentMethodTypesApi GetFulfillmentMethodTypesByFulfillmentLocationRequestScopeIdFulfillmentLocationIdGet GET /fulfillmentMethodTypes/{ScopeId}/{FulfillmentLocationId} Retrieve the fulfillment method types supported by a fulfillment location - {GetFulfillmentMethodTypesByFulfillmentLocationRequest}
FulfillmentMethodTypesApi GetFulfillmentMethodTypesByScopeRequestScopeIdGet GET /fulfillmentMethodTypes/{ScopeId} Retrieve the Fulfillment method types supported by the locations of a specific scope - {GetFulfillmentMethodTypesByScopeRequest}
FulfillmentMethodsApi FindCalculatedFulfillmentMethodsRequestScopeIdCustomerIdCartNamePost POST /fulfillmentMethods/{ScopeId}/{CustomerId}/{CartName} Retrieve the list of all the potential FulfillmentMethod of a given customer Cart - {FindCalculatedFulfillmentMethodsRequest}
FulfillmentMethodsApi GetAvailableFulfillmentMethodsByScopeRequestScopeIdGet GET /fulfillmentMethods/{ScopeId}/ Gets the list of all the available fulfillment methods for a given scope - {GetAvailableFulfillmentMethodsByScopeRequest}
FulfillmentsApi AddFulfillmentCompetitionLocationsRequestcompetitionsScopeIdFulfillmentCompetitionIdlocationsPost POST /fulfillments/competitions/{ScopeId}/{FulfillmentCompetitionId}/locations Adds one or more fulfillment locations to a fulfillment competition. - {AddFulfillmentCompetitionLocationsRequest}
FulfillmentsApi ChangeFulfillmentCompetitionLocationStatusRequestcompetitionsScopeIdFulfillmentCompetitionIdlocationsFulfillmentLocationIdstatusCreate PUT /fulfillments/competitions/{ScopeId}/{FulfillmentCompetitionId}/locations/{FulfillmentLocationId}/status Changes the status of a fulfillment competition location. - {ChangeFulfillmentCompetitionLocationStatusRequest}
FulfillmentsApi ChangeFulfillmentCompetitionStatusRequestcompetitionsScopeIdFulfillmentCompetitionIdstatusCreate PUT /fulfillments/competitions/{ScopeId}/{FulfillmentCompetitionId}/status Change the status of a fulfillment competition. - {ChangeFulfillmentCompetitionStatusRequest}
FulfillmentsApi ConfirmFulfillmentCarrierQuotesRequestcarriersScopeIdFulfillmentCarrierIdquotesconfirmPost POST /fulfillments/carriers/{ScopeId}/{FulfillmentCarrierId}/quotes/confirm Confirm shipping quotes for a package with a carrier - {ConfirmFulfillmentCarrierQuotesRequest}
FulfillmentsApi CreateFulfillmentCarrierManifestRequestcarriersScopeIdFulfillmentCarrierIdmanifestsPost POST /fulfillments/carriers/{ScopeId}/{FulfillmentCarrierId}/manifests Create manifests for a list of packages with a carrier - {CreateFulfillmentCarrierManifestRequest}
FulfillmentsApi CreateFulfillmentCompetitionRequestcompetitionsScopeIdPost POST /fulfillments/competitions/{ScopeId} Creates a new fulfillment competition in order to provide an opportunity for fulfillment locations to compete over fulfilling a shipment - {CreateFulfillmentCompetitionRequest}
FulfillmentsApi CreateFulfillmentPackageRequestpackagesScopeIdPost POST /fulfillments/packages/{ScopeId} Creates a new fulfillment package with a list of line items - {CreateFulfillmentPackageRequest}
FulfillmentsApi CreateFulfillmentPackageTypeRequestpackageTypesScopeIdPost POST /fulfillments/packageTypes/{ScopeId} Creates a new fulfillment package type - {CreateFulfillmentPackageTypeRequest}
FulfillmentsApi CreateFulfillmentSLARequestSLAsScopeIdPost POST /fulfillments/SLAs/{ScopeId} Create a fulfillment SLA for a specific fulfillment location - {CreateFulfillmentSLARequest}
FulfillmentsApi CreateOrUpdateFulfillmentExceptionRequestexceptionsScopeIdFulfillmentLocationIdOrderIdShipmentIdLineItemIdCreate PUT /fulfillments/exceptions/{ScopeId}/{FulfillmentLocationId}/{OrderId}/{ShipmentId}/{LineItemId} Creates or updates a fulfillment exception for a lineitem - {CreateOrUpdateFulfillmentExceptionRequest}
FulfillmentsApi DeleteFulfillmentCompetitionRequestcompetitionsScopeIdFulfillmentCompetitionIdDelete DELETE /fulfillments/competitions/{ScopeId}/{FulfillmentCompetitionId} Deletes a fulfillment competition - {DeleteFulfillmentCompetitionRequest}
FulfillmentsApi DeleteFulfillmentExceptionRequestexceptionsScopeIdFulfillmentLocationIdOrderIdShipmentIdLineItemIdDelete DELETE /fulfillments/exceptions/{ScopeId}/{FulfillmentLocationId}/{OrderId}/{ShipmentId}/{LineItemId} Deletes a fulfillment exception for a lineitem - {DeleteFulfillmentExceptionRequest}
FulfillmentsApi DeleteFulfillmentPackageForShipmentRequestpackagesScopeIdbyShipmentShipmentIdDelete DELETE /fulfillments/packages/{ScopeId}/byShipment/{ShipmentId} Delete all fulfillment packages for a specific shipment id - {DeleteFulfillmentPackageForShipmentRequest}
FulfillmentsApi DeleteFulfillmentPackageRequestpackagesScopeIdIdDelete DELETE /fulfillments/packages/{ScopeId}/{Id} Delete a fulfillment package for a specific id - {DeleteFulfillmentPackageRequest}
FulfillmentsApi DeleteFulfillmentPackageTypeRequestpackageTypesScopeIdIdDelete DELETE /fulfillments/packageTypes/{ScopeId}/{Id} Delete a fulfillment package type for a specific id - {DeleteFulfillmentPackageTypeRequest}
FulfillmentsApi DisableFulfillmentSLARequestSLAsdisablePost POST /fulfillments/SLAs/disable Disable a fulfillment SLA for a specific id - {DisableFulfillmentSLARequest}
FulfillmentsApi FindFulfillmentCompetitionsCountRequestcompetitionsScopeIdcountPost POST /fulfillments/competitions/{ScopeId}/count Gets the number of fulfillment competitions - {FindFulfillmentCompetitionsCountRequest}
FulfillmentsApi FindFulfillmentCompetitionsRequestcompetitionsScopeIdfindPost POST /fulfillments/competitions/{ScopeId}/find Search for a list of fulfillment competitions - {FindFulfillmentCompetitionsRequest}
FulfillmentsApi FindFulfillmentManifestPackagesRequestpackagesScopeIdfindmanifestGet GET /fulfillments/packages/{ScopeId}/findmanifest Search for a list of fulfillment packages - {FindFulfillmentManifestPackagesRequest}
FulfillmentsApi FindFulfillmentOrdersRequestordersScopeIdfindPost POST /fulfillments/orders/{ScopeId}/find Search for fulfillment orders - {FindFulfillmentOrdersRequest}
FulfillmentsApi FindFulfillmentPackageTypesRequestpackageTypesScopeIdfindPost POST /fulfillments/packageTypes/{ScopeId}/find Search for fulfillment package types - {FindFulfillmentPackageTypesRequest}
FulfillmentsApi FindFulfillmentPackagesRequestpackagesScopeIdfindGet GET /fulfillments/packages/{ScopeId}/find Search for a list of fulfillment packages - {FindFulfillmentPackagesRequest}
FulfillmentsApi FindFulfillmentSLARequestSLAsScopeIdfindPost POST /fulfillments/SLAs/{ScopeId}/find Search for fulfillment SLA - {FindFulfillmentSLARequest}
FulfillmentsApi GetFulfillmentCarrierDocumentsRequestcarriersScopeIdFulfillmentCarrierIdquotesdocumentsPost POST /fulfillments/carriers/{ScopeId}/{FulfillmentCarrierId}/quotes/documents Get shipping documents from a carrier - {GetFulfillmentCarrierDocumentsRequest}
FulfillmentsApi GetFulfillmentCarrierQuotesRequestcarriersScopeIdFulfillmentCarrierIdquotesPost POST /fulfillments/carriers/{ScopeId}/{FulfillmentCarrierId}/quotes Get shipping quotes for a package from a carrier - {GetFulfillmentCarrierQuotesRequest}
FulfillmentsApi GetFulfillmentCompetitionRequestcompetitionsScopeIdFulfillmentCompetitionIdGet GET /fulfillments/competitions/{ScopeId}/{FulfillmentCompetitionId} Gets a fulfillment competition by its identifier - {GetFulfillmentCompetitionRequest}
FulfillmentsApi GetFulfillmentExceptionsRequestexceptionsScopeIdFulfillmentLocationIdOrderIdGet GET /fulfillments/exceptions/{ScopeId}/{FulfillmentLocationId}/{OrderId} Gets the fulfillment exceptions for an order at a fulfillment location - {GetFulfillmentExceptionsRequest}
FulfillmentsApi GetFulfillmentPackageRequestpackagesScopeIdIdGet GET /fulfillments/packages/{ScopeId}/{Id} Gets a fulfillment package by its identifier - {GetFulfillmentPackageRequest}
FulfillmentsApi GetFulfillmentPackageTypeRequestpackageTypesScopeIdIdGet GET /fulfillments/packageTypes/{ScopeId}/{Id} Gets a fulfillment package type by its identifier - {GetFulfillmentPackageTypeRequest}
FulfillmentsApi GetFulfillmentSLARequestSLAsScopeIdIdGet GET /fulfillments/SLAs/{ScopeId}/{Id} Gets a fulfillment SLA by its identifier - {GetFulfillmentSLARequest}
FulfillmentsApi RefundFulfillmentCarrierQuotesRequestcarriersScopeIdFulfillmentCarrierIdquotesrefundPost POST /fulfillments/carriers/{ScopeId}/{FulfillmentCarrierId}/quotes/refund Refund shipping quotes from a carrier - {RefundFulfillmentCarrierQuotesRequest}
FulfillmentsApi RemoveFulfillmentCompetitionLocationsRequestcompetitionsScopeIdFulfillmentCompetitionIdlocationsDelete DELETE /fulfillments/competitions/{ScopeId}/{FulfillmentCompetitionId}/locations Removes a list of fulfillment competition locations from a specific fulfillment competition - {RemoveFulfillmentCompetitionLocationsRequest}
FulfillmentsApi TransferFulfillmentPackageItemsRequestpackagesScopeIdtransferFulfillmentPackageItemsPost POST /fulfillments/packages/{ScopeId}/transferFulfillmentPackageItems Transfers a list of fulfillment package items from one fulfillment package to another - {TransferFulfillmentPackageItemsRequest}
FulfillmentsApi UpdateFulfillmentPackageRequestpackagesScopeIdIdCreate PUT /fulfillments/packages/{ScopeId}/{Id} Updates a fulfillment package - {UpdateFulfillmentPackageRequest}
FulfillmentsApi UpdateFulfillmentPackageTypeRequestpackageTypesScopeIdIdCreate PUT /fulfillments/packageTypes/{ScopeId}/{Id} Updates a fulfillment package type - {UpdateFulfillmentPackageTypeRequest}
GroupsApi AddUserToGroupRequestGroupIdUserNamePost POST /groups/{GroupId}/{UserName} Add a user to a group - {AddUserToGroupRequest}
GroupsApi CreateGroupRequestDisplayNamePost POST /groups/{DisplayName}/ Create a new Group - {CreateGroupRequest}
GroupsApi DeleteGroupRequestGroupIdDelete DELETE /groups/{GroupId} Delete the group using its id. - {DeleteGroupRequest}
GroupsApi FindGroupsRequestfindPost POST /groups/find/ Find the groups with the specified name - {FindGroupsRequest}
GroupsApi GetGroupMembersWithPagingRequestGroupIdusersGet GET /groups/{GroupId}/users Retrieve the group members by group Id. - {GetGroupMembersWithPagingRequest}
GroupsApi GetGroupRequestGroupIdGet GET /groups/{GroupId}/ Retrieve the group by Id. - {GetGroupRequest}
GroupsApi RemoveUserFromGroupRequestGroupIdUserNameDelete DELETE /groups/{GroupId}/{UserName} Remove a user from a group - {RemoveUserFromGroupRequest}
GroupsApi SaveGroupRequestGroupIdCreate PUT /groups/{GroupId}/ Save the group. - {SaveGroupRequest}
IntegrationApi ExportOrderSchemaRequestordersschemaexportPost POST /integration/orders/schema/export Export order schema to a file that will be stored in the blob - {ExportOrderSchemaRequest}
IntegrationApi ExportProductPricesRequestproductsScopeIdpricesexportPost POST /integration/products/{ScopeId}/prices/export Exports a set of product prices - {ExportProductPricesRequest}
IntegrationApi ExportProductsRequestproductsScopeIdexportPost POST /integration/products/{ScopeId}/export Export Metadatas, Products, Prices, Categories and RelationShips - {ExportProductsRequest}
IntegrationApi ExportProfileSchemaRequestprofilesschemaexportPost POST /integration/profiles/schema/export Export the profile system schema - {ExportProfileSchemaRequest}
IntegrationApi ExportProfilesRequestprofilesexportPost POST /integration/profiles/export Export the profile system data - {ExportProfilesRequest}
IntegrationApi ImportInventoryItemsRequestinventoryItemsimportPost POST /integration/inventoryItems/import Import inventory items from a set of files - {ImportInventoryItemsRequest}
IntegrationApi ImportOrderSchemaRequestordersschemaimportPost POST /integration/orders/schema/import Import order schema from file - {ImportOrderSchemaRequest}
IntegrationApi 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}
IntegrationApi ImportProductsPricesRequestproductsScopeIdpricesimportPost POST /integration/products/{ScopeId}/prices/import Requests that a products prices import be started asynchronously. - {ImportProductsPricesRequest}
IntegrationApi ImportProductsRequestproductsScopeIdimportPost POST /integration/products/{ScopeId}/import Import Metadatas, Products, Prices, Categories and RelationShips - {ImportProductsRequest}
IntegrationApi ImportProfileSchemaRequestprofilesschemaimportPost POST /integration/profiles/schema/import Import the profile system schema - {ImportProfileSchemaRequest}
IntegrationApi ImportProfilesRequestprofilesimportPost POST /integration/profiles/import Import/Sync the profile system data - {ImportProfilesRequest}
InventoryItemsApi CancelAllInventoryReservedItemsRequestreservationsOwnerIdcancelAllPost POST /inventoryItems/reservations/{OwnerId}/cancelAll Cancel all inventory reserved items associated to the specified owner and inventory location. - {CancelAllInventoryReservedItemsRequest}
InventoryItemsApi CancelInventoryReservedItemsRequestreservationsOwnerIdcancelListPost POST /inventoryItems/reservations/{OwnerId}/cancelList Allows to cancel a list of inventory reserved items associated to the specified owner. - {CancelInventoryReservedItemsRequest}
InventoryItemsApi ChangeInventoryReservedItemsStockStatusRequestreservationsOwnerIdchangeStockStatusPost POST /inventoryItems/reservations/{OwnerId}/changeStockStatus Change the stock status of inventory reserved items from their current stock status to the new given stock status. - {ChangeInventoryReservedItemsStockStatusRequest}
InventoryItemsApi ConfirmInventoryReservedOrderItemsRequestreservationsOwnerIdconfirmPost POST /inventoryItems/reservations/{OwnerId}/confirm Applies the reserved items on the available quantitites in the inventory, decrement the effective reservation and changes the status Confirmed. - {ConfirmInventoryReservedOrderItemsRequest}
InventoryItemsApi CreateOrUpdateInventoryItemRequestScopeIdInventoryLocationIdSkuCreate PUT /inventoryItems/{ScopeId}/{InventoryLocationId}/{Sku} Create or update an inventory item - {CreateOrUpdateInventoryItemRequest}
InventoryItemsApi DecreaseInventoryQuantityRequestScopeIdbySkuSkubyLocationInventoryLocationIddecreaseQuantityPost POST /inventoryItems/{ScopeId}/bySku/{Sku}/byLocation/{InventoryLocationId}/decrease/{Quantity} Decrease an inventory quantity - {DecreaseInventoryQuantityRequest}
InventoryItemsApi EvaluateInventoryAvailabilityRequestreservationsOwnerIdevaluatePost POST /inventoryItems/reservations/{OwnerId}/evaluate Allows to send requests to evaluate inventory item availability - {EvaluateInventoryAvailabilityRequest}
InventoryItemsApi FindInventoryItemStatusByLocationAndSkusRequestScopeIdbyLocationInventoryLocationIdbySkusstatusPost POST /inventoryItems/{ScopeId}/byLocation/{InventoryLocationId}/bySkus/status Retrieve the detail about the status of Inventory Items represented by the specified InventoryLocationId and a list of skus for the specified date - {FindInventoryItemStatusByLocationAndSkusRequest}
InventoryItemsApi FindInventoryItemStatusBySkuAndLocationRequestScopeIdbySkuSkubyLocationInventoryLocationIdstatusPost POST /inventoryItems/{ScopeId}/bySku/{Sku}/byLocation/{InventoryLocationId}/status Retrieve the detail about the status of Inventory Item represented by the specified Sku and InventoryLocationId for the specified date - {FindInventoryItemStatusBySkuAndLocationRequest}
InventoryItemsApi FindInventoryItemsRequestScopeIdfindPost POST /inventoryItems/{ScopeId}/find Retrieve a list of InventoryItem - {FindInventoryItemsRequest}
InventoryItemsApi FindInventoryItemsStatusByScopeAndSkuRequestScopeIdbySkuSkustatusPost POST /inventoryItems/{ScopeId}/bySku/{Sku}/status Retrieve the detail about the status of Inventory Items represented by the specified Sku from all inventory location associated to the specific scope for the specified date - {FindInventoryItemsStatusByScopeAndSkuRequest}
InventoryItemsApi FindInventoryItemsStatusByScopeAndSkusRequestScopeIdbySkusstatusPost POST /inventoryItems/{ScopeId}/bySkus/status Retrieve the detail about the status of Inventory Items represented by the specified InventoryLocationId and a list of skus for the specified date - {FindInventoryItemsStatusByScopeAndSkusRequest}
InventoryItemsApi GetInventoryItemBySkuAndLocationRequestScopeIdbySkuSkubyLocationInventoryLocationIdGet GET /inventoryItems/{ScopeId}/bySku/{Sku}/byLocation/{InventoryLocationId} Retrieve an InventoryItem represented by association of sku and location id - {GetInventoryItemBySkuAndLocationRequest}
InventoryItemsApi GetInventoryItemsByLocationRequestScopeIdbyLocationInventoryLocationIdGet GET /inventoryItems/{ScopeId}/byLocation/{InventoryLocationId} Retrieve a list of InventoryItem represented by inventory location id - {GetInventoryItemsByLocationRequest}
InventoryItemsApi GetInventoryItemsByScopeAndSkuRequestScopeIdbySkuSkuGet GET /inventoryItems/{ScopeId}/bySku/{Sku} Retrieve a list of InventoryItemStatusDetails represented by sku from all inventory location associated to the specific scope - {GetInventoryItemsByScopeAndSkuRequest}
InventoryItemsApi GetInventoryItemsByScopeAndSkusRequestScopeIdbySkusPost POST /inventoryItems/{ScopeId}/bySkus Retrieve a list of InventoryItemStatusDetails represented by SKUs from all inventory location associated to the specific scope - {GetInventoryItemsByScopeAndSkusRequest}
InventoryItemsApi GetInventoryProvidersRequestScopeIdfindProvidersGet GET /inventoryItems/{ScopeId}/findProviders Retrieves all available inventory providers - {GetInventoryProvidersRequest}
InventoryItemsApi GetInventoryReservedItemsRequestreservationsOwnerIdGet GET /inventoryItems/reservations/{OwnerId} Find all reserved inventory items associated to the specified owner - {GetInventoryReservedItemsRequest}
InventoryItemsApi IncreaseInventoryQuantityRequestScopeIdbySkuSkubyLocationInventoryLocationIdincreaseQuantityPost POST /inventoryItems/{ScopeId}/bySku/{Sku}/byLocation/{InventoryLocationId}/increase/{Quantity} Increase an inventory quantity - {IncreaseInventoryQuantityRequest}
InventoryItemsApi ReserveInventoryItemsRequestreservationsOwnerIdPost POST /inventoryItems/reservations/{OwnerId} Allows to send requests to reserve a list of inventory items - {ReserveInventoryItemsRequest}
InventoryLocationsApi AddInventoryScheduleRequestInventoryLocationIdschedulesPost POST /inventoryLocations/{InventoryLocationId}/schedules Add an inventory schedule to a location - {AddInventoryScheduleRequest}
InventoryLocationsApi CreateInventoryLocationRequestScopeIdPost POST /inventoryLocations/{ScopeId} Creates or updates an inventory location - {CreateInventoryLocationRequest}
InventoryLocationsApi DeleteInventoryScheduleRequestInventoryLocationIdschedulesScheduleIdDelete DELETE /inventoryLocations/{InventoryLocationId}/schedules/{ScheduleId} Delete an inventory schedule - {DeleteInventoryScheduleRequest}
InventoryLocationsApi GetInventoryLocationRequestScopeIdAssociatedLocationIdGet GET /inventoryLocations/{ScopeId}/{AssociatedLocationId} Retrieve an inventory location by Id - {GetInventoryLocationRequest}
InventoryLocationsApi GetInventoryScheduleByIdRequestInventoryLocationIdschedulesbyIdScheduleIdGet GET /inventoryLocations/{InventoryLocationId}/schedules/byId/{ScheduleId} Retrieve an inventory schedule of a location using its id - {GetInventoryScheduleByIdRequest}
InventoryLocationsApi GetInventorySchedulesBySkuRequestInventoryLocationIdschedulesbySkuSkuGet GET /inventoryLocations/{InventoryLocationId}/schedules/bySku/{Sku} Retrieve all the inventory schedules of a location and a sku - {GetInventorySchedulesBySkuRequest}
InventoryLocationsApi GetInventorySchedulesRequestInventoryLocationIdschedulesGet GET /inventoryLocations/{InventoryLocationId}/schedules Retrieve all the inventory schedules of a location - {GetInventorySchedulesRequest}
InventoryLocationsApi UpdateInventoryScheduleRequestInventoryLocationIdschedulesCreate PUT /inventoryLocations/{InventoryLocationId}/schedules Update an inventory schedule daterange and status - {UpdateInventoryScheduleRequest}
InventoryQuantitiesApi GetInventoryQuantitiesByLocationRequestScopeIdbyLocationInventoryLocationIdGet GET /inventoryQuantities/{ScopeId}/byLocation/{InventoryLocationId} Retrieve inventory quantities for the specified inventory location id - {GetInventoryQuantitiesByLocationRequest}
MarketingApi GetMarketingSettingsRequestsettingsGet GET /marketing/settings Get the marketing application settings - {GetMarketingSettingsRequest}
MarketingApi UpdateMarketingSettingsRequestsettingsCreate PUT /marketing/settings Update the marketing application settings - {UpdateMarketingSettingsRequest}
MembershipApi ChangePasswordRequestScopeIdChangePasswordUserNamePost POST /membership/{ScopeId}/ChangePassword/{UserName} Change a Customer's password - {ChangePasswordRequest}
MembershipApi ChangeUserNameRequestScopeIdChangeUserNameOldUsernamePost POST /membership/{ScopeId}/ChangeUserName/{OldUsername} Change a Customer's user name - {ChangeUserNameRequest}
MembershipApi CreateCustomerMembershipRequestScopeIdPost POST /membership/{ScopeId} Create a new customer membership - {CreateCustomerMembershipRequest}
MembershipApi GetMembershipConfigurationRequestconfigurationGet GET /membership/configuration Retrieve the membership configuration from the system - {GetMembershipConfigurationRequest}
MembershipApi LoginRequestScopeIdLoginCreate PUT /membership/{ScopeId}/Login Login the user with the values provided - {LoginRequest}
MembershipApi ResetPasswordRequestScopeIdResetPasswordPost POST /membership/{ScopeId}/ResetPassword Send a password reset email or reset password directly - {ResetPasswordRequest}
MembershipApi UnlockUserRequestScopeIdUnlockUserUserNamePost POST /membership/{ScopeId}/UnlockUser/{UserName} Unlock a User account - {UnlockUserRequest}
MembershipApi ValidateUserRequestScopeIdValidateCreate PUT /membership/{ScopeId}/Validate Validate a username/password combination - {ValidateUserRequest}
MetadataApi CreateCategoryDefinitionRequestdefinitionscategoryNamePost POST /metadata/definitions/category/{Name} Create a category definition - {CreateCategoryDefinitionRequest}
MetadataApi CreateEntityTypeRequestEntityTypeEntityTypeNamePost POST /metadata/EntityType/{EntityTypeName} Create a new custom profile definition - {CreateEntityTypeRequest}
MetadataApi CreateProductAttributeGroupRequestattributegroupsproductNamePost POST /metadata/attributegroups/product/{Name} Create a product attribute group - {CreateProductAttributeGroupRequest}
MetadataApi CreateProductAttributeRequestattributesproductAttributeNamePost POST /metadata/attributes/product/{AttributeName} Create a product attribute - {CreateProductAttributeRequest}
MetadataApi CreateProductDefinitionRequestdefinitionsproductNamePost POST /metadata/definitions/product/{Name} Create a product definition - {CreateProductDefinitionRequest}
MetadataApi CreateProductLookupTypeDefinitionRequestlookupsproductLookupNamePost POST /metadata/lookups/product/{LookupName} Creates a new product lookup type definition - {CreateProductLookupTypeDefinitionRequest}
MetadataApi DeleteProductAttributeGroupRequestattributegroupsproductNameDelete DELETE /metadata/attributegroups/product/{Name} Delete a product attribute group - {DeleteProductAttributeGroupRequest}
MetadataApi DeleteProductAttributeRequestattributesproductAttributeNameDelete DELETE /metadata/attributes/product/{AttributeName} Delete a product attribute - {DeleteProductAttributeRequest}
MetadataApi DeleteProductLookupValuesRequestlookupsproductLookupNamevaluesDelete DELETE /metadata/lookups/product/{LookupName}/values Delete specified values from a product lookup type definition - {DeleteProductLookupValuesRequest}
MetadataApi FindProductAttributeGroupsRequestattributegroupsproductfindPost POST /metadata/attributegroups/product/find Get list of product attribute groups - {FindProductAttributeGroupsRequest}
MetadataApi GetCurrenciesRequestcurrenciesGet GET /metadata/currencies Retrieve all currencies - {GetCurrenciesRequest}
MetadataApi GetCustomerDefinitionRequestdefinitionscustomerNameGet GET /metadata/definitions/customer/{Name} Retrieve the entity definition from Profiles entities - {GetCustomerDefinitionRequest}
MetadataApi GetCustomerDefinitionsRequestdefinitionscustomerGet GET /metadata/definitions/customer Retrieve the entity definitions in Profiles - {GetCustomerDefinitionsRequest}
MetadataApi GetCustomerLookupRequestlookupscustomerLookupNameGet GET /metadata/lookups/customer/{LookupName} Retrieve the lookup from Profiles lookups - {GetCustomerLookupRequest}
MetadataApi GetCustomerLookupsRequestlookupscustomerGet GET /metadata/lookups/customer/ Retrieve the Profiles lookups - {GetCustomerLookupsRequest}
MetadataApi GetMarketingLookupRequestlookupsmarketingLookupNameGet GET /metadata/lookups/marketing/{LookupName} Retrieve the lookup from Marketing lookups - {GetMarketingLookupRequest}
MetadataApi GetMarketingLookupsRequestlookupsmarketingGet GET /metadata/lookups/marketing/ Retrieve the Marketing lookups - {GetMarketingLookupsRequest}
MetadataApi GetOrderDefinitionRequestdefinitionsorderNameGet GET /metadata/definitions/order/{Name} Retrieve the entity definition from Orders entities - {GetOrderDefinitionRequest}
MetadataApi GetOrderDefinitionsRequestdefinitionsorderGet GET /metadata/definitions/order Retrieve the entity definitions defined in Orders - {GetOrderDefinitionsRequest}
MetadataApi GetOrderLookupRequestlookupsorderLookupNameGet GET /metadata/lookups/order/{LookupName} Retrieve the lookup from Orders lookups - {GetOrderLookupRequest}
MetadataApi GetOrderLookupsRequestlookupsorderGet GET /metadata/lookups/order/ Retrieve the Orders lookups - {GetOrderLookupsRequest}
MetadataApi GetProductLookupRequestlookupsproductLookupNameGet GET /metadata/lookups/product/{LookupName} Retrieve the lookup from Products lookups - {GetProductLookupRequest}
MetadataApi GetProductLookupsRequestlookupsproductGet GET /metadata/lookups/product/ Retrieve the Product lookups - {GetProductLookupsRequest}
MetadataApi GetTargetingMetadataRequesttargetingGet GET /metadata/targeting Return the targeting items (metadata used to construct targeting expression) - {GetTargetingMetadataRequest}
MetadataApi UpdateCategoryDefinitionRequestdefinitionscategoryNameCreate PUT /metadata/definitions/category/{Name} Update a category definition - {UpdateCategoryDefinitionRequest}
MetadataApi UpdateMarketingLookupTypeDefinitionRequestLookupTypeMarketingLookupNamePost POST /metadata/LookupType/Marketing/{LookupName} Update a marketing lookup type definition - {UpdateMarketingLookupTypeDefinitionRequest}
MetadataApi UpdateProductAttributeGroupRequestattributegroupsproductNameCreate PUT /metadata/attributegroups/product/{Name} Update a product attribute group - {UpdateProductAttributeGroupRequest}
MetadataApi UpdateProductAttributeRequestattributesproductAttributeNameCreate PUT /metadata/attributes/product/{AttributeName} Update a product attribute - {UpdateProductAttributeRequest}
MetadataApi UpdateProductDefinitionRequestdefinitionsproductNameCreate PUT /metadata/definitions/product/{Name} Update a product definition - {UpdateProductDefinitionRequest}
MetadataApi UpdateProductLookupTypeDefinitionRequestlookupsproductLookupNameCreate PUT /metadata/lookups/product/{LookupName} Update a product lookup type definition - {UpdateProductLookupTypeDefinitionRequest}
ModulesApi GetApplicationModulesbyApplicationNameApplicationNameGet GET /modules/byApplicationName/{ApplicationName} Retrieve all the specified application modules. - {GetApplicationModules}
ModulesApi GetModulesRequestGet GET /modules/ Retrieve the full list of modules. - {GetModulesRequest}
MonerisCanadaVaultProfileApi CreateCartPaymentVaultProfileRequestcartsScopeIdCustomerIdCartNamepaymentsPaymentIdPost POST /monerisCanadaVaultProfile/carts/{ScopeId}/{CustomerId}/{CartName}/payments/{PaymentId} Create a vault profile for a cart payment - {CreateCartPaymentVaultProfileRequest}
MonerisCanadaVaultProfileApi CreateOrderDraftPaymentVaultProfileRequestorderdraftScopeIdDraftIdpaymentsPaymentIdPost POST /monerisCanadaVaultProfile/orderdraft/{ScopeId}/{DraftId}/payments/{PaymentId} Create a vault profile for a draft order - {CreateOrderDraftPaymentVaultProfileRequest}
MonitoringApi GetOvertureHostInfoRequesthealthGet GET /monitoring/health - {GetOvertureHostInfoRequest}
MyApi GetAuthorizedApplicationsRequestapplicationsGet GET /my/applications/ Retrieve the authorized applications list with the preferred application first. - {GetAuthorizedApplicationsRequest}
MyApi GetUserApplicationRequestapplicationGet GET /my/application Retrieve the user default application id - {GetUserApplicationRequest}
MyApi GetUserCultureRequestcultureGet GET /my/culture Retrive the user prefered culture - {GetUserCultureRequest}
MyApi GetUserScopeRequestscopeModuleGet GET /my/scope/{Module} Retrive the default user scope id for the provided module - {GetUserScopeRequest}
MyApi GetUserScopeTreeRequestscopeModuletreeGet GET /my/scope/{Module}/tree Retrieve scope tree based on the user permissions for the provided module - {GetUserScopeTreeRequest}
MyApi SaveUserApplicationRequestapplicationApplicationIdPost POST /my/application/{ApplicationId} Set the user default application by providing the application id - {SaveUserApplicationRequest}
MyApi SaveUserCultureRequestcultureCultureIsoPost POST /my/culture/{CultureIso} Set the user culture providing it's ISO format (ie en-US) - {SaveUserCultureRequest}
MyApi SaveUserScopeRequestscopeModuleScopeIdPost POST /my/scope/{Module}/{ScopeId} Set the user default scope providing the scope id and the module - {SaveUserScopeRequest}
NotificationsApi CustomerCreatedNotificationRequestScopeIdcustomerCreatedPost POST /notifications/{ScopeId}/customerCreated Sends a notification to a customer using the CustomerCreated template - {CustomerCreatedNotificationRequest}
NotificationsApi CustomerInvitationNotificationRequestScopeIdcustomerInvitationPost POST /notifications/{ScopeId}/customerInvitation Sends a notification to an Eboutique customer using the CustomerInvitation template - {CustomerInvitationNotificationRequest}
NotificationsApi CustomerPasswordChangedNotificationRequestScopeIdcustomerPasswordChangedPost POST /notifications/{ScopeId}/customerPasswordChanged Sends a notification to a customer using the CustomerPasswordChanged template - {CustomerPasswordChangedNotificationRequest}
NotificationsApi CustomerPasswordResetNotificationRequestScopeIdcustomerPasswordResetRequestedPost POST /notifications/{ScopeId}/customerPasswordResetRequested Sends a notification to a customer using the CustomerPasswordResetRequested template - {CustomerPasswordResetNotificationRequest}
OrderdraftApi GetOrderDraftPaymentRequestScopeIdDraftIdpaymentPaymentIdGet GET /orderdraft/{ScopeId}/{DraftId}/payment/{PaymentId} Retrieve an order draft - {GetOrderDraftPaymentRequest}
OrderdraftApi UpdateOrderDraftPaymentRequestScopeIdDraftIdpaymentPaymentIdPost POST /orderdraft/{ScopeId}/{DraftId}/payment/{PaymentId} Update an order draft payment - {UpdateOrderDraftPaymentRequest}
OrdersApi AddOrderHistoryRequestScopeIdorderhistoryPost POST /orders/{ScopeId}/orderhistory Add new history item related to specified order - {AddOrderHistoryRequest}
OrdersApi AddOrderNoteRequestScopeIdOrderIdnotesPost POST /orders/{ScopeId}/{OrderId}/notes Add a note to an order - {AddOrderNoteRequest}
OrdersApi AddShipmentFulfillmentMessagesRequestScopeIdOrderIdshipmentsShipmentIdstatemessagesPost POST /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/state/messages Return the fulfillment state of an order and each of its shipments - {AddShipmentFulfillmentMessagesRequest}
OrdersApi AddShipmentNoteRequestScopeIdOrderIdshipmentsShipmentIdnotesPost POST /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/notes Add a note to an order shipment - {AddShipmentNoteRequest}
OrdersApi ChangeOrderStatusRequestScopeIdOrderIdfulfillmentStatePost POST /orders/{ScopeId}/{OrderId}/fulfillmentState Request that all shipments statuses be transitioned from their current status to the submitted status. - {ChangeOrderStatusRequest}
OrdersApi ChangeShipmentStatusRequestScopeIdOrderIdshipmentsShipmentIdfulfillmentStatePost POST /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/fulfillmentState Request that a shipment status be transitioned from its current status to the submitted status. - {ChangeShipmentStatusRequest}
OrdersApi CopyCartFromOrderRequestScopeIdOrderIdcopycartPost POST /orders/{ScopeId}/{OrderId}/copycart Copy cart from an existing order - {CopyCartFromOrderRequest}
OrdersApi CopyOrderRequestScopeIdOrderIdcopyPost POST /orders/{ScopeId}/{OrderId}/copy Copy an order - {CopyOrderRequest}
OrdersApi CreateOrderRequestPost POST /orders Create a new order from a cart - {CreateOrderRequest}
OrdersApi CreateRmaGuestRequestRMAScopeIdOrderNumberGuestPost POST /orders/RMA/{ScopeId}/{OrderNumber}/Guest Create RMA Guest - {CreateRmaGuestRequest}
OrdersApi CreateRmaRegisteredRequestRMAScopeIdOrderNumberCustomerIdRegisteredPost POST /orders/RMA/{ScopeId}/{OrderNumber}/{CustomerId}/Registered Create RMA registered customer - {CreateRmaRegisteredRequest}
OrdersApi CreateShipmentDocumentRequestScopeIdOrderIdshipmentsShipmentIddocumentsNamePost POST /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/documents/{Name} Create a shipment document. - {CreateShipmentDocumentRequest}
OrdersApi DeleteShipmentDocumentRequestScopeIdOrderIdshipmentsShipmentIddocumentsNameDelete DELETE /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/documents/{Name} Delete a shipment document. - {DeleteShipmentDocumentRequest}
OrdersApi FindOrdersCountRequestScopeIdcountPost POST /orders/{ScopeId}/count Return to number of orders matching the search criteria - {FindOrdersCountRequest}
OrdersApi FindOrdersRequestScopeIdfindPost POST /orders/{ScopeId}/find Search for orders - {FindOrdersRequest}
OrdersApi FindShipmentDocumentsRequestScopeIdshipmentsdocumentsfindPost POST /orders/{ScopeId}/shipments/documents/find Retrieve shipment documents - {FindShipmentDocumentsRequest}
OrdersApi FindShipmentDocumentsSummariesRequestScopeIdshipmentsdocumentssummariesfindPost POST /orders/{ScopeId}/shipments/documents/summaries/find Retrieve shipment documents summaries - {FindShipmentDocumentsSummariesRequest}
OrdersApi GetAvailableTaxProvidersRequestavailableTaxProvidersGet GET /orders/availableTaxProviders Retrieve all the tax providers available in the system - {GetAvailableTaxProvidersRequest}
OrdersApi GetCustomerLastOrderRequestScopeIdCustomerIdlastOrderGet GET /orders/{ScopeId}/{CustomerId}/lastOrder Get customer last order - {GetCustomerLastOrderRequest}
OrdersApi GetOrderByIdRequestScopeIdOrderIdGet GET /orders/{ScopeId}/{OrderId} Retrieve an order - {GetOrderByIdRequest}
OrdersApi GetOrderByNumberRequestScopeIdbyNumberOrderNumberGet GET /orders/{ScopeId}/byNumber/{OrderNumber} Retrieve an order - {GetOrderByNumberRequest}
OrdersApi GetOrderFulfillmentStateRequestScopeIdOrderIdfulfillmentStateGet GET /orders/{ScopeId}/{OrderId}/fulfillmentState Retrieve the fulfillment state of an order and each of its shipments - {GetOrderFulfillmentStateRequest}
OrdersApi GetOrderHistoryRequestScopeIdorderhistoryGet GET /orders/{ScopeId}/orderhistory Get history items related to specified order - {GetOrderHistoryRequest}
OrdersApi GetOrderNotesRequestScopeIdOrderIdnotesGet GET /orders/{ScopeId}/{OrderId}/notes Get order notes - {GetOrderNotesRequest}
OrdersApi GetOrderSettingsRequestsettingsGet GET /orders/settings Get the order settings - {GetOrderSettingsRequest}
OrdersApi GetPrintableOrderUriRequestScopeIdOrderIdprinturiGet GET /orders/{ScopeId}/{OrderId}/printuri Get the uri of printable version of the order - {GetPrintableOrderUriRequest}
OrdersApi GetPrintableOrdersUriRequestScopeIdprintOrdersPost POST /orders/{ScopeId}/printOrders Get the uri of printable version of a list of order - {GetPrintableOrdersUriRequest}
OrdersApi GetRmaRequestRMAScopeIdOrderNumberRmaNumberGet GET /orders/RMA/{ScopeId}/{OrderNumber}/{RmaNumber} Retrieves RMA and items - {GetRmaRequest}
OrdersApi GetRmasByOrderRequestRMAScopeIdOrderNumberGet GET /orders/RMA/{ScopeId}/{OrderNumber} Retrieves all RMAs for an order - {GetRmasByOrderRequest}
OrdersApi GetShipmentDocumentRequestScopeIdOrderIdshipmentsShipmentIddocumentsNameGet GET /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/documents/{Name} Retrieve a shipment document - {GetShipmentDocumentRequest}
OrdersApi GetShipmentNotesRequestScopeIdShipmentIdshipmentnotesGet GET /orders/{ScopeId}/{ShipmentId}/shipment/notes Get shipment notes - {GetShipmentNotesRequest}
OrdersApi GetTaxCategoriesRequesttaxCategoriesGet GET /orders/taxCategories Retrieve the list of tax categories in the system - {GetTaxCategoriesRequest}
OrdersApi GetTaxProviderByScopeRequesttaxProviderByScopeGet GET /orders/taxProviderByScope Retrieve the tax provider for a scope - {GetTaxProviderByScopeRequest}
OrdersApi PostProcessOrderRequestScopeIdOrderIdpostProcessPost POST /orders/{ScopeId}/{OrderId}/postProcess Queue a post processing task for a given order - {PostProcessOrderRequest}
OrdersApi RefreshPaymentOrderRequestScopeIdOrderIdpaymentsPaymentIdrefreshPost POST /orders/{ScopeId}/{OrderId}/payments/{PaymentId}/refresh Refresh the payment of an order - {RefreshPaymentOrderRequest}
OrdersApi RefundPaymentRequestScopeIdOrderIdpaymentsPaymentIdrefundPost POST /orders/{ScopeId}/{OrderId}/payments/{PaymentId}/refund Refund the payment of an order - {RefundPaymentRequest}
OrdersApi RenderOrderShipmentTemplateRequestScopeIdOrderIdshipmentsShipmentIdrenderTemplateGet GET /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/renderTemplate Render a shipment's template. - {RenderOrderShipmentTemplateRequest}
OrdersApi ReportShipmentFulfillmentFailureRequestScopeIdOrderIdshipmentsShipmentIdstatefailurePost POST /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/state/failure Sets the state of a shipment to failed and halts all further processing - {ReportShipmentFulfillmentFailureRequest}
OrdersApi RestartShipmentFulfillmentProcessingRequestScopeIdOrderIdshipmentsShipmentIdfulfillmentStaterestartTaskPost POST /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/fulfillmentState/restartTask Restart the processing of a fulfillment after a failure - {RestartShipmentFulfillmentProcessingRequest}
OrdersApi ResumeOrderRequestScopeIdOrderIdresumePost POST /orders/{ScopeId}/{OrderId}/resume Resume the order which was on hold - {ResumeOrderRequest}
OrdersApi SaveOrderRequestScopeIdOrderIdPost POST /orders/{ScopeId}/{OrderId} Used to update an existing order based on the provided Order. - {SaveOrderRequest}
OrdersApi SetAdjustmentOrderRequestScopeIdOrderIdshipmentsShipmentIdadjustmentCreate PUT /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/adjustment Set the adjustment of a shipment - {SetAdjustmentOrderRequest}
OrdersApi SettlePaymentOrderRequestScopeIdOrderIdpaymentsPaymentIdsettlePost POST /orders/{ScopeId}/{OrderId}/payments/{PaymentId}/settle Settle the payment of an order - {SettlePaymentOrderRequest}
OrdersApi ShipmentSplitRequestScopeIdOrderIdshipmentsShipmentIdsplitCreate PUT /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/split Splits a shipment and queues post processing on the new shipment - {ShipmentSplitRequest}
OrdersApi StartNewShipmentFulfillmentWorkflowRequestScopeIdOrderIdshipmentsShipmentIdfulfillmentStatestartNewWorkflowPost POST /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/fulfillmentState/startNewWorkflow Start the workflow of a fulfillment from the beginning - {StartNewShipmentFulfillmentWorkflowRequest}
OrdersApi UpdateRmaRequestRMAScopeIdOrderNumberRmaNumberCreate PUT /orders/RMA/{ScopeId}/{OrderNumber}/{RmaNumber} Update RMA and items - {UpdateRmaRequest}
OrdersApi UpdateShipmentDocumentRequestScopeIdOrderIdshipmentsShipmentIddocumentsNameCreate PUT /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/documents/{Name} Update a shipment document. - {UpdateShipmentDocumentRequest}
OrdersApi UpdateShipmentFulfillmentStateRequestScopeIdOrderIdshipmentsShipmentIdstateCreate PUT /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/state Update the current state of a shipment - {UpdateShipmentFulfillmentStateRequest}
OrdersApi UpdateShipmentFulfillmentWorkflowXamlPathRequestScopeIdOrderIdshipmentsShipmentIdWorkflowXamlPathCreate PUT /orders/{ScopeId}/{OrderId}/shipments/{ShipmentId}/WorkflowXamlPath Update the path of the fulfillment workflow of a shipment. - {UpdateShipmentFulfillmentWorkflowXamlPathRequest}
OrganizationsApi CreateOrganizationRequestScopeIdPost POST /organizations/{ScopeId} Create an organization - {CreateOrganizationRequest}
OrganizationsApi FindOrganizationsRequestScopeIdfindPost POST /organizations/{ScopeId}/find Search for Organizations based on search terms - {FindOrganizationsRequest}
OrganizationsApi GetCustomersByOrganizationNameRequestScopeIdbyNameNamecustomersGet GET /organizations/{ScopeId}/byName/{Name}/customers Retrieve Customers based on the organization name - {GetCustomersByOrganizationNameRequest}
OrganizationsApi GetCustomersByOrganizationRequestScopeIdOrganizationIdcustomersGet GET /organizations/{ScopeId}/{OrganizationId}/customers Retrieve Customers based on the organization id - {GetCustomersByOrganizationRequest}
OrganizationsApi GetOrganizationByNameRequestScopeIdbyNameNameGet GET /organizations/{ScopeId}/byName/{Name} Retreive a specific organization by name - {GetOrganizationByNameRequest}
OrganizationsApi GetOrganizationRequestScopeIdOrganizationIdGet GET /organizations/{ScopeId}/{OrganizationId} Retreive a specific organization - {GetOrganizationRequest}
OrganizationsApi UpdateOrganizationRequestScopeIdOrganizationIdCreate PUT /organizations/{ScopeId}/{OrganizationId} Update an organization - {UpdateOrganizationRequest}
PickingMissionsApi AssignPickerToPickingMissionRequestScopeIdIdassignPickerPost POST /pickingMissions/{ScopeId}/{Id}/assignPicker Assigns a picker to the specified picking mission - {AssignPickerToPickingMissionRequest}
PickingMissionsApi CancelPickingMissionAssemblyRequestScopeIdIdcancelAssemblyPost POST /pickingMissions/{ScopeId}/{Id}/cancelAssembly Cancels the assembly of a picking mission which is currently in progress - {CancelPickingMissionAssemblyRequest}
PickingMissionsApi CancelPickingMissionRequestScopeIdIdcancelPost POST /pickingMissions/{ScopeId}/{Id}/cancel Cancels the specified picking mission - {CancelPickingMissionRequest}
PickingMissionsApi CompletePickingMissionAssemblyRequestScopeIdIdcompleteAssemblyPost POST /pickingMissions/{ScopeId}/{Id}/completeAssembly Completes the specified picking mission with the list of picked quantity items - {CompletePickingMissionAssemblyRequest}
PickingMissionsApi CreatePickingMissionRequestScopeIdPost POST /pickingMissions/{ScopeId} Creates a new picking mission for a fulfillment location and a list of mission items - {CreatePickingMissionRequest}
PickingMissionsApi GetFulfillmentLocationPickingMissionsRequestScopeIdbyLocationFulfillmentLocationIdGet GET /pickingMissions/{ScopeId}/byLocation/{FulfillmentLocationId} Gets the list of picking missions for a fulfillment location and optionally filtered by status - {GetFulfillmentLocationPickingMissionsRequest}
PickingMissionsApi GetOrderPickingMissionsRequestScopeIdbyOrderOrderIdGet GET /pickingMissions/{ScopeId}/byOrder/{OrderId} Gets the list of picking missions for an order and optionally filtered by fulfillment location and/or status - {GetOrderPickingMissionsRequest}
PickingMissionsApi GetPickingMissionRequestScopeIdIdGet GET /pickingMissions/{ScopeId}/{Id} Gets a picking mission by its identifier - {GetPickingMissionRequest}
PickingMissionsApi GetShipmentPickingMissionsRequestScopeIdbyShipmentShipmentIdGet GET /pickingMissions/{ScopeId}/byShipment/{ShipmentId} Gets the list of picking missions for a shipment and optionally filtered by fulfillment location and/or status - {GetShipmentPickingMissionsRequest}
PickingMissionsApi SavePickingMissionAssemblyProgressRequestScopeIdIdsaveAssemblyProgressCreate PUT /pickingMissions/{ScopeId}/{Id}/saveAssemblyProgress Saves the assembly progress made on the specified picking mission with the list of picked quantity items - {SavePickingMissionAssemblyProgressRequest}
PickingMissionsApi StartPickingMissionAssemblyRequestScopeIdIdstartAssemblyPost POST /pickingMissions/{ScopeId}/{Id}/startAssembly Starts the assembly of the specified picking mission - {StartPickingMissionAssemblyRequest}
PickingMissionsApi UnassignPickerFromPickingMissionRequestScopeIdIdunassignPickerPost POST /pickingMissions/{ScopeId}/{Id}/unassignPicker Unassigns the picker from the specified picking mission - {UnassignPickerFromPickingMissionRequest}
PickingMissionsApi UpdatePickingMissionRequestScopeIdIdCreate PUT /pickingMissions/{ScopeId}/{Id} Updates mission items of the specified picking mission - {UpdatePickingMissionRequest}
ProcessedOrdersApi ReleaseOrderLockForShipmentRequestScopeIdOrderIdreleaselockPost POST /processedOrders/{ScopeId}/{OrderId}/releaselock Release a lock on a given order for a shipment. - {ReleaseOrderLockForShipmentRequest}
ProcessedOrdersApi SaveProcessedOrderRequestScopeIdOrderIdPost POST /processedOrders/{ScopeId}/{OrderId} Update an existing order based on the provided Order. - {SaveProcessedOrderRequest}
ProcessedOrdersApi TryAcquireOrderLockForShipmentRequestScopeIdOrderIdlockPost POST /processedOrders/{ScopeId}/{OrderId}/lock Acquire a lock on a given order for a shipment. - {TryAcquireOrderLockForShipmentRequest}
ProductsApi AddFromGlobalRequestScopeIdfromGlobalPost POST /products/{ScopeId}/fromGlobal Copies products from Global scope to a sales scope - {AddFromGlobalRequest}
ProductsApi AddOrUpdatePriceListRequestScopeIdpriceListsPost POST /products/{ScopeId}/priceLists Adds or updates the given price lists into the specified scope - {AddOrUpdatePriceListRequest}
ProductsApi AddPriceListEntryRequestScopeIdProductIdpriceListEntriesPost POST /products/{ScopeId}/{ProductId}/priceListEntries Adds a price List Entry - {AddPriceListEntryRequest}
ProductsApi BulkAssignProductCategoriesRequestScopeIdbulkAssignCategoriesPost POST /products/{ScopeId}/bulkAssignCategories Starts a task that updates category associations for multiple products - {BulkAssignProductCategoriesRequest}
ProductsApi BulkRevertProductChangesRequestScopeIdbulkRevertPost POST /products/{ScopeId}/bulkRevert Starts a task that reverts not published product changes for multiple products by replacing working copies of products with their published counterparts - {BulkRevertProductChangesRequest}
ProductsApi BulkUpdatePublicationStatusRequestScopeIdbulkUpdatePublicationStatusPost POST /products/{ScopeId}/bulkUpdatePublicationStatus Starts a task that updates publication status for multiple products - {BulkUpdatePublicationStatusRequest}
ProductsApi CalculatePricesofProductsRequestScopeIdpricesPost POST /products/{ScopeId}/prices Retrieve the price of a product - {CalculatePricesofProductsRequest}
ProductsApi CalculateProductPriceRequestScopeIdProductIdpricePost POST /products/{ScopeId}/{ProductId}/price Retrieve the price of a product - {CalculateProductPriceRequest}
ProductsApi CopyProductRequestScopeIdProductIdcopyNewProductIdCreate PUT /products/{ScopeId}/{ProductId}/copy/{NewProductId} A request to copy a product - {CopyProductRequest}
ProductsApi CreatePriceListRequestScopeIdpriceListsPriceListIdPost POST /products/{ScopeId}/priceLists/{PriceListId} Creates a price list into the specified scope - {CreatePriceListRequest}
ProductsApi CreateProductRequestScopeIdPost POST /products/{ScopeId} Creates a product in the specified scope - {CreateProductRequest}
ProductsApi DeletePriceListEntryRequestScopeIdProductIdpriceListEntriesPriceListIdDelete DELETE /products/{ScopeId}/{ProductId}/priceListEntries/{PriceListId} Deletes a price List Entry - {DeletePriceListEntryRequest}
ProductsApi DeletePriceListRequestScopeIdpriceListsPriceListIdDelete DELETE /products/{ScopeId}/priceLists/{PriceListId} Deletes a price list - {DeletePriceListRequest}
ProductsApi DeleteProductByIdRequestScopeIdproductProductIdDelete DELETE /products/{ScopeId}/product/{ProductId} Deletes product from the scope and all child scopes - {DeleteProductByIdRequest}
ProductsApi DeleteProductByIdV2Requestv2ScopeIdProductIdDelete DELETE /products/v2/{ScopeId}/{ProductId} Deletes product from the scope and all child scopes - {DeleteProductByIdV2Request}
ProductsApi DeleteProductDraftRequestScopeIddraftProductIdDelete DELETE /products/{ScopeId}/draft/{ProductId} Delete a product draft - {DeleteProductDraftRequest}
ProductsApi DeleteProductSettingsEntryRequestsettingsEntryDelete DELETE /products/settings/{Entry} Delete a setting used in product module - {DeleteProductSettingsEntryRequest}
ProductsApi DeleteProductsRequestScopeIdbulkDeletePost POST /products/{ScopeId}/bulkDelete Starts a task that deletes multiple products - {DeleteProductsRequest}
ProductsApi DeleteUnusedMediaStorageRequestmediastorageDelete DELETE /products/media/storage Cleanup unused media storage - {DeleteUnusedMediaStorageRequest}
ProductsApi FindPriceListsRequestScopeIdpriceListsfindGet GET /products/{ScopeId}/priceLists/find Find all price lists - {FindPriceListsRequest}
ProductsApi FindProductPricesRequestScopeIdproductPricesPost POST /products/{ScopeId}/productPrices Retrieve the price of a set of Product and its Variants - {FindProductPricesRequest}
ProductsApi GetEffectivePriceEntryInfoRequestScopeIdProductIdeffectivePriceEntryInfoGet GET /products/{ScopeId}/{ProductId}/effectivePriceEntryInfo Retrieves the Price List Info for a product at a specific DateTime - {GetEffectivePriceEntryInfoRequest}
ProductsApi GetMediaBySkuRequestScopeIdbySkuSkumediaPost POST /products/{ScopeId}/bySku/{Sku}/media Retrieve the media by sku, it can be the product or the variant sku - {GetMediaBySkuRequest}
ProductsApi GetMediaRequestScopeIdProductIdmediaMediaIdGet GET /products/{ScopeId}/{ProductId}/media/{MediaId} Retrieve a media by Id - {GetMediaRequest}
ProductsApi GetMediaSettingsRequestmediasettingsGet GET /products/media/settings Get the settings used in products media - {GetMediaSettingsRequest}
ProductsApi GetPriceListEntriesRequestScopeIdProductIdpriceListEntriesGet GET /products/{ScopeId}/{ProductId}/priceListEntries Retrieve price list entries - {GetPriceListEntriesRequest}
ProductsApi GetPriceListsRequestScopeIdpriceListsGet GET /products/{ScopeId}/priceLists Gets all price lists - {GetPriceListsRequest}
ProductsApi GetProductAttributesRequestattributesGet GET /products/attributes/ Retrieve and merge all the product attributes from all product definitions - {GetProductAttributesRequest}
ProductsApi GetProductDefinitionRequestdefinitionsNameGet GET /products/definitions/{Name} Retrieve the entity definition defined in the system related to the Name parameter specified in the request - {GetProductDefinitionRequest}
ProductsApi GetProductDefinitionsRequestdefinitionsGet GET /products/definitions Retrieve the entity definitions defined in the system related to the EntityType parameter specified in the request - {GetProductDefinitionsRequest}
ProductsApi GetProductDraftRequestScopeIddraftProductIdGet GET /products/{ScopeId}/draft/{ProductId} Retrieve a product draft by product id - {GetProductDraftRequest}
ProductsApi GetProductDraftStatesRequestScopeIddraftStatesProductIdGet GET /products/{ScopeId}/draftStates/{ProductId} Retrieve a product draft states by product id - {GetProductDraftStatesRequest}
ProductsApi GetProductPriceEntriesRequestScopeIdProductIdproductPriceEntriesPost POST /products/{ScopeId}/{ProductId}/productPriceEntries Retrieve product prices by Id - {GetProductPriceEntriesRequest}
ProductsApi GetProductRelationshipsRequestScopeIdProductIdrelationshipsGet GET /products/{ScopeId}/{ProductId}/relationships Retrieve a product relationships - {GetProductRelationshipsRequest}
ProductsApi GetProductRequestScopeIdProductIdGet GET /products/{ScopeId}/{ProductId} Retrieve a product by Id - {GetProductRequest}
ProductsApi GetProductSettingsRequestsettingsGet GET /products/settings Get the settings used in product module - {GetProductSettingsRequest}
ProductsApi GetProductV2Requestv2ScopeIdProductIdGet GET /products/v2/{ScopeId}/{ProductId} Retrieve a product by Id - {GetProductV2Request}
ProductsApi GetProductsByIdsRequestScopeIdbyIdsPost POST /products/{ScopeId}/byIds Retrieve products by Ids - {GetProductsByIdsRequest}
ProductsApi GetProductsByIdsV2Requestv2ScopeIdbyIdsPost POST /products/v2/{ScopeId}/byIds Retrieve products by Ids - {GetProductsByIdsV2Request}
ProductsApi GetProductsByPublicationStatusRequestScopeIdbyPublicationStatusPost POST /products/{ScopeId}/byPublicationStatus Retrieve specified properties of all products with a given publication status and categories - {GetProductsByPublicationStatusRequest}
ProductsApi GetProductsBySkuRequestScopeIdbySkuSkuGet GET /products/{ScopeId}/bySku/{Sku} Retrieve the products by sku, it can be the product or the variant sku - {GetProductsBySkuRequest}
ProductsApi GetProductsBySkuV2Requestv2ScopeIdbySkuSkuGet GET /products/v2/{ScopeId}/bySku/{Sku} Retrieve the products by sku, it can be the product or the variant sku - {GetProductsBySkuV2Request}
ProductsApi GetProductsBySkusV2Requestv2ScopeIdbySkusPost POST /products/v2/{ScopeId}/bySkus Retrieve products by SKU-s - {GetProductsBySkusV2Request}
ProductsApi GetProductsCountByCategoryRequestScopeIdCategoryIdcountGet GET /products/{ScopeId}/{CategoryId}/count Retrieve the numbers of products by category - {GetProductsCountByCategoryRequest}
ProductsApi GetProductsPriceEntriesRequestScopeIdproductPriceEntriesPost POST /products/{ScopeId}/productPriceEntries Retrieve product prices by Id - {GetProductsPriceEntriesRequest}
ProductsApi GetProductsPropertiesByCategoryRequestScopeIdbyCategoryIdCategoryIdGet GET /products/{ScopeId}/byCategoryId/{CategoryId} Retrieve specified properties of all products in a given category - {GetProductsPropertiesByCategoryRequest}
ProductsApi GetProductsPropertiesByDraftStateAndCategoriesRequestScopeIdbyDraftStateAndCategoriesPost POST /products/{ScopeId}/byDraftStateAndCategories Retrieve specified properties of all products in a given state and categories - {GetProductsPropertiesByDraftStateAndCategoriesRequest}
ProductsApi GetProductsPropertiesByDraftStateRequestScopeIdbyDraftStateDraftStateGet GET /products/{ScopeId}/byDraftState/{DraftState} Retrieve specified properties of all products in a given state - {GetProductsPropertiesByDraftStateRequest}
ProductsApi GetProductsPropertiesFlagAsNewRequestScopeIdflagAsNewGet GET /products/{ScopeId}/flagAsNew Retrieve specified properties of all products flagged as new - {GetProductsPropertiesFlagAsNewRequest}
ProductsApi GetProductsPropertiesWithNotificationRequestScopeIdwithNotificationGet GET /products/{ScopeId}/withNotification Retrieve properties of all product with notification - {GetProductsPropertiesWithNotificationRequest}
ProductsApi GetProductsStatisticsRequestScopeIdstatisticsGet GET /products/{ScopeId}/statistics Gets statistics for products - {GetProductsStatisticsRequest}
ProductsApi GetQuickLinksCountDetailsRequestquicklinksGet GET /products/quicklinks Retrieve the products quick links count - {GetQuickLinksCountDetailsRequest}
ProductsApi GetVariantsByProductRequestScopeIdProductIdvariantsGet GET /products/{ScopeId}/{ProductId}/variants Retrieve all the product's variants - {GetVariantsByProductRequest}
ProductsApi ProductExistsRequestexistsScopeIdProductIdGet GET /products/exists/{ScopeId}/{ProductId} Checks whether the product exists in the specified scope - {ProductExistsRequest}
ProductsApi RepairProductInheritanceRequestScopeIdProductIdrepairInheritanceCreate PUT /products/{ScopeId}/{ProductId}/repairInheritance Repair Broken Inheritence for the product - {RepairProductInheritanceRequest}
ProductsApi RevertProductChangesRequestScopeIdrevertPost POST /products/{ScopeId}/revert Reverts not published product changes by replacing working copies of products with their published counterparts - {RevertProductChangesRequest}
ProductsApi SyncProductRequestsyncScopeIdProductIdCreate PUT /products/sync/{ScopeId}/{ProductId} Synchronizes a product - {SyncProductRequest}
ProductsApi UpdateMediaResizedInstancesRequestScopeIdProductIdmediaMediaIdresizedCreate PUT /products/{ScopeId}/{ProductId}/media/{MediaId}/resized Update media resized instances - {UpdateMediaResizedInstancesRequest}
ProductsApi UpdateMediaSettingsRequestmediasettingsCreate PUT /products/media/settings Update the settings used in product media - {UpdateMediaSettingsRequest}
ProductsApi UpdatePriceListEntryRequestScopeIdProductIdpriceListEntriesCreate PUT /products/{ScopeId}/{ProductId}/priceListEntries Updates a price List Entry - {UpdatePriceListEntryRequest}
ProductsApi UpdatePriceListRequestScopeIdpriceListsPriceListIdCreate PUT /products/{ScopeId}/priceLists/{PriceListId} Updates a price list in the specified scope - {UpdatePriceListRequest}
ProductsApi UpdateProductDraftRequestScopeIddraftProductIdPost POST /products/{ScopeId}/draft/{ProductId} Update a product draft - {UpdateProductDraftRequest}
ProductsApi UpdateProductPublicationStatusRequestScopeIdpublicationStatusPost POST /products/{ScopeId}/publicationStatus Updates publication status for a list of products - {UpdateProductPublicationStatusRequest}
ProductsApi UpdateProductRequestScopeIdProductIdCreate PUT /products/{ScopeId}/{ProductId} Updates a product - {UpdateProductRequest}
ProductsApi UpdateProductSettingsRequestsettingsCreate PUT /products/settings Update the settings used in product module - {UpdateProductSettingsRequest}
ProductsApi UpdateVariantsPriceListEntryRequestScopeIdProductIdvariantsPricesPriceListIdCreate PUT /products/{ScopeId}/{ProductId}/variantsPrices/{PriceListId} Batch update all variants price for a product for a specific pricelist - {UpdateVariantsPriceListEntryRequest}
ProductsApi UploadMediaRequestmediaScopeIdProductIduploadPost POST /products/media/{ScopeId}/{ProductId}/upload Uploads a media file and attaches it to the product/variant - {UploadMediaRequest}
PromotionApi ProcessPromotionEngineRequestenginePost POST /promotion/engine/ Invoke the promotions evaluation of a given Cart - {ProcessPromotionEngineRequest}
PromotionsApi ExportCouponCodesRequestPromotionIdcouponsexportPost POST /promotions/{PromotionId}/coupons/export Export a promotion's coupon codes list - {ExportCouponCodesRequest}
PromotionsApi FindPromoCodesRequestScopeIdPromotionIdpromoCodesPost POST /promotions/{ScopeId}/{PromotionId}/promoCodes Retrieve the list of the promotion's promo codes - {FindPromoCodesRequest}
PromotionsApi GeneratePromoCodesRequestScopeIdPromotionIdpromoCodesgeneratePost POST /promotions/{ScopeId}/{PromotionId}/promoCodes/generate Generate promo codes for the promotion - {GeneratePromoCodesRequest}
PromotionsApi GetPromoCodesCountRequestScopeIdPromotionIdpromoCodescountGet GET /promotions/{ScopeId}/{PromotionId}/promoCodes/count Retrieve the number of promo codes associated to a promotion with multiple promo codes - {GetPromoCodesCountRequest}
PromotionsApi ImportCouponCodesRequestPromotionIdcouponsimportPost POST /promotions/{PromotionId}/coupons/import Import (insert or update) a promotion's coupons - {ImportCouponCodesRequest}
PromotionsApi ValidatePromoCodeRequestScopeIdPromotionIdpromoCodesPromoCodevalidatePost POST /promotions/{ScopeId}/{PromotionId}/promoCodes/{PromoCode}/validate Validate if the promo code can be created - {ValidatePromoCodeRequest}
ProvidersApi CreateOrUpdateFulfillmentProviderRequestScopeIdfulfillmentCreate PUT /providers/{ScopeId}/fulfillment Create or update a fulfillment provider - {CreateOrUpdateFulfillmentProviderRequest}
ProvidersApi DeleteFulfillmentProviderRequestScopeIdfulfillmentIdDelete DELETE /providers/{ScopeId}/fulfillment/{Id} Delete a fulfillment provider - {DeleteFulfillmentProviderRequest}
ProvidersApi GetCarrierProvidersRequestScopeIdcarrierGet GET /providers/{ScopeId}/carrier Get the carrier providers information - {GetCarrierProvidersRequest}
ProvidersApi GetFulfillmentProvidersMetadataRequestfulfillmentmetadataGet GET /providers/fulfillment/metadata Get the fulfillment providers information - {GetFulfillmentProvidersMetadataRequest}
ProvidersApi GetFulfillmentProvidersRequestScopeIdfulfillmentGet GET /providers/{ScopeId}/fulfillment Get the fulfillment providers information - {GetFulfillmentProvidersRequest}
ProvidersApi GetPaymentProvidersRequestScopeIdpaymentGet GET /providers/{ScopeId}/payment Get the payment providers information - {GetPaymentProvidersRequest}
ProvidersApi GetProvidersRequestScopeIdtypesGet GET /providers/{ScopeId}/types Retrieve all providers configured for the given scope - {GetProvidersRequest}
ProvidersApi ValidateProviderSettingsRequestvalidateProviderSettingsGet GET /providers/validateProviderSettings Validate the settings of a provider in the system - {ValidateProviderSettingsRequest}
RecurringOrdersApi AddOrUpdateRecurringOrderLineItemsRequestScopeIdlineItemsforCustomerCustomerIdCreate PUT /recurringOrders/{ScopeId}/lineItems/forCustomer/{CustomerId} Add or update a list of recurring order line items - {AddOrUpdateRecurringOrderLineItemsRequest}
RecurringOrdersApi CreateRecurringOrderProgramRequestprogramsPost POST /recurringOrders/programs Create a new recurring order program - {CreateRecurringOrderProgramRequest}
RecurringOrdersApi DeleteRecurringCartLineItemsRequestScopeIdcartsCustomerIdlineItemsDelete DELETE /recurringOrders/{ScopeId}/carts/{CustomerId}/lineItems Delete line items from a recurring cart - {DeleteRecurringCartLineItemsRequest}
RecurringOrdersApi DeleteRecurringOrderLineItemsRequestScopeIdCustomerIdlineItemsDelete DELETE /recurringOrders/{ScopeId}/{CustomerId}/lineItems Delete a recurring order line item - {DeleteRecurringOrderLineItemsRequest}
RecurringOrdersApi DeleteRecurringOrderProgramRequestprogramsRecurringOrderProgramNameDelete DELETE /recurringOrders/programs/{RecurringOrderProgramName} Delete a new recurring order program - {DeleteRecurringOrderProgramRequest}
RecurringOrdersApi GetRecurringOrderLineItemRequestScopeIdlineItemsRecurringOrderLineItemIdGet GET /recurringOrders/{ScopeId}/lineItems/{RecurringOrderLineItemId} Get a recurring order line item - {GetRecurringOrderLineItemRequest}
RecurringOrdersApi GetRecurringOrderLineItemsForCustomerRequestScopeIdlineItemsbyCustomerCustomerIdGet GET /recurringOrders/{ScopeId}/lineItems/byCustomer/{CustomerId} Get the recurring order line items for a customer - {GetRecurringOrderLineItemsForCustomerRequest}
RecurringOrdersApi GetRecurringOrderProgramRequestprogramsRecurringOrderProgramNameGet GET /recurringOrders/programs/{RecurringOrderProgramName} Get a recurring order program - {GetRecurringOrderProgramRequest}
RecurringOrdersApi GetRecurringOrderProgramsByScopeIdRequestprogramsbyScopeScopeIdGet GET /recurringOrders/programs/byScope/{ScopeId} Get the recurring order programs associated to a scope - {GetRecurringOrderProgramsByScopeIdRequest}
RecurringOrdersApi RescheduleRecurringCartRequestScopeIdcartCartNamerescheduleCreate PUT /recurringOrders/{ScopeId}/cart/{CartName}/reschedule Reschedule the recurring order line items present in a recurring cart - {RescheduleRecurringCartRequest}
RecurringOrdersApi UpdateRecurringOrderProgramRequestprogramsRecurringOrderProgramNameCreate PUT /recurringOrders/programs/{RecurringOrderProgramName} Update a recurring order program - {UpdateRecurringOrderProgramRequest}
RelationshipsApi ClearRelationshipsRequestScopeIdEntityTypeEntityIdDelete DELETE /relationships/{ScopeId}/{EntityType}/{EntityId} Clears all relationships on the specified entity - {ClearRelationshipsRequest}
RelationshipsApi ClearRelationshipsV2Requestv2ScopeIdEntityTypeEntityIdDelete DELETE /relationships/v2/{ScopeId}/{EntityType}/{EntityId} Clears all relationships on the specified entity - {ClearRelationshipsV2Request}
RelationshipsApi CreateRelationshipsRequestScopeIdPost POST /relationships/{ScopeId} Creates relationships between entities - {CreateRelationshipsRequest}
RelationshipsApi CreateRelationshipsV2Requestv2ScopeIdPost POST /relationships/v2/{ScopeId} Creates relationships between entities - {CreateRelationshipsV2Request}
RelationshipsApi CreateSelfReferencingRelationshipsRequestScopeIdselfPost POST /relationships/{ScopeId}/self Creates self-referencing relationships between entities - {CreateSelfReferencingRelationshipsRequest}
RelationshipsApi CreateSelfReferencingRelationshipsV2Requestv2ScopeIdselfPost POST /relationships/v2/{ScopeId}/self Creates self-referencing relationships between entities - {CreateSelfReferencingRelationshipsV2Request}
RelationshipsApi DeleteRelationshipsRequestScopeIdDelete DELETE /relationships/{ScopeId} Deletes specified relationships - {DeleteRelationshipsRequest}
RelationshipsApi DeleteRelationshipsV2Requestv2ScopeIdDelete DELETE /relationships/v2/{ScopeId} Deletes specified relationships - {DeleteRelationshipsV2Request}
ReportingApi CreateSsrsReportPreviewRequestssrsreportsReportIdpreviewsPost POST /reporting/ssrs/reports/{ReportId}/previews Retrieve a preview image of a report in Ssrs - {CreateSsrsReportPreviewRequest}
ReportingApi ExportSsrsReportRequestssrsreportsReportIdexportPost POST /reporting/ssrs/reports/{ReportId}/export Export a report from Ssrs - {ExportSsrsReportRequest}
ReportingApi GetSsrsRenderingFormatsRequestssrsreportsrenderingformatsGet GET /reporting/ssrs/reports/renderingformats Retrieve a list of supported rendering formats for an Ssrs export - {GetSsrsRenderingFormatsRequest}
ReportingApi GetSsrsReportParametersRequestssrsreportsReportIdparametersPost POST /reporting/ssrs/reports/{ReportId}/parameters Retrieve a list of all report parameterss in Ssrs - {GetSsrsReportParametersRequest}
ReportingApi GetSsrsReportsRequestssrsreportsGet GET /reporting/ssrs/reports Retrieve a list of all reports in Ssrs - {GetSsrsReportsRequest}
RoleApi GetParentRolesRequestRoleIdparentsGet GET /role/{RoleId}/parents Retrieve the list of parent role of a child role - {GetParentRolesRequest}
RolesApi AddRoleChildRequestParentRoleIdChildRoleIdPost POST /roles/{ParentRoleId}/{ChildRoleId} Add a child role to a parent. - {AddRoleChildRequest}
RolesApi AddRoleChildToGlobalAdministratorRoleRequestsystemAdministratorChildRoleIdPost POST /roles/systemAdministrator/{ChildRoleId} This message is used to add a child role to the Global Administrator Role. - {AddRoleChildToGlobalAdministratorRoleRequest}
RolesApi AddRoleChildrenRequestParentRoleIdchildPost POST /roles/{ParentRoleId}/child Add a list of child role to a parent. - {AddRoleChildrenRequest}
RolesApi CreateCustomRoleRequestcustomNamePost POST /roles/custom/{Name} Create a new custom role. - {CreateCustomRoleRequest}
RolesApi CreateRoleRequestNamePost POST /roles/{Name} Create a new role. - {CreateRoleRequest}
RolesApi DeleteRoleRequestIdDelete DELETE /roles/{Id} Delete role. - {DeleteRoleRequest}
RolesApi GetCustomRolesRequestcustomGet GET /roles/custom Retrieve all the custom roles. - {GetCustomRolesRequest}
RolesApi GetRoleByIdRequestIdGet GET /roles/{Id} Retrieve the role by Id. - {GetRoleByIdRequest}
RolesApi GetRoleRequestModuleIdRoleNameGet GET /roles/{ModuleId}/{RoleName} Retrieve the role by name and module Id - {GetRoleRequest}
RolesApi GetRolesRequestGet GET /roles Retrieve all the roles - {GetRolesRequest}
RolesApi RemoveRoleChildRequestParentRoleIdChildRoleIdDelete DELETE /roles/{ParentRoleId}/{ChildRoleId} Remove a child role to a parent. - {RemoveRoleChildRequest}
RolesApi RemoveRoleChildrenRequestParentRoleIdchildDelete DELETE /roles/{ParentRoleId}/child Remove a list of children roles from a parent. - {RemoveRoleChildrenRequest}
RolesApi RoleIsHierarchicalChildOfParentRolesRequestChildRoleIdchildOfPost POST /roles/{ChildRoleId}/childOf Check if child role id is a hierarchical child of parent role ids. - {RoleIsHierarchicalChildOfParentRolesRequest}
RolesApi SaveCustomRoleRequestcustomRoleIdCreate PUT /roles/custom/{RoleId} Save the custom role. - {SaveCustomRoleRequest}
RolesApi UpdateRoleRequestIdCreate PUT /roles/{Id} Update an existing role. - {UpdateRoleRequest}
ScopesApi CreateScopeRequestScopeIdPost POST /scopes/{ScopeId} Create a scope - {CreateScopeRequest}
ScopesApi DeleteScopeRequestScopeIdDelete DELETE /scopes/{ScopeId} Delete a scope - {DeleteScopeRequest}
ScopesApi GetScopeChildrenRequestScopeIdchildrenGet GET /scopes/{ScopeId}/children Retreive the children of a specific scope - {GetScopeChildrenRequest}
ScopesApi GetScopeRequestScopeIdGet GET /scopes/{ScopeId} Retreive a specific scope - {GetScopeRequest}
ScopesApi UpdateScopeRequestScopeIdCreate PUT /scopes/{ScopeId} Update a scope - {UpdateScopeRequest}
SearchApi AddOrUpdateVariantSearchConfigurationRequestScopeIdconfigurationsvariantCreate PUT /search/{ScopeId}/configurations/variant Adds or updates the variant search configuration for the specified product definition. - {AddOrUpdateVariantSearchConfigurationRequest}
SearchApi AdvancedSearchRequestScopeIdCultureNameadvancedIndexNamePost POST /search/{ScopeId}/{CultureName}/advanced/{IndexName} Make a generic search - {AdvancedSearchRequest}
SearchApi GetVariantSearchConfigurationsRequestScopeIdconfigurationsvariantGet GET /search/{ScopeId}/configurations/variant Returns the list of variant search configurations in the system. - {GetVariantSearchConfigurationsRequest}
SearchApi IndexCustomersRequestindexescustomersCreate PUT /search/indexes/customers Start the customers indexing durable task - {IndexCustomersRequest}
SearchApi IndexInventoriesRequestindexesinventoriesCreate PUT /search/indexes/inventories Start the inventories indexing durable task - {IndexInventoriesRequest}
SearchApi IndexProductsRequestindexesproductsCreate PUT /search/indexes/products Start the products indexing durable tasks - {IndexProductsRequest}
SearchApi IndexStoresRequestindexesstoresCreate PUT /search/indexes/stores Start the stores indexing durable task - {IndexStoresRequest}
SearchApi SearchAvailableProductsByCategoryRequestScopeIdCultureNameavailableProductsbyCategoryCategoryNamePost POST /search/{ScopeId}/{CultureName}/availableProducts/byCategory/{CategoryName} Search for products available in the inventory using an optional search query - {SearchAvailableProductsByCategoryRequest}
SearchApi SearchAvailableProductsRequestScopeIdCultureNameavailableProductsPost POST /search/{ScopeId}/{CultureName}/availableProducts Search for products available in the inventory - {SearchAvailableProductsRequest}
SearchApi SearchBySearchQueryRequestScopeIdCultureNamebySearchQueryQueryTypeQueryNamePost POST /search/{ScopeId}/{CultureName}/bySearchQuery/{QueryType}/{QueryName} Search using a Search Query as a template - {SearchBySearchQueryRequest}
SearchApi SearchCustomersRequestScopeIdCultureNamecustomersPost POST /search/{ScopeId}/{CultureName}/customers Search for customers - {SearchCustomersRequest}
SearchApi SearchProductByIdsRequestScopeIdCultureNameproductsbyIdsPost POST /search/{ScopeId}/{CultureName}/products/byIds Search product by ids - {SearchProductByIdsRequest}
SearchApi SearchProductBySavedQueryRequestScopeIdCultureNameproductsbySavedQueryQueryIdPost POST /search/{ScopeId}/{CultureName}/products/bySavedQuery/{QueryId} Search product by saved query - {SearchProductBySavedQueryRequest}
SearchApi SearchProductRequestScopeIdCultureNameproductsPost POST /search/{ScopeId}/{CultureName}/products Search for product - {SearchProductRequest}
SearchApi SearchSimilarProductsRequestScopeIdCultureNameproductssimilarProductIdPost POST /search/{ScopeId}/{CultureName}/products/similar/{ProductId} Search for similar products - {SearchSimilarProductsRequest}
SearchqueriesApi CreateSearchQueryRequestScopeIdQueryTypeNamePost POST /searchqueries/{ScopeId}/{QueryType}/{Name} Creates a Search Query. - {CreateSearchQueryRequest}
SearchqueriesApi DeleteSearchQueryRequestScopeIdQueryTypeNameDelete DELETE /searchqueries/{ScopeId}/{QueryType}/{Name} Deletes a search query based on its Scope, its type and its name. - {DeleteSearchQueryRequest}
SearchqueriesApi FindSearchQueriesRequestScopeIdfindPost POST /searchqueries/{ScopeId}/find Finds search queries based on the Scope and the specified filters. - {FindSearchQueriesRequest}
SearchqueriesApi GetSearchQueryByNameRequestScopeIdQueryTypeNameGet GET /searchqueries/{ScopeId}/{QueryType}/{Name} Gets a search query based on its Scope, its type and its name. - {GetSearchQueryByNameRequest}
SearchqueriesApi UpdateSearchQueryRequestScopeIdQueryTypeNameCreate PUT /searchqueries/{ScopeId}/{QueryType}/{Name} Updates a Search Query. - {UpdateSearchQueryRequest}
SegmentApi CreateSegmentRequestPost POST /segment Create a segment - {CreateSegmentRequest}
SegmentApi UpdateSegmentRequestCreate PUT /segment Update a segment - {UpdateSegmentRequest}
SegmentsApi CreateOrUpdateSegmentRequestPost POST /segments Create or update a segment based on name - {CreateOrUpdateSegmentRequest}
SegmentsApi DeleteSegmentRequestSegmentIdDelete DELETE /segments/{SegmentId} Delete a segment - {DeleteSegmentRequest}
SegmentsApi FindSegmentsRequestfindPost POST /segments/find Search for segments matching the parameters - {FindSegmentsRequest}
SegmentsApi GetSegmentRequestSegmentIdGet GET /segments/{SegmentId} Retrieve a segment - {GetSegmentRequest}
SegmentsApi GetSegmentsRequestGet GET /segments Retrieve all segments - {GetSegmentsRequest}
ShipmentFulfillmentInfosApi GetCountShipmentFulfillmentInfosRequestScopeIdcountGet GET /shipmentFulfillmentInfos/{ScopeId}/count Get Number of shipment Fulfillment Infos - {GetCountShipmentFulfillmentInfosRequest}
ShipmentFulfillmentInfosApi GetNumberOfShipmentsForFulfillmentLocationRequestScopeIdnumberOfShipmentsForFulfillmentLocationFulfillmentLocationIdGet GET /shipmentFulfillmentInfos/{ScopeId}/numberOfShipmentsForFulfillmentLocation/{FulfillmentLocationId} Get the number of shipments for a fulfillment location - {GetNumberOfShipmentsForFulfillmentLocationRequest}
ShipmentFulfillmentInfosApi GetPrintableShipmentUriRequestScopeIdShipmentIdprinturiGet GET /shipmentFulfillmentInfos/{ScopeId}/{ShipmentId}/printuri Get the uri of printable version of the shipment - {GetPrintableShipmentUriRequest}
ShipmentFulfillmentInfosApi GetPrintableShipmentsUriRequestScopeIdprintShipmentsPost POST /shipmentFulfillmentInfos/{ScopeId}/printShipments Get the uri of printable version of a list of shipment - {GetPrintableShipmentsUriRequest}
ShipmentFulfillmentInfosApi GetShipmentFulfillmentInfosRequestScopeIdGet GET /shipmentFulfillmentInfos/{ScopeId} Get shipment Fulfillment Infos - {GetShipmentFulfillmentInfosRequest}
StoresApi CreateOrUpdateStoreByNumberRequestScopeIdNumberPost POST /stores/{ScopeId}/{Number} Create or update a store using its number - {CreateOrUpdateStoreByNumberRequest}
StoresApi DeleteStoreRequestScopeIdIdDelete DELETE /stores/{ScopeId}/{Id} Deletes a store using its Id - {DeleteStoreRequest}
StoresApi FindNearestStoresRequestScopeIdnearSearchTermsGet GET /stores/{ScopeId}/near/{SearchTerms} Find the nearest stores based on search terms - {FindNearestStoresRequest}
StoresApi FindStoresRequestScopeIdfindPost POST /stores/{ScopeId}/find Search for Stores based on search terms - {FindStoresRequest}
StoresApi GetStoreByNameRequestScopeIdbyNameNameGet GET /stores/{ScopeId}/byName/{Name} Retrieve a store using its name - {GetStoreByNameRequest}
StoresApi GetStoreByNumberRequestScopeIdbyNumberNumberGet GET /stores/{ScopeId}/byNumber/{Number} Retrieve a store using its number - {GetStoreByNumberRequest}
StoresApi GetStoreRequestScopeIdIdGet GET /stores/{ScopeId}/{Id} Retrieves a store using its Id - {GetStoreRequest}
TasksApi AddOrUpdateScheduledTaskTriggerscheduledTaskGroupTaskNametriggersTriggerGroupTriggerNameCreate PUT /tasks/scheduled/{TaskGroup}/{TaskName}/triggers/{TriggerGroup}/{TriggerName} Add or update a trigger of a scheduled task - {AddOrUpdateScheduledTaskTrigger}
TasksApi CancelTaskRequestTaskIdcancelPost POST /tasks/{TaskId}/cancel Cancels the specified long running (batch processing) task. - {CancelTaskRequest}
TasksApi DeleteAllScheduledTasksRequestscheduledallDelete DELETE /tasks/scheduled/all Remove all the scheduled task activities - {DeleteAllScheduledTasksRequest}
TasksApi DeleteScheduledTaskRequestscheduledGroupNameDelete DELETE /tasks/scheduled/{Group}/{Name} Remove a specific scheduled task activity - {DeleteScheduledTaskRequest}
TasksApi DeleteTaskInfoRequestTaskIdDelete DELETE /tasks/{TaskId} Delete a long running task - {DeleteTaskInfoRequest}
TasksApi GetAllScheduledTasksRequestscheduledallGet GET /tasks/scheduled/all Retrieve a list of all the scheduled tasks - {GetAllScheduledTasksRequest}
TasksApi GetRequesterTasksInfoRequestGet GET /tasks Retrieve a list of long running tasks for a specified requester - {GetRequesterTasksInfoRequest}
TasksApi GetRunningScheduledTasksRequestscheduledrunningGet GET /tasks/scheduled/running Retrieve the job info of the currently running scheduled tasks - {GetRunningScheduledTasksRequest}
TasksApi GetScheduledTaskRequestscheduledGroupNameGet GET /tasks/scheduled/{Group}/{Name} Retrieve a specfic scheduled task - {GetScheduledTaskRequest}
TasksApi GetTaskExecutionLogsRequestTaskIdlogsGet GET /tasks/{TaskId}/logs Retrieve the log entries from a long running task - {GetTaskExecutionLogsRequest}
TasksApi GetTaskInfoRequestTaskIdGet GET /tasks/{TaskId} Retrieve the state of a long running task - {GetTaskInfoRequest}
TasksApi GetTasksInfoByCorrelationIdRequestbyCorrelationIdIdGet GET /tasks/byCorrelationId/{Id} Retrieve the state of long running tasks by correlation id - {GetTasksInfoByCorrelationIdRequest}
TasksApi QueueActivityTaskRequestactivitiesTaskIdPost POST /tasks/activities/{TaskId} Queue a new task activity - {QueueActivityTaskRequest}
TasksApi QueueWorkflowTaskRequestworkflowsTaskIdPost POST /tasks/workflows/{TaskId} Queue a new task workflow - {QueueWorkflowTaskRequest}
TasksApi RemoveScheduledTaskTriggerRequestscheduledTaskGroupTaskNametriggersTriggerGroupTriggerNameDelete DELETE /tasks/scheduled/{TaskGroup}/{TaskName}/triggers/{TriggerGroup}/{TriggerName} Remove a given trigger of a scheduled task - {RemoveScheduledTaskTriggerRequest}
TasksApi ScheduleTaskActivityRequestscheduledactivitiesGroupNamePost POST /tasks/scheduled/activities/{Group}/{Name} Create a scheduled activity task based on a activity class - {ScheduleTaskActivityRequest}
TasksApi ScheduleTaskWorkflowRequestscheduledworkflowsGroupNamePost POST /tasks/scheduled/workflows/{Group}/{Name} Create a scheduled workflow task based on a workflow file - {ScheduleTaskWorkflowRequest}
TemplatesApi CreateOrUpdateTemplateVariableRequestScopeIdVariablesNameCreate PUT /templates/{ScopeId}/Variables/{Name} Create or update a template variable - {CreateOrUpdateTemplateVariableRequest}
TemplatesApi CreateTemplateRequestScopeIdTypeNamePost POST /templates/{ScopeId}/{Type}/{Name} Create a new template - {CreateTemplateRequest}
TemplatesApi DeleteTemplateRequestScopeIdTypeNameDelete DELETE /templates/{ScopeId}/{Type}/{Name} Delete a template - {DeleteTemplateRequest}
TemplatesApi DeleteTemplateVariableRequestScopeIdVariablesNameDelete DELETE /templates/{ScopeId}/Variables/{Name} Deletes a template variable - {DeleteTemplateVariableRequest}
TemplatesApi GetTemplateByNameRequestScopeIdTypeNameGet GET /templates/{ScopeId}/{Type}/{Name} Retrieves a template available for a scope and a name - {GetTemplateByNameRequest}
TemplatesApi GetTemplateVariablesRequestScopeIdVariablesGet GET /templates/{ScopeId}/Variables Gets a list of template variables for a scope - {GetTemplateVariablesRequest}
TemplatesApi GetTemplatesRequestScopeIdTypeGet GET /templates/{ScopeId}/{Type} Retrieve a list of all templates available for a scope and a type - {GetTemplatesRequest}
TemplatesApi UpdateTemplateRequestScopeIdTypeNameCultureCreate PUT /templates/{ScopeId}/{Type}/{Name}/{Culture} Update a template - {UpdateTemplateRequest}
TimezonesApi FindUtcOffsetForTimeZoneRequestconvertPost POST /timezones/convert Convert a UTC datetime to a specific TimeZone datetime - {FindUtcOffsetForTimeZoneRequest}
TimezonesApi GetTimeZonesRequestGet GET /timezones Retrieve a list of all time zones - {GetTimeZonesRequest}
TokenApi GetGuestTokenRequestcustomerguestGet GET /token/customer/guest Retrieve an authentication token for a guest customer to be able to access external tool like the product picker - {GetGuestTokenRequest}
TokenApi GetTokenRequestPost POST /token Retrieve an authentication token to be able to access external tool like the product picker - {GetTokenRequest}
UsersApi ActivateUserRequestUserNameactivatePost POST /users/{UserName}/activate Activate the user. - {ActivateUserRequest}
UsersApi ActivateUsersRequestactivateCreate PUT /users/activate Activate a batch of users using theirs usernames - {ActivateUsersRequest}
UsersApi CreateUserRequestUserNamePost POST /users/{UserName} Create a new user - {CreateUserRequest}
UsersApi DeactivateUserRequestUserNamedeactivatePost POST /users/{UserName}/deactivate Deactivate the user using its username - {DeactivateUserRequest}
UsersApi DeactivateUsersRequestdesactivateCreate PUT /users/desactivate Deactivate a batch of users using theirs usernames - {DeactivateUsersRequest}
UsersApi DeleteUserRequestUserNameDelete DELETE /users/{UserName} Delete the user. - {DeleteUserRequest}
UsersApi FindUsersByNameRequestfindPost POST /users/find Find the users by name. Search in userPrincipalName, displayName and givenName - {FindUsersByNameRequest}
UsersApi ForceChangeUserPasswordRequestUserNameforceChangePasswordPost POST /users/{UserName}/forceChangePassword Force the change of a user's password. - {ForceChangeUserPasswordRequest}
UsersApi GetAvailableDomainsRequestdomainsGet GET /users/domains Retrieve the available domains of the tenant. - {GetAvailableDomainsRequest}
UsersApi GetUserGroupsRequestUserNamegroupsGet GET /users/{UserName}/groups Retrieve the user's group(s). - {GetUserGroupsRequest}
UsersApi GetUserRequestUserNameGet GET /users/{UserName} Retrieve the user by its username - {GetUserRequest}
UsersApi ResetUserPasswordRequestUserNameresetUserPasswordCreate PUT /users/{UserName}/resetUserPassword Reset the user password. - {ResetUserPasswordRequest}
UsersApi SaveUserRequestUserNameCreate PUT /users/{UserName} Save the user. - {SaveUserRequest}
WarehousesApi CreateOrUpdateWarehouseByNumberRequestScopeIdcreateOrUpdateCreate PUT /warehouses/{ScopeId}/createOrUpdate Create or update a warehouse using its number - {CreateOrUpdateWarehouseByNumberRequest}
WarehousesApi CreateWarehouseRequestScopeIdPost POST /warehouses/{ScopeId} Creates a warehouse using the provided iD, if not provided, a new Id will be generated - {CreateWarehouseRequest}
WarehousesApi DeleteWarehouseRequestScopeIdIddeleteDelete DELETE /warehouses/{ScopeId}/{Id}/delete Deletes a warehouse using its Id - {DeleteWarehouseRequest}
WarehousesApi FindWarehousesRequestScopeIdfindPost POST /warehouses/{ScopeId}/find Search for warehouses based on search terms - {FindWarehousesRequest}
WarehousesApi GetWarehouseRequestScopeIdIdGet GET /warehouses/{ScopeId}/{Id} Retrieves a warehouse using its Id - {GetWarehouseRequest}
WarehousesApi UpdateWarehouseRequestScopeIdIdCreate PUT /warehouses/{ScopeId}/{Id} Update a warehouse using its Id - {UpdateWarehouseRequest}
WarehousesApi UpdateWarehouseScopeAssociationsRequestScopeIdIdAssociatedScopesCreate PUT /warehouses/{ScopeId}/{Id}/AssociatedScopes Updates the scope associations of a warehouse - {UpdateWarehouseScopeAssociationsRequest}

Documentation for Models

Documentation for Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

About

Based in the sample ASP.NET Core 5.0 reference application, powered by Microsoft, demonstrating a layered application architecture with monolithic deployment model this repository is a work in progress proof of concept integrating the Orckestra Commerce Cloud headless commerce services into the application and the Blazor admin

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 99.4%
  • HTML 0.4%
  • CSS 0.1%
  • SCSS 0.1%
  • Dockerfile 0.0%
  • Shell 0.0%