Xnapp Integration APIs
  1. xdSalesOrder
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 
        POST
      • /api/xd/1.0/set_sales_order
        POST
      • /api/xd/1.0/get_sales_order
        POST
      • /api/xd/1.0/get_xo_sales_order
        POST
    • 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. xdSalesOrder

/api/xd/1.0/get_dms_sales_order 

POST
/api/xd/1.0/get_dms_sales_order
xdSalesOrder

Request

Body Params application/json
principle_code
string  | null 
optional
sync_key
string  | null 
optional
tenant_code
string  | null 
optional
start_date_time
string <date-time>
optional
end_date_time
string <date-time>
optional
date_field_basis
integer <int32>
optional
page_number
integer <int32>
optional
pull_data_for_principle_managed_dt
string  | null 
optional
Example
{
    "principle_code": "string",
    "sync_key": "string",
    "tenant_code": "string",
    "start_date_time": "2019-08-24T14:15:22Z",
    "end_date_time": "2019-08-24T14:15:22Z",
    "date_field_basis": 0,
    "page_number": 0,
    "pull_data_for_principle_managed_dt": "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_order' \
--header 'Content-Type: application/json' \
--data-raw '{
    "principle_code": "string",
    "sync_key": "string",
    "tenant_code": "string",
    "start_date_time": "2019-08-24T14:15:22Z",
    "end_date_time": "2019-08-24T14:15:22Z",
    "date_field_basis": 0,
    "page_number": 0,
    "pull_data_for_principle_managed_dt": "string"
}'

Responses

🟢200Success
application/json
Body
array of:
internal_document_number
integer <int32>
required
principle_code
string 
required
<= 12 characters
tenant_code
string 
required
<= 12 characters
location_code
string 
required
<= 12 characters
document_number
string 
required
<= 20 characters
document_date
string <date-time>
required
schedule_delivery_date
string <date-time>
required
customer_code
string 
required
<= 12 characters
bill_to_customer
string 
required
<= 12 characters
payment_terms
string 
required
<= 12 characters
document_amount
number <double>
required
currency_code
string 
required
<= 12 characters
sales_description
string 
optional
<= 200 characters
delivery_instructions
string 
optional
<= 200 characters
source_of_data
enum<integer> <int32>
optional
Allowed values:
01234
ware_house_code
string 
optional
<= 12 characters
coupon_amount
number <double>
optional
order_type
integer <int32>
optional
salesman_code
string 
optional
<= 24 characters
credit_limit_exceeded
integer <int32>
optional
external_doc_no_1
string 
optional
<= 20 characters
external_doc_date_1
string <date-time>
optional
last_modified_date_time
string <date-time>
optional
dms_sales_order_details
array [object {21}] 
optional
internal_document_number
integer <int32>
required
order_line_number
integer <int32>
required
item_code
string 
required
<= 18 characters
sequence_number
string  | null 
optional
product_hierarchy_code
string 
required
<= 20 characters
manufacturer_item_code
string  | null 
optional
principle_item_code
string 
required
<= 20 characters
mrp
number <double>
required
item_quantity
number <float>
required
item_quantity_1
number <float>
required
item_quantity_2
number <float>
required
item_quantity_3
number <float>
required
conversion_1
number <float>
required
conversion_2
number <float>
required
base_uom
string 
required
<= 20 characters
item_price
number <double>
required
item_price_in_base_uom
number <double>
required
total_discount_amount
number <double>
required
total_tax_amount
number <double>
required
total_net_amount
number <double>
required
is_free_good
integer <int32>
required
dms_sales_order_tax_details
array [object {7}] 
optional
order_tax_line_number
integer <int32>
required
internal_document_number
integer <int32>
required
order_line_number
integer <int32>
required
tax_type_code
string 
required
<= 50 characters
taxable_amount
number <double>
required
tax_rate
number <double>
required
tax_amount
number <double>
required
dms_sales_order_promo_details
array [object {7}] 
optional
order_promo_line_number
integer <int32>
required
internal_document_number
integer <int32>
required
order_line_number
integer <int32>
required
promotion_code
string 
required
<= 50 characters
condition_type
string 
required
<= 50 characters
promotion_quantity
number <double>
optional
promotion_amount
number <double>
required
Example
[
    {
        "internal_document_number": 0,
        "principle_code": "string",
        "tenant_code": "string",
        "location_code": "string",
        "document_number": "string",
        "document_date": "2024-08-13T05:49:53.797Z",
        "schedule_delivery_date": "2024-08-13T05:49:53.797Z",
        "customer_code": "string",
        "bill_to_customer": "string",
        "payment_terms": "string",
        "document_amount": 0,
        "currency_code": "string",
        "sales_description": "string",
        "delivery_instructions": "string",
        "source_of_data": 0,
        "ware_house_code": "string",
        "coupon_amount": 0,
        "order_type": 0,
        "last_modified_date_time": "2024-08-13T05:49:53.797Z",
        "external_doc_no_1": "string",
        "external_doc_date_1": "2024-08-13T05:49:53.797Z",
        "coupon_source": "string",
        "coupon_code": "string",
        "salesman_code": "string",
        "document_status": 0,
        "credit_limit_exceeded": 0,
        "dms_sales_order_details": [
            {
                "internal_document_number": 0,
                "order_line_number": 0,
                "item_code": "string",
                "sequence_number": "string",
                "product_hierarchy_code": "string",
                "manufacturer_item_code": "string",
                "principle_item_code": "string",
                "mrp": 0,
                "item_quantity": 0,
                "item_quantity_1": 0,
                "item_quantity_2": 0,
                "item_quantity_3": 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
            }
        ],
        "dms_sales_order_tax_details": [
            {
                "order_tax_line_number": 0,
                "internal_document_number": 0,
                "order_line_number": 0,
                "tax_type_code": "string",
                "taxable_amount": 0,
                "tax_rate": 0,
                "tax_amount": 0
            }
        ],
        "dms_sales_order_promo_details": [
            {
                "order_promo_line_number": 0,
                "internal_document_number": 0,
                "order_line_number": 0,
                "promotion_code": "string",
                "condition_type": "string",
                "promotion_quantity": 0,
                "promotion_amount": 0
            }
        ]
    }
]
Modified at 2024-08-13 06:12:02
Previous
/api/xd/1.0/get_sales_invoice
Next
/api/xd/1.0/set_sales_order
Built with