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
    • TerritoryRoute
      • /api/xd/1.0/set_territory_route_book
    • TerritoryRoute Copy
      • /api/xd/1.0/set_territory_route_book
  1. xcOutlet

/api/xc/1.0/get_outlet

Developing
POST
/api/xc/1.0/get_outlet

Request

Body Params application/json
tenant_code
stringĀ 
required
<= 24 characters
page_number
integerĀ 
optional
start_date_time
stringĀ <date-time>
required
end_date_time
stringĀ <date-time>
required
Example
{
  "tenant_code": "string",
  "page_number": 0,
  "start_date_time": "2024-02-05T12:23:43.256Z",
  "end_date_time": "2024-02-05T12:23:43.256Z"
}

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_outlet' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenant_code": "string",
  "page_number": 0,
  "start_date_time": "2024-02-05T12:23:43.256Z",
  "end_date_time": "2024-02-05T12:23:43.256Z"
}'

Responses

šŸŸ¢200OK
application/json
Body
array of:
tenant_code
stringĀ 
required
<= 24 characters
outlet_code
stringĀ 
required
<= 24 characters
outlet_name
stringĀ 
optional
<= 100 characters
outlet_name_a
stringĀ 
optional
<= 100 characters
address_1
stringĀ 
optional
<= 300 characters
address_2
stringĀ 
optional
<= 100 characters
address_3
stringĀ 
optional
<= 100 characters
zip
stringĀ 
optional
<= 20 characters
mobile
stringĀ 
optional
<= 60 characters
phone
stringĀ 
optional
<= 60 characters
email
stringĀ 
optional
<= 200 characters
contact_person
stringĀ 
optional
<= 100 characters
category_code_1
stringĀ 
optional
<= 24 characters
category_code_2
stringĀ 
optional
<= 24 characters
category_code_3
stringĀ 
optional
<= 24 characters
category_code_4
stringĀ 
optional
<= 24 characters
category_code_5
stringĀ 
optional
<= 24 characters
category_code_6
stringĀ 
optional
<= 24 characters
category_code_7
stringĀ 
optional
<= 24 characters
category_code_8
stringĀ 
optional
<= 24 characters
category_code_9
stringĀ 
optional
<= 24 characters
category_code_10
stringĀ 
optional
<= 24 characters
category_description_1
stringĀ 
optional
<= 100 characters
category_description_2
stringĀ 
optional
<= 100 characters
category_description_3
stringĀ 
optional
<= 100 characters
category_description_4
stringĀ 
optional
<= 100 characters
category_description_5
stringĀ 
optional
<= 100 characters
category_description_6
stringĀ 
optional
<= 100 characters
category_description_7
stringĀ 
optional
<= 100 characters
category_description_8
stringĀ 
optional
<= 100 characters
category_description_9
stringĀ 
optional
<= 100 characters
category_description_10
stringĀ 
optional
<= 100 characters
hierarchy_code
stringĀ 
optional
<= 24 characters
hierarchy_code_level_1
stringĀ 
optional
<= 24 characters
hierarchy_code_level_2
stringĀ 
optional
<= 24 characters
hierarchy_code1_level_1
stringĀ 
optional
<= 24 characters
hierarchy_code1_level_2
stringĀ 
optional
<= 24 characters
hierarchy_code1_level_3
stringĀ 
optional
<= 24 characters
hierarchy_code2_level_1
stringĀ 
optional
<= 24 characters
hierarchy_code2_level_2
stringĀ 
optional
<= 24 characters
territory_hierarchy_level_3
stringĀ 
optional
<= 24 characters
territory_hierarchy_level_4
stringĀ 
optional
<= 24 characters
outlet_status
integerĀ 
optional
sales_mode
integerĀ 
optional
payment_type
integerĀ 
optional
bill_to_outlet
stringĀ 
optional
<= 24 characters
owner_name
stringĀ 
optional
<= 100 characters
date_of_registration
stringĀ <date-time>
optional
license_number_1
stringĀ 
optional
<= 50 characters
license_expiry_date_1
stringĀ <date-time>
optional
gst_number
stringĀ 
optional
<= 50 characters
state_code
stringĀ 
optional
<= 50 characters
enable_oms
stringĀ 
optional
<= 24 characters
is_outlet_owner_female
stringĀ 
optional
<= 10 characters
account_group_code
stringĀ 
optional
<= 4 characters
bill_to_code
stringĀ 
optional
<= 10 characters
last_modified_date_time
stringĀ <date-time>
optional
geo_code_x
integerĀ 
optional
geo_code_y
integerĀ 
optional
distributor_outlet_mapping
arrayĀ [object {5}]Ā 
optional
tenant_code
stringĀ 
required
<= 24 characters
outlet_code
stringĀ 
required
<= 24 characters
distributor_code
stringĀ 
required
<= 24 characters
distributor_outlet_code
stringĀ 
required
<= 24 characters
is_active
integerĀ 
required
Example
[
  {
    "tenant_code": "string",
    "outlet_code": "string",
    "outlet_name": "string",
    "outlet_name_a": "string",
    "address_1": "string",
    "address_2": "string",
    "address_3": "string",
    "zip": "string",
    "mobile": "string",
    "phone": "string",
    "email": "string",
    "contact_person": "string",
    "category_code_1": "string",
    "category_code_2": "string",
    "category_code_3": "string",
    "category_code_4": "string",
    "category_code_5": "string",
    "category_code_6": "string",
    "category_code_7": "string",
    "category_code_8": "string",
    "category_code_9": "string",
    "category_code_10": "string",
    "category_description_1": "string",
    "category_description_2": "string",
    "category_description_3": "string",
    "category_description_4": "string",
    "category_description_5": "string",
    "category_description_6": "string",
    "category_description_7": "string",
    "category_description_8": "string",
    "category_description_9": "string",
    "category_description_10": "string",
    "hierarchy_code": "string",
    "hierarchy_code_level_1": "string",
    "hierarchy_code_level_2": "string",
    "hierarchy_code1_level_1": "string",
    "hierarchy_code1_level_2": "string",
    "hierarchy_code1_level_3": "string",
    "hierarchy_code2_level_1": "string",
    "hierarchy_code2_level_2": "string",
    "territory_hierarchy_level_3": "string",
    "territory_hierarchy_level_4": "string",
    "outlet_status": 0,
    "sales_mode": 0,
    "payment_type": 0,
    "bill_to_outlet": "string",
    "owner_name": "string",
    "date_of_registration": "2024-02-05T12:23:43.258Z",
    "license_number_1": "string",
    "license_expiry_date_1": "2024-02-05T12:23:43.258Z",
    "gst_number": "string",
    "state_code": "string",
    "enable_oms": "string",
    "is_outlet_owner_female": "string",
    "account_group_code": "string",
    "bill_to_code": "string",
    "last_modified_date_time": "2024-02-05T12:23:43.258Z",
    "geo_code_x": 0,
    "geo_code_y": 0
  }
]
Modified atĀ 2024-06-26 04:26:54
Previous
/api/xc/1.0/get_organization_hierarchy
Next
/api/xc/1.0/set_outlet
Built with