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_sales_order

POST
/api/xd/1.0/get_sales_order
xdSalesOrder

Request

Body Params application/json
tenant_code
stringĀ Ā |Ā nullĀ 
required
<= 30 characters
location_code
stringĀ Ā |Ā nullĀ 
optional
document_type
integerĀ <int32>
optional
document_sub_type
integerĀ <int32>
optional
salesman_code
stringĀ Ā |Ā nullĀ 
optional
route_code
stringĀ Ā |Ā nullĀ 
optional
sync_key
stringĀ Ā |Ā nullĀ 
optional
page_number
integerĀ <int32>
optional
start_date_time
stringĀ <date-time>Ā |Ā nullĀ 
optional
end_date_time
stringĀ <date-time>Ā |Ā nullĀ 
optional
posting_date_time
stringĀ <date-time>Ā |Ā nullĀ 
optional
include_void_document
stringĀ Ā |Ā nullĀ 
optional
disable_rounding
integerĀ <int32>
optional
date_field_basis
integerĀ <int32>
optional
country_id
integerĀ <int32>
optional
Example
{
  "principle_code": "string",
  "tenant_code": "string",
  "location_code": "string",
  "document_type": 0,
  "document_sub_type": 0,
  "salesman_code": "string",
  "route_code": "string",
  "sync_key": "string",
  "page_number": 0,
  "start_date_time": "2024-12-30T10:29:44.736Z",
  "end_date_time": "2024-12-30T10:29:44.736Z",
  "posting_date_time": "2024-12-30T10:29:44.736Z",
  "include_void_document": "string",
  "disable_rounding": 0,
  "date_field_basis": 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/xd/1.0/get_sales_order' \
--header 'Content-Type: application/json' \
--data-raw '{
  "principle_code": "string",
  "tenant_code": "string",
  "location_code": "string",
  "document_type": 0,
  "document_sub_type": 0,
  "salesman_code": "string",
  "route_code": "string",
  "sync_key": "string",
  "page_number": 0,
  "start_date_time": "2024-12-30T10:29:44.736Z",
  "end_date_time": "2024-12-30T10:29:44.736Z",
  "posting_date_time": "2024-12-30T10:29:44.736Z",
  "include_void_document": "string",
  "disable_rounding": 0,
  "date_field_basis": 0
}'

Responses

šŸŸ¢200Success
application/json
Body
array of:
tenant_code
stringĀ 
required
<= 12 characters
location_code
stringĀ 
required
<= 12 characters
route_code
stringĀ 
required
<= 12 characters
salesman_code
stringĀ 
required
<= 12 characters
customer_code
stringĀ 
required
<= 12 characters
document_type
enum<integer>Ā <int32>
required
Allowed values:
12891113
document_prefix
stringĀ 
required
<= 12 characters
document_number
integerĀ <int32>
required
document_date
stringĀ <date-time>
required
delivery_date
stringĀ <date-time>
optional
posting_date_time
stringĀ <date-time>
required
document_amount
numberĀ <float>
required
void_indicator
enum<integer>Ā <int32>
required
Allowed values:
01
void_reason_code
stringĀ 
optional
<= 24 characters
currency_code
stringĀ 
optional
<= 3 characters
payment_type
enum<integer>Ā <int32>
required
Allowed values:
01
customer_price_level
integerĀ <int32>
optional
bill_to_customer
stringĀ 
optional
<= 12 characters
pricing_code
stringĀ 
optional
<= 12 characters
comments
stringĀ 
optional
<= 100 characters
presold_order_number
stringĀ 
optional
<= 50 characters
division_code
stringĀ 
required
<= 12 characters
vehicle_code
stringĀ 
optional
<= 12 characters
warehouse_code
stringĀ 
optional
<= 12 characters
priority
enum<integer>Ā <int32>
optional
Allowed values:
123
header_tax_amount
numberĀ <float>
optional
download_date_time
stringĀ <date-time>
optional
presold_order_date
stringĀ <date-time>
optional
rvt_key
stringĀ 
optional
<= 100 characters
capacity_variance
numberĀ <float>
optional
variance_remarks
stringĀ 
optional
<= 1000 characters
gl_account_code
stringĀ 
optional
<= 24 characters
tax_offset
numberĀ <float>
optional
sales_organization
stringĀ 
optional
<= 50 characters
external_document_number
stringĀ 
optional
<= 25 characters
ship_to_code
stringĀ 
optional
<= 24 characters
document_upload_url
stringĀ 
optional
<= 200 characters
header_discount_amount
numberĀ <float>
optional
total_lines
integerĀ <int32>
optional
verification_code
stringĀ 
optional
<= 24 characters
qr_code
stringĀ 
optional
<= 500 characters
fiscal_document_number
stringĀ 
optional
<= 24 characters
device_uid
stringĀ 
optional
<= 24 characters
sales_currency_code
stringĀ 
optional
<= 10 characters
exchange_rate
numberĀ <float>
optional
e_invoice_status
integerĀ <int32>
optional
sales_order_detail
arrayĀ [object {20}]Ā 
optional
rvt_key
stringĀ 
optional
<= 100 characters
ean_number
stringĀ 
optional
<= 20 characters
tenant_code
stringĀ 
required
<= 12 characters
location_code
stringĀ 
required
<= 12 characters
document_prefix
stringĀ 
required
<= 12 characters
document_number
integerĀ <int32>
required
sequence_number
integerĀ <int32>
required
transaction_type
enum<integer>Ā <int32>
required
Allowed values:
12345
item_code
stringĀ 
required
<= 18 characters
units_of_measure
stringĀ 
required
<= 20 characters
item_type_code
enum<integer>Ā <int32>
required
Allowed values:
12345
mrp
numberĀ <float>
optional
item_quantity
numberĀ <float>
required
gap_quantity
numberĀ <float>
optional
item_price
numberĀ <float>
required
promotion_amount
numberĀ <float>
required
item_excise_tax
numberĀ <float>
required
item_tax_amount_1
numberĀ <float>
optional
total_line_amount
numberĀ <float>
required
is_free_good
integerĀ <int32>
required
sales_order_return_exchanges
arrayĀ [object {15}]Ā 
optional
rvt_key
stringĀ 
optional
<= 100 characters
tenant_code
stringĀ 
required
<= 12 characters
location_code
stringĀ 
required
<= 12 characters
document_prefix
stringĀ 
required
<= 12 characters
document_number
integerĀ <int32>
required
sequence_number
integerĀ <int32>
required
item_transaction_type
enum<integer>Ā <int32>
required
Allowed values:
234
item_code
stringĀ 
required
<= 18 characters
units_of_measure
stringĀ 
required
<= 20 characters
item_type_code
enum<integer>Ā <int32>
required
Allowed values:
12345
manufacture_code
stringĀ 
optional
<= 50 characters
item_quantity
numberĀ <float>
required
reason_code
stringĀ 
required
<= 12 characters
sales_document_number
stringĀ 
optional
<= 50 characters
line_reference_number
integerĀ <int32>
optional
sales_order_promotions
arrayĀ [object {21}]Ā 
optional
rvt_key
stringĀ 
optional
<= 50 characters
tenant_code
stringĀ 
required
<= 12 characters
location_code
stringĀ 
required
<= 12 characters
document_prefix
stringĀ 
required
<= 12 characters
document_number
stringĀ 
required
sequence_number
stringĀ 
required
item_transaction_type
enum<integer>Ā <int32>
required
Allowed values:
12
item_code
stringĀ 
optional
<= 18 characters
units_of_measure
stringĀ 
optional
<= 20 characters
item_type_code
enum<integer>Ā <int32>
optional
Allowed values:
12345
promotion_quantity
numberĀ <float>
required
promotion_amount
numberĀ <float>
required
promotion_percentage
numberĀ <float>
required
promotion_code
stringĀ 
required
<= 50 characters
promotion_description
stringĀ 
required
<= 100 characters
promotion_type_code
integerĀ <int32>
required
promotion_indicator
stringĀ 
required
<= 3 characters
condition_type
stringĀ 
required
<= 25 characters
promo_chg_indicator
integerĀ <int32>
required
s_lab_number
integerĀ <int32>
optional
prom_coupon_indicator
enum<string>Ā 
required
<= 3 characters
Allowed values:
PCPCLC
sales_order_taxes
arrayĀ [object {14}]Ā 
optional
rvt_key
stringĀ 
optional
tenant_code
stringĀ 
optional
<= 12 characters
location_code
stringĀ 
optional
<= 12 characters
document_prefix
stringĀ 
optional
<= 12 characters
document_number
integerĀ <int32>
optional
item_code
stringĀ 
optional
<= 18 characters
units_of_measure
stringĀ 
optional
<= 20 characters
item_type_code
integerĀ <int32>
optional
tax_code
stringĀ 
optional
<= 24 characters
tax_description
stringĀ 
optional
<= 100 characters
tax_percentage
numberĀ <float>
optional
taxable_amount
numberĀ <float>
optional
tax_amount
numberĀ <float>
optional
sequence_number
integerĀ <int32>
optional
Example
[
    {
        "principle_code": "string",
        "tenant_code": "string",
        "location_code": "string",
        "route_code": "string",
        "salesman_code": "string",
        "customer_code": "string",
        "document_type": 0,
        "document_prefix": "string",
        "document_number": 0,
        "document_date": "2024-12-30T10:29:44.740Z",
        "delivery_date": "2024-12-30T10:29:44.740Z",
        "posting_date_time": "2024-12-30T10:29:44.740Z",
        "document_amount": 0,
        "void_indicator": 0,
        "void_reason_code": "string",
        "currency_code": "string",
        "payment_type": 0,
        "customer_price_level": 0,
        "bill_to_customer": "string",
        "pricing_code": "string",
        "comments": "string",
        "presold_order_number": "string",
        "division_code": "string",
        "vehicle_code": "string",
        "warehouse_code": "string",
        "priority": 0,
        "header_tax_amount": 0,
        "download_date_time": "2024-12-30T10:29:44.740Z",
        "presold_order_date": "2024-12-30T10:29:44.740Z",
        "rvt_key": "string",
        "capacity_variance": 0,
        "variance_remarks": "string",
        "gl_account_code": "string",
        "tax_offset": 0,
        "sales_organization": "string",
        "external_document_number": "string",
        "ship_to_code": "string",
        "document_upload_url": "string",
        "header_discount_amount": 0,
        "total_lines": 0,
        "verification_code": "string",
        "qr_code": "string",
        "fiscal_document_number": "string",
        "device_uid": "string",
        "sales_currency_code": "string",
        "exchange_rate": 0,
        "e_invoice_status": 0,
        "sales_order_detail": [
            {
                "rvt_key": "string",
                "ean_number": "string",
                "tenant_code": "string",
                "location_code": "string",
                "document_prefix": "string",
                "document_number": 0,
                "sequence_number": 0,
                "transaction_type": 0,
                "item_code": "string",
                "units_of_measure": "string",
                "item_type_code": 0,
                "mrp": 0,
                "item_quantity": 0,
                "gap_quantity": 0,
                "item_price": 0,
                "promotion_amount": 0,
                "item_excise_tax": 0,
                "item_tax_amount_1": 0,
                "total_line_amount": 0,
                "is_free_good": 0
            }
        ],
        "sales_order_return_exchanges": [
            {
                "rvt_key": "string",
                "tenant_code": "string",
                "location_code": "string",
                "document_prefix": "string",
                "document_number": 0,
                "sequence_number": 0,
                "item_transaction_type": 0,
                "item_code": "string",
                "units_of_measure": "string",
                "item_type_code": 0,
                "manufacture_code": "string",
                "item_quantity": 0,
                "reason_code": "string",
                "sales_document_number": "string",
                "line_reference_number": 0
            }
        ],
        "sales_order_promotions": [
            {
                "rvt_key": "string",
                "tenant_code": "string",
                "location_code": "string",
                "document_prefix": "string",
                "document_number": "string",
                "sequence_number": "string",
                "item_transaction_type": 0,
                "item_code": "string",
                "units_of_measure": "string",
                "item_type_code": 0,
                "promotion_quantity": 0,
                "promotion_amount": 0,
                "promotion_percentage": 0,
                "promotion_code": "string",
                "promotion_description": "string",
                "promotion_type_code": 0,
                "promotion_indicator": "string",
                "condition_type": "string",
                "promo_chg_indicator": 0,
                "slab_number": 0,
                "prom_coupon_indicator": "string"
            }
        ],
        "sales_order_taxes": [
            {
                "rvt_key": "string",
                "tenant_code": "string",
                "location_code": "string",
                "document_prefix": "string",
                "document_number": 0,
                "item_code": "string",
                "units_of_measure": "string",
                "item_type_code": 0,
                "tax_code": "string",
                "tax_description": "string",
                "tax_percentage": 0,
                "taxable_amount": 0,
                "tax_amount": 0,
                "sequence_number": 0
            }
        ]
    }
]
Modified atĀ 2024-12-30 10:34:13
Previous
/api/xd/1.0/set_sales_order
Next
/api/xd/1.0/get_xo_sales_order
Built with