Booking Acceptance Notification
This topic is part of the Service Provider's Published Rates flow.
A Service Provider receives a booking acceptance notification in application/JSON format posted to their recipient URL when the following occurs:
After the service provider has manually accepted the booking request via uShip.com (web), the Service Provider integrator receives the following notification.
This notification includes detailed information about the shipping customer's contact information as well as pick up and drop off addresses.
Sample Booking Acceptance Notification
The notification structure and fields are unique. They differ from the rest of the uShip API endpoints for timeframes, addresses, and users. We will announce when the notification matches the current API structure and update the documentation accordingly.
{ "shipperUserName": "mrshipper", "shipperFirstName": "MrShipper", "shipperLastName": "Shipperino", "shipperEmailAddress": "mrshipper@gmail.com", "shipperPrimaryPhoneNumber": "(123) 456-7890", "shipperSecondaryPhoneNumber": "(123) 456-7891", "shipperCompanyName": "mrshipper", "listingID": 347800153, "listingTitle": "2013 Cadillac CTS-V Coupe", "originAddress": { "streetAddress": "2109 South 5th Street", "city": "Austin", "administrativeDivision": "Texas", "administrativeDivisionCode": "TX", "postalCode": "78704", "latitude": 30.244144, "longitude": -97.76286, "countryId": "1", "countryCode": "US" }, "originTimeFrame": { "date": { "month": 12, "day": 26, "year": 2014 } }, "destinationAddress": { "streetAddress": "5392 Peach Drive", "city": "Gibsonia", "administrativeDivision": "Pennsylvania", "administrativeDivisionCode": "PA", "postalCode": "15044", "latitude": 40.625976, "longitude": -79.953769, "countryId": "1", "countryCode": "US" }, "destinationTimeFrame": { "date": { "month": 12, "day": 26, "year": 2014 } }, "acceptedBidAmount": { "amount": 832.53, "currencyType": "USD" }, "amountPaidByShipper": { "amount": 832.53, "currencyType": "USD" }, "amountDueToServiceProvider": { "amount": 758.43, "currencyType": "USD" }, "isUshipPayments": true, "thirdPartyUniqueID": "abc123def456ghi789", "originContactName": "John Smith", "originContactPhoneNumber": "(408) 876-5432", "destinationContactName": "Jane Smith", "destinationContactPhoneNumber": "(408) 123-4567" }
Reference
Field | Type | Description |
shipperUserName |
String | The shipping customer's uShip username. A user logs into uship.com by supplying their username. |
shipperFirstName |
String | The first name on the account supplied at registration. |
shipperLastname |
String | The last name on the account supplied at registration. |
shipperEmailAddress |
String | The shipping customer's email address. |
shipperPrimaryPhoneNumber |
String | The main phone number to contact the shipping customer. |
shipperSecondaryPhoneNumber |
String | An additional phone number supplied for the shipping customer. |
shipperCompanyName |
String | The name that displays on uShip for the shipping customer. |
listingId |
Integer | Unique identifier for the listing |
listingTitle |
String | The descriptive name of the listing. |
Field | Type | Description |
isUshipPayments |
Boolean |
uShip Payments - Service Provider selects to only accept uShip Payments. By default, as listed in the uShip User Agreement, all listings below a certain threshold can only use uShip Payments. See Payment Policy.
|
thirdPartyUniqueID |
String | Unique identifier supplied by a third party for custom tracking purposes when they requested or responded to a rate request. |
originContactName |
String | The contact name for the pick up location. |
originContactPhoneNumber |
String | The phone number for the contact at the pick up location. |
destinationContactName |
String | The contact name for the delivery location. |
destinationContactPhoneNumber |
String | The phone number for the contact at the delivery location. |
originAddress / destinationAddress Object
Field | Type | Description |
streetAddress |
String | The physical street address where the shipment will be picked up or delivered. Usually line 1 of the mailing address. |
city |
String | The city where the shipment will be picked up or delivered. |
administrativeDivision |
String | The local department that handles the shipment’s municipal affairs. |
administrativeDivisionCode |
String | The unique 2-letter identifier of the local department that handles the shipment’s municipal affairs. |
postalCode |
String | The postal code where the shipment will be picked up or delivered. International postal codes are supported. |
latitude |
Decimal | The geographical latitude of the shipment location in decimal degrees. |
longitude |
Decimal | The geographical longitude of the shipment location in decimal degrees. |
countryid |
String | Unique country identifier. |
countryCode |
String | The alpha-2 country code where the shipment will be picked up or delivered. |
originTimeFrame / destinationTimeFrame object
Field | Type | Description |
date |
Container | Wrapper for the date(s) that make sense for the time frame type. |
month |
Integer | 2-digit month between 01 through 12. |
day |
Integer | 2-digit day associated with the calendar date (rather than the day of the week). Must be within the valid range for the specific month. |
year |
Integer | 4-digit year. |
acceptedBidAmount
The service provider's bid price accepted on the listing.
amountPaidByShipper
The price the shipping customer paid.
amountDueToServiceProvider
The amount to pay the service provider minus any fees charged for the transaction.
Field | Type | Description |
amount |
Decimal | The price based on the object described. |
currencyType |
String | Obtain a list of 3-letter ISO4217 standard values currently supported by the uShip API via GET Currencies Lookup API https://api.uship.com/v2/lookups/currencies/. |
Docs Navigation
- Get Started
- apis