Xnapp Integration APIs
  1. xcPromotion
Xnapp Integration APIs
  • LIGHTHOUSE Rest API Walkthrough
  • Lighthouse APIs
    • Authentication
      • /api/1.0/auth
    • TransactionStatus
      • /api/1.0/get_transaction_status
    • xcAssetDetail
      • /api/xc/1.0/set_asset_detail
    • Shopping Cart
      • /api/1.0/shopping_cart
    • xcAuthorizedProduct
      • /api/xc/1.0/set_authorized_product
    • xcCFAMapping
      • /api/xc/1.0/set_cfa_mapping
    • xcCFAMaster
      • /api/xc/1.0/set_cfa_master
    • xcCFAStock
      • /api/xc/1.0/set_cfa_stock
    • xcDistributorDetail
      • /api/xc/1.0/set_distributor
      • /api/xc/1.0/get_distributor
    • xcGetPromotionDetail
      • /api/xc/1.0/get_promotion_detail
    • xcHSNMaster
      • /api/xc/1.0/set_hsn_master
    • xcJourneyPlan
      • /api/xc/1.0/set_journey_plan
      • /api/xc/1.0/get_journey_plan
    • xcSubDistributorMargin
      • /api/xc/1.0/set_journey_plan
      • /api/xc/1.0/get_sub_distributor_margin
    • xcOrganizationHierarchy
      • /api/xc/1.0/set_organization_hierarchy
    • xcGetOrganizationHierarchy
      • /api/xc/1.0/get_organization_hierarchy
    • xcOutlet
      • /api/xc/1.0/get_outlet
      • /api/xc/1.0/set_outlet
    • xcOutletPriceMapping
      • /api/xc/1.0/get_outlet_price_mapping
    • xcPricingControl
      • /api/xc/1.0/set_price
    • xcPricingPlan
      • /api/xc/1.0/get_pricing_plan
    • xcProduct
      • /api/xc/1.0/set_product
      • /api/xc/1.0/get_product
    • xcRouteDetail
      • /api/xc/1.0/set_route
      • /api/xc/1.0/get_route
    • xcTerritoryHierarchy
      • /api/xc/1.0/set_territory_hierarchy
    • xcUserList
      • /api/xc/1.0/set_user_list
    • xdARCollection
      • Central APIs
      • /api/xd/1.0/get_ar_collection
    • xdAROpenItems
      • /api/xd/1.0/set_ar_open_items
    • xdCreditDebitNote
      • /api/xd/1.0/set_credit_debit_note
    • xdCreditDetails
      • /api/xd/1.0/get_credit_details
      • /api/xd/1.0/set_credit_details
    • xdDMSARCollection
      • /api/xd/1.0/set_dms_ar_collection
      • /api/xd/1.0/get_dms_ar_collection
    • xdEmptieDispatchAdvice
      • /api/xd/1.0/get_emptie_dispatch_advice
    • xdGetPurchaseOrder
      • /api/xd/1.0/get_purchase_order
    • xdGRNDetails
      • /api/xd/1.0/get_grn_details
    • xdLocationCreditDetails
      • /api/xd/1.0/set_location_credit
    • xdOpenItems
      • /api/xd/1.0/get_open_items
    • xdPendingInvoice
      • /api/xd/1.0/set_pending_invoice
    • xdPoFillRate
      • /api/xd/1.0/set_po_fill_rate
    • xdPOStatus
      • /api/xd/1.0/set_po_status
    • xdProduct
      • /api/xd/1.0/set_product
    • xdPromotion
      • /api/xd/1.0/get_promotion
    • xdPurchaseInvoice
      • /api/xd/1.0/set_purchase_invoice
    • xdSalesInvoice
      • /api/xd/1.0/get_sales_invoice
    • xdSalesOrder
      • /api/xd/1.0/get_dms_sales_orderĀ 
      • /api/xd/1.0/set_sales_order
      • /api/xd/1.0/get_sales_order
      • /api/xd/1.0/get_xo_sales_order
    • xdSalesOrderStatusUpdate
      • /api/xd/1.0/get_sales_order_status_update
    • xdSalesReturn
      • /api/xd/1.0/get_dms_sales_return
    • xdStockTransfer
      • /api/xd/1.0/get_stock_transfer
    • xdWarehouseStock
      • /api/xd/1.0/get_warehouse_stock
    • xdInterDTStockIn
      • /api/xd/1.0/get_inter_dt_stock_in
    • xdInterDTStockOut
      • /api/xd/1.0/get_inter_dt_stock_out
    • xdGetPOShoppingCart
      • /api/xd/1.0/get_po_shopping_cart
    • xdReturnOrder
      • /api/xd/1.0/set_return_order
    • xdDMSStockAdjustment
      • /api/xd/1.0/get_dms_stock_adjustment
    • xcDistributorPriceMapping
      • /api/xc/1.0/set_distributor_price_mapping
    • xdLocationDetails
      • /api/xd/1.0/set_location_details
    • xdBeatDetails
      • /api/xd/1.0/set_beat_details
    • xdVehicleDetails
      • /api/xd/1.0/set_vehicle_details
      • /api/xd/1.0/get_vehicle_details_ln
    • xdHHTMaster
      • /api/xd/1.0/set_xn_hht_master
    • xdPricingPlan
      • /api/xd/1.0/set_pricing_plan
    • xdPrimaryPrice
      • /api/xd/1.0/set_primary_price
    • xdAuthorizedProduct
      • /api/xd/1.0/set_authorized_product
      • /api/xd/1.0/set_xn_authorized_product
    • xdWarehouseInventory
      • /api/xd/1.0/set_warehouse_inventory
    • xdCustomerMaster
      • /api/xd/1.0/set_customer_master
    • xdPromotionDefinition
      • /api/xd/1.0/set_promotion_definition_v1
    • xdJourneyPlan
      • /api/xd/1.0/set_journey_plan
      • /api/xd/1.0/set_xn_journey_plan
      • /api/xd/1.0/get_journey_plan
    • xdRouteSetupV2
      • /api/xd/1.0/set_route_setup
    • xdCustomerTarget
      • /api/xd/1.0/set_customer_target
    • xdRouteTarget
      • /api/xd/1.0/set_route_target
      • /api/xd/1.0/set_xn_route_target
    • xdSalesInvoice
      • /api/xd/1.0/set_sales_Invoice
      • /api/xd/1.0/set_dms_sales_invoice
    • xdSchemeAchievement
      • /api/xd/1.0/set_scheme_achievement
    • xdVanLoad
      • /api/xd/1.0/set_van_load
    • xdVanStock
      • /api/xd/1.0/set_van_stock
    • xdOrderHistoryV1
      • /api/xd/1.0/set_order_history
    • xnBeatMaster
      • /api/xd/1.0/set_xn_beat_master
    • xdSupervisorDetails
      • /api/xd/1.0/set_xn_supervisor_details
    • xnRouteSetup
      • /api/xd/1.0/set_xn_route_setup
    • xdVisitSummaryList
      • /api/xd/1.0/get_visit_summary_v1
      • /api/xd/1.0/get_visit_summary_v2
    • xdGetNewCustomerRequest
      • /api/xd/1.0/get_new_customer_request
    • xdCustomerInventory
      • /api/xd/1.0/get_customer_inventory
    • xdGetUploadSyncKeys
      • /api/xd/1.0/get_upload_sync_keys
    • xdGetLoadRequest
      • /api/xd/1.0/get_load_request
    • xdGetCustomerGeoCode
      • /api/xd/1.0/get_customer_geo_code
    • xdDMSVanOffLoad
      • /api/xd/1.0/get_van_off_load
    • xdGetRetailerContactInfo
      • /api/xd/1.0/get_retailer_contact_info
    • xdRouteSetupV2
      • /api/xd/1.0/get_route_detail
    • xdGetSalesman
      • /api/xd/1.0/get_Salesman_details
    • xdCustomer
      • /api/xd/1.0/get_customer
    • xdSetLoadRequest
      • /api/xd/1.0/set_load_request
    • xdLoadOut
      • /api/xd/1.0/get_load_out
    • xdLoadOutStatus
      • /api/xd/1.0/set_load_out_status
    • xcPromotion
      • /api/xc/1.0/set_promotion
        POST
    • xcProductHierarchy
      • /api/xc/1.0/set_product_hierarchy
      • /api/xc/1.0/get_product_hierarchy
    • xdIQData
      • /api/xd/1.0/set_iq_data
    • xdSetReturnHistoryV1
      • /api/xd/1.0/set_return_history_v1
    • xdSetDNPlanInfo
      • /api/xd/1.0/set_dn_plan_info
    • xnJourneyPlanTemplate
      • /api/xd/1.0/set_xn_journey_plan_template
    • xdGetBeatMaster
      • /api/xd/1.0/get_beat_master
    • xcGetListSchemes
      • /api/xc/1.0/get_list_schemes
    • xcGetSchemeIsDuplicate
      • /api/xc/1.0get_scheme_is_duplicate
    • xcUpdateShortClosure
      • /api/xc/1.0/update_short_closure
    • xcCreateScheme
      • /api/xc/1.0/create_scheme
    • xcGetListBundleSchemes
      • /api/xc/1.0/get_list_bundle_schemes
    • xdPODURL
      • /api/xd/1.0/set_pod_url
    • xdGetPromoAccrualDetails
      • /api/xd/1.0/get_promo_accrual_details
    • xcExclusionList
      • /api/xc/1.0/get_exclusion_list
    • xdProductMaster
      • /api/xd/1.0/set_product_master
    • TerritoryRoute
      • /api/xd/1.0/set_territory_route_book
    • TerritoryRoute Copy
      • /api/xd/1.0/set_territory_route_book
  1. xcPromotion

/api/xc/1.0/set_promotion

Developing
POST
/api/xc/1.0/set_promotion

Request

Body Params application/json
promotion_master
arrayĀ [object {68}]Ā 
required
sales_Organisation
stringĀ 
optional
promotionCode
stringĀ 
optional
promotionDescription
stringĀ 
optional
ioCode
stringĀ 
optional
promotionQuotaCode
stringĀ 
optional
disbursementMethod
integerĀ 
optional
rangeBasis
integerĀ 
optional
promotionTypeCode
integerĀ 
optional
proRata
stringĀ 
optional
bundle_Promotion
integerĀ 
optional
exclusionOption
integerĀ 
optional
sequenceNumber
integerĀ 
optional
specialPromotion
integerĀ 
optional
start_Date
stringĀ 
optional
end_Date
stringĀ 
optional
slabnum
integerĀ 
optional
slabfrom
integerĀ 
optional
slabto
integerĀ 
optional
discount
integerĀ 
optional
repeating_Range
integerĀ 
optional
productGroup
stringĀ 
optional
promotionQuantity
integerĀ 
optional
unitOfMeasure
stringĀ 
optional
skuCode
stringĀ 
optional
product_Hierarchy
stringĀ 
optional
brand
stringĀ 
optional
beverage_Category
stringĀ 
optional
beverage_Product
stringĀ 
optional
packType
stringĀ 
optional
flavor
stringĀ 
optional
carbonationIndicator
stringĀ 
optional
packSize
stringĀ 
optional
productGroupBasis
stringĀ 
optional
tradeMark
stringĀ 
optional
general_Item_Category_Group
stringĀ 
optional
numberOfUniqueSKU
integerĀ 
optional
displayweightage
integerĀ 
optional
territory
stringĀ 
optional
distributorCode
stringĀ 
optional
outletHierarchyName
stringĀ 
optional
outletCode
stringĀ 
optional
premiseStatus
stringĀ 
optional
populatedArea
stringĀ 
optional
classification
stringĀ 
optional
category
stringĀ 
optional
customerGroupCode
stringĀ 
optional
customerBusienssType
stringĀ 
optional
customerKeyAccount
stringĀ 
optional
redCustomerName
stringĀ 
optional
customerType
stringĀ 
optional
coolerCustomer
stringĀ 
optional
exclusionCustomerCode
stringĀ 
optional
digital_Agreement
stringĀ 
optional
qualificationMode
stringĀ 
optional
amountBasis
stringĀ 
optional
allowCapQuota
stringĀ 
optional
sourceTags_Client
stringĀ 
optional
applyCount_Client
integerĀ 
optional
applyOn_Basket
integerĀ 
optional
cpc
integerĀ 
optional
exclusion_Group_Code
stringĀ 
optional
header_Level_Amount_Basis
integerĀ 
optional
isConsumer_Promotion
integerĀ 
optional
promotionQuota
integerĀ 
optional
useIn_Or
integerĀ 
optional
volume
integerĀ 
optional
isDiscretionary
integerĀ 
optional
dan
integerĀ 
optional
Example
{
  "promotion_master": [
    {
      "sales_Organisation": "string",
      "promotionCode": "string",
      "promotionDescription": "string",
      "ioCode": "string",
      "promotionQuotaCode": "string",
      "disbursementMethod": 0,
      "rangeBasis": 0,
      "promotionTypeCode": 0,
      "proRata": "string",
      "bundle_Promotion": 0,
      "exclusionOption": 0,
      "sequenceNumber": 0,
      "specialPromotion": 0,
      "start_Date": "string",
      "end_Date": "string",
      "slabnum": 0,
      "slabfrom": 0,
      "slabto": 0,
      "discount": 0,
      "repeating_Range": 0,
      "productGroup": "string",
      "promotionQuantity": 0,
      "unitOfMeasure": "string",
      "skuCode": "string",
      "product_Hierarchy": "string",
      "brand": "string",
      "beverage_Category": "string",
      "beverage_Product": "string",
      "packType": "string",
      "flavor": "string",
      "carbonationIndicator": "string",
      "packSize": "string",
      "productGroupBasis": "string",
      "tradeMark": "string",
      "general_Item_Category_Group": "string",
      "numberOfUniqueSKU": 0,
      "displayweightage": 0,
      "territory": "string",
      "distributorCode": "string",
      "outletHierarchyName": "string",
      "outletCode": "string",
      "premiseStatus": "string",
      "populatedArea": "string",
      "classification": "string",
      "category": "string",
      "customerGroupCode": "string",
      "customerBusienssType": "string",
      "customerKeyAccount": "string",
      "redCustomerName": "string",
      "customerType": "string",
      "coolerCustomer": "string",
      "exclusionCustomerCode": "string",
      "digital_Agreement": "string",
      "qualificationMode": "string",
      "amountBasis": "string",
      "allowCapQuota": "string",
      "sourceTags_Client": "string",
      "applyCount_Client": 0,
      "applyOn_Basket": 0,
      "cpc": 0,
      "exclusion_Group_Code": "string",
      "header_Level_Amount_Basis": 0,
      "isConsumer_Promotion": 0,
      "promotionQuota": 0,
      "useIn_Or": 0,
      "volume": 0,
      "isDiscretionary": 0,
      "dan": 0
    }
  ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://testapi.com/api/xc/1.0/set_promotion' \
--header 'Content-Type: application/json' \
--data-raw '{
  "promotion_master": [
    {
      "sales_Organisation": "string",
      "promotionCode": "string",
      "promotionDescription": "string",
      "ioCode": "string",
      "promotionQuotaCode": "string",
      "disbursementMethod": 0,
      "rangeBasis": 0,
      "promotionTypeCode": 0,
      "proRata": "string",
      "bundle_Promotion": 0,
      "exclusionOption": 0,
      "sequenceNumber": 0,
      "specialPromotion": 0,
      "start_Date": "string",
      "end_Date": "string",
      "slabnum": 0,
      "slabfrom": 0,
      "slabto": 0,
      "discount": 0,
      "repeating_Range": 0,
      "productGroup": "string",
      "promotionQuantity": 0,
      "unitOfMeasure": "string",
      "skuCode": "string",
      "product_Hierarchy": "string",
      "brand": "string",
      "beverage_Category": "string",
      "beverage_Product": "string",
      "packType": "string",
      "flavor": "string",
      "carbonationIndicator": "string",
      "packSize": "string",
      "productGroupBasis": "string",
      "tradeMark": "string",
      "general_Item_Category_Group": "string",
      "numberOfUniqueSKU": 0,
      "displayweightage": 0,
      "territory": "string",
      "distributorCode": "string",
      "outletHierarchyName": "string",
      "outletCode": "string",
      "premiseStatus": "string",
      "populatedArea": "string",
      "classification": "string",
      "category": "string",
      "customerGroupCode": "string",
      "customerBusienssType": "string",
      "customerKeyAccount": "string",
      "redCustomerName": "string",
      "customerType": "string",
      "coolerCustomer": "string",
      "exclusionCustomerCode": "string",
      "digital_Agreement": "string",
      "qualificationMode": "string",
      "amountBasis": "string",
      "allowCapQuota": "string",
      "sourceTags_Client": "string",
      "applyCount_Client": 0,
      "applyOn_Basket": 0,
      "cpc": 0,
      "exclusion_Group_Code": "string",
      "header_Level_Amount_Basis": 0,
      "isConsumer_Promotion": 0,
      "promotionQuota": 0,
      "useIn_Or": 0,
      "volume": 0,
      "isDiscretionary": 0,
      "dan": 0
    }
  ]
}'

Responses

šŸŸ¢200OK
application/json
Body
status
integerĀ 
required
message
stringĀ 
required
transaction_id
stringĀ 
required
record_count
integerĀ 
required
Example
{
  "status": 0,
  "message": "string",
  "transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "record_count": 0
}
Modified atĀ 2024-06-24 04:54:48
Previous
/api/xd/1.0/set_load_out_status
Next
/api/xc/1.0/set_product_hierarchy
Built with