API Endpoint Overview

The order details retrieval endpoint provides comprehensive transaction data through a RESTful interface using the GET method.

Request Configuration

HTTP Method: GET

Path Parameter: orderId - Unique identifier for the transaction record

Response Data Format

{
  "order_retrieval_result": {
    "record_count": 100,
    "transactions": {
      "transaction": [
        {
          "merchant_identifier": "demo_store",
          "customer_unique_id": "BBJm7e-FBBfHxKfevTGv1YYY",
          "product_name": "Fashion Handbag",
          "pricing_model": "fixed_price",
          "creation_timestamp": "2000-01-01 00:00:00",
          "transaction_id": 3342069450,
          "affiliate_cookie": "2b22b1098739883d113fd8e1ffd3b463",
          "session_identifier": "OQ2132357257",
          "merchant_rated": true,
          "customer_rated": true,
          "transaction_state": "UNPAID_ORDER",
          "amount_paid": "300.10",
          "discount_amount": "300.10",
          "adjustment_amount": "300.10",
          "shipping_cost": "300.10",
          "gross_amount": "300.10",
          "payment_timestamp": "2000-01-01 00:00:00",
          "completion_timestamp": "2000-01-01 00:00:00",
          "last_modified": "2000-01-01 00:00:00",
          "async_update_time": "2000-01-01 00:00:00",
          "shipment_timestamp": "2000-01-01 00:00:00",
          "actual_payment_received": "300.10",
          "commission_charged": "300.10",
          "payment_gateway_reference": "2010122192284942",
          "payment_gateway_id": 3122193300678560,
          "customer_location": "Jiangsu Province, Nanjing City",
          "extended_attributes": ";customernick:tester;card:456;customerRegion:Nanjing",
          "image_url": "http://img09.taobao.net/bao/uploaded/i9/T2kWYYYfQcYYbpQC7b_102028.jpg",
          "item_identifier": 4535345,
          "unit_price": "300.10",
          "cash_on_delivery_fee": "13.10",
          "delivery_status": "ORDER_GENERATED",
          "freight_type": "complimentary",
          "quantity_ordered": 1,
          "loyalty_points_used": 0,
          "actual_points_deducted": 0,
          "points_earned_by_customer": 0,
          "recipient_full_name": "****West Lake",
          "recipient_province": "Jiangsu Province",
          "recipient_city": "Nanjing City",
          "recipient_district": "Gulou District",
          "recipient_township": "Four Towns",
          "delivery_address": "****Taobao Plaza",
          "postal_code": "334801",
          "mobile_contact": "****2937",
          "telephone_contact": "****6483",
          "merchant_tag": 2,
          "logistics_premium": true,
          "delivery_speed_category": "same_day",
          "delivery_deadline": "2013-07-20 16:17:15",
          "brand_partnership": true,
          "warehouse_logistics_enforced": true,
          "customer_message_exists": true,
          "credit_card_processing_fee": "41.6",
          "transaction_origin": "MOBILE,FLASH_SALE",
          "installment_status": "INITIAL_UNPAID_FINAL_UNPAID",
          "installment_amount_paid": "636.81",
          "administrative_notes": "Extended delivery timeframe required",
          "insurance_applied": true,
          "insurance_premium": "0.61",
          "insurance_identifier": "246862827584249",
          "insurance_category": "taojinbi",
          "source_channel": "official_store",
          "scheduled_delivery_date": "2000-01-01",
          "merchant_eligible_for_rating": true,
          "partial_shipment": true,
          "cross_border_transaction": true,
          "drop_shipping": true,
          "offline_to_online_integration": "crm",
          "sales_associate_id": "789012",
          "sales_associate_name": "Gulou Store Associate 1",
          "retail_location_id": "789012",
          "retail_location_name": "Gulou Store",
          "delivery_method": "instore",
          "external_transaction_id": "789012",
          "line_items": {
            "item": [
              {
                "product_title": "Prototype Testing Device",
                "thumbnail_url": "http://img09.taobao.net/bao/uploaded/i9/T2kWYYYfQcYYbpQC7b_102028.jpg",
                "selling_price": "300.10",
                "catalog_item_id": 3453455,
                "inventory_unit_id": "6048257",
                "external_product_id": "263f553bf0f99ee52dc198034d01edc1",
                "external_variant_id": "92904959",
                "return_status": "REFUND_COMPLETED",
                "item_state": "UNPAID_ORDER",
                "order_line_id": 3342069450,
                "original_cost": "300.10",
                "final_payment": "300.10",
                "line_discount": "300.10",
                "modification_fee": "2.02",
                "allocation_cost": "32.01",
                "promotion_split_discount": "32.01",
                "variant_specifications": "Color:Orange;Size:L",
                "bundle_package_id": 3675965743,
                "bundle_name": "M9 Original Battery:Travel Stand:M9 Dedicated Charger:Protection Pouch",
                "units_purchased": 1,
                "customer_reviewed": true,
                "merchant_reviewed": true,
                "refund_reference": "3342069450",
                "vendor_classification": "MALL_MERCHANT",
                "category_id": 234567,
                "item_completion_time": "2013-05-08 01:01:01",
                "package_dispatch_time": "2014-02-14 16:24:01",
                "shipping_mode": "parcel",
                "carrier_name": "Express Delivery",
                "tracking_number": "06543576",
                "linked_order_id": 34205185254249,
                "wholesale_dropship": true,
                "voucher_external_id": "234567bcde",
                "voucher_expiry_key": "211GGGG134851310111111311021345111B",
                "website_origin": true,
                "warehouse_code": "NanjingRDIJXM-1115",
                "service_catalog_code": "Home Installation Service",
                "sub_item_tax_amount": "0",
                "sub_item_tax_rate": "0",
                "certification_status": "1",
                "merchant_qualification": "verified_access",
                "merchant_fee": "000",
                "sub_item_tax_promotion": "0",
                "tax_exempt": true,
                "tax_voucher_reduction": "0",
                "special_return_category": "price_protection",
                "reduced_value_handling": true,
                "pre_owned_indicator": "1",
                "promised_collection_time": "2000-01-01 00:00:00",
                "distribution_center_mandatory": true,
                "shipping_information": {
                  "delivery_options": [
                    {
                      "transport_modes": "express,merchant,instant"
                    }
                  ]
                }
              }
            ]
          },
          "service_components": {
            "service_component": [
              {
                "component_id": 221881703934249,
                "parent_item_id": 221881703914249,
                "service_catalog_id": 3453455,
                "service_details_page": "http://wt.taobao.com/plan.htm?plan_id=planId",
                "service_quantity": 1,
                "service_unit_price": "40.10",
                "service_payment_amount": "30.09",
                "service_description": "Front Load Washing Machine",
                "service_total_cost": "40.10",
                "client_nickname": "XiaoQian2006",
                "service_refund_id": "3342069450",
                "provider_nickname": "Fashion Handbag",
                "service_image_url": "http://img09.taobao.com/bao/upload/i9/T2kWYYYfQc_a1019.jpg",
                "service_spu_code": "Home Installation Service"
              }
            ]
          },
          "zero_cost_purchase": true,
          "destination_country": "China",
          "transaction_tax_amount": "0",
          "store_pickup_enabled": "1",
          "prescription_review_status": "0",
          "postal_declaration_required": true,
          "cross_border_declaration": true,
          "transaction_tax_promotion": "0",
          "service_categories": "scheduled,jiaju",
          "o2o_membership_active": true,
          "mall_exclusive_delivery": true,
          "third_party_scheduling": true,
          "customer_service_codes": "95_61",
          "cut_off_duration_minutes": "771",
          "estimated_duration_hours": "5",
          "planned_delivery_time": "2019-07-10 13:14:15",
          "expected_collection_time": "2019-07-10 13:14:15",
          "dispatch_scheduled_time": "2019-07-10 13:14:15",
          "delivery_confirmation_time": "2019-07-10 13:14:15",
          "carrier_partner": "STO",
          "delivery_window": "10:01-13:01",
          "delivery_target_date": "2019-07-10",
          "operational_window": "10:01-13:01",
          "operational_date": "2019-07-10",
          "logistics_business_type": "enhanced_logistics",
          "logistics_additional_services": "312",
          "pharmaceutical_registration": "1",
          "committed_signature_time": "2000-01-01 00:00:00",
          "anonymized_identifier": "3x3SZF56jbhoG5bjaK8qILDK4Ixochoq3QI4BgqRWxXAOILTaAOBBPVgDWU0AYGeFuqhOIxd",
          "business_scenario_group": "TXD_B2C_FRESH_HALFDAY",
          "distribution_center_enforced": true,
          "customer_nickname": "demo_store",
          "logistics_terms": {
            "service_commitments": "door_delivery",
            "logistics_type": "enhanced_logistics",
            "service_addons": "312",
            "signature_acquired_time": "2020-05-13 17:01:01",
            "committed_delivery_time": "2020-05-13 17:01:01"
          },
          "logistics_events": {
            "event": [
              {
                "delivery_option_type": 1,
                "warehouse_avoidance_warning": "Current order has service commitment: same-day dispatch next-day delivery. Warehouse selection recommended per platform requirements to avoid penalty risks.",
                "carrier_avoidance_notice": "Platform recommends specific carrier selection for current route. Alternative selections may cause electronic waybill printing failures.",
                "blacklisted_carrier_warning": "Platform advises against selected carrier for current route. Electronic waybill printing failure risk exists.",
                "promised_dispatch_time": "2020-05-13 17:01:01",
                "main_transaction_id": 2211181971283692724,
                "sub_transaction_id": 2211181971284692724,
                "promised_pickup_time": "2000-01-01 00:00:00"
              }
            ]
          },
          "document_type": "PRODUCT",
          "merchant_flag_label": "Blue Flag",
          "merchant_comments": "Transaction Notes"
        }
      ]
    },
    "more_records_available": true
  }
}

Implementation Considerations

Security Measures

Production implementations should incorporate secure communication protocols, authentication mechanisms like OAuth 2.0 or JWT tokens, and proper access control policies.

Error Menagement

Comprehensive error handling strategies must define HTTP status codes, error messages, and recovery procedures for various failure scenarios.

Data Management

For datasets with extensive transaction histories, pagination controls and sorting capabilities should be implemented to optimize performance.

Privacy Compliance

All returned information must comply with applicable privacy regulations and avoid exposure of personally identifiable information.