SAP Customer Activity Repository 4.0 FPS01: Warning

Download as pdf or txt
Download as pdf or txt
You are on page 1of 34

8/16/2020

SAP Customer Activity Repository 4.0


FPS01
Generated on: 2020-08-16

SAP Customer Activity Repository applications bundle | 4.0 FPS01

PUBLIC

Original content: https://help.sap.com/viewer/e95c8443f589486bbfec99331049704a/4.0.1/en-US

Warning

This document has been generated from the SAP Help Portal and is an incomplete version of the official SAP product
documentation. The information included in custom documentation may not re ect the arrangement of topics in the SAP Help
Portal, and may be missing important aspects and/or correlations to other topics. For this reason, it is not for productive use.

For more information, please visit the https://help.sap.com/viewer/disclaimer.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21eb… 1/34
8/16/2020

OData Services
Use
OData services are provided for integration by customers that want to use custom applications or integration tools for loading
master and transactional data. You can receive the data from an SAP ERP application or a non-SAP application. To use these
services, the following is assumed:

You are using OData version 2.0.

You are responsible for custom applications or integration tools in order to load the data.

Import Documents
Technical name: API_DOCUMENT

This service enables you to upload document data for wholesale sales order and shipments from the originating system to
Demand Data Foundation (DDF). You can create, update or delete data in DDF to be used by consuming applications of SAP
Customer Activity Repository 4.0 FPS01.

Entities
The entities contain the business data of the service.

Entity Name Description Link to Details

Document Order or shipment item and line number Document


detail.

Extension Customer de ned elds. Extension

Header The business system name. Header

Document
This entity contains all pertinent information required to represent a document used for wholesale sales order and shipments.

Properties

Properties Description Necessity

DocumentNo Sales and Distribution Document Number Mandatory

DocumentItemNo Item number of the SD Document Mandatory

ScheduleLineNumber Schedule line Mandatory

TsWsDocTcd Document Type Code for Wholesale

ExtSoldToParty Ext Location Identi er of Sold To Location

SoldToPartyTcd Location Type Code of Sold To Location

ExtShipToParty Ext Location Identi er of Ship To Location

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21eb… 2/34
8/16/2020

Properties Description Necessity

ExtShipToPartyTcd Location Type Code of Ship To Location

ExtSupplyLocation Ext Location Identi er of Supplier Location

SupplyLocationTcd Location Type Code of Supplier Location

ExtSalesOrgId Sales Organization

ExtDistrChnlId Distribution Channel

ReturnedSale Product Return Flag

ExtProdId Ext Product ID

PrcTcd Price Type Code

SoReasonCode Reason for Rejection of Sales Orders

RefSalesOrderNo Referenced Sales and Distribution


Document Number

RefSalesOrderItemNo Referenced Item number of the SD


Document

OrderedDate Date of Order

ExpectedDeliveryDate Expected Delivery Date

GoodsMovementDate Goods Movement Date

OrderQuantity Order Qty in Unit Quantity

Con rmedQuantity Con rmed Qty in Unit Quantity

SalesUom Unit of Measure

GrossSalesAmnt Monetary Gross Value in the Location


Speci c Currency

NetSalesAmnt Monetary Net Value in the Location Speci c


Currency

Currency Currency

Uom Unit of Measure

LocalCurrency Local Currency

CostPrcPerUnit Monetary value in location-speci c currency

SeasonYear Fiscal year as text

SeasonId Season ID

CollectionId Fashion Collection

ThemeId Fashion Theme

 Note
To display more information about the properties, open an operation of the entity and select Model.

Extension
https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21eb… 3/34
8/16/2020
This optional entity is used in the BAPI parameter extension concept for customers. It is the reference structure for the
standardized BAPI extension parameters "ExtensionIn" and "ExtensionOut".

The BAPI parameter extension concept for customers uses the standardized BAPI parameters "ExtensionIn" and "ExtensionOut".
The parameters can be included in the BAPI using "BAPI table extensions" and customer exits. Using append or include
techniques customer-de ned table extensions can then be used automatically in the interface and in the BAPI program. For
further information see the documentation on the extension parameters for the BAPI.

Customers can freely use these prede ned extension parameters to enhance the interface without causing incompatabilities in
the interface communication.

Properties

Properties Description Necessity

IN_ExtnStructure Structure name of BAPI table extension. Mandatory

IN_ExtnValPart1 Data part for BAPI parameters "ExtensionIn" Mandatory


and "ExtensionOut".

IN_ExtnValPart2 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart3 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart4 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

 Note
To display more information about the properties, open an operation of the entity and select Model.

Header
The header entity contains the value of the originating system and is a required input for inbound data.

Properties

Properties Description Necessity

BusinessSystemName The system that created the data being send Mandatory
to the application system.

 Note
To display more information about the properties, open an operation of the entity and select Model.

Import Generic Time Series


Technical name: API_GENERIC_TIME_SERIES

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21eb… 4/34
8/16/2020
This service enables you to upload your historical transaction data indicating the unit volume of a speci c product sold in a
speci c location for a speci c time period (for example, in a distribution center) to Demand Data Foundation (DDF). You can
create, update or delete this data in DDF to be used by consuming applications, as well as the Uni ed Demand Forecast (UDF)
module of SAP Customer Activity Repository 4.0 FPS01.

Entities
The entities contain the business data of the service.

Entity Name Description Link to Details

GenericTimeSeriesData Sales date, prod/loca, and organizational GenericTimeSeriesData


data.

Header The business system name. Header

GenericTimeSeriesData
Properties

Properties Description Necessity

Product External Product ID Mandatory

RetailLocation External Location ID Mandatory

RetailLocationType Location type for this location Mandatory

TimeSeriesSourceType The time series source (key gure


parameter), for example POS

PeriodStartUTCDateTime The date time stamp Mandatory

TimeIntervalType The time granularity of the data record Mandatory


(D/W)

TimeSeriesRecordValue Key gure value

RecordIsAbsoluteForPeriod Absolute value indicator

SalesOrganization Sales Organization ID Mandatory

DistributionChannel Distribution Channel ID Mandatory

OrderChannel Order Channel ID Mandatory

 Note
To display more information about the properties, open an operation of the entity and select Model.

Header
The header entity contains the value of the originating system and is a required input for inbound data.

Properties

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21eb… 5/34
8/16/2020

Properties Description Necessity

BusinessSystemName The system that created the data being send Mandatory
to the application system.

 Note
To display more information about the properties, open an operation of the entity and select Model.

Import Inventory
Technical name: API_INVENTORY

This service enables you to receive the inventory data into Demand Data Foundation (DDF). This data represents the inventory
information for a speci c product in a speci c location at a speci c time. You can create, update or delete this data in DDF. This
demand data is available for consuming applications of SAP Customer Activity Repository 4.0 FPS01

Entities
The entities contain the business data of the service.

Entity Name Description Link to Details

Extension Customer de ned elds. Extension

Header The business system name. Header

Inventory Includes product location inventory postion. Inventory

Extension
This optional entity is used in the BAPI parameter extension concept for customers. It is the reference structure for the
standardized BAPI extension parameters "ExtensionIn" and "ExtensionOut".

The BAPI parameter extension concept for customers uses the standardized BAPI parameters "ExtensionIn" and "ExtensionOut".
The parameters can be included in the BAPI using "BAPI table extensions" and customer exits. Using append or include
techniques customer-de ned table extensions can then be used automatically in the interface and in the BAPI program. For
further information see the documentation on the extension parameters for the BAPI.

Customers can freely use these prede ned extension parameters to enhance the interface without causing incompatabilities in
the interface communication.

Properties

Properties Description Necessity

IN_ExtnStructure Structure name of BAPI table extension. Mandatory

IN_ExtnValPart1 Data part for BAPI parameters "ExtensionIn" Mandatory


and "ExtensionOut".

IN_ExtnValPart2 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21eb… 6/34
8/16/2020

Properties Description Necessity

IN_ExtnValPart3 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart4 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

 Note
To display more information about the properties, open an operation of the entity and select Model.

Header
The header entity contains the value of the originating system and is a required input for inbound data.

Properties

Properties Description Necessity

BusinessSystemName The system that created the data being send Mandatory
to the application system.

 Note
To display more information about the properties, open an operation of the entity and select Model.

Inventory
Properties

Properties Description Necessity

Product External Product ID Mandatory

RetailLocation External Location ID Mandatory

RetailLocationType Location Type Code Mandatory

InventoryQty Quantity amount

UnitOfMeasure Unit of Measure

UnitOfMeasureISOCode ISO Unit of Measure

InventoryUsabilityCode Inventory Usability Type Code

InventoryDate Inventory Validity Timestamp

StockSegment Stock Segment (is used to segregate a Mandatory


segment of inventory)

 Note
To display more information about the properties, open an operation of the entity and select Model.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21eb… 7/34
8/16/2020

Import Location
Technical name: API_LOCATION

This service enables you to create, update or delete location master data from your originating system in to Demand Data
Foundation (DDF). This location master data is used to support planning, logistics, modeling, forecasting, and reporting.

Entities
The entities contain the business data of the service.

Entity Name Description Link to Details

Extension Customer de ned elds. Extension

Header The business system name. Header

RetailLocationAddress Physical address information. RetailLocationAddress

RetailLocationAssignment Location hierarchy assignment. RetailLocationAssignment

RetailLocationDescription Language dependent description. RetailLocationDescription

RetailLocationDetails Organizational data about the location. RetailLocationDetails

RetailLocationOrganization Distribution, Purchasing, Sale RetailLocationOrganization


dorganizations.

RetailLocationSubtype Business Partner information. RetailLocationSubtype

Extension
This optional entity is used in the BAPI parameter extension concept for customers. It is the reference structure for the
standardized BAPI extension parameters "ExtensionIn" and "ExtensionOut".

The BAPI parameter extension concept for customers uses the standardized BAPI parameters "ExtensionIn" and "ExtensionOut".
The parameters can be included in the BAPI using "BAPI table extensions" and customer exits. Using append or include
techniques customer-de ned table extensions can then be used automatically in the interface and in the BAPI program. For
further information see the documentation on the extension parameters for the BAPI.

Customers can freely use these prede ned extension parameters to enhance the interface without causing incompatabilities in
the interface communication.

Properties

Properties Description Necessity

IN_ExtnStructure Structure name of BAPI table extension. Mandatory

IN_ExtnValPart1 Data part for BAPI parameters "ExtensionIn" Mandatory


and "ExtensionOut".

IN_ExtnValPart2 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21eb… 8/34
8/16/2020

Properties Description Necessity

IN_ExtnValPart3 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart4 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

 Note
To display more information about the properties, open an operation of the entity and select Model.

Header
The header entity contains the value of the originating system and is a required input for inbound data.

Properties

Properties Description Necessity

BusinessSystemName The system that created the data being send Mandatory
to the application system.

 Note
To display more information about the properties, open an operation of the entity and select Model.

RetailLocationAddress
Properties

Properties Description Necessity

AddressID Record Identi er Mandatory

FormOfAddress Title

InternationalPhoneNumber Full number (dialing


code+number+extension)

PhoneNumber Phone number (dialing code+number)

PhoneNumberExtension Extension (if required)

FaxCountry Country code for fax number

AddressName Address line 1

AddressLineText2 Address line 2

AddressLineText3 Address line 3

AddressLineText4 Address line 4

CareOfName Name of person

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21eb… 9/34
8/16/2020

Properties Description Necessity

CityName City name

District District name

CityCode City Code for City/Street File

AddressDistrictCode District code for City and Street le

CityFileTestStatus Test Status of the City File

RegionalStructureGrouping Regional Structure Grouping

AddressPostalCode City Postal Code

POBoxPostalCode PO Box Postal Code

CompanyPostalCode Company Postal Code (For Large


Customers)

POBox Post Office Box number

POBoxIsWithoutNumber P.O. Box without number

POBoxDeviatingCityName P.O. box city name

POBoxDeviatingCityCode P.O. box city code

POBoxDeviatingRegion Region for PO Box (Country, State, Province,


...)

POBoxDeviatingCountry PO Box Country

POBoxCountryISOCode Country ISO Code

TransportZone Transport zone

AddressStreetName Full street address

AddressStreetNumber Street Number for City/Street File

AddressHouseNumber House Number

HouseNumberSupplementText House Number

StreetPre xName

AdditionalStreetPre xName

StreetSuffixName

AdditionalStreetSuffixName

Building

Floor

RoomNumber

AddressCountry Country Code

CountryISOCode ISO Code for Country

Language External Language

LanguageISOCode ISO Code Language

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 10/34
8/16/2020

Properties Description Necessity

AddressRegion Region in an address

AddressSearchText1 Address search or sort term

AddressSearchText2 Secondary address search or sort term

FirstTelephoneExtension Extension (only for data conversion) (e.g.


data line)

FirstFaxExtension Extension (only for data conversion) (e.g.


telebox)

AddressTimeZone Time Zone of Address

TaxJurisdiction Tax Jurisdiction

OriginalAddressLanguage Original language

OriginalAddressLanguageISOCode Original language ISO code

CommunicationMediumType Communication Method (Key) (Business


Address Services)

HomeCityName City that is Different from Postal City

CityDeviationCode Different City Code for City or Street File

 Note
To display more information about the properties, open an operation of the entity and select Model.

RetailLocationAssignment
This entity contains the location hierarchy types and node assignments for the location.

Properties

Properties Description Necessity

RetailLocationHierarchy External Location Hierarchy ID Mandatory

RetailLocationHierarchy Location Hierarchy Type Code Mandatory

RetailLocationHierarchy External Location Hierarchy Node Identi er Mandatory

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

RetailLocationDescription
This entity contains information about the language type for descriptive text purposes.

Properties
https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 11/34
8/16/2020

Properties Description Necessity

Language External Language Mandatory

LanguageISOCode ISO Code Language Mandatory

RetailLocationName Location Description Mandatory

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

RetailLocationDetails
This entity contains organizational detail information about the location.

Properties

Properties Description Necessity

RetailLocation Location Identi er Mandatory

RetailLocationType Location Type Code Mandatory

ObjectActionCode Function code

OrderCalendarCode Calendar Code (see GDT


PublicHolidayCalendarCode)

GoodsIssuedCalendarCode Calendar Code (see GDT


PublicHolidayCalendarCode)

GoodsReceivedCalendarCode Calendar Code (see GDT


PublicHolidayCalendarCode)

LocationTimeZone Time Zone of the location

PurchasingOrganization Purchasing Organizational Unit Identi er

SalesOrganization Sales Organizational Unit Identi er

DistributionChannel Distribution Channel Organizational Unit


Identi er

DistributionChain Distribution Chain Organizational Unit


Identi er

RetailLocationBlockingStatus Blocking Status

RetailLocationBlockFromDate Begin date of block status

RetailLocationBlockToDate End date of block status

StoreOpenDate Date store opened

StoreCloseDate Date store closed

StoreSize Store size

StoreSizeUnit Unit of measure for size

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 12/34
8/16/2020

Properties Description Necessity

StoreSizeUnitISO ISO UOM for size

Currency Currency

CurrencyISOCode ISO Currency

BusinessPartnerParent Loc ID of BP parent

CustomerType Customer TCD

BusinessPartnerSubtype BP subtype ID (role of this wholesale loc)

Region Region of loc

DemandPlanningAccountGroup The account group is the lowest planning


level for accounts.

ReferenceRetailLocation External ID of the reference location

ValidityStartDate Use reference location start date

ValidityEndDate Use reference location end date

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

RetailLocationOrganization
This entity contains information of the organization assignment.

Properties

Properties Description Necessity

PurchasingOrganization Purchasing Organizational Unit Identi er

SalesOrganization Sales Organizational Unit Identi er

DistributionChannel Distribution Channel Organizational Unit


Identi er

DistributionChain Distribution Chain Organizational Unit


Identi er

PriceListType Price List Type Code

SubRegion Region ID

CustomerTier Customer Tier Code

SalesOffice Sales Office

CustomerGroup Customer Group

SupplyLocation External Supply Location

 Note
https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 13/34
8/16/2020
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

RetailLocationSubtype
This entity contains the business partner subtype information. The business partner (BP) subtype value is used to track the role
associated with a location.

Properties

Properties Description Necessity

BusinessPartnerSubtype BP Subtype code Mandatory

BusinessPartnerParent External location ID Mandatory

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

Import Location Hierarchy


Technical name: API_LOCATION_HIERARCHY

The location hierarchy is created in the originating system and must be imported to the application server. This inbound service
enables a location hierarchy to be created, updated or deleted in Demand Data Foundation (DDF). The location hierarchy master
data is used to support planning, logistics, modeling, forecasting, and reporting.

Entities
The entities contain the business data of the service.

Entity Name Description Link to Details

Header The business system name. Header

RetailLocationHierarchyAssignment Contains the location hierarchy RetailLocationHierarchyAssignment


assignments.

RetailLocationHierarchyDescription Contains the location hierarchy RetailLocationHierarchyDescription


descriptions.

RetailLocationHierarchyDetails Type location hierarchy and action code. RetailLocationHierarchyDetails

RetailLocationHierarchyNodeDescription Language code and matching name. RetailLocationHierarchyNodeDescription

RetailLocationHierarchyNodeDetails Node ID and Parent ID RetailLocationHierarchyNodeDetails

Header
The header entity contains the value of the originating system and is a required input for inbound data.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 14/34
8/16/2020

Properties

Properties Description Necessity

BusinessSystemName The system that created the data being send Mandatory
to the application system.

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

RetailLocationHierarchyAssignment
This entity contains the location hierarchy node and the location assignments.

Properties

Properties Description Necessity

RetailLocationHierarchyNode External Location Hierarchy Node ID Mandatory

RetailLocation External Location ID Mandatory

RetailLocationType Location Type Code Mandatory

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

RetailLocationHierarchyDescription
This entity contains information about the language type for descriptive text purposes.

Properties

Properties Description Necessity

RetailLocationHierarchyNode Location Hierarchy Node ID Mandatory

LanguageCode Code Language Mandatory

LanguageISOCode ISO Code Language Mandatory

RetailLocationHierarchyNodeName Location Hierarchy Description

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 15/34
8/16/2020

RetailLocationHierarchyDetails
This entity contains information about the location hierarchy identity to maintain.

Properties

Properties Description Necessity

RetailLocationHierarchy Location Hierarchy Identi er Mandatory

RetailLocationHierarchyType Location Hierarchy Type Code Mandatory

ObjectActionCode Function code (I/C/D)

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

RetailLocationHierarchyNodeDescription
This entity contains information about the language type for descriptive text purposes.

Properties

Properties Description Necessity

RetailLocationHierarchyNode Location Hierarchy Node ID Mandatory

Language External Language Mandatory

LanguageISOCode ISO Code Language Mandatory

RetailLocationHierarchyNodeName Location Hierarchy Node Description

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

RetailLocationHierarchyNodeDetails
This entity contains information about the location hierarchy node identity to maintain.

Properties

Properties Description Necessity

RetailLocationHierarchyNode Location Hierarchy Node Identi er Mandatory

RtlLocationHierarchyParentNode Location Hierarchy Parent Node

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 16/34
8/16/2020

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

Import Product
Technical name: API_PRODUCT

This service enables you to upload your product data from the originating system to Demand Data Foundation (DDF). You can
create, update or delete data in DDF. The product data includes the description of the product, the association to hierarchies and
seasons, unit of measure, and components.

Entities
The entities contain the business data of the service.

Entity Name Description Link to Details

Extension Customer de ned elds. Extension

Header The business system name. Header

ProductBOM Component information for a product. ProductBOM

ProductDescription Description of the product. ProductDescription

ProductDetails Extensive details about the product. ProductDetails

ProductHierarchyAssignment Hierarchy nodes associated with the ProductHierarchyAssignment


product.

ProductPrice Pricing by date for the product/location, and ProductPrice


price type.

ProductSeason Season collection theme information ProductSeason

ProductUOM Unit of measure data. ProductUOM

Extension
This optional entity is used in the BAPI parameter extension concept for customers. It is the reference structure for the
standardized BAPI extension parameters "ExtensionIn" and "ExtensionOut".

The BAPI parameter extension concept for customers uses the standardized BAPI parameters "ExtensionIn" and "ExtensionOut".
The parameters can be included in the BAPI using "BAPI table extensions" and customer exits. Using append or include
techniques customer-de ned table extensions can then be used automatically in the interface and in the BAPI program. For
further information see the documentation on the extension parameters for the BAPI.

Customers can freely use these prede ned extension parameters to enhance the interface without causing incompatabilities in
the interface communication.

Properties

Properties Description Necessity

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 17/34
8/16/2020

Properties Description Necessity

IN_ExtnStructure Structure name of BAPI table extension. Mandatory

IN_ExtnValPart1 Data part for BAPI parameters "ExtensionIn" Mandatory


and "ExtensionOut".

IN_ExtnValPart2 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart3 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart4 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

 Note
To display more information about the properties, open an operation of the entity and select Model.

Header
The header entity contains the value of the originating system and is a required input for inbound data.

Properties

Properties Description Necessity

BusinessSystemName The system that created the data being send Mandatory
to the application system.

 Note
To display more information about the properties, open an operation of the entity and select Model.

ProductBOM
This optional entity is used in the API_Product OData service to import bill of material information.

Properties

Properties Description Necessity

BillOfMaterialItemNodeNumber Product component node number Mandatory

BillOfMaterialComponent Product component identi er Mandatory

BillOfMaterialItemQuantity Component quantity Mandatory

BillOfMaterialItemUnit Unit of measure for the component Mandatory

UnitOfMeasureISOCode The ISO code for the unit of measure. Mandatory

 Note

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 18/34
8/16/2020
To display more information about the properties, open an operation of the entity and select Model.

ProductDescription
This optional entity is used in the API_Product OData service to import description information.

Properties

Properties Description Necessity

Language Language code Mandatory

ProductName Name of Product

LanguageISOCode Language ISO code Mandatory

 Note
To display more information about the properties, open an operation of the entity and select Model.

ProductDetails
This entity is used in the API_Product OData service to import product detail characteristics information.

Properties

Properties Description Necessity

Product Product Identi er Mandatory

ObjectActionCode Add, Change, Delete

GenericProduct Product Id of Generic

InternationalArticleNumber ERP International EAN

ProductBaseUnit Unit of Measure Type

ProductBaseUnitISOCode ISO Unit of Measure Type

MerchandiseCategory ERP Material Group

ProductCategory

ProductMainSize Number of objects per process

ProductColor Color Code

Brand Brand Value

NetWeight Weight of Product

WeightUnit UOM for Product weight

WeightUnitISOCode ISO UOM for Product weight

ContentUnit Unit of Measure

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 19/34
8/16/2020

Properties Description Necessity

ContentUnitISOCode Iso code for unit of measure

NetContent Volume of Product

ComparisonPriceQuantity Condition Price Unit

IsVariantPriceAllowed Variant Price Allowed

ProductType Type of Material

ProductSize2 Characteristic Value for Second Size


variant

RetailCharacteristicColor Characteristic Number of Color


Characteristics

RetailCharacteristicMainSize Internal Char Number of Characteristics for


Main Sizes

RetailCharacteristicSecondSize Internal Char Number of Characteristics for


Second Sizes

PriceBandType Price Band Category

ProductSeasonType Season Category

RetailCharacteristicColorName Characteristic Name of Color

RetailCharcMainSizeName Characteristic Name of Main Size

RetailCharacteristicSizeName2 Characteristic Name of Secondary Size

ProductFasionGrade Fashion Grade

 Note
To display more information about the properties, open an operation of the entity and select Model.

ProductHierarchyAssignment
This optional entity is used in the API_Product OData service to import the product hierarchy levels and validity dates.

Properties

Properties Description Necessity

ProductHierarchy External Product Hierarchy ID Mandatory

ProductHierarchyType External Product Hierarchy Type Mandatory

ProductHierarchyNode External Product Hierarchy Node ID Mandatory

ValidityStartDate The Start Date this Hierarchy is Active Mandatory

ValidityEndDate The End Date this Hierarchy is Active

 Note
To display more information about the properties, open an operation of the entity and select Model.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 20/34
8/16/2020

ProductPrice
This optional entity is used in the API_Product OData service to import the product prices and validity dates.

Properties

Properties Description Necessity

AlternativeUnit Unitof Measure Mandatory

SalesOrganization External Sales Org ID Mandatory

DistributionChannel External Distribution Channel ID Mandatory

PriceListType Price List Code Mandatory

BusinessUnit External Location ID Mandatory

BusinessUnitType Location Type Mandatory

ProductPriceType Price Type Code Mandatory

ValidityStartDate The Start Date this is Active Mandatory

ValidityEndDate The End Date this is Active

Currency Currency Code

GrossProductPrice Gross Price

NetProductPrice Net Price

ProductPriceVATPercent Fraction Percent of VAT

 Note
To display more information about the properties, open an operation of the entity and select Model.

ProductSeason
This optional entity is used in the API_Product OData service to import seasonality information.

Properties

Properties Description Necessity

SeasonYear Year the Season is Active Mandatory

ProductSeas External Season ID Mandatory

ProductCollection External Collection ID Mandatory

ProductTheme External Theme ID Mandatory

IsProductSeasonType1 Season One Flag

IsProductSeasonType2 Season Two Flag

IsProductSeasonType3 Season Three Flag

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 21/34
8/16/2020

Properties Description Necessity

ProductSeasonName Description of Season

ProductIsSeasonal Seasonal Flag

GenericProduct External Generic Product ID

 Note
To display more information about the properties, open an operation of the entity and select Model.

ProductUOM
This entity is used in the API_Product OData service to import product unit of measure characteristics information.

Properties

Properties Description Necessity

AlternativeUnit Product Identi er Mandatory

UnitOfMeasureISOCode ISO Unit of Measure

InternationalArticleNumber ERP International EAN

QuantityNumerator Numerator for Conversion to Base Units of


Measure

QuantityDenominator Denominator for Conversion to Base Units of


Measure

UnitSpeci cProductLength Length

UnitSpeci cProductHeight Height

UnitSpeci cProductWidth Width

ProductMeasurementUnit UOM for Length

ProductMeasurementUnitISOCode ISO UOM for Length

Volume Volume

VolumeUnit UOM for Volume

VolumeUnitISOCode ISO UOM for Volume

GrossWeight Weight

WeightUnit UOM for Product Weight

WeightUnitISOCode ISO UOM for Product Weight

 Note
To display more information about the properties, open an operation of the entity and select Model.

Import Product Hierarchy


https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 22/34
8/16/2020
Technical name: API_PRODUCT_HIERARCHY

The product hierarchy is created in the originating system and must be imported to the application server. This inbound service
enables a product hierarchy to be created, updated or deleted in Demand Data Foundation (DDF). The product hierarchy master
data is used to support planning, logistics, modeling, forecasting, and reporting.

Entities
The entities contain the business data of the service.

Entity Name Description Link to Details

Extension Customer de ned elds. Extension

Header The business system name; the originating Header


system as de ned on the target server.

ProductHierarchyDescription Hierarchy text description and language ProductHierarchyDescription


codes.

ProductHierarchyDetails Status and validity information for the ProductHierarchyDetails


nodes.

ProductHierarchyNodeDescription Hierarchy nodes text description and ProductHierarchyNodeDescription


language codes.

ProductHierarchyNodeDetails Nodes, parents, and merchandising data. ProductHierarchyNodeDetails

Extension
This optional entity is used in the BAPI parameter extension concept for customers.

The BAPI parameter extension concept for customers uses the standardized BAPI parameters "ExtensionIn" and "ExtensionOut".
The parameters can be included in the BAPI using "BAPI table extensions" and customer exits. Using append or include
techniques customer-de ned table extensions can then be used automatically in the interface and in the BAPI program. For
further information see the documentation on the extension parameters for the BAPI.

Customers can freely use these prede ned extension parameters to enhance the interface without causing incompatibilities in the
interface communication.

Properties

Properties Description Necessity

IN_ExtnStructure Structure name of BAPI table extension. Mandatory

IN_ExtnValPart1 Data part for BAPI parameters "ExtensionIn" Mandatory


and "ExtensionOut".

IN_ExtnValPart2 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart3 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart4 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 23/34
8/16/2020

 Note
To display more information about the properties, open an operation of the entity and select Model.

Header
The header entity contains the value of the originating system and is a required input for inbound data.

Properties

Properties Description Necessity

BusinessSystemName The system that created the data being send Mandatory
to the application system.

 Note
To display more information about the properties, open an operation of the entity and select Model.

ProductHierarchyDescription
This optional entity is used in the API_Product_Hierarchy OData service to import product hierarchy description information.

Properties

Properties Description Necessity

LanguageISOCode Language ISO code Mandatory

Language Language code Mandatory

ProductHierarchyName Text of Name

 Note
To display more information about the properties, open an operation of the entity and select Model.

ProductHierarchyDetails
This entity is used in the API_PRODUCT_HIERARCHY OData service and contains information about the product hierarchy and
organization.

Properties Description Necessity

ProductHierarchy External Product Hierarchy ID Mandatory

ProductHierarchyType External Hierarchy Type Code Mandatory

ProductHierarchyStatus Hierarchy Status Code

SalesOrganization External Sales Org ID

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 24/34
8/16/2020

Properties Description Necessity

DistributionChannel External Distribution Channel ID

ObjectActionCode Add, Change, Delete

ProductHierarchyPlanningStatus Planning Status TCD

ProductHierarchyNodeDescription
This entity is used in the API_Product_Hierarchy OData and contains information about the hierarchy node for descriptive text
purposes.

Properties

Properties Description Necessity

ProductHierarchyNode Product Hierarchy Node ID Mandatory

ProductHierarchyNodeType Node Type Code Mandatory

LanguageISOCode ISO Code Language Mandatory

Language External Language Mandatory

ProductHierarchyNodeName Product Hierarchy Node Description

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

ProductHierarchyNodeDetails
This entity is used in the API_Product_Hierarchy OData service to import product hierarchy detail characteristics information.

Properties

Properties Description Necessity

ProductHierarchyNode External Product Hierarchy Node ID Mandatory

ProductHierarchyNodeType Product Hierarchy Node Type Mandatory

Product External Product ID Mandatory

ProductHierarchyLevel Product Hierarchy Level

ProductHierarchyParentNode Product Hierarchy Parent Node ID

ProductHierarchyParentNodeType Product Hierarchy Parent Node Type

ProdHierNodeIsMerchandiseCat Node is Merchandise Category Flag

ValidityStartDate Begin Date This Node is Active Mandatory

ValidityEndDate End Date This Node is Active

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 25/34
8/16/2020

Properties Description Necessity

MerchandiseCategoryRole Category Role

MerchandiseCategoryStrategy Category Strategy

ProductPriceLevelGroup Price Group

ProductHierarchyNodeReference External ID of Reference Product Hierarchy

PersonResponsible Person Name or ID

 Note
To display more information about the properties, open an operation of the entity and select Model.

Import Product Location


Technical name: API_PRODUCT_LOCATION

This service enables you to upload your product by location data from the originating system to Demand Data Foundation (DDF).
You can create, update or delete data in DDF to be used by consuming applications of SAP Customer Activity Repository 4.0
FPS01. The product/location data is used for planning, forecasting and analytical reporting where time dependent activity with
cost and price is relevant.

Entities
The entities contain the business data of the service.

Entity Name Description Link to Details

Extension Customer de ned elds. Extension

Header The business system name. Header

ProdLoc Details about the product location. ProdLoc

ProdLocCost Component information for a product. ProdLocCost

ProdLocCostOfGoods Description of the product. ProdLocCostOfGoods

ProdLocLandingCost UOM, currency, landed cost, and date range ProdLocLandingCost


validity of prod/loc landed cost.

ProdLocPrice UOM, currency, and date range validity of ProdLocPrice


prod/loc price.

ProdLocTimeDependentData Date range for validity of prod/loc. ProdLocTimeDependentData

Extension
This optional entity is used in the BAPI parameter extension concept for customers. It is the reference structure for the
standardized BAPI extension parameters "ExtensionIn" and "ExtensionOut".

The BAPI parameter extension concept for customers uses the standardized BAPI parameters "ExtensionIn" and "ExtensionOut".
The parameters can be included in the BAPI using "BAPI table extensions" and customer exits. Using append or include

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 26/34
8/16/2020
techniques customer-de ned table extensions can then be used automatically in the interface and in the BAPI program. For
further information see the documentation on the extension parameters for the BAPI.

Customers can freely use these prede ned extension parameters to enhance the interface without causing incompatabilities in
the interface communication.

Properties

Properties Description Necessity

IN_ExtnStructure Structure name of BAPI table extension. Mandatory

IN_ExtnValPart1 Data part for BAPI parameters "ExtensionIn" Mandatory


and "ExtensionOut".

IN_ExtnValPart2 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart3 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart4 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

 Note
To display more information about the properties, open an operation of the entity and select Model.

Header
The header entity contains the value of the originating system and is a required input for inbound data.

Properties

Properties Description Necessity

BusinessSystemName The system that created the data being send Mandatory
to the application system.

 Note
To display more information about the properties, open an operation of the entity and select Model.

ProdLoc
This entity is used in the API_PRODUCT_LOCATION OData service and contains information about the product location and
organization.

Properties

Properties Description Necessity

Product Mandatory

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 27/34
8/16/2020

Properties Description Necessity

RetailLocation Mandatory

RetailLocationType Mandatory

ObjectActionCode

ConsumptionReferenceProduct

CnsmpnReferenceRetailLocation

CnsmpnRefRetailLocationType

CnsmpnRefBusSystName

ConsumptionReferenceFactor

ConsumptionRefUsageEndDate

ProductIsSeasonal

ProductHasConsignmentCtrl

ProductSellingClass

ProductListingStatus

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

ProdLocCost
This entity is used in the API_PRODUCT_LOCATION OData service and contains information about the product location cost.

Properties

Properties Description Necessity

ValidityStartDate Mandatory

ValidityEndDate Mandatory

AverageProductPurchasePrice

Currency

CurrencyISOCode

UnitOfMeasure

UnitOfMeasureISOCode

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 28/34
8/16/2020

ProdLocCostOfGoods
This entity is used in the API_PRODUCT_LOCATION OData service and contains information about the product location COG.

Properties

Properties Description Necessity

ValidityStartDate Mandatory

ValidityEndDate Mandatory

CostOfGoodsSold

Currency

CurrencyISOCode

UnitOfMeasure

UnitOfMeasureISOCode

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

ProdLocLandingCost
This entity is used in the API_PRODUCT_LOCATION OData service and contains information about the product location landed
cost values.

Properties

Properties Description Necessity

ValidityStartDate Mandatory

ValidityEndDate Mandatory

ProductLandedCost

Currency

CurrencyISOCode

UnitOfMeasure

UnitOfMeasureISOCode

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 29/34
8/16/2020

ProdLocPrice
This entity is used in the API_PRODUCT_LOCATION OData service and contains information about the product location prices.

Properties

Properties Description Necessity

ValidityStartDate Mandatory

ValidityEndDate Mandatory

NetAmount

GrossAmount

Currency

CurrencyISOCode

UnitOfMeasure

UnitOfMeasureISOCode

ProductPriceVATPercent

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

ProdLocTimeDependentData
This entity is used in the API_PRODUCT_LOCATION OData service and contains information about the product location time
dependent priorities.

Properties

Properties Description Necessity

RetailLocationProductPriority Mandatory

ValidityStartDate Mandatory

ValidityEndDate Mandatory

IsValid

 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.

Import Transportation Lane


https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 30/34
8/16/2020
Technical name: API_TRANSPORTATION_LANE

This service enables you to import transportation lane master data from the originating system to Demand Data Foundation (DDF)
to be used by consuming applications of SAP Customer Activity Repository 4.0 FPS01.

A transportation lane de nes the delivery relationship between a supplying location, a receiving location, and a product. The
transportation lane contains the purchase price for the relationship and has a validity period. This data can be used to determine
the procurement costs for a speci c product. It also supports planning, logistics, and reporting.

Entities
The entities contain the business data of the service.

Entity Name Description Link to Details

Extension Customer de ned elds. Extension

Header The business system name. Header

Lane Detail about the prod/loc & types, purchase Lane


group, and organizational data.

LanePriceData Supplier, target, purchase grp, order LanePriceData


information.

LaneVariablePrice Vendor/loc/prod price by date. LaneVariablePrice

Extension
This optional entity is used in the BAPI parameter extension concept for customers. It is the reference structure for the
standardized BAPI extension parameters "ExtensionIn" and "ExtensionOut".

The BAPI parameter extension concept for customers uses the standardized BAPI parameters "ExtensionIn" and "ExtensionOut".
The parameters can be included in the BAPI using "BAPI table extensions" and customer exits. Using append or include
techniques customer-de ned table extensions can then be used automatically in the interface and in the BAPI program. For
further information see the documentation on the extension parameters for the BAPI.

Customers can freely use these prede ned extension parameters to enhance the interface without causing incompatabilities in
the interface communication.

Properties

Properties Description Necessity

IN_ExtnStructure Structure name of BAPI table extension. Mandatory

IN_ExtnValPart1 Data part for BAPI parameters "ExtensionIn" Mandatory


and "ExtensionOut".

IN_ExtnValPart2 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart3 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

IN_ExtnValPart4 Data part for BAPI parameters "ExtensionIn"


and "ExtensionOut".

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 31/34
8/16/2020

 Note
To display more information about the properties, open an operation of the entity and select Model.

Header
The header entity contains the value of the originating system and is a required input for inbound data.

Properties

Properties Description Necessity

BusinessSystemName The system that created the data being send Mandatory
to the application system.

 Note
To display more information about the properties, open an operation of the entity and select Model.

Lane
This entity is used in the API_TRANSPORTATION_LANE OData service and contains information about the source of product
prices.

Properties

Properties Description Necessity

SupplyRetailLocation

SupplyRetailLocationType Mandatory

Product Mandatory

TargetRetailLocation

TargetRetailLocationType Mandatory

SupplierSubrange Mandatory

SOSType Mandatory

PurchasingOrganization Mandatory

ProductHasConsignmentControl Mandatory

PurchasingDocument Mandatory

PurchasingDocumentItem Mandatory

ValidityStartDate Mandatory

ValidityEndDate Mandatory

ObjectActionCode

SourceOfSupplyPriority

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 32/34
8/16/2020

Properties Description Necessity

GoodsIssue

MinimumOrderQuantity

MaximumOrderQuantity

SupplierProductID

VarblPurOrdUnitActvtnStatus

RoundingPro le

RestrictionPro le

PurchasingPlanner

ProcmtRelationshipIsActive

PurchaseOrderUnit

PurchaseOrderUnitISOCode

IsBlocked

PurgDepartmentProcessingTime

OrderProcessingGroup

PurchasingGroup

ProcessingMethodType

 Note
To display more information about the properties, open an operation of the entity and select Model.

LanePriceData
This entity is used in the API_TRANSPORTATION_LANE OData service and contains information about the product quantity and
unit cost/price.

Properties

Properties Description Necessity

PriceValidityStartDate Mandatory

PriceValidityEndDate Mandatory

QuantityFrom Mandatory

QuantityTo Mandatory

Currency

CurrencyISOCode

QuantityUnit Mandatory

QuantityUnitISOCode Mandatory

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 33/34
8/16/2020

Properties Description Necessity

PriceUnit

PriceUnitISOCode

CostPricePerUnit

 Note
To display more information about the properties, open an operation of the entity and select Model.

LaneVariablePrice
This entity is used in the API_TRANSPORTATION_LANE OData service and contains information about the product quantity and
unit cost/price for variable pricing.

Properties

Properties Description Necessity

PriceValidityStartDate Mandatory

PriceValidityEndDate Mandatory

QuantityFrom Mandatory

QuantityTo Mandatory

Currency

CurrencyISOCode

QuantityUnit Mandatory

QuantityUnitISOCode Mandatory

PriceUnit

PriceUnitISOCode

CostPricePerUnit

ProductPriceType Mandatory

 Note
To display more information about the properties, open an operation of the entity and select Model.

Business Functions (Obsolete)


As of SAP Customer Activity Repository 4.0 FPS01, all business functions for Uni ed Demand Forecast (UDF) and Demand Data
Foundation (DDF) have been deprecated. An activation during post-installation is no longer required. For more information, see
the Additional Improvements section in What's New in SAP Customer Activity Repository 4.0.

https://help.sap.com/http.svc/dynamicpdfcontentpreview?deliverable_id=21695042&topics=fbbab0a70976408e8afb97d21e… 34/34

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy