Xnapp Integration APIs
  1. Shopping Cart
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
        POST
    • 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
      • /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. Shopping Cart

/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
Previous
/api/xc/1.0/set_asset_detail
Next
/api/xc/1.0/set_authorized_product
Built with