- LIGHTHOUSE Rest API Walkthrough
- Lighthouse APIs
- Authentication
- TransactionStatus
- xcAssetDetail
- Shopping Cart
- xcAuthorizedProduct
- xcCFAMapping
- xcCFAMaster
- xcCFAStock
- xcDistributorDetail
- xcGetPromotionDetail
- xcHSNMaster
- xcJourneyPlan
- xcSubDistributorMargin
- xcOrganizationHierarchy
- xcGetOrganizationHierarchy
- xcOutlet
- xcOutletPriceMapping
- xcPricingControl
- xcPricingPlan
- xcProduct
- xcRouteDetail
- xcTerritoryHierarchy
- xcUserList
- xdARCollection
- xdAROpenItems
- xdCreditDebitNote
- xdCreditDetails
- xdDMSARCollection
- xdEmptieDispatchAdvice
- xdGetPurchaseOrder
- xdGRNDetails
- xdLocationCreditDetails
- xdOpenItems
- xdPendingInvoice
- xdPoFillRate
- xdPOStatus
- xdProduct
- xdPromotion
- xdPurchaseInvoice
- xdSalesInvoice
- xdSalesOrder
- xdSalesOrderStatusUpdate
- xdSalesReturn
- xdStockTransfer
- xdWarehouseStock
- xdInterDTStockIn
- xdInterDTStockOut
- xdGetPOShoppingCart
- xdReturnOrder
- xdDMSStockAdjustment
- xcDistributorPriceMapping
- xdLocationDetails
- xdBeatDetails
- xdVehicleDetails
- xdHHTMaster
- xdPricingPlan
- xdPrimaryPrice
- xdAuthorizedProduct
- xdWarehouseInventory
- xdCustomerMaster
- xdPromotionDefinition
- xdJourneyPlan
- xdRouteSetupV2
- xdCustomerTarget
- xdRouteTarget
- xdSalesInvoice
- xdSchemeAchievement
- xdVanLoad
- xdVanStock
- xdOrderHistoryV1
- xnBeatMaster
- xdSupervisorDetails
- xnRouteSetup
- xdVisitSummaryList
- xdGetNewCustomerRequest
- xdCustomerInventory
- xdGetUploadSyncKeys
- xdGetLoadRequest
- xdGetCustomerGeoCode
- xdDMSVanOffLoad
- xdGetRetailerContactInfo
- xdRouteSetupV2
- xdGetSalesman
- xdCustomer
- xdSetLoadRequest
- xdLoadOut
- xdLoadOutStatus
- xcPromotion
- xcProductHierarchy
- xdIQData
- xdSetReturnHistoryV1
- xdSetDNPlanInfo
- xnJourneyPlanTemplate
- xdGetBeatMaster
- xcGetListSchemes
- xcGetSchemeIsDuplicate
- xcUpdateShortClosure
- xcCreateScheme
- xcGetListBundleSchemes
- xdPODURL
- xdGetPromoAccrualDetails
- xcExclusionList
- xdProductMaster
- TerritoryRoute
- TerritoryRoute Copy
/api/xc/1.0/set_outlet
POST
/api/xc/1.0/set_outlet
xcOutlet
Request
Body Params application/json
outlet
arrayĀ [object {108}]Ā
optional
tenant_code
stringĀ
required
<= 24 characters
outlet_code
stringĀ
required
<= 24 characters
outlet_name
stringĀ
required
<= 50 characters
outlet_name_a
stringĀ
optional
<= 50 characters
address_1
stringĀ
optional
<= 70 characters
address_2
stringĀ
optional
<= 70 characters
address_3
stringĀ
optional
<= 70 characters
address_4
stringĀ
optional
<= 70 characters
city
stringĀ
optional
<= 40 characters
state
stringĀ
optional
<= 40 characters
zip
stringĀ
optional
<= 20 characters
mobile
stringĀ
optional
<= 30 characters
phone
stringĀ
optional
<= 30 characters
telephone
stringĀ
optional
<= 30 characters
fax
stringĀ
optional
<= 30 characters
email
stringĀ
optional
<= 50 characters
website
stringĀ
optional
<= 50 characters
contact_person
stringĀ
optional
<= 50 characters
notes
stringĀ
optional
<= 100 characters
category_code_1
stringĀ
optional
<= 12 characters
category_description_1
stringĀ
optional
<= 12 characters
category_code_2
stringĀ
optional
<= 12 characters
category_description_2
stringĀ
optional
<= 12 characters
category_code_3
stringĀ
optional
<= 12 characters
category_description_3
stringĀ
optional
<= 12 characters
category_code_4
stringĀ
optional
<= 12 characters
category_description_4
stringĀ
optional
<= 12 characters
category_code_5
stringĀ
optional
<= 12 characters
category_description_5
stringĀ
optional
<= 12 characters
category_code_6
stringĀ
optional
<= 12 characters
category_description_6
stringĀ
optional
<= 12 characters
category_code_7
stringĀ
optional
<= 12 characters
category_description_7
stringĀ
optional
<= 12 characters
category_code_8
stringĀ
optional
<= 12 characters
category_description_8
stringĀ
optional
<= 12 characters
category_code_9
stringĀ
optional
<= 12 characters
category_description_9
stringĀ
optional
<= 12 characters
category_code_10
stringĀ
optional
<= 12 characters
category_description_10
stringĀ
optional
<= 12 characters
hierarchy_code_1
stringĀ
optional
<= 100 characters
hierarchy_name_1
stringĀ
optional
<= 100 characters
hierarchy_code_2
stringĀ
optional
<= 100 characters
hierarchy_name_2
stringĀ
optional
<= 100 characters
hierarchy_code_3
stringĀ
optional
<= 100 characters
hierarchy_name_3
stringĀ
optional
<= 100 characters
hierarchy_code_4
stringĀ
optional
<= 100 characters
hierarchy_name_4
stringĀ
optional
<= 100 characters
hierarchy_code_5
stringĀ
optional
<= 100 characters
hierarchy_name_5
stringĀ
optional
<= 100 characters
hierarchy_code_6
stringĀ
optional
<= 100 characters
hierarchy_name_6
stringĀ
optional
<= 100 characters
hierarchy_code_7
stringĀ
optional
<= 100 characters
hierarchy_name_7
stringĀ
optional
<= 100 characters
hierarchy_code_8
stringĀ
optional
<= 100 characters
hierarchy_name_8
stringĀ
optional
<= 100 characters
hierarchy_code_9
stringĀ
optional
<= 100 characters
hierarchy_name_9
stringĀ
optional
<= 100 characters
hierarchy_code_10
stringĀ
optional
<= 100 characters
hierarchy_name_10
stringĀ
optional
<= 100 characters
outlet_hierarchy_code
stringĀ
optional
<= 100 characters
territory_hierarchy
stringĀ
optional
<= 100 characters
geo_code_x
numberĀ <double>
optional
geo_code_y
numberĀ <double>
optional
outlet_status
enum<integer>Ā <int32>
optional
>= 0<= 1
Allowed values:
01
sales_mode
enum<integer>Ā <int32>
optional
>= 0<= 1
Allowed values:
01
payment_type
enum<integer>Ā <int32>
optional
>= 0<= 1
Allowed values:
01
bill_to_outlet
stringĀ
optional
<= 24 characters
is_taxable
enum<integer>Ā <int32>
optional
>= 0<= 1
Allowed values:
01
sales_group_code
stringĀ
optional
<= 24 characters
seviced_by_outlet
stringĀ
optional
<= 24 characters
tertiary_outlet
integerĀ <int32>
optional
sub_db_attribute
integerĀ <int32>
optional
outlet_pricing_key
stringĀ
optional
<= 12 characters
authorized_item_code
stringĀ
optional
<= 12 characters
owner_name
stringĀ
optional
<= 100 characters
date_of_registration
stringĀ <date-time>
optional
date_of_birth
stringĀ <date-time>
optional
anniversary_date
stringĀ <date-time>
optional
id_number
stringĀ
optional
<= 50 characters
trade_id_number
stringĀ
optional
<= 50 characters
license_number
stringĀ
optional
<= 50 characters
license_expiry_date
stringĀ <date-time>
optional
license_number_1
stringĀ
optional
<= 50 characters
license_expiry_date_1
stringĀ <date-time>
optional
license_number_2
stringĀ
optional
license_expiry_date_2
stringĀ <date-time>
optional
tin_number
stringĀ
optional
<= 50 characters
gst_number
stringĀ
optional
<= 50 characters
pan_card_number
stringĀ
optional
<= 50 characters
gst_registration_type
integerĀ <int32>
optional
related_party
integerĀ <int32>
optional
state_code
stringĀ
optional
<= 12 characters
enable_oms
stringĀ
optional
<= 1 characters
is_outlet_owner_female
stringĀ
optional
<= 1 characters
income_class
stringĀ
optional
<= 50 characters
bp_number
stringĀ
optional
<= 50 characters
tax_admin_office
stringĀ
optional
<= 50 characters
is_active_tax_payer
integerĀ <int32>
optional
last_mile_delivery_vehicleType
integerĀ <int32>
optional
asset_ownership_status
stringĀ
optional
<= 1 characters
tax_number
stringĀ
optional
<= 50 characters
day_off
stringĀ
optional
<= 10 characters
coverage
stringĀ
optional
<= 50 characters
tax_type
integerĀ
optional
enforce_capturing_claim_ref_no
integerĀ
optional
disable_delivery_edit
integerĀ
optional
enforce_capturing_grn_pod_no
integerĀ
optional
distributor_outlet_mapping
arrayĀ [object {5}]Ā
optional
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 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
status
integerĀ <int32>
optional
message
stringĀ Ā |Ā nullĀ
optional
transaction_id
stringĀ <uuid>
optional
record_count
integerĀ <int32>
optional
Example
{
"status": 0,
"message": "string",
"transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
"record_count": 0
}
Modified atĀ 2025-05-08 07:28:06