The Shipping module is implemented for internal use. The public REST API endpoints described below are planned for release in v0.2. For now, shipping functionality is available through the core library and order management system.
The Shipping API provides comprehensive shipping management including rate calculation, shipment creation, tracking, and carrier management.
{"id":"550e8400-e29b-41d4-a716-446655440300","carrier":"UPS","service_code":"ground","service_name":"UPS Ground","description":"1-5 business days","estimated_days":3,"price":"12.50","currency":"USD","weight_limit":"68.0","weight_unit":"kg","dimensions_limit":{"length":274,"width":274,"height":274,"unit":"cm"},"is_negotiated_rate":false,"delivery_date_guaranteed":false,"delivery_date":"2024-01-18T17:00:00Z"}
{"data":[{"id":"550e8400-e29b-41d4-a716-446655440300","carrier":"UPS","service_code":"ground","service_name":"UPS Ground","description":"1-5 business days","estimated_days":3,"price":"12.50","currency":"USD","delivery_date":"2024-01-18T17:00:00Z"},{"id":"550e8400-e29b-41d4-a716-446655440301","carrier":"UPS","service_code":"3day_select","service_name":"UPS 3 Day Select","description":"3 business days","estimated_days":3,"price":"28.75","currency":"USD","delivery_date":"2024-01-18T17:00:00Z"},{"id":"550e8400-e29b-41d4-a716-446655440302","carrier":"FedEx","service_code":"FEDEX_GROUND","service_name":"FedEx Ground","description":"1-5 business days","estimated_days":3,"price":"11.95","currency":"USD","delivery_date":"2024-01-18T20:00:00Z"}],"meta":{"request_id":"req_ship_001","from_address":{"country":"US","zip":"78701"},"to_address":{"country":"US","zip":"10001"},"weight":"2.5","weight_unit":"kg"}}
{"data":{"id":"550e8400-e29b-41d4-a716-446655440400","order_id":"550e8400-e29b-41d4-a716-446655440100","carrier":"UPS","service_code":"ground","service_name":"UPS Ground","tracking_number":"1Z999AA10123456784","tracking_url":"https://www.ups.com/track?tracknum=1Z999AA10123456784","label_url":"https://api.rcommerce.app/labels/550e8400-e29b-41d4-a716-446655440400.pdf","status":"in_transit","price":"12.50","currency":"USD","weight":"2.5","ship_from":{"name":"R Commerce Warehouse","city":"Austin","state":"TX","country":"US","zip":"78701"},"ship_to":{"name":"John Doe","city":"New York","state":"NY","country":"US","zip":"10001"},"tracking_history":[{"status":"picked_up","description":"Package picked up by carrier","location":"Austin, TX","timestamp":"2024-01-15T14:00:00Z"},{"status":"in_transit","description":"Departed facility in Austin, TX","location":"Austin, TX","timestamp":"2024-01-15T18:30:00Z"},{"status":"in_transit","description":"Arrived at facility in Memphis, TN","location":"Memphis, TN","timestamp":"2024-01-16T02:15:00Z"}],"created_at":"2024-01-15T10:30:00Z","shipped_at":"2024-01-15T14:00:00Z","estimated_delivery":"2024-01-18T17:00:00Z"}}
{"data":{"tracking_number":"1Z999AA10123456784","carrier":"UPS","status":"in_transit","status_description":"In Transit","estimated_delivery":"2024-01-18T17:00:00Z","delivered_at":null,"signed_by":null,"tracking_history":[{"status":"picked_up","status_code":"P","description":"Package picked up by carrier","location":"Austin, TX","timestamp":"2024-01-15T14:00:00Z"},{"status":"in_transit","status_code":"I","description":"Departed facility in Austin, TX","location":"Austin, TX","timestamp":"2024-01-15T18:30:00Z"},{"status":"in_transit","status_code":"I","description":"Arrived at facility in Memphis, TN","location":"Memphis, TN","timestamp":"2024-01-16T02:15:00Z"}]}}
// Public tracking - no authentication requiredconstresponse=awaitfetch('https://api.rcommerce.app/api/v1/shipping/tracking/1Z999AA10123456784');consttracking=awaitresponse.json();console.log(tracking.data.status);console.log(tracking.data.estimated_delivery);
{"data":[{"id":"550e8400-e29b-41d4-a716-446655440600","name":"UPS","code":"ups","is_active":true,"supports_tracking":true,"supports_label_generation":true,"supports_rate_calculation":true,"supported_countries":["US","CA","MX","GB","DE","FR","AU","JP"],"services":[{"code":"ground","name":"UPS Ground","description":"1-5 business days","is_active":true,"domestic":true,"international":false},{"code":"3day_select","name":"UPS 3 Day Select","description":"3 business days","is_active":true,"domestic":true,"international":false},{"code":"2nd_day_air","name":"UPS 2nd Day Air","description":"2 business days","is_active":true,"domestic":true,"international":false},{"code":"next_day_air","name":"UPS Next Day Air","description":"Next business day","is_active":true,"domestic":true,"international":false},{"code":"worldwide_expedited","name":"UPS Worldwide Expedited","description":"2-5 business days","is_active":true,"domestic":false,"international":true}],"credentials_configured":true,"test_mode":false},{"id":"550e8400-e29b-41d4-a716-446655440601","name":"FedEx","code":"fedex","is_active":true,"supports_tracking":true,"supports_label_generation":true,"supports_rate_calculation":true,"supported_countries":["US","CA","MX","GB","DE","FR","AU","JP"],"services":[{"code":"FEDEX_GROUND","name":"FedEx Ground","description":"1-5 business days","is_active":true,"domestic":true,"international":false},{"code":"FEDEX_2_DAY","name":"FedEx 2Day","description":"2 business days","is_active":true,"domestic":true,"international":false},{"code":"FEDEX_EXPRESS_SAVER","name":"FedEx Express Saver","description":"3 business days","is_active":true,"domestic":true,"international":false},{"code":"FEDEX_PRIORITY_OVERNIGHT","name":"FedEx Priority Overnight","description":"Next business day morning","is_active":true,"domestic":true,"international":false}],"credentials_configured":true,"test_mode":false},{"id":"550e8400-e29b-41d4-a716-446655440602","name":"USPS","code":"usps","is_active":true,"supports_tracking":true,"supports_label_generation":true,"supports_rate_calculation":true,"supported_countries":["US"],"services":[{"code":"first_class_mail","name":"First-Class Mail","description":"1-3 business days","is_active":true,"domestic":true,"international":false},{"code":"priority_mail","name":"Priority Mail","description":"1-3 business days","is_active":true,"domestic":true,"international":false},{"code":"priority_mail_express","name":"Priority Mail Express","description":"Overnight to most locations","is_active":true,"domestic":true,"international":false}],"credentials_configured":true,"test_mode":false}]}