sap.s4hana.api_sd_incoterms_srv
Module sap.s4hana.api_sd_incoterms_srv
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_sap.s4hana.api_sd_incoterms_srv_1.0.0.png)
ballerinax/sap.s4hana.api_sd_incoterms_srv Ballerina library
Overview
S/4HANA is a robust enterprise resource planning (ERP) solution, designed for large-scale enterprises by SAP SE.
The ballerinax/sap.s4hana.api_sd_incoterms_srv
package provides APIs that enable seamless integration with the Incoterm - Read (A2X) v1.0.0. The service allows users to read incoterms defined in the system.
Setup guide
-
Sign in to your S/4HANA dashboard.
-
Under the
Communication Management
section, click on theDisplay Communications Scenario
title. -
In the search bar, type
Sales Master Data Integration
and select the corresponding scenario from the results. -
In the top right corner of the screen, click on
Create Communication Arrangement
. -
Enter a unique name for the arrangement.
-
Choose an existing
Communication System
from the dropdown menu and save your arrangement. -
The hostname (
<unique id>-api.s4hana.cloud.sap
) will be displayed in the top right corner of the screen.
Quickstart
To use the sap.s4hana.api_sd_incoterms_srv
connector in your Ballerina application, modify the .bal
file as follows:
Step 1: Import the module
Import the sap.s4hana.api_sd_incoterms_srv
module.
import ballerinax/sap.s4hana.api_sd_incoterms_srv as incoterms;
Step 2: Instantiate a new connector
Use the hostname and credentials to initiate a client
configurable string hostname = ?; configurable string username = ?; configurable string password = ?; incoterms:Client incotermsClient = check new ( { auth: { username, password } }, hostname );
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
incoterms:CollectionOfA_IncotermsClassificationWrapper listIncoTerms = check incotermsClient->listA_IncotermsClassifications();
Step 4: Run the Ballerina application
bal run
Examples
The S/4 HANA Sales and Distribution Ballerina connectors provide practical examples illustrating usage in various scenarios. Explore these examples, covering use cases like accessing S/4HANA Sales Order (A2X) API.
-
Salesforce to S/4HANA Integration - Demonstrates leveraging the
sap.s4hana.api_sales_order_srv:Client
in Ballerina for S/4HANA API interactions. It specifically showcases how to respond to a Salesforce Opportunity Close Event by automatically generating a Sales Order in the S/4HANA SD module. -
Shopify to S/4HANA Integration - Details the integration process between Shopify, a leading e-commerce platform, and SAP S/4HANA, a comprehensive ERP system. The objective is to automate SAP sales order creation for new orders placed on Shopify, enhancing efficiency and accuracy in order management.
Clients![](/images/permalink.svg)
sap.s4hana.api_sd_incoterms_srv: Client![](/images/permalink.svg)
The OData service enables external systems and other consumers to retrieve Incoterms data in your system. Retrievable details include Incoterms and Incoterms versions.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
init (ConnectionConfig config, string hostname, int port)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- hostname string -
- port int 443 -
getA_IncotermsClassification![](/images/permalink.svg)
function getA_IncotermsClassification(string IncotermsClassification, map<string|string[]> headers, *GetA_IncotermsClassificationQueries queries) returns A_IncotermsClassificationWrapper|error
Reads the ID and description of a specific Incoterm.
Parameters
- IncotermsClassification string - Incoterms (Part 1)
- queries *GetA_IncotermsClassificationQueries - Queries to be sent with the request
Return Type
- A_IncotermsClassificationWrapper|error - Retrieved entity
getA_IncotermsClassificationText![](/images/permalink.svg)
function getA_IncotermsClassificationText(string IncotermsClassification, string Language, map<string|string[]> headers, *GetA_IncotermsClassificationTextQueries queries) returns A_IncotermsClassificationTextWrapper|error
Reads the description of a specific Incoterm in a specific language.
Parameters
- IncotermsClassification string - Incoterms (Part 1)
- Language string - Language Key
- queries *GetA_IncotermsClassificationTextQueries - Queries to be sent with the request
Return Type
- A_IncotermsClassificationTextWrapper|error - Retrieved entity
getA_IncotermsVersion![](/images/permalink.svg)
function getA_IncotermsVersion(string IncotermsVersion, map<string|string[]> headers, *GetA_IncotermsVersionQueries queries) returns A_IncotermsVersionWrapper|error
Reads the ID and description of a specific Incoterms version.
Parameters
- IncotermsVersion string - Incoterms Version
- queries *GetA_IncotermsVersionQueries - Queries to be sent with the request
Return Type
- A_IncotermsVersionWrapper|error - Retrieved entity
getA_IncotermsVersionText![](/images/permalink.svg)
function getA_IncotermsVersionText(string IncotermsVersion, string Language, map<string|string[]> headers, *GetA_IncotermsVersionTextQueries queries) returns A_IncotermsVersionTextWrapper|error
Reads the description of a specific Incoterms version in a specific language.
Parameters
- IncotermsVersion string - Incoterms Version
- Language string - Language Key
- queries *GetA_IncotermsVersionTextQueries - Queries to be sent with the request
Return Type
- A_IncotermsVersionTextWrapper|error - Retrieved entity
listA_IncotermsClassificationTexts![](/images/permalink.svg)
function listA_IncotermsClassificationTexts(map<string|string[]> headers, *ListA_IncotermsClassificationTextsQueries queries) returns CollectionOfA_IncotermsClassificationTextWrapper|error
Reads the descriptions of all Incoterms.
Parameters
- queries *ListA_IncotermsClassificationTextsQueries - Queries to be sent with the request
Return Type
- CollectionOfA_IncotermsClassificationTextWrapper|error - Retrieved entities
listA_IncotermsClassifications![](/images/permalink.svg)
function listA_IncotermsClassifications(map<string|string[]> headers, *ListA_IncotermsClassificationsQueries queries) returns CollectionOfA_IncotermsClassificationWrapper|error
Reads the IDs and descriptions of all Incoterms.
Parameters
- queries *ListA_IncotermsClassificationsQueries - Queries to be sent with the request
Return Type
- CollectionOfA_IncotermsClassificationWrapper|error - Retrieved entities
listA_IncotermsVersionTexts![](/images/permalink.svg)
function listA_IncotermsVersionTexts(map<string|string[]> headers, *ListA_IncotermsVersionTextsQueries queries) returns CollectionOfA_IncotermsVersionTextWrapper|error
Reads the descriptions of all Incoterms versions.
Parameters
- queries *ListA_IncotermsVersionTextsQueries - Queries to be sent with the request
Return Type
- CollectionOfA_IncotermsVersionTextWrapper|error - Retrieved entities
listA_IncotermsVersions![](/images/permalink.svg)
function listA_IncotermsVersions(map<string|string[]> headers, *ListA_IncotermsVersionsQueries queries) returns CollectionOfA_IncotermsVersionWrapper|error
Reads the IDs and descriptions of all Incoterms versions.
Parameters
- queries *ListA_IncotermsVersionsQueries - Queries to be sent with the request
Return Type
- CollectionOfA_IncotermsVersionWrapper|error - Retrieved entities
listIncotermsClassificationTextsOfA_IncotermsClassification![](/images/permalink.svg)
function listIncotermsClassificationTextsOfA_IncotermsClassification(string IncotermsClassification, map<string|string[]> headers, *ListIncotermsClassificationTextsOfA_IncotermsClassificationQueries queries) returns CollectionOfA_IncotermsClassificationTextWrapper|error
Reads the description of a specific Incoterm.
Parameters
- IncotermsClassification string - Incoterms (Part 1)
- queries *ListIncotermsClassificationTextsOfA_IncotermsClassificationQueries - Queries to be sent with the request
Return Type
- CollectionOfA_IncotermsClassificationTextWrapper|error - Retrieved entities
listIncotermsVersionTextsOfA_IncotermsVersion![](/images/permalink.svg)
function listIncotermsVersionTextsOfA_IncotermsVersion(string IncotermsVersion, map<string|string[]> headers, *ListIncotermsVersionTextsOfA_IncotermsVersionQueries queries) returns CollectionOfA_IncotermsVersionTextWrapper|error
Reads the description of a specific Incoterms version.
Parameters
- IncotermsVersion string - Incoterms Version
- queries *ListIncotermsVersionTextsOfA_IncotermsVersionQueries - Queries to be sent with the request
Return Type
- CollectionOfA_IncotermsVersionTextWrapper|error - Retrieved entities
performBatchOperation![](/images/permalink.svg)
function performBatchOperation(Request request, map<string|string[]> headers) returns Response|error
Send a group of requests
Parameters
- request Request - Batch request
Records![](/images/permalink.svg)
sap.s4hana.api_sd_incoterms_srv: A_IncotermsClassification![](/images/permalink.svg)
Fields
- IncotermsClassification string? - Incoterms (Part 1)
- LocationIsMandatory boolean? - Location is mandatory
- to_IncotermsClassificationText A_IncotermsClassification_to_IncotermsClassificationText? -
sap.s4hana.api_sd_incoterms_srv: A_IncotermsClassification_to_IncotermsClassificationText![](/images/permalink.svg)
Fields
- results A_IncotermsClassificationText[]? -
sap.s4hana.api_sd_incoterms_srv: A_IncotermsClassificationText![](/images/permalink.svg)
Fields
- IncotermsClassification string? - Incoterms (Part 1)
- Language string? -
- IncotermsClassificationName string? -
sap.s4hana.api_sd_incoterms_srv: A_IncotermsClassificationTextWrapper![](/images/permalink.svg)
Fields
sap.s4hana.api_sd_incoterms_srv: A_IncotermsClassificationWrapper![](/images/permalink.svg)
Fields
sap.s4hana.api_sd_incoterms_srv: A_IncotermsVersion![](/images/permalink.svg)
Fields
- IncotermsVersion string? -
- to_IncotermsVersionText A_IncotermsVersion_to_IncotermsVersionText? -
sap.s4hana.api_sd_incoterms_srv: A_IncotermsVersion_to_IncotermsVersionText![](/images/permalink.svg)
Fields
- results A_IncotermsVersionText[]? -
sap.s4hana.api_sd_incoterms_srv: A_IncotermsVersionText![](/images/permalink.svg)
Fields
- IncotermsVersion string? -
- Language string? -
- IncotermsVersionName string? -
sap.s4hana.api_sd_incoterms_srv: A_IncotermsVersionTextWrapper![](/images/permalink.svg)
Fields
sap.s4hana.api_sd_incoterms_srv: A_IncotermsVersionWrapper![](/images/permalink.svg)
Fields
- d A_IncotermsVersion? -
sap.s4hana.api_sd_incoterms_srv: ClientHttp1Settings![](/images/permalink.svg)
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
- proxy ProxyConfig? - Proxy server related options
sap.s4hana.api_sd_incoterms_srv: CollectionOfA_IncotermsClassification![](/images/permalink.svg)
Fields
- __count count? -
- results A_IncotermsClassification[]? -
sap.s4hana.api_sd_incoterms_srv: CollectionOfA_IncotermsClassificationText![](/images/permalink.svg)
Fields
- __count count? -
- results A_IncotermsClassificationText[]? -
sap.s4hana.api_sd_incoterms_srv: CollectionOfA_IncotermsClassificationTextWrapper![](/images/permalink.svg)
Fields
sap.s4hana.api_sd_incoterms_srv: CollectionOfA_IncotermsClassificationWrapper![](/images/permalink.svg)
Fields
sap.s4hana.api_sd_incoterms_srv: CollectionOfA_IncotermsVersion![](/images/permalink.svg)
Fields
- __count count? -
- results A_IncotermsVersion[]? -
sap.s4hana.api_sd_incoterms_srv: CollectionOfA_IncotermsVersionText![](/images/permalink.svg)
Fields
- __count count? -
- results A_IncotermsVersionText[]? -
sap.s4hana.api_sd_incoterms_srv: CollectionOfA_IncotermsVersionTextWrapper![](/images/permalink.svg)
Fields
sap.s4hana.api_sd_incoterms_srv: CollectionOfA_IncotermsVersionWrapper![](/images/permalink.svg)
Fields
sap.s4hana.api_sd_incoterms_srv: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth CredentialsConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- 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
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- 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
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
sap.s4hana.api_sd_incoterms_srv: GetA_IncotermsClassificationQueries![](/images/permalink.svg)
Represents the Queries record for the operation: getA_IncotermsClassification
Fields
- \$expand A_IncotermsClassificationExpandOptions? - Expand related entities, see Expand
- \$select A_IncotermsClassificationSelectOptions? - Select properties to be returned, see Select
sap.s4hana.api_sd_incoterms_srv: GetA_IncotermsClassificationTextQueries![](/images/permalink.svg)
Represents the Queries record for the operation: getA_IncotermsClassificationText
Fields
- \$select A_IncotermsClassificationTextSelectOptions? - Select properties to be returned, see Select
sap.s4hana.api_sd_incoterms_srv: GetA_IncotermsVersionQueries![](/images/permalink.svg)
Represents the Queries record for the operation: getA_IncotermsVersion
Fields
- \$expand A_IncotermsVersionExpandOptions? - Expand related entities, see Expand
- \$select A_IncotermsVersionSelectOptions? - Select properties to be returned, see Select
sap.s4hana.api_sd_incoterms_srv: GetA_IncotermsVersionTextQueries![](/images/permalink.svg)
Represents the Queries record for the operation: getA_IncotermsVersionText
Fields
- \$select A_IncotermsVersionTextSelectOptions? - Select properties to be returned, see Select
sap.s4hana.api_sd_incoterms_srv: ListA_IncotermsClassificationsQueries![](/images/permalink.svg)
Represents the Queries record for the operation: listA_IncotermsClassifications
Fields
- \$skip int? - Skip the first n items, see Paging - Skip
- \$top int? - Show only the first n items, see Paging - Top
- \$orderby A_IncotermsClassificationOrderByOptions? - Order items by property values, see Sorting
- \$expand A_IncotermsClassificationExpandOptions? - Expand related entities, see Expand
- \$inlinecount "allpages"|"none" ? - Include count of items, see Inlinecount
- \$select A_IncotermsClassificationSelectOptions? - Select properties to be returned, see Select
sap.s4hana.api_sd_incoterms_srv: ListA_IncotermsClassificationTextsQueries![](/images/permalink.svg)
Represents the Queries record for the operation: listA_IncotermsClassificationTexts
Fields
- \$skip int? - Skip the first n items, see Paging - Skip
- \$top int? - Show only the first n items, see Paging - Top
- \$orderby A_IncotermsClassificationTextOrderByOptions? - Order items by property values, see Sorting
- \$inlinecount "allpages"|"none" ? - Include count of items, see Inlinecount
- \$select A_IncotermsClassificationTextSelectOptions? - Select properties to be returned, see Select
sap.s4hana.api_sd_incoterms_srv: ListA_IncotermsVersionsQueries![](/images/permalink.svg)
Represents the Queries record for the operation: listA_IncotermsVersions
Fields
- \$skip int? - Skip the first n items, see Paging - Skip
- \$top int? - Show only the first n items, see Paging - Top
- \$orderby A_IncotermsVersionOrderByOptions? - Order items by property values, see Sorting
- \$expand A_IncotermsVersionExpandOptions? - Expand related entities, see Expand
- \$inlinecount "allpages"|"none" ? - Include count of items, see Inlinecount
- \$select A_IncotermsVersionSelectOptions? - Select properties to be returned, see Select
sap.s4hana.api_sd_incoterms_srv: ListA_IncotermsVersionTextsQueries![](/images/permalink.svg)
Represents the Queries record for the operation: listA_IncotermsVersionTexts
Fields
- \$skip int? - Skip the first n items, see Paging - Skip
- \$top int? - Show only the first n items, see Paging - Top
- \$orderby A_IncotermsVersionTextOrderByOptions? - Order items by property values, see Sorting
- \$inlinecount "allpages"|"none" ? - Include count of items, see Inlinecount
- \$select A_IncotermsVersionTextSelectOptions? - Select properties to be returned, see Select
sap.s4hana.api_sd_incoterms_srv: ListIncotermsClassificationTextsOfA_IncotermsClassificationQueries![](/images/permalink.svg)
Represents the Queries record for the operation: listIncotermsClassificationTextsOfA_IncotermsClassification
Fields
- \$skip int? - Skip the first n items, see Paging - Skip
- \$top int? - Show only the first n items, see Paging - Top
- \$orderby IncotermsClassificationTextOfA_IncotermsClassificationOrderByOptions? - Order items by property values, see Sorting
- \$inlinecount "allpages"|"none" ? - Include count of items, see Inlinecount
- \$select IncotermsClassificationTextOfA_IncotermsClassificationSelectOptions? - Select properties to be returned, see Select
sap.s4hana.api_sd_incoterms_srv: ListIncotermsVersionTextsOfA_IncotermsVersionQueries![](/images/permalink.svg)
Represents the Queries record for the operation: listIncotermsVersionTextsOfA_IncotermsVersion
Fields
- \$skip int? - Skip the first n items, see Paging - Skip
- \$top int? - Show only the first n items, see Paging - Top
- \$orderby IncotermsVersionTextOfA_IncotermsVersionOrderByOptions? - Order items by property values, see Sorting
- \$inlinecount "allpages"|"none" ? - Include count of items, see Inlinecount
- \$select IncotermsVersionTextOfA_IncotermsVersionSelectOptions? - Select properties to be returned, see Select
sap.s4hana.api_sd_incoterms_srv: ProxyConfig![](/images/permalink.svg)
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
Array types![](/images/permalink.svg)
sap.s4hana.api_sd_incoterms_srv: A_IncotermsClassificationTextOrderByOptions![](/images/permalink.svg)
A_IncotermsClassificationTextOrderByOptions
sap.s4hana.api_sd_incoterms_srv: IncotermsClassificationTextOfA_IncotermsClassificationSelectOptions![](/images/permalink.svg)
IncotermsClassificationTextOfA_IncotermsClassificationSelectOptions
sap.s4hana.api_sd_incoterms_srv: A_IncotermsVersionTextOrderByOptions![](/images/permalink.svg)
A_IncotermsVersionTextOrderByOptions
sap.s4hana.api_sd_incoterms_srv: A_IncotermsVersionExpandOptions![](/images/permalink.svg)
A_IncotermsVersionExpandOptions
sap.s4hana.api_sd_incoterms_srv: A_IncotermsClassificationExpandOptions![](/images/permalink.svg)
A_IncotermsClassificationExpandOptions
sap.s4hana.api_sd_incoterms_srv: A_IncotermsVersionOrderByOptions![](/images/permalink.svg)
A_IncotermsVersionOrderByOptions
sap.s4hana.api_sd_incoterms_srv: A_IncotermsVersionSelectOptions![](/images/permalink.svg)
A_IncotermsVersionSelectOptions
sap.s4hana.api_sd_incoterms_srv: A_IncotermsVersionTextSelectOptions![](/images/permalink.svg)
A_IncotermsVersionTextSelectOptions
sap.s4hana.api_sd_incoterms_srv: A_IncotermsClassificationSelectOptions![](/images/permalink.svg)
A_IncotermsClassificationSelectOptions
sap.s4hana.api_sd_incoterms_srv: IncotermsVersionTextOfA_IncotermsVersionSelectOptions![](/images/permalink.svg)
IncotermsVersionTextOfA_IncotermsVersionSelectOptions
sap.s4hana.api_sd_incoterms_srv: IncotermsClassificationTextOfA_IncotermsClassificationOrderByOptions![](/images/permalink.svg)
IncotermsClassificationTextOfA_IncotermsClassificationOrderByOptions
sap.s4hana.api_sd_incoterms_srv: A_IncotermsClassificationTextSelectOptions![](/images/permalink.svg)
A_IncotermsClassificationTextSelectOptions
sap.s4hana.api_sd_incoterms_srv: A_IncotermsClassificationOrderByOptions![](/images/permalink.svg)
A_IncotermsClassificationOrderByOptions
sap.s4hana.api_sd_incoterms_srv: IncotermsVersionTextOfA_IncotermsVersionOrderByOptions![](/images/permalink.svg)
IncotermsVersionTextOfA_IncotermsVersionOrderByOptions
String types![](/images/permalink.svg)
sap.s4hana.api_sd_incoterms_srv: count![](/images/permalink.svg)
count
The number of entities in the collection. Available when using the $inlinecount query option.
Import
import ballerinax/sap.s4hana.api_sd_incoterms_srv;
Metadata
Released date: about 2 months ago
Version: 1.0.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.9.0
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Business Management/ERP
Cost/Paid
Vendor/SAP
Sales and Distribution
SD
Contributors
Other versions
1.0.0