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

/api/xc/1.0/get_promotion_detail

POST
/api/xc/1.0/get_promotion_detail
xcGetPromotionDetail

Request

Body Params application/json
tenant_code
stringĀ Ā |Ā nullĀ 
required
<= 10 characters
distributor_code
stringĀ Ā |Ā nullĀ 
required
<= 30 characters
start_date
stringĀ <date-time>Ā |Ā nullĀ 
optional
end_date
stringĀ <date-time>Ā |Ā nullĀ 
optional
page_number
integerĀ <int32>
optional
Example
{
    "tenant_code": "string",
    "distributor_code": "string",
    "start_date": "2019-08-24T14:15:22Z",
    "end_date": "2019-08-24T14:15:22Z",
    "page_number": 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/get_promotion_detail' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tenant_code": "string",
    "distributor_code": "string",
    "start_date": "2019-08-24T14:15:22Z",
    "end_date": "2019-08-24T14:15:22Z",
    "page_number": 0
}'

Responses

šŸŸ¢200Success
application/json
Body
array of:
tenant_code
stringĀ 
required
<= 12 characters
promotion_code
stringĀ 
required
<= 25 characters
promotion_description
stringĀ 
required
<= 50 characters
promotion_type_code
enum<integer>Ā <int32>
required
>= 1<= 6
Allowed values:
123456
range_basis
enum<integer>Ā <int32>
required
>= 0<= 2
Allowed values:
012
amount_basis
enum<integer>Ā <int32>
required
>= 0<= 2
Allowed values:
012
exclusion_option
integerĀ <int32>
optional
>= 0<= 1
promotion_indicator
stringĀ 
required
<= 3 characters
condition_type
stringĀ 
optional
<= 25 characters
special_promotion
integerĀ <int32>
optional
promotion_product_level
integerĀ <int32>
required
pro_rata
stringĀ 
optional
<= 1 characters
allow_promotion_quota
integerĀ <int32>
optional
promotion_quota
numberĀ <double>
optional
promotion_quota_code
stringĀ 
optional
<= 25 characters
allow_qps
integerĀ <int32>
required
approval_status
integerĀ <int32>
optional
closure_type
integerĀ <int32>
optional
is_discretionary_promotion
integerĀ <int32>
optional
created_date_time
stringĀ <date-time>
optional
modified_date_time
stringĀ <date-time>
optional
bundle_promotion
integerĀ <int32>
optional
source_tags
stringĀ 
required
<= 500 characters
is_consumer_promotion
integerĀ <int32>
optional
always_apply
stringĀ 
optional
promotion_assignment
arrayĀ [object {7}]Ā 
optional
tenant_code
stringĀ 
required
<= 12 characters
promotion_code
stringĀ 
required
<= 25 characters
range_low
numberĀ <double>
required
range_high
numberĀ <double>
required
repeating_range
integerĀ <int32>
required
promotion_amount
numberĀ <double>
required
slab_number
integerĀ <int32>
required
outlet_promotion_mapping
arrayĀ [object {20}]Ā 
optional
tenant_code
stringĀ 
required
<= 12 characters
distributor_code
stringĀ 
required
<= 12 characters
outlet_code
stringĀ 
optional
<= 12 characters
category_code1
stringĀ 
optional
<= 12 characters
category_code2
stringĀ 
optional
<= 12 characters
category_code3
stringĀ 
optional
<= 12 characters
category_code4
stringĀ 
optional
<= 12 characters
category_code5
stringĀ 
optional
<= 12 characters
category_code6
stringĀ 
optional
<= 12 characters
category_code7
stringĀ 
optional
<= 12 characters
category_code8
stringĀ 
optional
<= 12 characters
category_code9
stringĀ 
optional
<= 12 characters
category_code10
stringĀ 
optional
<= 12 characters
outlet_hierarchy_code
stringĀ 
optional
<= 20 characters
exclusion_outlet_codes
stringĀ 
optional
promotion_code
stringĀ 
required
<= 25 characters
start_date
stringĀ <date-time>
required
end_date
stringĀ <date-time>
required
active_indicator
enum<integer>Ā 
required
Allowed values:
01
sequence_number
integerĀ 
required
product_group
arrayĀ [object {22}]Ā 
optional
tenant_code
stringĀ 
required
<= 12 characters
promotion_code
stringĀ 
required
<= 25 characters
group_type
stringĀ 
required
<= 1 characters
product_hierarchy_code
stringĀ 
required
<= 20 characters
product_category_type
integerĀ <int32>
optional
product_category_code
stringĀ 
optional
<= 12 characters
category_code1
stringĀ 
optional
<= 12 characters
category_code2
stringĀ 
optional
<= 12 characters
category_code3
stringĀ 
optional
<= 12 characters
category_code4
stringĀ 
optional
<= 12 characters
category_code5
stringĀ 
optional
<= 12 characters
category_code6
stringĀ 
optional
<= 12 characters
category_code7
stringĀ 
optional
<= 12 characters
category_code8
stringĀ 
optional
<= 12 characters
category_code9
stringĀ 
optional
<= 12 characters
category_code10
stringĀ 
optional
<= 12 characters
item_code
stringĀ 
required
<= 18 characters
units_of_measure
stringĀ 
optional
<= 20 characters
item_type_code
integerĀ <int32>
optional
quantity
integerĀ <int32>
optional
product_group_id
stringĀ 
optional
<= 16 characters
set_code
stringĀ 
optional
<= 36 characters
distributor_promotion_mapping
arrayĀ [object {3}]Ā 
optional
tenant_code
stringĀ 
required
<= 12 characters
distributor_code
stringĀ 
required
<= 12 characters
promotion_code
stringĀ 
optional
<= 25 characters
Example
[
    {
        "tenant_code": "string",
        "promotion_code": "string",
        "promotion_description": "string",
        "promotion_type_code": 0,
        "range_basis": 0,
        "amount_basis": 0,
        "exclusion_option": 0,
        "promotion_indicator": "string",
        "condition_type": "string",
        "special_promotion": 0,
        "promotion_product_level": 0,
        "pro_rata": "string",
        "allow_promotion_quota": 0,
        "promotion_quota": 0,
        "promotion_quota_code": "string",
        "allow_qps": 0,
        "approval_status": 0,
        "closure_type": 0,
        "is_discretionary_promotion": 0,
        "created_date_time": "2024-08-28T07:47:15.260Z",
        "modified_date_time": "2024-08-28T07:47:15.260Z",
        "bundle_promotion": 0,
        "source_tags": "string",
        "is_consumer_promotion": 0,
        "always_apply": "string",
        "promotion_assignment": [
            {
                "tenant_code": "string",
                "promotion_code": "string",
                "range_low": 0,
                "range_high": 0,
                "repeating_range": 0,
                "promotion_amount": 0,
                "slab_number": 0
            }
        ],
        "outlet_promotion_mapping": [
            {
                "tenant_code": "string",
                "distributor_code": "string",
                "outlet_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",
                "category_code10": "string",
                "outlet_hierarchy_code": "string",
                "exclusion_outlet_codes": "string",
                "promotion_code": "string",
                "start_date": "2024-08-28T07:47:15.260Z",
                "end_date": "2024-08-28T07:47:15.260Z",
                "active_indicator": 0,
                "sequence_number": 0
            }
        ],
        "product_group": [
            {
                "tenant_code": "string",
                "promotion_code": "string",
                "group_type": "string",
                "product_hierarchy_code": "string",
                "product_category_type": 0,
                "product_category_code": "string",
                "item_code": "string",
                "units_of_measure": "string",
                "item_type_code": 0,
                "quantity": 0,
                "product_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "product_category_code1": "string",
                "product_category_code2": "string",
                "product_category_code3": "string",
                "product_category_code4": "string",
                "product_category_code5": "string",
                "product_category_code6": "string",
                "product_category_code7": "string",
                "product_category_code8": "string",
                "product_category_code9": "string",
                "product_category_code10": "string",
                "set_code": "string"
            }
        ],
        "distributor_promotion_mapping": [
            {
                "tenant_code": "string",
                "distributor_code": "string",
                "promotion_code": "string"
            }
        ]
    }
]
Modified atĀ 2024-04-18 09:43:36
Previous
/api/xc/1.0/get_distributor
Next
/api/xc/1.0/set_hsn_master
Built with