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

/api/xd/1.0/get_dms_sales_return

POST
/api/xd/1.0/get_dms_sales_return
xdSalesReturn

Request

Body Params application/json
principle_code
stringĀ 
optional
<= 24 characters
tenant_code
stringĀ 
optional
<= 24 characters
page_no
integerĀ 
optional
sync_key
stringĀ Ā |Ā nullĀ 
optional
<= 50 characters
start_date_time
stringĀ <date-time>
optional
end_date_time
stringĀ <date-time>
optional
pull_data_for_principle_managed_dt
stringĀ 
optional
<= 1 characters
document_number
stringĀ 
optional
<= 50 characters
sales_invoice_no
stringĀ 
optional
<= 50 characters
Example
{
  "principle_code": "string",
  "tenant_code": "string",
  "page_no": 0,
  "sync_key": "string",
  "start_date_time": "2025-03-25T07:37:46.795Z",
  "end_date_time": "2025-03-25T07:37:46.795Z",
  "pull_data_for_principle_managed_dt": "string",
  "document_number": "string",
  "sales_invoice_no": "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/xd/1.0/get_dms_sales_return' \
--header 'Content-Type: application/json' \
--data-raw '{
  "principle_code": "string",
  "tenant_code": "string",
  "page_no": 0,
  "sync_key": "string",
  "start_date_time": "2025-03-25T07:37:46.795Z",
  "end_date_time": "2025-03-25T07:37:46.795Z",
  "pull_data_for_principle_managed_dt": "string",
  "document_number": "string",
  "sales_invoice_no": "string"
}'

Responses

šŸŸ¢200Success
application/json
Body
array of:
internal_document_no
integerĀ <int32>
required
principle_code
stringĀ 
optional
<= 12 characters
tenant_code
stringĀ 
optional
<= 12 characters
location_code
stringĀ 
optional
<= 12 characters
document_number
stringĀ 
optional
<= 20 characters
document_date
stringĀ <date-time>
optional
customer_code
stringĀ 
optional
<= 12 characters
bill_to_customer
stringĀ 
optional
<= 12 characters
load_out_no
stringĀ 
optional
<= 20 characters
si_reference_no
stringĀ 
optional
<= 25 characters
return_order_no
stringĀ 
optional
<= 25 characters
so_reference_no
stringĀ 
optional
<= 25 characters
payment_terms
stringĀ 
optional
<= 12 characters
sales_mode
enum<integer>Ā <int32>
optional
Allowed values:
01
shipping_fee
numberĀ <float>
optional
shipping_fee_disc_amount
numberĀ <float>
optional
service_fee
numberĀ <double>
optional
document_amount
numberĀ <double>
optional
net_off_amount
numberĀ <double>
optional
currency_code
stringĀ 
optional
<= 12 characters
warehouse_code
stringĀ 
optional
<= 12 characters
route_code
stringĀ 
optional
<= 24 characters
division_code
stringĀ 
optional
<= 24 characters
salesman_code
stringĀ 
optional
<= 24 characters
total_taxes
numberĀ <float>
optional
tota_promotion
numberĀ <float>
optional
payment_method
integerĀ 
optional
void_indicator
enum<integer>Ā <int32>
optional
Allowed values:
01
last_modified_date_time
stringĀ <date-time>
optional
dms_sales_return_details
arrayĀ [object {20}]Ā 
optional
internal_document_no
integerĀ <int32>
required
return_line_no
integerĀ <int32>
required
item_code
stringĀ 
optional
<= 18 characters
product_hierarchy_code
stringĀ 
optional
<= 20 characters
manufacturer_item_code
stringĀ 
optional
principle_item_code
stringĀ 
optional
<= 20 characters
sub_hierarchy_code
stringĀ 
optional
<= 20 characters
mrp
numberĀ <double>
optional
item_quantity
numberĀ <double>
optional
item_quantity_1
numberĀ <double>
optional
item_quantity_2
numberĀ <double>
optional
conversion_1
numberĀ <double>
optional
base_uom
stringĀ 
optional
<= 20 characters
item_price
numberĀ <double>
optional
item_price_in_base_uom
numberĀ <double>
optional
total_discount_amount
numberĀ <double>
optional
total_tax_amount
numberĀ <double>
optional
total_net_amount
numberĀ <double>
optional
is_free_good
integerĀ <int32>
optional
return_type
integerĀ <int32>
optional
dms_sales_return_tax_details
arrayĀ [object {7}]Ā 
optional
return_tax_line_no
integerĀ <int32>
required
internal_document_no
integerĀ <int32>
required
return_line_no
integerĀ <int32>
optional
tax_type_code
stringĀ 
optional
<= 50 characters
taxable_amount
numberĀ <double>
optional
tax_rate
numberĀ <double>
optional
tax_amount
numberĀ <double>
optional
dms_sales_return_promo_details
arrayĀ [object {7}]Ā 
optional
return_promo_line_no
integerĀ <int32>
required
internal_document_no
integerĀ <int32>
required
return_line_no
integerĀ <int32>
optional
promotion_code
stringĀ 
optional
<= 50 characters
condition_type
stringĀ 
optional
<= 50 characters
promotion_quantity
numberĀ <double>
optional
promotion_amount
numberĀ <double>
optional
dms_sales_return_batch_details
arrayĀ [object {7}]Ā 
optional
internal_document_no
integerĀ <int32>
required
return_line_no
integerĀ <int32>
required
sequence_number
integerĀ <int32>
optional
sub_hierarchy_code
stringĀ 
optional
<= 20 characters
item_quantity
numberĀ <double>
optional
item_quantity_1
numberĀ <double>
optional
item_quantity_2
numberĀ <double>
optional
Example
[
    {
        "internal_document_no": 0,
        "principle_code": "string",
        "tenant_code": "string",
        "location_code": "string",
        "document_number": "string",
        "document_date": "2025-03-25T10:03:54.559Z",
        "customer_code": "string",
        "bill_to_customer": "string",
        "load_out_no": "string",
        "si_reference_no": "string",
        "return_order_no": "string",
        "so_reference_no": "string",
        "payment_terms": "string",
        "sales_mode": 0,
        "shipping_fee": 0,
        "shipping_fee_disc_amount": 0,
        "service_fee": 0,
        "document_amount": 0,
        "net_off_amount": 0,
        "currency_code": "string",
        "warehouse_code": "string",
        "void_indicator": 0,
        "last_modified_date_time": "2025-03-25T10:03:54.559Z",
        "route_code": "string",
        "division_code": "string",
        "salesman_code": "string",
        "total_taxes": 0,
        "total_promotion": 0,
        "payment_method": 0,
        "dms_sales_return_details": [
            {
                "internal_document_no": 0,
                "return_line_no": 0,
                "item_code": "string",
                "product_hierarchy_code": "string",
                "manufacturer_item_code": "string",
                "principle_item_code": "string",
                "sub_hierarchy_code": "string",
                "mrp": 0,
                "item_quantity": 0,
                "item_quantity_1": 0,
                "item_quantity_2": 0,
                "conversion_1": 0,
                "base_uom": "string",
                "item_price": 0,
                "item_price_in_base_uom": 0,
                "total_discount_amount": 0,
                "total_tax_amount": 0,
                "total_net_amount": 0,
                "is_free_good": 0,
                "return_type": 0
            }
        ],
        "dms_sales_return_tax_details": [
            {
                "return_tax_line_no": 0,
                "internal_document_no": 0,
                "return_line_no": 0,
                "tax_type_code": "string",
                "taxable_amount": 0,
                "tax_rate": 0,
                "tax_amount": 0
            }
        ],
        "dms_sales_return_promo_details": [
            {
                "return_promo_line_no": 0,
                "internal_document_no": 0,
                "return_line_no": 0,
                "promotion_code": "string",
                "condition_type": "string",
                "promotion_quantity": 0,
                "promotion_amount": 0
            }
        ],
        "dms_sales_return_batch_details": [
            {
                "internal_document_no": 0,
                "return_line_no": 0,
                "sequence_number": 0,
                "sub_hierarchy_code": "string",
                "item_quantity": 0,
                "item_quantity_1": 0,
                "item_quantity_2": 0
            }
        ]
    }
]
Modified atĀ 2025-03-25 07:40:47
Previous
/api/xd/1.0/get_sales_order_status_update
Next
/api/xd/1.0/get_stock_transfer
Built with