- 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/1.0/shopping_cart
POST
/api/1.0/shopping_cart
xcAssetDetail
Request
Body Params application/json
principle_code
stringĀ
required
<= 20 characters
tenant_code
stringĀ
required
<= 20 characters
location_code
stringĀ
required
<= 20 characters
customer_code
stringĀ
required
<= 18 characters
request_time
stringĀ <date-time>
required
promotion_source_tag_filter
integerĀ
optional
delivery_date
stringĀ <date-time>
optional
item_list
arrayĀ [object {5}]Ā
required
item_code
stringĀ
optional
<= 50 characters
uom
stringĀ
required
<= 12 characters
item_quantity
numberĀ <float>
required
item_price
numberĀ <float>
required
discretionary_promotion_code
array[string]
optional
Example
{
"principle_code": "string",
"tenant_code": "string",
"location_code": "string",
"customer_code": "string",
"request_time": "2024-05-23T04:42:03.550Z",
"promotion_source_tag_filter": 0,
"delivery_date": "2024-05-23T04:42:03.550Z",
"item_list": [
{
"item_code": "string",
"uom": "string",
"item_quantity": 0,
"item_price": 0,
"discretionary_promotion_code": [
"string"
]
}
]
}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/1.0/shopping_cart' \
--header 'Content-Type: application/json' \
--data-raw '{
"principle_code": "string",
"tenant_code": "string",
"location_code": "string",
"customer_code": "string",
"request_time": "2024-05-23T04:42:03.550Z",
"promotion_source_tag_filter": 0,
"delivery_date": "2024-05-23T04:42:03.550Z",
"item_list": [
{
"item_code": "string",
"uom": "string",
"item_quantity": 0,
"item_price": 0,
"discretionary_promotion_code": [
"string"
]
}
]
}'Responses
š¢200Success
application/json
Body
cart_header
objectĀ
required
principle_code
stringĀ
optional
<= 20 characters
tenant_code
stringĀ
optional
<= 20 characters
location_code
stringĀ
optional
<= 20 characters
customer_code
stringĀ
optional
<= 18 characters
transaction_date_time
stringĀ <date-time>
optional
gross_total
numberĀ <double>
optional
discount
numberĀ <double>
optional
total_line_discount
numberĀ <double>
optional
header_discount
numberĀ <double>
optional
total_tax
numberĀ <double>
optional
total_value
numberĀ <double>
optional
scheduled_delivery_date
stringĀ <date-time>
optional
item_count
integerĀ
optional
coupon_code
stringĀ
optional
<= 100 characters
coupon_amount
numberĀ <double>
optional
coupon_status
integerĀ
optional
lp_discount
numberĀ <double>
optional
lp_discount_total_available
numberĀ <double>
optional
total_coupon_value
numberĀ <double>
optional
total_loyalty_coupon_value
numberĀ <double>
optional
total_promo_coupon_value
numberĀ <double>
optional
shopping_cart_detail
arrayĀ [object {8}]Ā
required
shopping_cart_item_tax_detail
arrayĀ [object {4}]Ā
required
shopping_cart_promotion_detail
arrayĀ [object {30}]Ā
required
shopping_cart_applied_coupons
arrayĀ [object {3}]Ā
required
shopping_cart_applied_loyalty_coupons
arrayĀ [object {3}]Ā
required
shopping_cart_qualified_promo_coupons
arrayĀ [object {13}]Ā
required
shopping_cart_non_qualified_promo_coupons
arrayĀ [object {13}]Ā
required
shopping_cart_applied_promo_coupons
arrayĀ [object {13}]Ā
required
Example
{
"cart_header": {
"principle_code": "string",
"tenant_code": "string",
"location_code": "string",
"customer_code": "string",
"transaction_date_time": "2024-05-23T04:42:03.552Z",
"gross_total": 0,
"discount": 0,
"total_line_discount": 0,
"header_discount": 0,
"total_tax": 0,
"total_value": 0,
"scheduled_delivery_date": "2024-05-23T04:42:03.552Z",
"item_count": 0,
"coupon_code": "string",
"coupon_amount": 0,
"coupon_status": 0,
"lp_discount": 0,
"lp_discount_total_available": 0,
"total_coupon_value": 0,
"total_loyalty_coupon_value": 0,
"total_promo_coupon_value": 0,
"shopping_cart_detail": [
{
"item_code": "string",
"item_price": 0,
"uom": "string",
"item_quantity": 0,
"gross_amount": 0,
"discount": 0,
"total_value": 0,
"is_free_good": 0
}
],
"shopping_cart_item_tax_detail": [
{
"item_code": "string",
"tax_code": "string",
"tax_percentage": 0,
"tax": 0
}
],
"shopping_cart_promotion_detail": [
{
"tenant_id": 0,
"item_number": "string",
"item_code": "string",
"promotion_type_code": 0,
"promotion_amount": 0,
"promotion_amount_with_tax": 0,
"subhierarchy_code": "string",
"promotion_quantity": 0,
"promotion_plan_number": 0,
"promotion_indicator": "string",
"promo_chg_indicator": 0,
"promotion_code": "string",
"promotion_description": "string",
"pro_rata": "string",
"condition_type": "string",
"allow_qps": "string",
"allow_claim": 0,
"is_freegood": 0,
"allow_promotion_quota": 0,
"promotion_quota_code": "string",
"header_promo_to_linelevelmode": "string",
"payout_date": "string",
"number_of_unique_sku": "string",
"slab_number": 0,
"inv_number": "string",
"qualification_mode": "string",
"apply_on_basket": "string",
"promotion_end_date": "2024-05-23T04:42:03.552Z",
"free_goods_choice": 0,
"discard_promotion": 0
}
],
"shopping_cart_applied_coupons": [
{
"coupon_code": "string",
"coupon_amount": 0,
"coupon_status": 0
}
],
"shopping_cart_applied_loyalty_coupons": [
{
"coupon_code": "string",
"coupon_amount": 0,
"coupon_status": 0
}
],
"shopping_cart_qualified_promo_coupons": [
{
"promotion_code": "string",
"item_code": "string",
"promotion_type_code": 0,
"promotion_amount": 0,
"promotion_quantity": 0,
"promo_chg_indicator": 0,
"actual_promotion_amount": 0,
"actual_promotion_qty": 0,
"insufficient_quota_types": "string",
"condition_type": "string",
"promotion_indicator": "string",
"promotion_end_date": "2024-05-23T04:42:03.552Z",
"promotion_quota_code": "string"
}
],
"shopping_cart_non_qualified_promo_coupons": [
{
"promotion_code": "string",
"item_code": "string",
"promotion_type_code": 0,
"promotion_amount": 0,
"promotion_quantity": 0,
"promo_chg_indicator": 0,
"actual_promotion_amount": 0,
"actual_promotion_qty": 0,
"insufficient_quota_types": "string",
"condition_type": "string",
"promotion_indicator": "string",
"promotion_end_date": "2024-05-23T04:42:03.552Z",
"promotion_quota_code": "string"
}
],
"shopping_cart_applied_promo_coupons": [
{
"promotion_code": "string",
"item_code": "string",
"promotion_type_code": 0,
"promotion_amount": 0,
"promotion_quantity": 0,
"promo_chg_indicator": 0,
"actual_promotion_amount": 0,
"actual_promotion_qty": 0,
"insufficient_quota_types": "string",
"condition_type": "string",
"promotion_indicator": "string",
"promotion_end_date": "2024-05-23T04:42:03.552Z",
"promotion_quota_code": "string"
}
]
}
}Modified atĀ 2024-05-23 04:59:46