• Register

Promotions Details

This API allows to retrieve the detail of a specific promotion. #### Request URI
#### Request Parameters
API field Type Description Mandatory Technical Details
promotionCode String Promotion code used to retrieve the promotion detail. Y Path parameter.
#### Request Example

#### Response Structure
API field Type Mandatory Description
promotionCode String N Promotion identifier.
customerCode String N Customer code associated with the promotion.
customerName String N Customer name associated with the promotion.
salesOrganizationCode String N Sales organization code.
promotionDescription String N Promotion description.
promotionTypeCode String N Promotion type code.
comment String N Promotion comment.
sellInStartDate String N Sell-in start date.
sellInEndDate String N Sell-in end date.
sellOutStartDate String N Sell-out start date.
sellOutEndDate String N Sell-out end date.
deliveryStartDate String N Delivery start date.
deliveryEndDate String N Delivery end date.
promotionStatus String N Promotion status.
financialReferencePromotion String N Financial reference promotion.
groupOperation String N Group operation code.
depotCode String N Depot code.
operationClosed Boolean N Indicates whether the operation is closed.
orderReceived Boolean N Indicates whether the order has been received.
creationDate String N Promotion creation date.
modificationTime String N Promotion last modification time.
modificationDate String N Promotion last modification date.
modifiedBy String N User who last modified the promotion.
accrualCurrencyCode String N Accrual currency code.
accrualAmount Decimal N Accrual amount.
promotionItems (0..∞)
promotionCode String N Promotion identifier associated with the item.
materialCode String N Material code.
productName String N Product name.
plannedQuantity Decimal N Planned quantity.
orderedQuantity Decimal N Ordered quantity.
unitOfMeasure String N Unit of measure.
mechanicCode String N Promotion mechanic code.
unitCost Decimal N Unit cost.
currencyCode String N Currency code.
discountRate Decimal N Discount rate.
promotionValue Decimal N Promotion value.
netPrice Decimal N Net price.
completed Boolean N Indicates whether the promotion item is completed.
remise1Amount Decimal N First remise amount.
remise2Amount Decimal N Second remise amount.
remiseCurrencyCode String N Remise currency code.
remise1Percentage Decimal N First remise percentage.
remise2Percentage Decimal N Second remise percentage.
remiseUnitOfMeasure String N Remise unit of measure.
orderedCumulativeQuantity Decimal N Ordered cumulative quantity.
deliveredCumulativeQuantity Decimal N Delivered cumulative quantity.
lineCanceled Boolean N Indicates whether the line is canceled.
agreementNumber Decimal N Agreement number.
invoicedAmount Decimal N Invoiced amount.
unitInvoicedAmount Decimal N Unit invoiced amount.
invoicedVolume Decimal N Invoiced volume.
actualRate Decimal N Actual rate.
baseUnitOfMeasure String N Base unit of measure.
itemComment String N Promotion item comment.
lineCancelled Boolean N Indicates whether the line is cancelled.
eanCode String N EAN code.
#### Response Example

#### Error Response Structure
API field Type Mandatory Description
status String Y Response status. Returned as Error in case of failed processing.
message String Y Error message describing the reason of the failure.
#### Error Response Examples

Validation error

Business error

SAP / backend processing error

Docs Navigation