Xnapp Integration APIs
  1. xcOutlet
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
        POST
      • /api/xc/1.0/set_outlet
        POST
    • 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
    • rtRouteIncentive
      • /api/xd/1.0/set_route_incentive
    • xcProductRCMapping
      • /api/xc/1.0/set_product_rc_mapping
    • xdDMSPriceList
      • /api/xd/1.0/set_dms_price_list
    • TerritoryRoute
      • /api/xd/1.0/set_territory_route_book
    • xdDMSLoadoutSettlement
      • /api/xd/1.0/get_dms_loadout_settlement
    • xdAssetTransaction
      • /api/xd/1.0/get_dms_asset_transaction
    • xdGetOutletEmpties
      • api/xd/1.0/get_outlet_empties
    • xdGetDMSStockConversion
      • /api/xd/1.0/get_dms_stock_conversion
    • xdGetDMSWarehouseBatchStock
      • /api/xd/1.0/get_dms_warehouse_batch_stock
  1. xcOutlet

/api/xc/1.0/set_outlet

POST
/api/xc/1.0/set_outlet

Request

Body Params application/json

Example
{
  "outlet": [
    {
      "tenant_code": "string",
      "outlet_code": "string",
      "outlet_name": "string",
      "outlet_name_a": "string",
      "address_1": "string",
      "address_2": "string",
      "address_3": "string",
      "address_4": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "mobile": "string",
      "phone": "string",
      "telephone": "string",
      "fax": "string",
      "email": "string",
      "website": "string",
      "contact_person": "string",
      "notes": "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",
      "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",
      "outlet_hierarchy_code": "string",
      "territory_hierarchy": "string",
      "organization_hierarchy": "string",
      "geo_code_x": 0,
      "geo_code_y": 0,
      "outlet_status": 0,
      "sales_mode": 0,
      "payment_type": 0,
      "bill_to_outlet": 0,
      "is_taxable": 0,
      "sales_group_code": "string",
      "seviced_by_outlet": 0,
      "tertiary_outlet": 0,
      "sub_db_attribute": 0,
      "outlet_pricing_key": "string",
      "authorized_item_code": "string",
      "owner_name": "string",
      "date_of_registration": "2025-05-08T07:25:02.540Z",
      "date_of_birth": "2025-05-08T07:25:02.540Z",
      "anniversary_date": "2025-05-08T07:25:02.540Z",
      "id_number": "string",
      "trade_id_number": "string",
      "license_number": "string",
      "license_expiry_date": "2025-05-08T07:25:02.540Z",
      "license_number_1": "string",
      "license_expiry_date_1": "2025-05-08T07:25:02.540Z",
      "license_number_2": "string",
      "license_expiry_date_2": "2025-05-08T07:25:02.540Z",
      "tin_number": "string",
      "gst_number": "string",
      "pan_card_number": "string",
      "gst_registration_type": 0,
      "related_party": 0,
      "state_code": "string",
      "enable_oms": 0,
      "is_outlet_owner_female": 0,
      "income_class": "string",
      "bp_number": "string",
      "tax_admin_office": "string",
      "is_active_tax_payer": 0,
      "last_mile_delivery_vehicleType": 0,
      "asset_ownership_status": "string",
      "tax_number": "string",
      "day_off": "string",
      "coverage": "string",
      "tax_type": 0,
      "enforce_capturing_claim_ref_no": 0,
      "disable_delivery_edit": 0,
      "enforce_capturing_grn_pod_no": 0,
      "tax_code": "string",
      "distributor_outlet_mapping": [
        {
          "tenant_code": "string",
          "outlet_code": "string",
          "distributor_code": "string",
          "distributor_outlet_code": "string",
          "is_active": 0
        }
      ]
    }
  ]
}

Request Code 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_outlet' \
--header 'Content-Type: application/json' \
--data-raw '{
  "outlet": [
    {
      "tenant_code": "string",
      "outlet_code": "string",
      "outlet_name": "string",
      "outlet_name_a": "string",
      "address_1": "string",
      "address_2": "string",
      "address_3": "string",
      "address_4": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "mobile": "string",
      "phone": "string",
      "telephone": "string",
      "fax": "string",
      "email": "string",
      "website": "string",
      "contact_person": "string",
      "notes": "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",
      "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",
      "outlet_hierarchy_code": "string",
      "territory_hierarchy": "string",
      "organization_hierarchy": "string",
      "geo_code_x": 0,
      "geo_code_y": 0,
      "outlet_status": 0,
      "sales_mode": 0,
      "payment_type": 0,
      "bill_to_outlet": 0,
      "is_taxable": 0,
      "sales_group_code": "string",
      "seviced_by_outlet": 0,
      "tertiary_outlet": 0,
      "sub_db_attribute": 0,
      "outlet_pricing_key": "string",
      "authorized_item_code": "string",
      "owner_name": "string",
      "date_of_registration": "2025-05-08T07:25:02.540Z",
      "date_of_birth": "2025-05-08T07:25:02.540Z",
      "anniversary_date": "2025-05-08T07:25:02.540Z",
      "id_number": "string",
      "trade_id_number": "string",
      "license_number": "string",
      "license_expiry_date": "2025-05-08T07:25:02.540Z",
      "license_number_1": "string",
      "license_expiry_date_1": "2025-05-08T07:25:02.540Z",
      "license_number_2": "string",
      "license_expiry_date_2": "2025-05-08T07:25:02.540Z",
      "tin_number": "string",
      "gst_number": "string",
      "pan_card_number": "string",
      "gst_registration_type": 0,
      "related_party": 0,
      "state_code": "string",
      "enable_oms": 0,
      "is_outlet_owner_female": 0,
      "income_class": "string",
      "bp_number": "string",
      "tax_admin_office": "string",
      "is_active_tax_payer": 0,
      "last_mile_delivery_vehicleType": 0,
      "asset_ownership_status": "string",
      "tax_number": "string",
      "day_off": "string",
      "coverage": "string",
      "tax_type": 0,
      "enforce_capturing_claim_ref_no": 0,
      "disable_delivery_edit": 0,
      "enforce_capturing_grn_pod_no": 0,
      "tax_code": "string",
      "distributor_outlet_mapping": [
        {
          "tenant_code": "string",
          "outlet_code": "string",
          "distributor_code": "string",
          "distributor_outlet_code": "string",
          "is_active": 0
        }
      ]
    }
  ]
}'

Responses

šŸŸ¢200Success
application/json
Body

Example
{
    "status": 0,
    "message": "string",
    "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
    "record_count": 0
}
Modified atĀ 2025-05-08 07:28:06
Previous
/api/xc/1.0/get_outlet
Next
/api/xc/1.0/get_outlet_price_mapping
Built with