Xnapp Integration APIs
  1. xdPromotionDefinition
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
        POST
    • 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
    • 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. xdPromotionDefinition

/api/xd/1.0/set_promotion_definition_v1

Developing
POST
/api/xd/1.0/set_promotion_definition_v1

Request

Body Params application/json
promotion_control
arrayĀ [object {32}]Ā 
required
tenant_code
stringĀ 
required
<= 48 characters
promotion_code
stringĀ 
required
<= 100 characters
promotion_description
stringĀ 
required
<= 200 characters
promotion_remarks
stringĀ 
optional
<= 1000 characters
promotion_type_code
integerĀ 
required
range_basis
integerĀ 
required
amount_basis
integerĀ 
optional
exclusion_option
integerĀ 
required
promotion_indicator
stringĀ 
required
<= 6 characters
condition_type
stringĀ 
optional
<= 50 characters
sub_condition_type
stringĀ 
optional
<= 50 characters
promotion_product_level
integerĀ 
optional
enable_base_set
integerĀ 
optional
enable_foc_set
integerĀ 
optional
pro_rata
stringĀ 
optional
<= 2 characters
allow_promotion_quota
integerĀ 
required
allow_location_quota
integerĀ 
optional
allow_cap_quota
integerĀ 
optional
promotion_quota
numberĀ <float>
required
promotion_quota_code
stringĀ 
optional
<= 100 characters
minimum_sku
integerĀ 
optional
display_type
integerĀ 
optional
application_type
integerĀ 
optional
disable_gift_icon
integerĀ 
optional
allow_qps
integerĀ 
optional
promotion_mechanics
stringĀ 
optional
<= 50 characters
apply_promotion_as_coupon
integerĀ 
optional
exclusion_group_code
stringĀ 
optional
<= 100 characters
exclusion_group_list_for_net_value
stringĀ 
optional
<= 1000 characters
promotion_assignments
arrayĀ [object {7}]Ā 
optional
promo_groups
arrayĀ [object {9}]Ā 
optional
customer_promotion_mappings
arrayĀ [object {21}]Ā 
optional
Example
{
  "promotion_control": [
    {
      "tenant_code": "string",
      "promotion_code": "string",
      "promotion_description": "string",
      "promotion_remarks": "string",
      "promotion_type_code": 0,
      "range_basis": 0,
      "amount_basis": 0,
      "exclusion_option": 0,
      "promotion_indicator": "string",
      "condition_type": "string",
      "sub_condition_type": "string",
      "promotion_product_level": 0,
      "enable_base_set": 0,
      "enable_foc_set": 0,
      "pro_rata": "string",
      "allow_promotion_quota": 0,
      "allow_location_quota": 0,
      "allow_cap_quota": 0,
      "promotion_quota": 0,
      "promotion_quota_code": "string",
      "minimum_sku": 0,
      "display_type": 0,
      "application_type": 0,
      "disable_gift_icon": 0,
      "allow_qps": 0,
      "promotion_mechanics": "string",
      "apply_promotion_as_coupon": 0,
      "exclusion_group_code": "string",
      "exclusion_group_list_for_net_value": "string",
      "promotion_assignments": [
        {
          "tenant_code": "string",
          "promotion_code": "string",
          "range_low": 0,
          "range_high": 0,
          "repeating_range": 0,
          "promotion_amount": 0,
          "slab_number": 0
        }
      ],
      "promo_groups": [
        {
          "tenant_code": "string",
          "promotion_code": "string",
          "group_type": "string",
          "product_hierarchy_code": "string",
          "item_code": "string",
          "units_of_measure": "string",
          "item_type_code": "string",
          "quantity": 0,
          "set_code": "string"
        }
      ],
      "customer_promotion_mappings": [
        {
          "tenant_code": "string",
          "location_code": "string",
          "customer_code": "string",
          "category_code1": "string",
          "category_code2": "string",
          "category_code3": "string",
          "category_code4": "string",
          "category_code5": "string",
          "category_code6": "string",
          "category_code7": "string",
          "category_code8": "string",
          "category_code9": "string",
          "customer_hierarchy_code": "string",
          "segment_code": "string",
          "exclusion_customer_codes": "string",
          "promotion_code": "string",
          "start_date": "2024-04-16T11:04:00.730Z",
          "end_date": "2024-04-16T11:04:00.730Z",
          "active_indicator": 0,
          "sequence_number": 0,
          "group_sequence_no": 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/xd/1.0/set_promotion_definition_v1' \
--header 'Content-Type: application/json' \
--data-raw '{
  "promotion_control": [
    {
      "tenant_code": "string",
      "promotion_code": "string",
      "promotion_description": "string",
      "promotion_remarks": "string",
      "promotion_type_code": 0,
      "range_basis": 0,
      "amount_basis": 0,
      "exclusion_option": 0,
      "promotion_indicator": "string",
      "condition_type": "string",
      "sub_condition_type": "string",
      "promotion_product_level": 0,
      "enable_base_set": 0,
      "enable_foc_set": 0,
      "pro_rata": "string",
      "allow_promotion_quota": 0,
      "allow_location_quota": 0,
      "allow_cap_quota": 0,
      "promotion_quota": 0,
      "promotion_quota_code": "string",
      "minimum_sku": 0,
      "display_type": 0,
      "application_type": 0,
      "disable_gift_icon": 0,
      "allow_qps": 0,
      "promotion_mechanics": "string",
      "apply_promotion_as_coupon": 0,
      "exclusion_group_code": "string",
      "exclusion_group_list_for_net_value": "string",
      "promotion_assignments": [
        {
          "tenant_code": "string",
          "promotion_code": "string",
          "range_low": 0,
          "range_high": 0,
          "repeating_range": 0,
          "promotion_amount": 0,
          "slab_number": 0
        }
      ],
      "promo_groups": [
        {
          "tenant_code": "string",
          "promotion_code": "string",
          "group_type": "string",
          "product_hierarchy_code": "string",
          "item_code": "string",
          "units_of_measure": "string",
          "item_type_code": "string",
          "quantity": 0,
          "set_code": "string"
        }
      ],
      "customer_promotion_mappings": [
        {
          "tenant_code": "string",
          "location_code": "string",
          "customer_code": "string",
          "category_code1": "string",
          "category_code2": "string",
          "category_code3": "string",
          "category_code4": "string",
          "category_code5": "string",
          "category_code6": "string",
          "category_code7": "string",
          "category_code8": "string",
          "category_code9": "string",
          "customer_hierarchy_code": "string",
          "segment_code": "string",
          "exclusion_customer_codes": "string",
          "promotion_code": "string",
          "start_date": "2024-04-16T11:04:00.730Z",
          "end_date": "2024-04-16T11:04:00.730Z",
          "active_indicator": 0,
          "sequence_number": 0,
          "group_sequence_no": 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-04-16 11:18:39
Previous
/api/xd/1.0/set_customer_master
Next
/api/xd/1.0/set_journey_plan
Built with