Ballerina library

saps4hana.itcm.promotion

Module saps4hana.itcm.promotion

OverviewPrerequisites

API

Client

Definitions

ClientHttp1Settings
ConnectionConfig
ExternalCustomerHierarchyNodeKeyVDTO
ExternalProductHierarchyNodeKeyVDTO
ExternalPromotionCustomerVDTO
ExternalPromotionDTO
ExternalPromotionProductDTO
ExternalPromotionReferenceDTO
ExternalSalesAreaVDTO
OAuth2ClientCredentialsGrantConfig
PromotionDateDTO
PromotionTypeCodeV
ProxyConfig
ResponseExternalPromotionListMessage
ResponseExternalPromotionMessage
ResponseForbiddenMessage
ResponseInvalidCustomer
ResponseInvalidDate
ResponseInvalidProduct
ResponseMessage
ResponseNotFoundMessage
ResponseNotFoundPromotionDeletionMessage
ResponseNotFoundPromotionMessage
ResponsePromotionCreationMessage
ResponsePromotionDeleteAllMessage
ResponsePromotionDeletionMessage
ResponseUnauthorizedMessage

InlineResponse400

ballerinax/saps4hana.itcm.promotion Ballerina library

1.5.1

Overview

This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAPS4HANA Intelligent Trade Claims Management, the promotion service allows you to create, add, and delete information about promotions. Execution of Promotions should be done in an particular order.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

  • Create and configure an OAuth2 client credentials by following this guide.

Clients

saps4hana.itcm.promotion: Client

Isolated

This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAPS4HANA Intelligent Trade Claims Management, the promotion service allows you to create, add, and delete information about promotions. Execution of Promotions should be done in an particular order.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create and configure an OAuth2 client credentials by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string - URL of the target service

createPromotion

Isolated FunctionRemote Function
function createPromotion(ExternalPromotionDTO payload) returns ResponsePromotionCreationMessage|error

Create a new Promotion

Parameters
Return Type

getPromotionByExternalId

Isolated FunctionRemote Function
function getPromotionByExternalId(string externalId) returns ResponseExternalPromotionMessage|error

Get Promotion with externalId

Parameters
  • externalId string - The external id of the promotion, for example 348328430
Return Type

deletePromotion

Isolated FunctionRemote Function
function deletePromotion(string externalId) returns ResponsePromotionDeletionMessage|error

Delete a Promotion with externalId

Parameters
  • externalId string - The external id of the promotion, for example 348328430
Return Type

Records

saps4hana.itcm.promotion: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

saps4hana.itcm.promotion: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

saps4hana.itcm.promotion: ExternalCustomerHierarchyNodeKeyVDTO

Fields
  • customerHierarchyNodeId string -
  • customerHierarchyTypeCode string -

saps4hana.itcm.promotion: ExternalProductHierarchyNodeKeyVDTO

Fields
  • productHierarchyNodeId string -
  • productHierarchyTypeCode string -

saps4hana.itcm.promotion: ExternalPromotionCustomerVDTO

Fields

saps4hana.itcm.promotion: ExternalPromotionDTO

Fields
  • businessSystem int -

saps4hana.itcm.promotion: ExternalPromotionProductDTO

Fields

saps4hana.itcm.promotion: ExternalPromotionReferenceDTO

Fields

saps4hana.itcm.promotion: ExternalSalesAreaVDTO

Fields
  • distributionChannel string? -

saps4hana.itcm.promotion: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

Fields
  • tokenUrl string(default "https://colgate-dev1.authentication.us30.hana.ondemand.com/oauth/token") - Token URL

saps4hana.itcm.promotion: PromotionDateDTO

Fields
  • promotionDateTypeCode string -

saps4hana.itcm.promotion: PromotionTypeCodeV

Fields

saps4hana.itcm.promotion: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

saps4hana.itcm.promotion: ResponseExternalPromotionListMessage

Fields

saps4hana.itcm.promotion: ResponseExternalPromotionMessage

Fields

saps4hana.itcm.promotion: ResponseForbiddenMessage

Fields

saps4hana.itcm.promotion: ResponseInvalidCustomer

Fields

saps4hana.itcm.promotion: ResponseInvalidDate

Fields
  • externalId int? -

saps4hana.itcm.promotion: ResponseInvalidProduct

Fields

saps4hana.itcm.promotion: ResponseMessage

Fields

saps4hana.itcm.promotion: ResponseNotFoundMessage

Fields

saps4hana.itcm.promotion: ResponseNotFoundPromotionDeletionMessage

Fields

saps4hana.itcm.promotion: ResponseNotFoundPromotionMessage

Fields

saps4hana.itcm.promotion: ResponsePromotionCreationMessage

Fields
  • externalId int? -

saps4hana.itcm.promotion: ResponsePromotionDeleteAllMessage

Fields

saps4hana.itcm.promotion: ResponsePromotionDeletionMessage

Fields

saps4hana.itcm.promotion: ResponseUnauthorizedMessage

Fields

Union types

saps4hana.itcm.promotion: InlineResponse400

ResponseInvalidCustomer|ResponseInvalidDate|ResponseInvalidProduct

InlineResponse400

Import

import ballerinax/saps4hana.itcm.promotion;Copy

Metadata

Released date: over 1 year ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 1

Current verison: 1

Weekly downloads

Source repository

Keywords

Business Management/ERP

Cost/Paid

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/constraint/1.1.0ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC