Reference Numbers
Reference numbers are a key factor to include when creating a listing. uShip leverages reference numbers in order to extract vehicle data, inform our pricing algorithm, produce reports for clients and much more. In order to leverage a reference number, simply include the number and type in your POST to v2/listings.
Example
The following example demonstrates a motorcycle listing which includes the Price Correlation ID reference number type at the end of the request body.
{ "title": "Required (Motorcycle Listing) Title", "description": "Provide optional details about the motorcycle listing.", "route": { "items": [ { "address": { "streetAddress": "10155 Montague St", "alternateStreetAddress": "Building 200, Suite 100", "majorMunicipality": "Tampa", "postalCode": "33626", "stateProvince": "FL", "country": "US", "latitude": 28.056858, "longitude": -82.605871, "type": "Residence", "timeZone": "America/New_York" }, "timeFrame": { "earliestArrival": "2014/10/10", "latestArrival": "2014/10/30", "timeFrameType": "between" } }, { "address": { "streetAddress": "1234 Linton Drive", "majorMunicipality": "Acworth", "postalCode": "30102", "stateProvince": "GA", "country": "US", "latitude": 34.097324, "longitude": -84.614194, "type": "BusinessWithLoadingDockOrForklift" }, "timeFrame": { "latestArrival": "2014/11/12", "timeFrameType": "before" } } ] }, "pricing": { "namedPrice": { "amount": 300, "currencyType": "USD" } }, "items": [ { "Commodity": "MotorcyclesMopeds", "Title": "Item title", "Description": "Details about the motorcycle 1. 150cc Three Wheels Scooter", "Year": 2008, "MakeName": "Liang Zi Power", "ModelName": "TC_150_TKB", "IsRunning": true, "weightInGrams": 149685, "lengthInMeters": 2.045, "heightInMeters": 1.13, "wheelbaseInMeters": 1.5494, "groundClearanceInMeters": 0.14986, "widthInMeters": 0.72, "hasSidecar": false, "isPalletized": false, "isTrike": false }, { "Commodity": "MotorcyclesMopeds", "Title": "Item title 2", "Description": "Details about the motorcycle 2.", "Year": 2008, "MakeName": "Suzuki", "ModelName": "GSX-R1000", "IsRunning": true, "weightInGrams": 171912, "lengthInMeters": 2.045, "heightInMeters": 1.13, "wheelbaseInMeters": 1.415, "groundClearanceInMeters": 0.12, "widthInMeters": 0.72, "hasSidecar": true, "isPalletized": false, "isTrike": false } ], "serviceTypes": [ "OpenTransport", "EnclosedTransport", ] "referenceNumbers": [ { "type": "VIN", "number": "ZARFAEBN5J7579532" }}Reference Number Types
The following table outlines our available reference number types and their enum. You can include multiple reference numbers in a given listing creation. Reference number '10' is required for customers using our fixed price endpoint, and reference number type '11' is required for all MSTS Pay on Terms partners.
| Enum | Reference Type |
|---|---|
| 1 | Pickup Number |
| 2 | Delivery Number |
| 3 | Invoice Number |
| 4 | Purchase Order Number |
| 5 | Sales Order Number |
| 6 | Other Number |
| 7 | Lot Number |
| 8 | Release Reference Number |
| 9 | Third Party Tracking Number. Must be included for LTL partners to correctly map the tracking and delivery documents back to their shippers via /reports API. |
| 10 | Price Correlation ID. Must be included for IHD or v2/fixedprice integrators. You will receive a "priceCorrelationId": "01db311e-6296-476d-a25x-59976a8e0616" value upon retrieving your fixed price. Return this value when creating the listing as reference number type 10. |
| 11 | Third Party Order Number. Partners onboarding with MSTS should use this to include order numbers for Pay on Terms aggregation. |
| 12 | VIN |
| 13 | SKU |