Xnapp Integration APIs
  1. xcProduct
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
        POST
      • /api/xc/1.0/get_product
        POST
    • 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. xcProduct

/api/xc/1.0/get_product

POST
/api/xc/1.0/get_product
xcProduct

Request

Body Params application/json
tenant_code
stringĀ 
required
<= 50 characters
start_date_time
stringĀ <date-time>
optional
end_date_time
stringĀ <date-time>
optional
page_number
integerĀ 
required
Example
{
  "tenant_code": "string",
  "start_date_time": "2024-06-05T07:03:30.995Z",
  "end_date_time": "2024-06-05T07:03:30.995Z",
  "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_product' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenant_code": "string",
  "start_date_time": "2024-06-05T07:03:30.995Z",
  "end_date_time": "2024-06-05T07:03:30.995Z",
  "page_number": 0
}'

Responses

šŸŸ¢200Success
application/json
Body
array of:
tenant_code
stringĀ 
optional
<= 50 characters
item_code
stringĀ 
optional
<= 50 characters
item_type_code
integerĀ 
optional
item_description
stringĀ 
optional
<= 200 characters
item_description_a
stringĀ 
optional
<= 200 characters
ean_number
stringĀ 
optional
<= 50 characters
division_code
stringĀ 
optional
<= 25 characters
category_code_1
stringĀ 
optional
<= 50 characters
category_description_1
stringĀ 
optional
<= 100 characters
category_code_2
stringĀ 
optional
<= 50 characters
category_description_2
stringĀ 
optional
<= 100 characters
category_code_3
stringĀ 
optional
<= 50 characters
category_description_3
stringĀ 
optional
<= 100 characters
category_code_4
stringĀ 
optional
<= 50 characters
category_description_4
stringĀ 
optional
<= 100 characters
category_code_5
stringĀ 
optional
<= 50 characters
category_description_5
stringĀ 
optional
<= 100 characters
category_code_6
stringĀ 
optional
<= 50 characters
category_description_6
stringĀ 
optional
<= 100 characters
category_code_7
stringĀ 
optional
<= 50 characters
category_description_7
stringĀ 
optional
<= 100 characters
category_code_8
stringĀ 
optional
<= 50 characters
category_description_8
stringĀ 
optional
<= 100 characters
category_code_9
stringĀ 
optional
<= 50 characters
category_description_9
stringĀ 
optional
<= 100 characters
category_code_10
stringĀ 
optional
<= 50 characters
category_description_10
stringĀ 
optional
<= 100 characters
category_code_11
stringĀ 
optional
<= 50 characters
category_description_11
stringĀ 
optional
<= 100 characters
category_code_12
stringĀ 
optional
<= 50 characters
category_description_12
stringĀ 
optional
<= 100 characters
category_code_13
stringĀ 
optional
<= 50 characters
category_description_13
stringĀ 
optional
<= 100 characters
category_code_14
stringĀ 
optional
<= 50 characters
category_description_14
stringĀ 
optional
<= 100 characters
category_code_15
stringĀ 
optional
<= 50 characters
category_description_15
stringĀ 
optional
<= 100 characters
category_code_16
stringĀ 
optional
<= 50 characters
category_description_16
stringĀ 
optional
<= 100 characters
category_code_17
stringĀ 
optional
<= 50 characters
category_description_17
stringĀ 
optional
<= 100 characters
category_code_18
stringĀ 
optional
<= 50 characters
category_description_18
stringĀ 
optional
<= 100 characters
category_code_19
stringĀ 
optional
<= 50 characters
category_description_19
stringĀ 
optional
<= 100 characters
category_code_20
stringĀ 
optional
<= 50 characters
category_description_20
stringĀ 
optional
<= 100 characters
product_hierarchy_code
stringĀ 
optional
<= 50 characters
hierarchy_code_1
stringĀ 
optional
<= 50 characters
hierarchy_name_1
stringĀ 
optional
<= 100 characters
hierarchy_code_2
stringĀ 
optional
<= 50 characters
hierarchy_name_2
stringĀ 
optional
<= 100 characters
hierarchy_code_3
stringĀ 
optional
<= 50 characters
hierarchy_name_3
stringĀ 
optional
<= 100 characters
hierarchy_code_4
stringĀ 
optional
<= 50 characters
hierarchy_name_4
stringĀ 
optional
<= 100 characters
hierarchy_code_5
stringĀ 
optional
<= 50 characters
hierarchy_name_5
stringĀ 
optional
<= 100 characters
hierarchy_code_6
stringĀ 
optional
<= 50 characters
hierarchy_name_6
stringĀ 
optional
<= 100 characters
hierarchy_code_7
stringĀ 
optional
<= 50 characters
hierarchy_name_7
stringĀ 
optional
<= 100 characters
hierarchy_code_8
stringĀ 
optional
<= 50 characters
hierarchy_name_8
stringĀ 
optional
<= 100 characters
hierarchy_code_9
stringĀ 
optional
<= 50 characters
hierarchy_name_9
stringĀ 
optional
<= 100 characters
hierarchy_code_10
stringĀ 
optional
<= 50 characters
hierarchy_name_10
stringĀ 
optional
<= 100 characters
base_uom
stringĀ 
optional
<= 20 characters
units_of_measure
stringĀ 
optional
<= 20 characters
uom_1
stringĀ 
optional
<= 20 characters
uom_2
stringĀ 
optional
<= 20 characters
uom_3
stringĀ 
optional
<= 20 characters
uom_4
stringĀ 
optional
<= 20 characters
conversion_1
numberĀ <float>
optional
conversion_2
numberĀ <float>
optional
conversion_3
numberĀ <float>
optional
conversion_4
numberĀ <float>
optional
mrp
numberĀ <float>
optional
pack_size
stringĀ 
optional
<= 50 characters
weight
numberĀ <float>
optional
volume
numberĀ <float>
optional
length
numberĀ <float>
optional
width
numberĀ <float>
optional
height
numberĀ <float>
optional
item_shelf_life
integerĀ 
optional
code_date_format
integerĀ 
optional
sequence_number
integerĀ 
optional
use_alternative_uom
integerĀ 
optional
use_fixed_conversion
integerĀ 
optional
is_active
integerĀ 
optional
is_batch_managed
integerĀ 
optional
hsn_code
stringĀ 
optional
<= 50 characters
principle_item_code
stringĀ 
optional
<= 50 characters
principle_item_description
stringĀ 
optional
<= 100 characters
manufacturer_item_code
stringĀ 
optional
<= 50 characters
manufacturer_item_description
stringĀ 
optional
<= 200 characters
short_description
stringĀ 
optional
<= 100 characters
commission_type
integerĀ 
optional
commission_fixed_amount
numberĀ <float>
optional
commission_perc_of_sales
numberĀ <float>
optional
drug_license
integerĀ 
optional
pest_license
integerĀ 
optional
stock_cover_days
integerĀ 
optional
tax_group_code
stringĀ 
optional
<= 50 characters
pc_conversion
numberĀ <float>
optional
uc_conversion
numberĀ <float>
optional
lbd_days
integerĀ 
optional
mrp_with_tax
numberĀ <float>
optional
dod_days
integerĀ 
optional
sbd_days
integerĀ 
optional
Example
[
  {
    "tenant_code": "string",
    "item_code": "string",
    "item_type_code": 0,
    "item_description": "string",
    "item_description_a": "string",
    "ean_number": "string",
    "division_code": "string",
    "category_code_1": "string",
    "category_description_1": "string",
    "category_code_2": "string",
    "category_description_2": "string",
    "category_code_3": "string",
    "category_description_3": "string",
    "category_code_4": "string",
    "category_description_4": "string",
    "category_code_5": "string",
    "category_description_5": "string",
    "category_code_6": "string",
    "category_description_6": "string",
    "category_code_7": "string",
    "category_description_7": "string",
    "category_code_8": "string",
    "category_description_8": "string",
    "category_code_9": "string",
    "category_description_9": "string",
    "category_code_10": "string",
    "category_description_10": "string",
    "category_code_11": "string",
    "category_description_11": "string",
    "category_code_12": "string",
    "category_description_12": "string",
    "category_code_13": "string",
    "category_description_13": "string",
    "category_code_14": "string",
    "category_description_14": "string",
    "category_code_15": "string",
    "category_description_15": "string",
    "category_code_16": "string",
    "category_description_16": "string",
    "category_code_17": "string",
    "category_description_17": "string",
    "category_code_18": "string",
    "category_description_18": "string",
    "category_code_19": "string",
    "category_description_19": "string",
    "category_code_20": "string",
    "category_description_20": "string",
    "product_hierarchy_code": "string",
    "hierarchy_code_1": "string",
    "hierarchy_name_1": "string",
    "hierarchy_code_2": "string",
    "hierarchy_name_2": "string",
    "hierarchy_code_3": "string",
    "hierarchy_name_3": "string",
    "hierarchy_code_4": "string",
    "hierarchy_name_4": "string",
    "hierarchy_code_5": "string",
    "hierarchy_name_5": "string",
    "hierarchy_code_6": "string",
    "hierarchy_name_6": "string",
    "hierarchy_code_7": "string",
    "hierarchy_name_7": "string",
    "hierarchy_code_8": "string",
    "hierarchy_name_8": "string",
    "hierarchy_code_9": "string",
    "hierarchy_name_9": "string",
    "hierarchy_code_10": "string",
    "hierarchy_name_10": "string",
    "base_uom": "string",
    "units_of_measure": "string",
    "uom_1": "string",
    "uom_2": "string",
    "uom_3": "string",
    "uom_4": "string",
    "conversion_1": 0,
    "conversion_2": 0,
    "conversion_3": 0,
    "conversion_4": 0,
    "mrp": 0,
    "pack_size": "string",
    "weight": 0,
    "volume": 0,
    "length": 0,
    "width": 0,
    "height": 0,
    "item_shelf_life": 0,
    "code_date_format": 0,
    "sequence_number": 0,
    "use_alternative_uom": 0,
    "use_fixed_conversion": 0,
    "is_active": 0,
    "is_batch_managed": 0,
    "hsn_code": "string",
    "principle_item_code": "string",
    "principle_item_description": "string",
    "manufacturer_item_code": "string",
    "manufacturer_item_description": "string",
    "short_description": "string",
    "commission_type": 0,
    "commission_fixed_amount": 0,
    "commission_perc_of_sales": 0,
    "drug_license": 0,
    "pest_license": 0,
    "stock_cover_days": 0,
    "tax_group_code": "string",
    "pc_conversion": 0,
    "uc_conversion": 0,
    "lbd_days": 0,
    "mrp_with_tax": 0
  }
]
Modified atĀ 2024-06-05 09:16:48
Previous
/api/xc/1.0/set_product
Next
/api/xc/1.0/set_route
Built with