PRIMAVERA Lithium eCommerce Connect Service (ECCO) Client Library

Supports the integration with various eCommerce marketplaces and online stores.

Service Client

Class	Description
`ECommerceConnectClient`	The entry point of the eCommerce Connect Service client library.

Operations

Class	Name	Description
`AppStore`	App Store	Provides actions for integrating the service with the App Store.
`CatalogCategories`	Catalog Categories	Provides actions on catalog categories.
`CatalogItemImages`	Catalog Item Images	Provides actions on catalog item images.
`CatalogItems`	Catalog Items	Provides actions on catalog items.
`ClientSettings`	Client Settings	Provides actions that allow clients to manipulate their runtime settings.
`Configuration`	Configuration	Provides actions to collect configuration required by integrations.
`Dashboard`	Dashboard	Provides actions on dashboards.
`Feeds`	Feeds	Provides actions that publish feeds.
`Integrations`	Integrations	Provides actions on integrations.
`Orders`	Orders	Provides actions on orders.
`Provisioning`	Provisioning	Provides actions to provision/deprovision the usage of the ecco service.
`Reference`	Reference	Provides actions on reference data.
`Reset`	Reset	Provides actions to reset the state of the service.
`Returns`	Returns	Provides actions on returns.
`Shopify`	Shopify	Provides actions specifig for Shopify.
`Subscriptions`	Subscriptions	Provides action on subscriptions.

Models

Class	Name	Description
`AddCatalogItemImageRequest`	Add Catalog Item Image Request	Describes a request to add a catalog item image.
`AddressData`	Address Data	Describes an address.
`AppStoreRequestData`	App Store Request Data	Describes the payload received in a notification from the AppStore. Represents a request from the App Store.
`AttributeBindingData`	Attribute Binding Data	Describes the binding of an attribute for a specific channel.
`AttributeData`	Attribute Data	Describes an attribute.
`BagData`	Bag Data	Defines a bag of properties (for storing configuration).
`CatalogCategoryAttributeData`	Catalog Category Attribute Data	Describes an attribute used by a catalog category.
`CatalogCategoryData`	Catalog Category Data	Describes a catalog category.
`CatalogData`	Catalog Data	Describes a catalog available for configuration.
`CatalogFeedData`	Catalog Feed Data	Describes a record in the catalog feed.
`CatalogItemChannelCategoryData`	Catalog Item Channel Category Data	Describes the category in which a catalog item was published on a channel.
`CatalogItemChannelData`	Catalog Item Channel Data	Describes information about the publication of a catalog item in a channel.
`CatalogItemChannelOfferData`	Catalog Item Channel Offer Data	Describes information about the offer of a catalog item in a channel.
`CatalogItemConditionData`	Catalog Item Condition Data	Describes the condition of a catalog item.
`CatalogItemData`	Catalog Item Data	Describes a catalog item data.
`CatalogItemImageData`	Catalog Item Image Data	Describes a catalog item image.
`CatalogItemsPage`	Catalog Items Page	Describes a page of the list of catalog items.
`CatalogsData`	Catalogs Data	Describes the catalogs available for configuration.
`ClientSettingsData`	Client Settings Data	Describes client settings.
`CollectConfigurationRequest`	Collect Configuration Request	Describes a request to collect configuration for an integration.
`CompaniesData`	Companies Data	Describes the companies available for configuration.
`CompanyData`	Company Data	Describes a company available for configuration.
`ConfigurationsData`	Configurations Data	Defines the base model for all models that represent configurations.
`CreateIntegrationRequest`	Create Integration Request	Describes a request to create an integration.
`CustomerData`	Customer Data	Defines a customer.
`DashboardChartData`	Dashboard Chart Data	Describes a chart in a dashboard.
`DashboardChartDatasetData`	Dashboard Chart Dataset Data	Describes a data set of a chart in a dashboard.
`DashboardChartHeaderData`	Dashboard Chart Header Data	Describes the header of a chart in a dashboard.
`DashboardChartTitleData`	Dashboard Chart Title Data	Describes a title of a dashboard chart.
`DashboardData`	Dashboard Data	Describes a dashboard.
`DashboardIndicatorData`	Dashboard Indicator Data	Describes an indicator in a dashboard.
`EventPayload`	Event Payload	Defines the payload of the events sent to an on-premises client.
`EventResponsePayload`	Event Response Payload	Defines the payload of the events received from an on-premises client.
`ExportCatalogItemsRequest`	Export Catalog Items Request	Describes information about the catalog items to export .
`FinancialAccountData`	Financial Account Data	Describes a financial account available for configuration.
`FinancialAccountsData`	Financial Accounts Data	Describes the financial accounts available for configuration.
`GdprRequestData`	Gdpr Request Data	Describes a request concerning GDPR.
`ImportCatalogItemsRequest`	Import Catalog Items Request	Describes information about the catalog items to import.
`InstanceData`	Instance Data	Describes a client instance.
`IntegrationData`	Integration Data	Describes an integration.
`IntegrationHistoryApplicationData`	Integration History Application Data	Describes an integration created for an application.
`IntegrationHistoryData`	Integration History Data	Describes the history of integrations for a subscription.
`IntegrationLicensingData`	Integration Licensing Data	Describes information about the integration used for licensing.
`InvoiceTypeData`	Invoice Type Data	Describes an invoice type available for configuration.
`InvoiceTypesData`	Invoice Types Data	Describes the invoice types available for configuration.
`KeyDescriptionData`	Key Description Data	Defines the base model for all models that include a key and a description.
`OrderData`	Order Data	Describes an order.
`OrderIntegrationChannelData`	Order Integration Channel Data	Describes information about the integration of an order in a channel.
`OrderIntegrationInfoData`	Order Integration Info Data	Provides additional information about the integration of an order.
`OrderIntegrationProductData`	Order Integration Product Data	Describes information about the integration of an order in a product.
`OrderIntegrationStatusUpdateData`	Order Integration Status Update Data	Describes an update of the status of an order.
`OrderItemData`	Order Item Data	Describes an item in an order.
`OrderShippingItemData`	Order Shipping Item Data	Describes a shipping item in an order.
`OrdersPage`	Orders Page	Describes a page of the list of orders.
`OrderStatusData`	Order Status Data	Describes the status of an order.
`OrderTypeData`	Order Type Data	Describes an order type available for configuration.
`OrderTypesData`	Order Types Data	Describes the order types available for configuration.
`ProvisioningParametersData`	Provisioning Parameters Data	Describes information required to provision the ECCO service.
`RefreshCatalogItemsRequest`	Refresh Catalog Items Request	Describes a request to refresh catalog items.
`RefundReasonData`	Refund Reason Data	Describes a refund reason available for configuration.
`RefundReasonsData`	Refund Reasons Data	Describes the refund reasons available for configuration.
`RefundTypeData`	Refund Type Data	Describes a refund type available for configuration.
`RefundTypesData`	Refund Types Data	Describes the refund types available for configuration.
`ReturnData`	Return Data	Describes a return.
`ReturnIntegrationChannelData`	Return Integration Channel Data	Describes information about the integration of a return in a channel.
`ReturnIntegrationInfoData`	Return Integration Info Data	Provides additional information about the integration of a return.
`ReturnIntegrationProductData`	Return Integration Product Data	Describes information about the integration of a return in a product.
`ReturnIntegrationStatusUpdateData`	Return Integration Status Update Data	Describes an update of the status of a return.
`ReturnItemData`	Return Item Data	Describes a return item.
`ReturnsPage`	Returns Page	Describes a page of the list of returns.
`ReturnStatusData`	Return Status Data	Describes the status of a return.
`SalesChannelData`	Sales Channel Data	Describes a sales channel available for configuration.
`SalesChannelsData`	Sales Channels Data	Describes the sales channels available for configuration.
`SeriesData`	Series Data	Describes a series available for configuration.
`ShopifyCustomerDataRequestPayload`	Shopify Customer Data Request Payload	Describes the payload received from Shopify for the customers/data_request webhook.
`ShopifyCustomerPayload`	Shopify Customer Payload	Describes the payload received from Shopify for a customer.
`ShopifyCustomerRedactPayload`	Shopify Customer Redact Payload	Describes the payload received from Shopify for the customers/redact webhook.
`ShopifyDataRequestPayload`	Shopify Data Request Payload	Describes the payload received from Shopify for a data request.
`ShopifyOrderPayload`	Shopify Order Payload	Describes the payload received from Shopify for an order.
`ShopifyShopRedactPayload`	Shopify Shop Redact Payload	Describes the payload received from Shopify for the shop/redact webhook.
`SubscribeParameterRequest`	Subscribe Parameter Request	A set of parameters used while executing the provisioning of an ecco subscription.
`SubscribeParameterResponse`	Subscribe Parameter Response	A set of parameters used while executing the provisioning of an ecco subscription.
`SubscriptionData`	Subscription Data	Describes a customer subscription.
`SubscriptionDependentData`	Subscription Dependent Data	Defines the base model for all models that depend on the product subscription.
`UnsubscribeParameterRequest`	Unsubscribe Parameter Request	A set of parameters used while executing the deprovisioning of an ECCO subscription.
`UnsubscribeParameterResponse`	Unsubscribe Parameter Response	A set of parameters used while executing the deprovisioning of an ECCO subscription.
`UpdateIntegrationConfigurationRequest`	Update Integration Configuration Request	Describes a request to update the configuration of an integration.
`UploadOrderDocumentRequest`	Upload Order Document Request	Describes a request to upload an order document.
`VatRegimeData`	Vat Regime Data	Describes a VAT regime available for configuration.
`VatRegimesData`	Vat Regimes Data	Describes the VAT regimes available for configuration.
`VoidEventPayload`	Void Event Payload	Describes a void payload for an event (sends no actual data).
`WarehouseData`	Warehouse Data	Describes a warehouse available for configuration.
`WarehousesData`	Warehouses Data	Describes the warehouses available for configuration.

Enumerations

Class	Name	Description
`CatalogItemCondition`	Catalog Item Condition	Defines the condition of a catalog item.
`DashboardChartKind`	Dashboard Chart Kind	Defines the kind of a dashboard chart.
`DashboardChartTitleKind`	Dashboard Chart Title Kind	Defines the kind of a dashboard chart title.
`DashboardIndicatorKind`	Dashboard Indicator Kind	Defines the kind of a dashboard indicator.
`EventId`	Event Id	Defines the identifier of an event.
`GdprRequestKind`	Gdpr Request Kind	Defines the kind of GDPR request.
`OrderDocumentKind`	Order Document Kind	Defines the kind of a document associated with an order.
`OrderFinancialStatus`	Order Financial Status	Defines the financial status of an order.
`OrderStatus`	Order Status	Defines the status of an order.
`ReturnStatus`	Return Status	Defines the status of a return.

Authorization Scopes

Scope	Description
`lithium-ecco`	Allows accessing all the service endpoints.

Reference

Service Client Classes

`ECommerceConnectClient`

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: ECommerceConnectClientBase (ServiceClient<ECommerceConnectClientBase>)

Constructors

`ECommerceConnectClient(Uri, ServiceClientCredentials)`

Parameter	Type	Description
`baseUri`	`Uri`	The base URI of the service.
`credentials`	`ServiceClientCredentials`	The credentials that should be used to access the service.

`ECommerceConnectClient(Uri, ServiceClientCredentials, HttpMessageHandler)`

Parameter	Type	Description
`baseUri`	`Uri`	The base URI of the service.
`credentials`	`ServiceClientCredentials`	The credentials that should be used to access the service.
`handler`	`HttpMessageHandler`	The root message handler.

`ECommerceConnectClient(Uri, ServiceClientCredentials, HttpMessageHandler, bool)`

Parameter	Type	Description
`baseUri`	`Uri`	The base URI of the service.
`credentials`	`ServiceClientCredentials`	The credentials that should be used to access the service.
`handler`	`HttpMessageHandler`	The root message handler.
`disposeHandler`	`bool`	True if the inner handler should be disposed of, false if the inner handler is intended to be reused.

`ECommerceConnectClient(Uri, AuthenticationCallback)`

Parameter	Type	Description
`baseUri`	`Uri`	The base URI of the service.
`callback`	`AuthenticationCallback`	The callback that will be invoked during authentication to get the access token.

`ECommerceConnectClient(Uri, AuthenticationCallback, HttpMessageHandler)`

Parameter	Type	Description
`baseUri`	`Uri`	The base URI of the service.
`callback`	`AuthenticationCallback`	The callback that will be invoked during authentication to get the access token.
`handler`	`HttpMessageHandler`	The root message handler.

`ECommerceConnectClient(Uri, AuthenticationCallback, HttpMessageHandler, bool)`

Parameter	Type	Description
`baseUri`	`Uri`	The base URI of the service.
`callback`	`AuthenticationCallback`	The callback that will be invoked during authentication to get the access token.
`handler`	`HttpMessageHandler`	The root message handler.
`disposeHandler`	`bool`	True if the inner handler should be disposed of, false if the inner handler is intended to be reused.

Properties

Property	Type	Description
`AcceptLanguage`	`string`	Gets or sets the preferred language for the response.

Methods

`SetRetryPolicy(RetryPolicy)`

Sets the retry policy.

Parameter	Type	Description
`retryPolicy`	`RetryPolicy`	The new retry policy.

`SetUserAgent(string, string, string)`

Sets the user agent header when making requests to the service.

Parameter	Type	Description
`productName`	`string`	The product name.
`version`	`string`	The version.
`info`	`string`	Additional information.

Example

Uri address = new Uri("[service-address]");
string clientId = "[client-id]"
string clientSecret = "[client-secret]"

using ECommerceConnectClient client = new ECommerceConnectClient(
    new Uri(address),
    async (args) =>
    {
        string accessToken = await ClientCredentials
            .ForAllScopes(
                new Uri(args.Authority),
                clientId,
                clientSecret)
            .RetrieveAccessTokenAsync()
            .ConfigureAwait(false);

        return accessToken;
    });

^ Back to top

Operations Classes

`AppStoreOperations`

Provides actions for integrating the service with the App Store.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: AppStoreOperationsBase (IAppStoreOperations)

Methods

`NotificationAsync()`

Receives a notification from the App Store when an application is added or removed from a customer subscription.

public async Task<ServiceOperationResult> NotificationAsync(AppStoreRequestData request, CancellationToken cancellationToken = default);

public ServiceOperationResult Notification(AppStoreRequestData request);

Parameters

Parameter	Type	Description	Rules
`request`	`AppStoreRequestData`	The request payload.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RetrievePendingRequestsAsync()`

Retrieves the pending App Store requests for the specified application.

public async Task<ServiceOperationResult<IEnumerable<AppStoreRequestData>>> RetrievePendingRequestsAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<AppStoreRequestData>> RetrievePendingRequests(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.AppStoreRequestData>`	A list containing all the pending App Store requests for the specified application.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`CatalogCategoriesOperations`

Provides actions on catalog categories.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: CatalogCategoriesOperationsBase (ICatalogCategoriesOperations)

Methods

`RetrieveCategoriesAsync()`

Retrieves all the catalog categories available.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<CatalogCategoryData>>> RetrieveCategoriesAsync(string accountKey, string subscriptionAlias, string channel, CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<CatalogCategoryData>> RetrieveCategories(string accountKey, string subscriptionAlias, string channel);

Parameters

Parameter	Type	Description	Rules
`channel`	`string`	The channel used in the integration.	Required.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.CatalogCategoryData>`	The list of all the categories available.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`CatalogItemImagesOperations`

Provides actions on catalog item images.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: CatalogItemImagesOperationsBase (ICatalogItemImagesOperations)

Methods

`AddCatalogItemImageAsync()`

Adds a catalog item image.

Scope: lithium-ecco

public async Task<ServiceOperationResult<CatalogItemImageData>> AddCatalogItemImageAsync(AddCatalogItemImageRequest request, CancellationToken cancellationToken = default);

public ServiceOperationResult<CatalogItemImageData> AddCatalogItemImage(AddCatalogItemImageRequest request);

Parameters

Parameter	Type	Description	Rules
`request`	`AddCatalogItemImageRequest`	The request to add a catalog item image.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.CatalogItemImageData`	The catalog item image that was created.

Status Codes

Status Code	Description
`HttpStatusCode.Created`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`DeleteCatalogItemImageAsync()`

Deletes a catalog item image.

Scope: lithium-ecco

public async Task<ServiceOperationResult> DeleteCatalogItemImageAsync(string accountKey, string subscriptionAlias, string itemId, string name, CancellationToken cancellationToken = default);

public ServiceOperationResult DeleteCatalogItemImage(string accountKey, string subscriptionAlias, string itemId, string name);

Parameters

Parameter	Type	Description	Rules
`itemId`	`string`	The catalog item identifier.	Required.
`name`	`string`	The image name.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.NoContent`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RetrieveCatalogItemImageAsync()`

Retrieves the specified catalog item image.

Scope: lithium-ecco

public async Task<ServiceOperationResult<byte[]>> RetrieveCatalogItemImageAsync(string accountKey, string subscriptionAlias, string itemId, string name, CancellationToken cancellationToken = default);

public ServiceOperationResult<byte[]> RetrieveCatalogItemImage(string accountKey, string subscriptionAlias, string itemId, string name);

Parameters

Parameter	Type	Description	Rules
`itemId`	`string`	The catalog item identifier.	Required.
`name`	`string`	The image name.	Required.

Returns

Return Type	Description
`byte[]`	The catalog item image contents (the bytes).

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`CatalogItemsOperations`

Provides actions on catalog items.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: CatalogItemsOperationsBase (ICatalogItemsOperations)

Methods

`CreateCatalogItemAsync()`

Creates or updates the specified catalog item.

Scope: lithium-ecco

public async Task<ServiceOperationResult> CreateCatalogItemAsync(CatalogItemData item, CancellationToken cancellationToken = default);

public ServiceOperationResult CreateCatalogItem(CatalogItemData item);

Parameters

Parameter	Type	Description	Rules
`item`	`CatalogItemData`	The item that should be added or updated.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`CreateCatalogItemsAsync()`

Creates or updates the specified catalog items.

Scope: lithium-ecco

public async Task<ServiceOperationResult> CreateCatalogItemsAsync(IEnumerable<CatalogItemData> items, CancellationToken cancellationToken = default);

public ServiceOperationResult CreateCatalogItems(IEnumerable<CatalogItemData> items);

Parameters

Parameter	Type	Description	Rules
`items`	`IEnumerable<CatalogItemData>`	The items that should be added or updated.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`DeleteCatalogItemAsync()`

Deletes the specified catalog item.

Scope: lithium-ecco

public async Task<ServiceOperationResult> DeleteCatalogItemAsync(string accountKey, string subscriptionAlias, string id, CancellationToken cancellationToken = default);

public ServiceOperationResult DeleteCatalogItem(string accountKey, string subscriptionAlias, string id);

Parameters

Parameter	Type	Description	Rules
`id`	`string`	The catalog item identifier.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.NoContent`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`ExportAsync()`

Exports Catalog Items Information.

Scope: lithium-ecco

public async Task<ServiceOperationResult<byte[]>> ExportAsync(ExportCatalogItemsRequest request, CancellationToken cancellationToken = default);

public ServiceOperationResult<byte[]> Export(ExportCatalogItemsRequest request);

Parameters

Parameter	Type	Description	Rules
`request`	`ExportCatalogItemsRequest`	The request.	Required.

Returns

Return Type	Description
`byte[]`	The file with the exported items information.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`ImportAsync()`

Imports Catalog Items Information.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ImportAsync(ImportCatalogItemsRequest request, CancellationToken cancellationToken = default);

public ServiceOperationResult Import(ImportCatalogItemsRequest request);

Parameters

Parameter	Type	Description	Rules
`request`	`ImportCatalogItemsRequest`	The request.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`PublishCatalogItemAsync()`

Publishes the specified catalog item.

Scope: lithium-ecco

public async Task<ServiceOperationResult<CatalogItemData>> PublishCatalogItemAsync(CatalogItemData item, CancellationToken cancellationToken = default);

public ServiceOperationResult<CatalogItemData> PublishCatalogItem(CatalogItemData item);

Parameters

Parameter	Type	Description	Rules
`item`	`CatalogItemData`	The item that should be added or updated.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.CatalogItemData`	The catalog item after being published.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RefreshCatalogItemOfferAsync()`

Refreshes the specified catalog item offer for the specified channel.

Scope: lithium-ecco

public async Task<ServiceOperationResult<CatalogItemChannelOfferData>> RefreshCatalogItemOfferAsync(string accountKey, string subscriptionAlias, string id, string channel, CancellationToken cancellationToken = default);

public ServiceOperationResult<CatalogItemChannelOfferData> RefreshCatalogItemOffer(string accountKey, string subscriptionAlias, string id, string channel);

Parameters

Parameter	Type	Description	Rules
`id`	`string`	The catalog item identifier.	Required.
`channel`	`string`	The channel identifier.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.CatalogItemChannelOfferData`	The catalog item offer for the specified channel.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RefreshCatalogItemsAsync()`

Refreshes the specified catalog items.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<CatalogItemData>>> RefreshCatalogItemsAsync(RefreshCatalogItemsRequest request, CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<CatalogItemData>> RefreshCatalogItems(RefreshCatalogItemsRequest request);

Parameters

Parameter	Type	Description	Rules
`request`	`RefreshCatalogItemsRequest`	The request.	Required.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.CatalogItemData>`	A list containing all the catalog items refreshed.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RetrieveCatalogItemAsync()`

Retrieves the specified catalog item.

Scope: lithium-ecco

public async Task<ServiceOperationResult<CatalogItemData>> RetrieveCatalogItemAsync(string accountKey, string subscriptionAlias, string id, CancellationToken cancellationToken = default);

public ServiceOperationResult<CatalogItemData> RetrieveCatalogItem(string accountKey, string subscriptionAlias, string id);

Parameters

Parameter	Type	Description	Rules
`id`	`string`	The catalog item identifier.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.CatalogItemData`	The specified catalog item.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RetrieveCatalogItemAttributesAsync()`

Retrieves the attributes for the specified catalog item (for all channels or per channel).

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<CatalogCategoryAttributeData>>> RetrieveCatalogItemAttributesAsync(string accountKey, string subscriptionAlias, string id, string channel, CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<CatalogCategoryAttributeData>> RetrieveCatalogItemAttributes(string accountKey, string subscriptionAlias, string id, string channel);

Parameters

Parameter	Type	Description	Rules
`id`	`string`	The catalog item identifier.	Required.
`channel`	`string`	The channel identifier (all if for all channels).	Required.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.CatalogCategoryAttributeData>`	The list of the catalog item attributes.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RetrieveCatalogItemsAsync()`

Retrieves the list of all the catalog items available.

Scope: lithium-ecco

public async Task<ServiceOperationResult<CatalogItemsPage>> RetrieveCatalogItemsAsync(string accountKey, string subscriptionAlias, string continuationToken, CancellationToken cancellationToken = default);

public ServiceOperationResult<CatalogItemsPage> RetrieveCatalogItems(string accountKey, string subscriptionAlias, string continuationToken);

Parameters

Parameter	Type	Description	Rules
`continuationToken`	`string`	The continuation token. Optional.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.CatalogItemsPage`	A page of the list of catalog items.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RetrieveCatalogItemsChannelAsync()`

Retrieves the list of all the catalog items published for the specified channel.

Scope: lithium-ecco

public async Task<ServiceOperationResult<CatalogItemsPage>> RetrieveCatalogItemsChannelAsync(string accountKey, string subscriptionAlias, string channel, string continuationToken, CancellationToken cancellationToken = default);

public ServiceOperationResult<CatalogItemsPage> RetrieveCatalogItemsChannel(string accountKey, string subscriptionAlias, string channel, string continuationToken);

Parameters

Parameter	Type	Description	Rules
`channel`	`string`	The channel used in the integration.	Required.
`continuationToken`	`string`	The continuation token. Optional.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.CatalogItemsPage`	A page of the list of catalog items.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`ClientSettingsOperations`

Provides actions that allow clients to manipulate their runtime settings.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: ClientSettingsOperationsBase (IClientSettingsOperations)

Methods

`RetrieveClientSettingsAsync()`

Retrieves all the clients settings.

Scope: lithium-ecco

public async Task<ServiceOperationResult<ClientSettingsData>> RetrieveClientSettingsAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult<ClientSettingsData> RetrieveClientSettings(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.ClientSettingsData`	The client settings.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`SetClientSettingsAsync()`

Sets custom client settings.

Scope: lithium-ecco

public async Task<ServiceOperationResult> SetClientSettingsAsync(ClientSettingsData settings, CancellationToken cancellationToken = default);

public ServiceOperationResult SetClientSettings(ClientSettingsData settings);

Parameters

Parameter	Type	Description	Rules
`settings`	`ClientSettingsData`	The client settings that should be set (added or updated).	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`ConfigurationOperations`

Provides actions to collect configuration required by integrations.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: ConfigurationOperationsBase (IConfigurationOperations)

Methods

`CollectConfigurationAsync()`

Starts collecting configuration required by integrations on the specified subscription.

Scope: lithium-ecco

public async Task<ServiceOperationResult> CollectConfigurationAsync(CollectConfigurationRequest request, CancellationToken cancellationToken = default);

public ServiceOperationResult CollectConfiguration(CollectConfigurationRequest request);

Parameters

Parameter	Type	Description	Rules
`request`	`CollectConfigurationRequest`	The request to collect configuration for a request.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`GetCatalogsAsync()`

Retrieves the catalogs available for configuration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<CatalogsData>> GetCatalogsAsync(string accountKey, string subscriptionAlias, string company, CancellationToken cancellationToken = default);

public ServiceOperationResult<CatalogsData> GetCatalogs(string accountKey, string subscriptionAlias, string company);

Parameters

Parameter	Type	Description	Rules
`company`	`string`	The company used in the configuration.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.CatalogsData`	The catalogs available for configuration.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`GetCompaniesAsync()`

Retrieves the companies available for configuration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<CompaniesData>> GetCompaniesAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult<CompaniesData> GetCompanies(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.CompaniesData`	The companies available for configuration.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`GetFinancialAccountsAsync()`

Retrieves the financial accounts available for configuration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<FinancialAccountsData>> GetFinancialAccountsAsync(string accountKey, string subscriptionAlias, string company, CancellationToken cancellationToken = default);

public ServiceOperationResult<FinancialAccountsData> GetFinancialAccounts(string accountKey, string subscriptionAlias, string company);

Parameters

Parameter	Type	Description	Rules
`company`	`string`	The company used in the configuration.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.FinancialAccountsData`	The financial accounts available for configuration.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`GetInvoiceTypesAsync()`

Retrieves the invoice types available for configuration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<InvoiceTypesData>> GetInvoiceTypesAsync(string accountKey, string subscriptionAlias, string company, CancellationToken cancellationToken = default);

public ServiceOperationResult<InvoiceTypesData> GetInvoiceTypes(string accountKey, string subscriptionAlias, string company);

Parameters

Parameter	Type	Description	Rules
`company`	`string`	The company used in the configuration.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.InvoiceTypesData`	The invoice types available for configuration.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`GetOrderTypesAsync()`

Retrieves the order types available for configuration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<OrderTypesData>> GetOrderTypesAsync(string accountKey, string subscriptionAlias, string company, CancellationToken cancellationToken = default);

public ServiceOperationResult<OrderTypesData> GetOrderTypes(string accountKey, string subscriptionAlias, string company);

Parameters

Parameter	Type	Description	Rules
`company`	`string`	The company used in the configuration.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.OrderTypesData`	The order types available for configuration.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`GetRefundReasonsAsync()`

Retrieves the refund reasons available for configuration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<RefundReasonsData>> GetRefundReasonsAsync(string accountKey, string subscriptionAlias, string company, CancellationToken cancellationToken = default);

public ServiceOperationResult<RefundReasonsData> GetRefundReasons(string accountKey, string subscriptionAlias, string company);

Parameters

Parameter	Type	Description	Rules
`company`	`string`	The company used in the configuration.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.RefundReasonsData`	The refund reasons available for configuration.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`GetRefundTypesAsync()`

Retrieves the refund types available for configuration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<RefundTypesData>> GetRefundTypesAsync(string accountKey, string subscriptionAlias, string company, CancellationToken cancellationToken = default);

public ServiceOperationResult<RefundTypesData> GetRefundTypes(string accountKey, string subscriptionAlias, string company);

Parameters

Parameter	Type	Description	Rules
`company`	`string`	The company used in the configuration.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.RefundTypesData`	The refund types available for configuration.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`GetSalesChannelsAsync()`

Retrieves the sales channels available for configuration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<SalesChannelsData>> GetSalesChannelsAsync(string accountKey, string subscriptionAlias, string company, CancellationToken cancellationToken = default);

public ServiceOperationResult<SalesChannelsData> GetSalesChannels(string accountKey, string subscriptionAlias, string company);

Parameters

Parameter	Type	Description	Rules
`company`	`string`	The company used in the configuration.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.SalesChannelsData`	The sales channels available for configuration.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`GetVatRegimesAsync()`

Retrieves the VAT regimes available for configuration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<VatRegimesData>> GetVatRegimesAsync(string accountKey, string subscriptionAlias, string company, CancellationToken cancellationToken = default);

public ServiceOperationResult<VatRegimesData> GetVatRegimes(string accountKey, string subscriptionAlias, string company);

Parameters

Parameter	Type	Description	Rules
`company`	`string`	The company used in the configuration.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.VatRegimesData`	The VAT regimes available for configuration.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`GetWarehousesAsync()`

Retrieves the warehouses available for configuration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<WarehousesData>> GetWarehousesAsync(string accountKey, string subscriptionAlias, string company, CancellationToken cancellationToken = default);

public ServiceOperationResult<WarehousesData> GetWarehouses(string accountKey, string subscriptionAlias, string company);

Parameters

Parameter	Type	Description	Rules
`company`	`string`	The company used in the configuration.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.WarehousesData`	The warehouses available for configuration.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`DashboardOperations`

Provides actions on dashboards.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: DashboardOperationsBase (IDashboardOperations)

Methods

`RefreshDashboardAsync()`

Refreshes the dashboard for the specified subscription.

Scope: lithium-ecco

public async Task<ServiceOperationResult> RefreshDashboardAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult RefreshDashboard(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RetrieveDashboardAsync()`

Retrieves the dashboard for the specified subscription.

Scope: lithium-ecco

public async Task<ServiceOperationResult<DashboardData>> RetrieveDashboardAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult<DashboardData> RetrieveDashboard(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.DashboardData`	The dashboard data.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RetrieveDashboardChartsAsync()`

Retrieves the dashboard for the specified subscription.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<DashboardChartData>>> RetrieveDashboardChartsAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<DashboardChartData>> RetrieveDashboardCharts(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.DashboardChartData>`	The dashboard charts data.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RetrieveDashboardIndicatorsAsync()`

Retrieves the dashboard indicators for the specified subscription.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<DashboardIndicatorData>>> RetrieveDashboardIndicatorsAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<DashboardIndicatorData>> RetrieveDashboardIndicators(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.DashboardIndicatorData>`	The dashboard indicators data.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`FeedsOperations`

Provides actions that publish feeds.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: FeedsOperationsBase (IFeedsOperations)

Methods

`GenerateFeedLinksAsync()`

Generates the feed(s) link(s) for the specified application.

public async Task<ServiceOperationResult<IEnumerable<string>>> GenerateFeedLinksAsync(string accountKey, string subscriptionAlias, string application, CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<string>> GenerateFeedLinks(string accountKey, string subscriptionAlias, string application);

Parameters

Parameter	Type	Description	Rules
`application`	`string`	The application used in the integration.	Required.

Returns

Return Type	Description
`IEnumerable<string>`	The feed(s) link(s). Empty if there no feeds for the specified application.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RetrieveCatalogFeedAsync()`

Retrieves the catalog feed for ithe specified application.

public async Task<ServiceOperationResult<IEnumerable<CatalogFeedData>>> RetrieveCatalogFeedAsync(string accountKey, string subscriptionAlias, string application, CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<CatalogFeedData>> RetrieveCatalogFeed(string accountKey, string subscriptionAlias, string application);

Parameters

Parameter	Type	Description	Rules
`application`	`string`	The application used in the integration.	Required.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.CatalogFeedData>`	The feed data.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`IntegrationsOperations`

Provides actions on integrations.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: IntegrationsOperationsBase (IIntegrationsOperations)

Methods

`ActivateIntegrationAsync()`

Activates/deactivates an existing integration.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ActivateIntegrationAsync(string accountKey, string subscriptionAlias, string id, bool active, CancellationToken cancellationToken = default);

public ServiceOperationResult ActivateIntegration(string accountKey, string subscriptionAlias, string id, bool active);

Parameters

Parameter	Type	Description	Rules
`id`	`string`	The integration unique identifier.	Required.
`active`	`bool`	A value indicating whether the integration should be activated or deactivated.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`CreateIntegrationAsync()`

Creates a new integration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<string>> CreateIntegrationAsync(CreateIntegrationRequest request, CancellationToken cancellationToken = default);

public ServiceOperationResult<string> CreateIntegration(CreateIntegrationRequest request);

Parameters

Parameter	Type	Description	Rules
`request`	`CreateIntegrationRequest`	The request to create a new integration.	Required.

Returns

Return Type	Description
`string`	The new integration identifier.

Status Codes

Status Code	Description
`HttpStatusCode.Created`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RetrieveIntegrationAsync()`

Retrieves the specified integration.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IntegrationData>> RetrieveIntegrationAsync(string accountKey, string subscriptionAlias, string id, CancellationToken cancellationToken = default);

public ServiceOperationResult<IntegrationData> RetrieveIntegration(string accountKey, string subscriptionAlias, string id);

Parameters

Parameter	Type	Description	Rules
`id`	`string`	The integration unique identifier.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.IntegrationData`	The specified integration.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RetrieveIntegrationsAsync()`

Retrieves all the active integrations for the specified subscription.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<IntegrationData>>> RetrieveIntegrationsAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<IntegrationData>> RetrieveIntegrations(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.IntegrationData>`	A list containing all the active integrations for the specified subscription.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`UpdateIntegrationConfigurationAsync()`

Updates the configuration of an existing integration.

Scope: lithium-ecco

public async Task<ServiceOperationResult> UpdateIntegrationConfigurationAsync(UpdateIntegrationConfigurationRequest request, CancellationToken cancellationToken = default);

public ServiceOperationResult UpdateIntegrationConfiguration(UpdateIntegrationConfigurationRequest request);

Parameters

Parameter	Type	Description	Rules
`request`	`UpdateIntegrationConfigurationRequest`	The request to update the integration.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`OrdersOperations`

Provides actions on orders.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: OrdersOperationsBase (IOrdersOperations)

Methods

`ProcessOrderStatusAcceptedAsync()`

Processes the specified accepted order.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ProcessOrderStatusAcceptedAsync(string accountKey, string subscriptionAlias, string orderId, CancellationToken cancellationToken = default);

public ServiceOperationResult ProcessOrderStatusAccepted(string accountKey, string subscriptionAlias, string orderId);

Parameters

Parameter	Type	Description	Rules
`orderId`	`string`	The order unique identifier.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`ProcessOrderStatusOpenAsync()`

Processes the specified open order.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ProcessOrderStatusOpenAsync(string accountKey, string subscriptionAlias, string orderId, CancellationToken cancellationToken = default);

public ServiceOperationResult ProcessOrderStatusOpen(string accountKey, string subscriptionAlias, string orderId);

Parameters

Parameter	Type	Description	Rules
`orderId`	`string`	The order unique identifier.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`ProcessOrderStatusReadyToShipAsync()`

Processes the specified ready to ship order.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ProcessOrderStatusReadyToShipAsync(string accountKey, string subscriptionAlias, string orderId, CancellationToken cancellationToken = default);

public ServiceOperationResult ProcessOrderStatusReadyToShip(string accountKey, string subscriptionAlias, string orderId);

Parameters

Parameter	Type	Description	Rules
`orderId`	`string`	The order unique identifier.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`ProcessOrderStatusShippingStartedAsync()`

Processes the specified shipping started order.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ProcessOrderStatusShippingStartedAsync(string accountKey, string subscriptionAlias, string orderId, CancellationToken cancellationToken = default);

public ServiceOperationResult ProcessOrderStatusShippingStarted(string accountKey, string subscriptionAlias, string orderId);

Parameters

Parameter	Type	Description	Rules
`orderId`	`string`	The order unique identifier.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RefreshOrderOffersAsync()`

Refreshes the offers (associated with the items) for the specified order.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<CatalogItemData>>> RefreshOrderOffersAsync(string accountKey, string subscriptionAlias, string orderId, CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<CatalogItemData>> RefreshOrderOffers(string accountKey, string subscriptionAlias, string orderId);

Parameters

Parameter	Type	Description	Rules
`orderId`	`string`	The order unique identifier.	Required.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.CatalogItemData>`	The catalog items corresponding to the order items.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RetrieveOrderAsync()`

Retrieves the specified order.

Scope: lithium-ecco

public async Task<ServiceOperationResult<OrderData>> RetrieveOrderAsync(string accountKey, string subscriptionAlias, string orderId, CancellationToken cancellationToken = default);

public ServiceOperationResult<OrderData> RetrieveOrder(string accountKey, string subscriptionAlias, string orderId);

Parameters

Parameter	Type	Description	Rules
`orderId`	`string`	The order unique identifier.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.OrderData`	The specified order.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RetrieveOrderDocumentsAsync()`

Retrieves all the documents for the specified order.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<Uri>>> RetrieveOrderDocumentsAsync(string accountKey, string subscriptionAlias, string orderId, CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<Uri>> RetrieveOrderDocuments(string accountKey, string subscriptionAlias, string orderId);

Parameters

Parameter	Type	Description	Rules
`orderId`	`string`	The order unique identifier.	Required.

Returns

Return Type	Description
`IEnumerable<Uri>`	A list containing the URL of all the order documents.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RetrieveOrdersAsync()`

Retrieves all the orders.

Scope: lithium-ecco

public async Task<ServiceOperationResult<OrdersPage>> RetrieveOrdersAsync(string accountKey, string subscriptionAlias, string continuationToken, CancellationToken cancellationToken = default);

public ServiceOperationResult<OrdersPage> RetrieveOrders(string accountKey, string subscriptionAlias, string continuationToken);

Parameters

Parameter	Type	Description	Rules
`continuationToken`	`string`	The continuation token. Optional.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.OrdersPage`	A page of the list of orders.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RetrieveOrdersStatusAsync()`

Retrieves all the orders in the specified status.

Scope: lithium-ecco

public async Task<ServiceOperationResult<OrdersPage>> RetrieveOrdersStatusAsync(string accountKey, string subscriptionAlias, OrderStatus status, string continuationToken, CancellationToken cancellationToken = default);

public ServiceOperationResult<OrdersPage> RetrieveOrdersStatus(string accountKey, string subscriptionAlias, OrderStatus status, string continuationToken);

Parameters

Parameter	Type	Description	Rules
`status`	`OrderStatus`	The order status.
`continuationToken`	`string`	The continuation token. Optional.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.OrdersPage`	A page of the list of orders.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`SetOrderItemCanceledAsync()`

Sets the specified order item as canceled.

Scope: lithium-ecco

public async Task<ServiceOperationResult> SetOrderItemCanceledAsync(string accountKey, string subscriptionAlias, string orderId, string orderItemId, CancellationToken cancellationToken = default);

public ServiceOperationResult SetOrderItemCanceled(string accountKey, string subscriptionAlias, string orderId, string orderItemId);

Parameters

Parameter	Type	Description	Rules
`orderId`	`string`	The order unique identifier.	Required.
`orderItemId`	`string`	The order item unique identifier.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`SetOrderItemOpenAsync()`

Sets the specified order item as open.

Scope: lithium-ecco

public async Task<ServiceOperationResult> SetOrderItemOpenAsync(string accountKey, string subscriptionAlias, string orderId, string orderItemId, CancellationToken cancellationToken = default);

public ServiceOperationResult SetOrderItemOpen(string accountKey, string subscriptionAlias, string orderId, string orderItemId);

Parameters

Parameter	Type	Description	Rules
`orderId`	`string`	The order unique identifier.	Required.
`orderItemId`	`string`	The order item unique identifier.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`UploadOrderInvoiceAsync()`

Uploads the invoice the specified order.

Scope: lithium-ecco

public async Task<ServiceOperationResult> UploadOrderInvoiceAsync(UploadOrderDocumentRequest request, CancellationToken cancellationToken = default);

public ServiceOperationResult UploadOrderInvoice(UploadOrderDocumentRequest request);

Parameters

Parameter	Type	Description	Rules
`request`	`UploadOrderDocumentRequest`	The request to upload the invoice.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`UploadOrderRefundAsync()`

Uploads the refund for the specified order.

Scope: lithium-ecco

public async Task<ServiceOperationResult> UploadOrderRefundAsync(UploadOrderDocumentRequest request, CancellationToken cancellationToken = default);

public ServiceOperationResult UploadOrderRefund(UploadOrderDocumentRequest request);

Parameters

Parameter	Type	Description	Rules
`request`	`UploadOrderDocumentRequest`	The request to upload the refund.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`ProvisioningOperations`

Provides actions to provision/deprovision the usage of the ecco service.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: ProvisioningOperationsBase (IProvisioningOperations)

Methods

`SubscribeAsync()`

Receives and returns a set of parameters used for provisioning an ecco subscription.

public async Task<ServiceOperationResult<IEnumerable<SubscribeParameterResponse>>> SubscribeAsync(string productId, string licensingPlanId, IEnumerable<SubscribeParameterRequest> parameters, CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<SubscribeParameterResponse>> Subscribe(string productId, string licensingPlanId, IEnumerable<SubscribeParameterRequest> parameters);

Parameters

Parameter	Type	Description	Rules
`parameters`	`IEnumerable<SubscribeParameterRequest>`	List of parameters while executing ecco provisioning/subscribe operation.	Required.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.SubscribeParameterResponse>`	A set of parameters used for provisioning an ecco subscription.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`UnsubscribeAsync()`

Receives and returns a set of parameters used for deprovisioning an ecco subscription.

public async Task<ServiceOperationResult<IEnumerable<UnsubscribeParameterResponse>>> UnsubscribeAsync(string productId, string licensingPlanId, IEnumerable<UnsubscribeParameterRequest> parameters, CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<UnsubscribeParameterResponse>> Unsubscribe(string productId, string licensingPlanId, IEnumerable<UnsubscribeParameterRequest> parameters);

Parameters

Parameter	Type	Description	Rules
`parameters`	`IEnumerable<UnsubscribeParameterRequest>`	List of parameters while executing ecco deprovisioning/unsubscribe opertation.	Required.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.UnsubscribeParameterResponse>`	A set of parameters used for deprovisioning an ecco subscription.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`ReferenceOperations`

Provides actions on reference data.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: ReferenceOperationsBase (IReferenceOperations)

Methods

`RetrieveCatalogItemConditionsListAsync()`

Retrieves all the catalog item conditions available.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<CatalogItemConditionData>>> RetrieveCatalogItemConditionsListAsync(CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<CatalogItemConditionData>> RetrieveCatalogItemConditionsList();

Parameters

The operation has no parameters.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.CatalogItemConditionData>`	The list of all the catalog item conditions available.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RetrieveOrderStatusListAsync()`

Retrieves all the order status available.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<OrderStatusData>>> RetrieveOrderStatusListAsync(CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<OrderStatusData>> RetrieveOrderStatusList();

Parameters

The operation has no parameters.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.OrderStatusData>`	The list of all the order status available.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RetrieveReturnStatusListAsync()`

Retrieves all the return status available.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<ReturnStatusData>>> RetrieveReturnStatusListAsync(CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<ReturnStatusData>> RetrieveReturnStatusList();

Parameters

The operation has no parameters.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.ReturnStatusData>`	The list of all the return status available.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`ResetOperations`

Provides actions to reset the state of the service.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: ResetOperationsBase (IResetOperations)

Methods

`ResetSubscriptionAsync()`

Resets the state of the specified subscription.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ResetSubscriptionAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult ResetSubscription(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`ResetSubscriptionCatalogItemsAsync()`

Resets the state of the specified subscription catalog items.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ResetSubscriptionCatalogItemsAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult ResetSubscriptionCatalogItems(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`ResetSubscriptionCatalogPublicationsAsync()`

Resets the state of the specified subscription catalog publications.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ResetSubscriptionCatalogPublicationsAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult ResetSubscriptionCatalogPublications(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`ResetSubscriptionOrdersAsync()`

Resets the state of the specified subscription orders.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ResetSubscriptionOrdersAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult ResetSubscriptionOrders(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`ResetSubscriptionReturnsAsync()`

Resets the state of the specified subscription returns.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ResetSubscriptionReturnsAsync(string accountKey, string subscriptionAlias, , CancellationToken cancellationToken = default);

public ServiceOperationResult ResetSubscriptionReturns(string accountKey, string subscriptionAlias, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`ReturnsOperations`

Provides actions on returns.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: ReturnsOperationsBase (IReturnsOperations)

Methods

`ProcessReturnStatusAcceptedAsync()`

Processes the specified accepted return.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ProcessReturnStatusAcceptedAsync(string accountKey, string subscriptionAlias, string returnId, CancellationToken cancellationToken = default);

public ServiceOperationResult ProcessReturnStatusAccepted(string accountKey, string subscriptionAlias, string returnId);

Parameters

Parameter	Type	Description	Rules
`returnId`	`string`	The return unique identifier.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`ProcessReturnStatusOpenAsync()`

Processes the specified open return.

Scope: lithium-ecco

public async Task<ServiceOperationResult> ProcessReturnStatusOpenAsync(string accountKey, string subscriptionAlias, string returnId, CancellationToken cancellationToken = default);

public ServiceOperationResult ProcessReturnStatusOpen(string accountKey, string subscriptionAlias, string returnId);

Parameters

Parameter	Type	Description	Rules
`returnId`	`string`	The return unique identifier.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RetrieveReturnAsync()`

Retrieves the specified return.

Scope: lithium-ecco

public async Task<ServiceOperationResult<ReturnData>> RetrieveReturnAsync(string accountKey, string subscriptionAlias, string returnId, CancellationToken cancellationToken = default);

public ServiceOperationResult<ReturnData> RetrieveReturn(string accountKey, string subscriptionAlias, string returnId);

Parameters

Parameter	Type	Description	Rules
`returnId`	`string`	The return unique identifier.	Required.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.ReturnData`	The specified return.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`RetrieveReturnsAsync()`

Retrieves all the returns.

Scope: lithium-ecco

public async Task<ServiceOperationResult<ReturnsPage>> RetrieveReturnsAsync(string accountKey, string subscriptionAlias, string continuationToken, CancellationToken cancellationToken = default);

public ServiceOperationResult<ReturnsPage> RetrieveReturns(string accountKey, string subscriptionAlias, string continuationToken);

Parameters

Parameter	Type	Description	Rules
`continuationToken`	`string`	The continuation token. Optional.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.ReturnsPage`	A page of the list of returns.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RetrieveReturnsStatusAsync()`

Retrieves all the returns in the specified status.

Scope: lithium-ecco

public async Task<ServiceOperationResult<ReturnsPage>> RetrieveReturnsStatusAsync(string accountKey, string subscriptionAlias, ReturnStatus status, string continuationToken, CancellationToken cancellationToken = default);

public ServiceOperationResult<ReturnsPage> RetrieveReturnsStatus(string accountKey, string subscriptionAlias, ReturnStatus status, string continuationToken);

Parameters

Parameter	Type	Description	Rules
`status`	`ReturnStatus`	The order status.
`continuationToken`	`string`	The continuation token. Optional.

Returns

Return Type	Description
`Primavera.Lithium.ECommerceConnect.Models.ReturnsPage`	A page of the list of returns.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`SetReturnItemOpenAsync()`

Sets the specified return item as open.

Scope: lithium-ecco

public async Task<ServiceOperationResult> SetReturnItemOpenAsync(string accountKey, string subscriptionAlias, string returnId, string returnItemId, CancellationToken cancellationToken = default);

public ServiceOperationResult SetReturnItemOpen(string accountKey, string subscriptionAlias, string returnId, string returnItemId);

Parameters

Parameter	Type	Description	Rules
`returnId`	`string`	The return unique identifier.	Required.
`returnItemId`	`string`	The return item unique identifier.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`SetReturnItemRejectedAsync()`

Sets the specified return item as rejected.

Scope: lithium-ecco

public async Task<ServiceOperationResult> SetReturnItemRejectedAsync(string accountKey, string subscriptionAlias, string returnId, string returnItemId, CancellationToken cancellationToken = default);

public ServiceOperationResult SetReturnItemRejected(string accountKey, string subscriptionAlias, string returnId, string returnItemId);

Parameters

Parameter	Type	Description	Rules
`returnId`	`string`	The return unique identifier.	Required.
`returnItemId`	`string`	The return item unique identifier.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`ShopifyOperations`

Provides actions specifig for Shopify.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: ShopifyOperationsBase (IShopifyOperations)

Methods

`CustomerDataRequestWebhookCallbackAsync()`

Accepts the customers/data_request webhook callback.

public async Task<ServiceOperationResult> CustomerDataRequestWebhookCallbackAsync(ShopifyCustomerDataRequestPayload payload, CancellationToken cancellationToken = default);

public ServiceOperationResult CustomerDataRequestWebhookCallback(ShopifyCustomerDataRequestPayload payload);

Parameters

Parameter	Type	Description	Rules
`payload`	`ShopifyCustomerDataRequestPayload`	The payload received.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`CustomerRedactWebhookCallbackAsync()`

Accepts the customers/redact webhook callback.

public async Task<ServiceOperationResult> CustomerRedactWebhookCallbackAsync(ShopifyCustomerRedactPayload payload, CancellationToken cancellationToken = default);

public ServiceOperationResult CustomerRedactWebhookCallback(ShopifyCustomerRedactPayload payload);

Parameters

Parameter	Type	Description	Rules
`payload`	`ShopifyCustomerRedactPayload`	The payload received.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`OrderWebhooksCallbackAsync()`

Accepts the order webhooks callbacks.

public async Task<ServiceOperationResult> OrderWebhooksCallbackAsync(string accountKey, string subscriptionAlias, string integrationId, ShopifyOrderPayload payload, CancellationToken cancellationToken = default);

public ServiceOperationResult OrderWebhooksCallback(string accountKey, string subscriptionAlias, string integrationId, ShopifyOrderPayload payload);

Parameters

Parameter	Type	Description	Rules
`integrationId`	`string`	The identifier of the integration that should be used for the webhooks.	Required.
`payload`	`ShopifyOrderPayload`	The payload received.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`ShopRedactWebhookCallbackAsync()`

Accepts the shop/redact webhook callback.

public async Task<ServiceOperationResult> ShopRedactWebhookCallbackAsync(ShopifyShopRedactPayload payload, CancellationToken cancellationToken = default);

public ServiceOperationResult ShopRedactWebhookCallback(ShopifyShopRedactPayload payload);

Parameters

Parameter	Type	Description	Rules
`payload`	`ShopifyShopRedactPayload`	The payload received.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`SubscriptionsOperations`

Provides action on subscriptions.

Namespace: Primavera.Lithium.ECommerceConnect
Inheritance: SubscriptionsOperationsBase (ISubscriptionsOperations)

Methods

`RetrieveAvailableSubscriptionsAsync()`

Retrieves the available subscriptions for the specified user.

Scope: lithium-ecco

public async Task<ServiceOperationResult<IEnumerable<SubscriptionData>>> RetrieveAvailableSubscriptionsAsync(string userId, bool noCache, bool ignoreChannelSubscriptions, CancellationToken cancellationToken = default);

public ServiceOperationResult<IEnumerable<SubscriptionData>> RetrieveAvailableSubscriptions(string userId, bool noCache, bool ignoreChannelSubscriptions);

Parameters

Parameter	Type	Description	Rules
`userId`	`string`	The identifier of the user associated with the subscriptions.	Required.
`noCache`	`bool`	A value indicating whether the operation should not use the cache.
`ignoreChannelSubscriptions`	`bool`	A value indicating whether the operation should ignore the channel subscriptions.

Returns

Return Type	Description
`IEnumerable<Primavera.Lithium.ECommerceConnect.Models.SubscriptionData>`	The active subscriptions.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

Models Classes

`AddCatalogItemImageRequest`

Describes a request to add a catalog item image.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: AddCatalogItemImageRequestBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`ItemId`	`string`	The catalog item identifier.	Required.
`Name`	`string`	The image name.	Required.
`ContentType`	`string`	The image content type.	Required.
`Bytes`	`byte[]`	The image contents (the bytes).	Required.
`Product`	`string`	The product from which the image was retrieved (if any).

^ Back to top

`AddressData`

Describes an address.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: AddressDataBase

Properties

Property	Type	Description	Rules
`Name`	`string`	The address name.	Required.
`FiscalNumber`	`string`	The fiscal number associated with the address.	Required.
`AddressLine1`	`string`	The first line of the address.	Required.
`AddressLine2`	`string`	The second line of the address.	Required.
`City`	`string`	The address city.	Required.
`ZipCode`	`string`	The address ZIP code.	Required.
`CountryCode`	`string`	The country code.	Required.
`FormattedAddress`	`string`	The full address (formatted).

^ Back to top

`AppStoreRequestData`

Describes the payload received in a notification from the AppStore. Represents a request from the App Store.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: AppStoreRequestDataBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Id`	`string`	The internal unique identifier.
`RequestId`	`string`	The request unique identifier.	Required.
`Application`	`string`	The application used in the integration.	Required.
`Channel`	`string`	The channel used in the integration.
`Subscribed`	`bool`	A value indicating whether the application was added or removed.
`UserId`	`string`	The identifier of the user that triggered the request.	Required.
`CreatedOn`	`DateTime`	The moment when the request was first created.
`ModifiedOn`	`DateTime`	The moment when the request was last created.
`Completed`	`bool`	Indicates whether the request has been completed.

^ Back to top

`AttributeBindingData`

Describes the binding of an attribute for a specific channel.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: AttributeBindingDataBase

Properties

Property	Type	Description	Rules
`Name`	`string`	The attribute name on the channel.	Required.
`Required`	`bool`	A value indicating whether the attribute is required.
`DataType`	`string`	The attribute data type.	Required.

^ Back to top

`AttributeData`

Describes an attribute.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: AttributeDataBase

Properties

Property	Type	Description	Rules
`Id`	`string`	The attribute unique identifier.	Required.
`Remarks`	`string`	The attribute remarks.
`Standard`	`string`	The attribute mapping to a standard attribute.	Required.
`Bindings`	`AttributeBindingData`	The attribute bindings (indexed by channel).	Required.

^ Back to top

`BagData`

Defines a bag of properties (for storing configuration).

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: BagDataBase

Properties

Property	Type	Description	Rules
`Key`	`string`	The bag key.	Required.
`Id`	`string`	The bag identifier.	Required.
`Properties`	`string`	The bag properties.	Required.

^ Back to top

`CatalogCategoryAttributeData`

Describes an attribute used by a catalog category.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogCategoryAttributeDataBase

Properties

Property	Type	Description	Rules
`Id`	`string`	The attribute unique identifier.	Required.
`Title`	`string`	The attribute title.	Required.
`Standard`	`string`	The attribute mapping to a standard attribute.	Required.
`Binding`	`AttributeBindingData`	The attribute binding.	Required.

^ Back to top

`CatalogCategoryData`

Describes a catalog category.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogCategoryDataBase

Properties

Property	Type	Description	Rules
`Channel`	`string`	The channel used in the integration.	Required.
`Id`	`string`	The category unique identifier (channel specific).	Required.
`Title`	`string`	The catalog category title.	Required.
`Attributes`	`CatalogCategoryAttributeData`	The attributes used in the category to specify items.	Required.

^ Back to top

`CatalogData`

Describes a catalog available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogDataBase (KeyDescriptionData)

Properties

The model has no properties.

^ Back to top

`CatalogFeedData`

Describes a record in the catalog feed.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogFeedDataBase

Properties

Property	Type	Description	Rules
`Channel`	`string`	The channel used in the feed.
`Categories`	`string`	The catalog item category.
`Sku`	`string`	The catalog item SKU.
`Ean`	`string`	The catalog item EAN.
`Name`	`string`	The catalog item name.
`Description`	`string`	The catalog item description.
`PreparationTime`	`int`	The catalog item preparation time (in hours).
`Warranty`	`string`	The catalog item warranty.	Required.
`Condition`	`CatalogItemCondition`	The catalog item condition.
`ShippApart`	`bool`	Indicates whether multiple items should always be shipped apart.
`Stock`	`double`	The current stock.
`Price`	`decimal`	The current price.
`ReferencePrice`	`decimal`	The reference price.
`Currency`	`string`	The catalog item currency.
`TaxPercentage`	`double`	The tax percentage.
`Attributes`	`string`	The catalog item attributes.
`CreatedOn`	`DateTime`	The moment when the catalog item was created.
`ModifiedOn`	`DateTime`	The moment when the catalog item was last modified.

^ Back to top

`CatalogItemChannelCategoryData`

Describes the category in which a catalog item was published on a channel.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogItemChannelCategoryDataBase

Properties

Property	Type	Description	Rules
`Id`	`string`	The category identifier.	Required.
`Title`	`string`	The category title.	Required.

^ Back to top

`CatalogItemChannelData`

Describes information about the publication of a catalog item in a channel.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogItemChannelDataBase

Properties

Property	Type	Description
`Id`	`string`	The catalog item first identifier in the channel (if any).
`Id2`	`string`	The catalog item second identifier in the channel (if any).
`Id3`	`string`	The catalog item third identifier in the channel (if any).
`ChannelCategories`	`CatalogItemChannelCategoryData`	The categories in which the catalog item was published.

^ Back to top

`CatalogItemChannelOfferData`

Describes information about the offer of a catalog item in a channel.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogItemChannelOfferDataBase

Properties

Property	Type	Description
`CurrentStock`	`double`	The catalog item current stock.
`CurrentStockFormatted`	`string`	The catalog item current stock (formatted).
`CurrentPrice`	`decimal`	The catalog item current price.
`CurrentPriceFormatted`	`string`	The catalog item current price (formatted).
`ReferencePrice`	`decimal`	The catalog item reference price.
`ReferencePriceFormatted`	`string`	The catalog item reference price (formatted).
`Currency`	`string`	The catalog item price currency.

^ Back to top

`CatalogItemConditionData`

Describes the condition of a catalog item.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogItemConditionDataBase

Properties

Property	Type	Description	Rules
`Condition`	`CatalogItemCondition`	The catalog item condition.
`Name`	`string`	The catalog item condition name.	Required.
`Description`	`string`	The catalog item condition description.	Required.

^ Back to top

`CatalogItemData`

Describes a catalog item data.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogItemDataBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Id`	`string`	The item unique identifier.	Required.
`Ean`	`string`	The item EAN code.
`Description`	`string`	The item description.
`Details`	`string`	The item detailed description.
`ItemThumbnail`	`Uri`	The catalog item image thumbnail.
`ItemImages`	`CatalogItemImageData`	The images associated with the item.
`Family`	`string`	The item family.
`Brand`	`string`	The item brand.
`Model`	`string`	The item model.
`SalesUnit`	`string`	The item sales unit.
`PreparationTime`	`int`	The preparation time (in hours).
`Warranty`	`string`	The warranty associated with the item (if any).
`Condition`	`CatalogItemCondition`	The item condition.
`ShippApart`	`bool`	Indicates whether multiple items should always be shipped apart.
`Tags`	`string`	The tags associated with the catalog item.
`TaxPercentage`	`double`	The catalog item tax percentage.
`CreatedOn`	`DateTime`	The moment when the catalog item was created.
`ModifiedOn`	`DateTime`	The moment when the catalog item was last modified.
`ChannelIds`	`string`	The identifiers of the channels where the catalog item is published.
`Channels`	`CatalogItemChannelData`	Information about the publication of the catalog item in the channels.
`ChannelOffers`	`CatalogItemChannelOfferData`	Information about the offers of the catalog item in the channels.
`Attributes`	`string`	Information about additional attributes of the catalog item (used by channels).

^ Back to top

`CatalogItemImageData`

Describes a catalog item image.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogItemImageDataBase

Properties

Property	Type	Description	Rules
`Url`	`Uri`	The image URL.	Required.
`Product`	`string`	The product from where the image was retrieved (if any).

^ Back to top

`CatalogItemsPage`

Describes a page of the list of catalog items.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogItemsPageBase

Properties

Property	Type	Description	Rules
`Items`	`CatalogItemData`	The list of catalog items.
`ContinuationToken`	`string`	The continuation token.

^ Back to top

`CatalogsData`

Describes the catalogs available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CatalogsDataBase (ConfigurationsData)

Properties

Property	Type	Description	Rules
`Company`	`string`	The company to whose the order types belong.	Required.
`Data`	`CatalogData`	The catalogs available for configuration.	Required.

^ Back to top

`ClientSettingsData`

Describes client settings.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ClientSettingsDataBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Settings`	`string`	The client settings.	Required.

^ Back to top

`CollectConfigurationRequest`

Describes a request to collect configuration for an integration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CollectConfigurationRequestBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Application`	`string`	The application used in the integration.	Required.
`Company`	`string`	The company used in the integration.
`Properties`	`string`	The additional properties.

^ Back to top

`CompaniesData`

Describes the companies available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CompaniesDataBase (ConfigurationsData)

Properties

Property	Type	Description	Rules
`Data`	`CompanyData`	The order types available for configuration.	Required.

^ Back to top

`CompanyData`

Describes a company available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CompanyDataBase (KeyDescriptionData)

Properties

The model has no properties.

^ Back to top

`ConfigurationsData`

Defines the base model for all models that represent configurations.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ConfigurationsDataBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Id`	`string`	The identifier that uniquely identifies the configurations.	Required.

^ Back to top

`CreateIntegrationRequest`

Describes a request to create an integration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CreateIntegrationRequestBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Application`	`string`	The application used in the integration.	Required.
`Company`	`string`	The company used in the integration.
`UserId`	`string`	The identifier of the user that is creating the integration.	Required.
`Configuration`	`string`	The configuration values.

^ Back to top

`CustomerData`

Defines a customer.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: CustomerDataBase

Properties

Property	Type	Description	Rules
`Id`	`string`	The customer identifier.
`Name`	`string`	The customer name.	Required.
`Email`	`string`	The customer email address.	Email.
`PhoneNumber`	`string`	The customer phone number.	Phone number. Required.
`Currency`	`string`	The customer currency.
`AcceptsMarketing`	`bool`	A value indicating whether the customer accepts marketing.

^ Back to top

`DashboardChartData`

Describes a chart in a dashboard.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: DashboardChartDataBase

Properties

Property	Type	Description	Rules
`Kind`	`DashboardChartKind`	The chart kind.
`Type`	`string`	The type of chart that should be rendered.	Required.
`Header`	`DashboardChartHeaderData`	The chart header.	Required.
`Titles`	`DashboardChartTitleData`	The chart titles.	Required.
`Datasets`	`DashboardChartDatasetData`	The chart data sets.	Required.

^ Back to top

`DashboardChartDatasetData`

Describes a data set of a chart in a dashboard.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: DashboardChartDatasetDataBase

Properties

Property	Type	Description	Rules
`Title`	`string`	The data set title.	Required.
`Data`	`decimal`	The data set data.
`DataFormatted`	`string`	The data set data formatted.
`DataIsCurrency`	`bool`	A value indicating whether the data represents currency.

^ Back to top

`DashboardChartHeaderData`

Describes the header of a chart in a dashboard.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: DashboardChartHeaderDataBase

Properties

Property	Type	Description	Rules
`Title`	`string`	The header title.	Required.
`Value`	`decimal`	The header value.
`ValueFormatted`	`string`	The header value formatted.
`ValueIsCurrency`	`bool`	A value indicating whether the value represents currency.

^ Back to top

`DashboardChartTitleData`

Describes a title of a dashboard chart.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: DashboardChartTitleDataBase

Properties

Property	Type	Description	Rules
`Kind`	`DashboardChartTitleKind`	The kind of the dashboard chart title.
`Value`	`string`	The dashboard chart title value.	Required.
`Title`	`string`	The dashboard chart title.

^ Back to top

`DashboardData`

Describes a dashboard.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: DashboardDataBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Id`	`string`	The dashboard identifier.	Required.
`UpdatedOn`	`DateTime`	The moment when the dashboard was last updated.
`UpdatedOnFormatted`	`string`	The moment when the dashboard was last updated (formatted).
`Indicators`	`DashboardIndicatorData`	The list of indicators in the dashboard.	Required.
`Charts`	`DashboardChartData`	The list of charts in the dashboard.	Required.

^ Back to top

`DashboardIndicatorData`

Describes an indicator in a dashboard.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: DashboardIndicatorDataBase

Properties

Property	Type	Description	Rules
`Kind`	`DashboardIndicatorKind`	The indicator kind.
`RelatedTo`	`string`	The entity the indicator relates to.	Required.
`Title`	`string`	The indicator title.	Required.
`Value`	`double`	The indicator value.
`ValueFormatted`	`string`	The indicator value formatted.

^ Back to top

`EventPayload`

Defines the payload of the events sent to an on-premises client.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: EventPayloadBase

Properties

Property	Type	Description	Rules
`EventId`	`EventId`	The event identifier.
`PayloadType`	`string`	The type of the payload object.	Required.
`Payload`	`string`	Contains the event payload.	Required.

^ Back to top

`EventResponsePayload`

Defines the payload of the events received from an on-premises client.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: EventResponsePayloadBase

Properties

Property	Type	Description	Rules
`EventId`	`EventId`	The event identifier (of the original event).
`Succeeded`	`bool`	A value indicating whether the original event was handled with success.
`Error`	`string`	The error message (when the original event handling failed).	Required.
`PayloadType`	`string`	The type of the payload object.	Required.
`Payload`	`string`	Contains the event payload.	Required.

^ Back to top

`ExportCatalogItemsRequest`

Describes information about the catalog items to export .

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ExportCatalogItemsRequestBase (SubscriptionDependentData)

Properties

Property	Type	Description
`Ids`	`string`	The identifiers of the catalog items that should be refreshed. Null or empty indicates that all catalog items should be exported.
`Categories`	`string`	The list of categories aggregated by channel that should be included for export.
`FilterQuery`	`string`	Text used to filter items list to export.

^ Back to top

`FinancialAccountData`

Describes a financial account available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: FinancialAccountDataBase (KeyDescriptionData)

Properties

The model has no properties.

^ Back to top

`FinancialAccountsData`

Describes the financial accounts available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: FinancialAccountsDataBase (ConfigurationsData)

Properties

Property	Type	Description	Rules
`Company`	`string`	The company to whose the order types belong.	Required.
`Data`	`FinancialAccountData`	The financial accounts available for configuration.	Required.

^ Back to top

`GdprRequestData`

Describes a request concerning GDPR.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: GdprRequestDataBase

Properties

Property	Type	Description	Rules
`Id`	`string`	The request identifier.	Required.
`Kind`	`GdprRequestKind`	The kind of request.
`KindName`	`string`	The name of the kind of request.
`Payload`	`string`	The request payload.	Required.
`CreatedOn`	`DateTime`	The moment when the request was first created.

^ Back to top

`ImportCatalogItemsRequest`

Describes information about the catalog items to import.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ImportCatalogItemsRequestBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`ContentType`	`string`	The file content type.	Required.
`Bytes`	`byte[]`	The file contents (the bytes).	Required.

^ Back to top

`InstanceData`

Describes a client instance.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: InstanceDataBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Id`	`string`	The instance identifier.	Required.
`Key`	`string`	The instance key.	Required.
`Company`	`string`	The company associated with the instance.	Required.

^ Back to top

`IntegrationData`

Describes an integration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: IntegrationDataBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Id`	`string`	The integration unique identifier.	Required.
`Application`	`string`	The application used in the integration.	Required.
`Product`	`string`	The product used in the integration.	Required.
`Channel`	`string`	The channel used in the integration.
`Company`	`string`	The company used in the integration.	Required.
`CreatedBy`	`string`	The identifier of the user that activated the integration.	Required.
`CreatedOn`	`DateTime`	The moment when the integration was first created.
`ModifiedOn`	`DateTime`	The moment when the integration was last modified.
`Active`	`bool`	Indicates whether the integration is active.
`Configuration`	`string`	The configuration values.
`Licensing`	`IntegrationLicensingData`	The licensing information.

^ Back to top

`IntegrationHistoryApplicationData`

Describes an integration created for an application.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: IntegrationHistoryApplicationDataBase

Properties

Property	Type	Description	Rules
`IntegrationId`	`string`	The integration identifier.	Required.
`Application`	`string`	The application used in the integration.	Required.
`UserId`	`string`	The identifier of the user that created the integration.	Required.
`CreatedOn`	`DateTime`	The moment when the integration was first created.

^ Back to top

`IntegrationHistoryData`

Describes the history of integrations for a subscription.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: IntegrationHistoryDataBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Id`	`string`	The identifier that uniquely identifies the history record.	Required.
`CreatedOn`	`DateTime`	The moment when the history record was first created.
`ModifiedOn`	`DateTime`	The moment when the history record was last modified.
`History`	`IntegrationHistoryApplicationData`	The history records.	Required.

^ Back to top

`IntegrationLicensingData`

Describes information about the integration used for licensing.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: IntegrationLicensingDataBase

Properties

Property	Type	Description	Rules
`GracePeriodEndsOn`	`DateTime`	The moment when the grace period ends (if applicable).

^ Back to top

`InvoiceTypeData`

Describes an invoice type available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: InvoiceTypeDataBase (KeyDescriptionData)

Properties

Property	Type	Description	Rules
`Series`	`SeriesData`	The series available for configuration.	Required.

^ Back to top

`InvoiceTypesData`

Describes the invoice types available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: InvoiceTypesDataBase (ConfigurationsData)

Properties

Property	Type	Description	Rules
`Company`	`string`	The company to whose the order types belong.	Required.
`Data`	`InvoiceTypeData`	The invoice types available for configuration.	Required.

^ Back to top

`KeyDescriptionData`

Defines the base model for all models that include a key and a description.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: KeyDescriptionDataBase

Properties

Property	Type	Description	Rules
`Key`	`string`	The key that identifies the data.	Required.
`Description`	`string`	The description associated with the data.

^ Back to top

`OrderData`

Describes an order.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: OrderDataBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Id`	`string`	The order identifier.	Required.
`Id2`	`string`	The order second identifier (if any).
`Id3`	`string`	The order third identifier (if any).
`Status`	`OrderStatus`	The order status.
`StatusName`	`string`	The order status name.
`StatusDescription`	`string`	The order status description.
`FinancialStatus`	`OrderFinancialStatus`	The order financial status.
`FinancialStatusName`	`string`	The order financial status name.
`FinancialStatusDescription`	`string`	The order financial status description.
`Customer`	`CustomerData`	The order customer.	Required.
`ShippingAddress`	`AddressData`	The shipping address.	Required.
`BillingAddress`	`AddressData`	The billing address.	Required.
`Items`	`OrderItemData`	The order items.	Required.
`ShippingItems`	`OrderShippingItemData`	The order shipping items.
`Currency`	`string`	The order currency.	Required.
`Total`	`decimal`	The order total amount.
`TotalFormatted`	`string`	The order total amount (formatted).
`TotalItems`	`decimal`	The order items total amount.
`TotalItemsFormatted`	`string`	The order items total amount (formatted).
`TotalTax`	`decimal`	The order tax total amount.
`TotalTaxFormatted`	`string`	The order tax total amount (formatted).
`TotalDiscount`	`decimal`	The order discount total amount.
`TotalDiscountFormatted`	`string`	The order discount total amount (formatted).
`TaxIncluded`	`bool`	A value indicating whether the prices include taxes.
`CreatedOn`	`DateTime`	The moment when the order was created.
`CreatedOnFormatted`	`string`	The moment when the order was created (formatted).
`ModifiedOn`	`DateTime`	The moment when the order was last modified.
`ModifiedOnFormatted`	`string`	The moment when the order was last modified (formatted).
`IntegrationInfo`	`OrderIntegrationInfoData`	Provides additional information about the integration.	Required.

^ Back to top

`OrderIntegrationChannelData`

Describes information about the integration of an order in a channel.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: OrderIntegrationChannelDataBase

Properties

Property	Type	Description	Rules
`ReceivedOn`	`DateTime`	The moment when the order was first received from the channel.
`UpdatedOn`	`DateTime`	The moment when an update of the order was last received from the channel.

^ Back to top

`OrderIntegrationInfoData`

Provides additional information about the integration of an order.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: OrderIntegrationInfoDataBase

Properties

Property	Type	Description	Rules
`IntegrationId`	`string`	The identifier of the integration.	Required.
`Application`	`string`	The application associated with the integration.	Required.
`Channel`	`string`	The channel associated with the integration.	Required.
`Company`	`string`	The company associated with the integration.	Required.
`CompanyDescription`	`string`	The description of the company associated with the integration.	Required.
`ChannelInfo`	`OrderIntegrationChannelData`	Information about the integration of the order in the channel.
`ProductInfo`	`OrderIntegrationProductData`	Information about the integration of the order in the product.
`StatusUpdatesInfo`	`OrderIntegrationStatusUpdateData`	Information about the status updates of the order.
`AllowProcessOpen`	`bool`	A value indicating whether the user can process this order when it is the open status.
`AllowProcessAccepted`	`bool`	A value indicating whether the user can process this order when it is the accepted status.
`AllowProcessReadyToShip`	`bool`	A value indicating whether the user can process this order when it is the ready to ship status.
`AllowProcessShippingStarted`	`bool`	A value indicating whether the user can process this order when it is the shipping started status.

^ Back to top

`OrderIntegrationProductData`

Describes information about the integration of an order in a product.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: OrderIntegrationProductDataBase

Properties

Property	Type	Description
`OrderId`	`string`	The order identifier in the product (if any).
`InvoiceId`	`string`	The invoice identifier in the product (if any).
`RefundId`	`string`	The refund identifier in the product (if any).
`CreatedOn`	`DateTime`	The moment when the order was first created (represented) in the product.
`ModifiedOn`	`DateTime`	The moment when the order was last modified (represented) in the product.

^ Back to top

`OrderIntegrationStatusUpdateData`

Describes an update of the status of an order.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: OrderIntegrationStatusUpdateDataBase

Properties

Property	Type	Description
`Status`	`OrderStatus`	The order status.
`UpdatedOn`	`DateTime`	The moment when the status was updated.
`Notes`	`string`	Notes associated with the status update.

^ Back to top

`OrderItemData`

Describes an item in an order.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: OrderItemDataBase

Properties

Property	Type	Description	Rules
`Id`	`string`	The order item identifier.	Required.
`Id2`	`string`	The order item second identifier (if any).
`Id3`	`string`	The order item third identifier (if any).
`Status`	`OrderStatus`	The order item status.
`StatusName`	`string`	The order item status name.
`StatusDescription`	`string`	The order item status description.
`FinancialStatus`	`OrderFinancialStatus`	The order item financial status.
`FinancialStatusName`	`string`	The order financial status name.	Required.
`FinancialStatusDescription`	`string`	The order financial status description.	Required.
`Sku`	`string`	The SKU associated with the item.	Required.
`Description`	`string`	The item description.	Required.
`Quantity`	`double`	The item quantity.
`QuantityFormatted`	`string`	The item quantity (formatted).
`Price`	`decimal`	The item price.
`PriceFormatted`	`string`	The item price (formatted).
`Discount`	`decimal`	The item discount.
`DiscountFormatted`	`string`	The item discount (formatted).
`RequiresShipping`	`bool`	A value indicating whether the item requires shipping.
`Taxable`	`bool`	A value indicating whether the item is taxable.

^ Back to top

`OrderShippingItemData`

Describes a shipping item in an order.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: OrderShippingItemDataBase

Properties

Property	Type	Description	Rules
`Id`	`string`	The order shipping item identifier.	Required.
`Id2`	`string`	The order shipping item second identifier (if any).
`Id3`	`string`	The order shipping item third identifier (if any).
`Price`	`decimal`	The shipping item price.
`PriceFormatted`	`string`	The shipping item price (formatted).

^ Back to top

`OrdersPage`

Describes a page of the list of orders.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: OrdersPageBase

Properties

Property	Type	Description	Rules
`Orders`	`OrderData`	The list of orders.
`ContinuationToken`	`string`	The continuation token.

^ Back to top

`OrderStatusData`

Describes the status of an order.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: OrderStatusDataBase

Properties

Property	Type	Description	Rules
`Status`	`OrderStatus`	The order status.
`Name`	`string`	The order status name.	Required.
`Description`	`string`	The order status description.	Required.

^ Back to top

`OrderTypeData`

Describes an order type available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: OrderTypeDataBase (KeyDescriptionData)

Properties

Property	Type	Description	Rules
`Series`	`SeriesData`	The series available for configuration.	Required.

^ Back to top

`OrderTypesData`

Describes the order types available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: OrderTypesDataBase (ConfigurationsData)

Properties

Property	Type	Description	Rules
`Company`	`string`	The company to whose the order types belong.	Required.
`Data`	`OrderTypeData`	The order types available for configuration.	Required.

^ Back to top

`ProvisioningParametersData`

Describes information required to provision the ECCO service.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ProvisioningParametersDataBase

Properties

Property	Type	Description	Rules
`Parameter`	`string`	The name of the parameter.	Required.
`Value`	`string`	The value of the parameter.	Required.

^ Back to top

`RefreshCatalogItemsRequest`

Describes a request to refresh catalog items.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: RefreshCatalogItemsRequestBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Ids`	`string`	The identifiers of the catalog items that should be refreshed. Null or empty indicates that all catalog items should be refreshed.
`IncludeImages`	`bool`	A value indicating whether the images should be refreshed.

^ Back to top

`RefundReasonData`

Describes a refund reason available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: RefundReasonDataBase (KeyDescriptionData)

Properties

The model has no properties.

^ Back to top

`RefundReasonsData`

Describes the refund reasons available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: RefundReasonsDataBase (ConfigurationsData)

Properties

Property	Type	Description	Rules
`Company`	`string`	The company to whose the order types belong.	Required.
`Data`	`RefundReasonData`	The refund reasons available for configuration.	Required.

^ Back to top

`RefundTypeData`

Describes a refund type available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: RefundTypeDataBase (KeyDescriptionData)

Properties

Property	Type	Description	Rules
`Series`	`SeriesData`	The series available for configuration.	Required.

^ Back to top

`RefundTypesData`

Describes the refund types available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: RefundTypesDataBase (ConfigurationsData)

Properties

Property	Type	Description	Rules
`Company`	`string`	The company to whose the order types belong.	Required.
`Data`	`RefundTypeData`	The refund types available for configuration.	Required.

^ Back to top

`ReturnData`

Describes a return.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ReturnDataBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Id`	`string`	The return identifier.	Required.
`OrderId`	`string`	The order identifier.	Required.
`OrderId2`	`string`	The order second identifier (if any).
`Customer`	`CustomerData`	The customer.	Required.
`Status`	`ReturnStatus`	The return status.
`StatusName`	`string`	The return status name.	Required.
`StatusDescription`	`string`	The return status description.	Required.
`Items`	`ReturnItemData`	The return items.	Required.
`Amount`	`decimal`	The amount.
`AmountFormatted`	`string`	The amount (formatted).
`AmountTaxExcluded`	`decimal`	The amount (tax excluded).
`AmountTaxExcludedFormatted`	`string`	The amount (tax excluded) (formatted).
`Reason`	`string`	The return reason.	Required.
`Comment`	`string`	The comment on the return.
`CreatedOn`	`DateTime`	The moment when the return was created.
`CreatedOnFormatted`	`string`	The moment when the return was created (formatted).
`ModifiedOn`	`DateTime`	The moment when the return was last modified.
`ModifiedOnFormatted`	`string`	The moment when the return was last modified (formatted).
`IntegrationInfo`	`ReturnIntegrationInfoData`	Provides additional information about the integration.	Required.

^ Back to top

`ReturnIntegrationChannelData`

Describes information about the integration of a return in a channel.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ReturnIntegrationChannelDataBase

Properties

Property	Type	Description	Rules
`ReceivedOn`	`DateTime`	The moment when the return was first received from the channel.
`UpdatedOn`	`DateTime`	The moment when an update of the return was last received from the channel.

^ Back to top

`ReturnIntegrationInfoData`

Provides additional information about the integration of a return.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ReturnIntegrationInfoDataBase

Properties

Property	Type	Description	Rules
`IntegrationId`	`string`	The identifier of the integration.	Required.
`Application`	`string`	The application associated with the integration.	Required.
`Channel`	`string`	The channel associated with the integration.	Required.
`Company`	`string`	The company associated with the integration.	Required.
`CompanyDescription`	`string`	The description of the company associated with the integration.	Required.
`ChannelInfo`	`ReturnIntegrationChannelData`	Information about the integration of the return in the channel.
`ProductInfo`	`ReturnIntegrationProductData`	Information about the integration of the return in the product.
`StatusUpdatesInfo`	`ReturnIntegrationStatusUpdateData`	Information about the status updates of the return.

^ Back to top

`ReturnIntegrationProductData`

Describes information about the integration of a return in a product.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ReturnIntegrationProductDataBase

Properties

Property	Type	Description
`OrderId`	`string`	The order identifier in the product (if any).
`InvoiceId`	`string`	The invoice identifier in the product (if any).
`RefundId`	`string`	The refund identifier in the product (if any).
`CreatedOn`	`DateTime`	The moment when the order was first created (represented) in the product.
`ModifiedOn`	`DateTime`	The moment when the order was last modified (represented) in the product.

^ Back to top

`ReturnIntegrationStatusUpdateData`

Describes an update of the status of a return.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ReturnIntegrationStatusUpdateDataBase

Properties

Property	Type	Description
`Status`	`ReturnStatus`	The return status.
`UpdatedOn`	`DateTime`	The moment when the status was updated.
`Notes`	`string`	Notes associated with the status update.

^ Back to top

`ReturnItemData`

Describes a return item.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ReturnItemDataBase

Properties

Property	Type	Description	Rules
`Id`	`string`	The return item identifier.	Required.
`OrderItemId`	`string`	The order item identifier.	Required.
`Sku`	`string`	The item SKU.	Required.
`Ean`	`string`	The item EAN.	Required.
`Description`	`string`	The item description.	Required.
`QuantityOrdered`	`double`	The quantity ordered.
`QuantityOrderedFormatted`	`string`	The quantity ordered (formatted).
`QuantityReturned`	`double`	The quantity returned.
`QuantityReturnedFormatted`	`string`	The quantity returned (formatted).
`Amount`	`decimal`	The amount.
`AmountFormatted`	`string`	The amount (formatted).
`AmountTaxExcluded`	`decimal`	The amount (tax excluded).
`AmountTaxExcludedFormatted`	`string`	The amount (tax excluded) (formatted).
`TaxAmount`	`decimal`	The tax amount.
`TaxAmountFormatted`	`string`	The tax amount (formatted).
`Status`	`ReturnStatus`	The return item status.
`StatusName`	`string`	The return item status name.
`StatusDescription`	`string`	The return item status description.

^ Back to top

`ReturnsPage`

Describes a page of the list of returns.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ReturnsPageBase

Properties

Property	Type	Description	Rules
`Returns`	`ReturnData`	The list of returns.
`ContinuationToken`	`string`	The continuation token.

^ Back to top

`ReturnStatusData`

Describes the status of a return.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ReturnStatusDataBase

Properties

Property	Type	Description	Rules
`Status`	`ReturnStatus`	The return status.
`Name`	`string`	The return status name.	Required.
`Description`	`string`	The return status description.	Required.

^ Back to top

`SalesChannelData`

Describes a sales channel available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: SalesChannelDataBase (KeyDescriptionData)

Properties

The model has no properties.

^ Back to top

`SalesChannelsData`

Describes the sales channels available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: SalesChannelsDataBase (ConfigurationsData)

Properties

Property	Type	Description	Rules
`Company`	`string`	The company to whose the order types belong.	Required.
`Data`	`SalesChannelData`	The sales channels available for configuration.	Required.

^ Back to top

`SeriesData`

Describes a series available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: SeriesDataBase (KeyDescriptionData)

Properties

Property	Type	Description	Rules
`IsDefault`	`bool`	Indicates whether the series is the default.

^ Back to top

`ShopifyCustomerDataRequestPayload`

Describes the payload received from Shopify for the customers/data_request webhook.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ShopifyCustomerDataRequestPayloadBase

Properties

The model has no properties.

^ Back to top

`ShopifyCustomerPayload`

Describes the payload received from Shopify for a customer.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ShopifyCustomerPayloadBase

Properties

Property	Type	Description
`Id`	`long`	The customer identifier.
`Email`	`string`	The customer email address.
`PhoneNumber`	`string`	The customer phone number.

^ Back to top

`ShopifyCustomerRedactPayload`

Describes the payload received from Shopify for the customers/redact webhook.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ShopifyCustomerRedactPayloadBase

Properties

The model has no properties.

^ Back to top

`ShopifyDataRequestPayload`

Describes the payload received from Shopify for a data request.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ShopifyDataRequestPayloadBase

Properties

Property	Type	Description	Rules
`Id`	`long`	The data request identifier.

^ Back to top

`ShopifyOrderPayload`

Describes the payload received from Shopify for an order.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ShopifyOrderPayloadBase

Properties

Property	Type	Description	Rules
`Id`	`long`	The order identifier.

^ Back to top

`ShopifyShopRedactPayload`

Describes the payload received from Shopify for the shop/redact webhook.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: ShopifyShopRedactPayloadBase

Properties

The model has no properties.

^ Back to top

`SubscribeParameterRequest`

A set of parameters used while executing the provisioning of an ecco subscription.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: SubscribeParameterRequestBase (ProvisioningParametersData)

Properties

The model has no properties.

^ Back to top

`SubscribeParameterResponse`

A set of parameters used while executing the provisioning of an ecco subscription.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: SubscribeParameterResponseBase (ProvisioningParametersData)

Properties

The model has no properties.

^ Back to top

`SubscriptionData`

Describes a customer subscription.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: SubscriptionDataBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Description`	`string`	The subscription description.	Required.
`LicensingPlan`	`string`	The subscription current licensing plan.	Required.

^ Back to top

`SubscriptionDependentData`

Defines the base model for all models that depend on the product subscription.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: SubscriptionDependentDataBase

Properties

Property	Type	Description	Rules
`AccountKey`	`string`	The key that identifies the customer account.	Required.
`SubscriptionAlias`	`string`	The alias that identifies the customer subscription.	Required.
`SubscriptionReference`	`string`	The reference that uniquely identifies the customer subscription.	Required.

^ Back to top

`UnsubscribeParameterRequest`

A set of parameters used while executing the deprovisioning of an ECCO subscription.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: UnsubscribeParameterRequestBase (ProvisioningParametersData)

Properties

The model has no properties.

^ Back to top

`UnsubscribeParameterResponse`

A set of parameters used while executing the deprovisioning of an ECCO subscription.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: UnsubscribeParameterResponseBase (ProvisioningParametersData)

Properties

The model has no properties.

^ Back to top

`UpdateIntegrationConfigurationRequest`

Describes a request to update the configuration of an integration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: UpdateIntegrationConfigurationRequestBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`Id`	`string`	The integration identifier.	Required.
`Configuration`	`string`	The configuration values.	Required.

^ Back to top

`UploadOrderDocumentRequest`

Describes a request to upload an order document.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: UploadOrderDocumentRequestBase (SubscriptionDependentData)

Properties

Property	Type	Description	Rules
`OrderId`	`string`	The order unique identifier.	Required.
`DocumentName`	`string`	The file name.	Required.
`Contents`	`byte[]`	The file contents (bytes).	Required.

^ Back to top

`VatRegimeData`

Describes a VAT regime available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: VatRegimeDataBase (KeyDescriptionData)

Properties

The model has no properties.

^ Back to top

`VatRegimesData`

Describes the VAT regimes available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: VatRegimesDataBase (ConfigurationsData)

Properties

Property	Type	Description	Rules
`Company`	`string`	The company to whose the order types belong.	Required.
`Data`	`VatRegimeData`	The VAT regimes available for configuration.	Required.

^ Back to top

`VoidEventPayload`

Describes a void payload for an event (sends no actual data).

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: VoidEventPayloadBase

Properties

The model has no properties.

^ Back to top

`WarehouseData`

Describes a warehouse available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: WarehouseDataBase (KeyDescriptionData)

Properties

The model has no properties.

^ Back to top

`WarehousesData`

Describes the warehouses available for configuration.

Namespace: Primavera.Lithium.ECommerceConnect.Models
Inheritance: WarehousesDataBase (ConfigurationsData)

Properties

Property	Type	Description	Rules
`Company`	`string`	The company to whose the order types belong.	Required.
`Data`	`WarehouseData`	The warehouses available for configuration.	Required.

^ Back to top

Enumerations Classes

`CatalogItemCondition`

Defines the condition of a catalog item.

Namespace: Primavera.Lithium.ECommerceConnect.Models

Members

Member	Value	Description
`New`	0	The catalog item is new.
`Used`	1	The catalog item is used.
`Refurbished`	2	The catalog item is refurbished.

^ Back to top

`DashboardChartKind`

Defines the kind of a dashboard chart.

Namespace: Primavera.Lithium.ECommerceConnect.Models

Members

Member	Value	Description
`DailyOrders`	0	The orders per day per channel.
`TotalSales`	1	The total sales per channel.

^ Back to top

`DashboardChartTitleKind`

Defines the kind of a dashboard chart title.

Namespace: Primavera.Lithium.ECommerceConnect.Models

Members

Member	Value	Description
`String`	0	The dashboard chart title is a string.
`DateTime`	1	The dashboard chart title is a date time value.

^ Back to top

`DashboardIndicatorKind`

Defines the kind of a dashboard indicator.

Namespace: Primavera.Lithium.ECommerceConnect.Models

Members

Member	Value	Description
`OpenOrders`	0	The number of orders open.
`AcceptedOrders`	1	The number of orders accepted.
`ReadyToShipOrders`	2	The number of orders ready to ship.
`ShippingStartedOrders`	3	The number of orders whose shipping started.
`OpenReturns`	4	The number of returns open.
`AcceptedReturns`	5	The number of returns accepted.

^ Back to top

`EventId`

Defines the identifier of an event.

Namespace: Primavera.Lithium.ECommerceConnect.Models

Members

Member	Value	Description
`CollectConfiguration`	0	The event that triggers configuration collection.
`CollectCatalogs`	1	The event that triggers catalogs collection.
`CollectOrderTypes`	2	The event that triggers order types collection.
`CollectReturnTypes`	3	The event that triggers return types collection.
`CollectWharehouses`	4	The event that triggers wharehouses collection.
`CollectCatalog`	5	The event that triggers a catalog items collection.
`CollectRefundReasons`	10	The event that triggers refund reasons collection.
`CollectItemInfo`	7	The event that triggers a catalog item stock and price collection.
`CreateOrder`	8	The event that triggers a create orders command.
`CreateReturn`	9	The event that triggers a create return command.
`OrderIntegrated`	11	The event that signals that an order was integrated in the product.
`ReturnIntegrated`	12	The event that signals that a return was integrated in the product.
`InvoiceIntegrated`	13	The event that signals that an invoice was integrated in the product.
`CreditNoteIntegrated`	14	The event that signals that a credit note was integrated in the product.
`RetrieveInvoice`	15	The event that triggers a retrieve invoice command.
`RetrieveCreditNote`	16	The event that triggers a retrieve credit note command.
`UpdateItem`	17	The event that triggers the update of an item in the backend.
`CanDeleteItem`	18	The event that triggers the backend validation the verifies if an item can be deleted.

^ Back to top

`GdprRequestKind`

Defines the kind of GDPR request.

Namespace: Primavera.Lithium.ECommerceConnect.Models

Members

Member	Value	Description
`Unknown`	0	The request kind is unknown.
`ShopifyCustomerRedact`	1	The request is a customer redact for Shopify.
`ShopifyShopRedact`	2	The request is a shop redact for Shopify.
`ShopifyCustomerDataRequest`	3	The request is a customer data request for Shopify.

^ Back to top

`OrderDocumentKind`

Defines the kind of a document associated with an order.

Namespace: Primavera.Lithium.ECommerceConnect.Models

Members

Member	Value	Description
`Invoice`	0	The document is an invoice.
`Refund`	1	The document is a refund.

^ Back to top

`OrderFinancialStatus`

Defines the financial status of an order.

Namespace: Primavera.Lithium.ECommerceConnect.Models

Members

Member	Value	Description
`Unknown`	0	The order financial status is unknown.
`Pending`	1	The order payments are pending.
`Authorized`	2	The order payments are authorized.
`Paid`	3	The order payments are paid.
`Refunded`	4	The order payments are refunded.
`Voided`	5	The order payments are voided.
`PaidPartially`	6	The order payments are paid partially.
`RefundedPartially`	7	The order payments are refunded partially.

^ Back to top

`OrderStatus`

Defines the status of an order.

Namespace: Primavera.Lithium.ECommerceConnect.Models

Members

Member	Value	Description
`Unknown`	0	The order status is unknown.
`Open`	1	The order is open.
`Accepted`	2	The order is accepted.
`ReadyToShip`	3	The order is ready to ship.
`ShippingStarted`	4	The order shippment started.
`Completed`	5	The order is complete.
`Canceled`	6	The order is canceled.

^ Back to top

`ReturnStatus`

Defines the status of a return.

Namespace: Primavera.Lithium.ECommerceConnect.Models

Members

Member	Value	Description
`Unknown`	0	The return status is unknown.
`Open`	1	The return is open.
`Accepted`	2	The return is accepted.
`Refunded`	3	The return is refunded.
`Rejected`	4	The return is rejected.

^ Back to top