Booking Acceptance Notification


This topic is part of the Shipping Customer's Published Rates flow.

A Shipping Customer receives a booking acceptance notification in application/JSON format posted to their recipient URL.These notifications do not apply to LTL shipments since LTL listings are booked immediately.

This notification provides the ability for the Shipping Customer to get the contact information for the Service Provider they booked. A Shipping Customer who has integrated the Published Rates (v2) flow receives this notification after a Service Provider accepted their booking request on uShip.com.

After the Service Provider selects "Accept Request", the Shipping Customer's credit card must be successfully charged before this notification will get sent to the Shipping Customer Integrator. If the credit card transaction does not go through, the Shipping Customer gets notified to provide another payment method.

 

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.

{
                "serviceProviderUserName": "BidAcceptNotificationTsp",
                "serviceProviderFirstName": "BidAccept",
                "serviceProviderLastName": "NotificationTsp",
                "serviceProviderEmailAddress": "BidAcceptNotificationTsp@test.com",
                "serviceProviderPrimaryPhoneNumber": "(512) 333-4444",
                "serviceProviderSecondaryPhoneNumber": "-",
                "serviceProviderCompanyName": "BidAcceptNotificationTsp Company",
                "paymentCode": "ABC123",
                "additionalInformation": "Details",
                "paymentMethod": "uShip Payments",
                "paymentTimeframe": "",
                "insurance": "",
                "auctionServiceFee": {
                    "amount": 15.0,
                    "currencyType": "USD"
                },
                "mcNumber": "",
                "listingID": 107430611,
                "listingTitle": "Car and Light Truck Listing Title",
                "originAddress": {
                    "streetAddress": "here1",
                    "alternateStreetAddress": "",
                    "city": "Beverly Hills",
                    "administrativeDivision": "California",
                    "administrativeDivisionCode": "CA",
                    "postalCode": "90210",
                    "latitude": 34.096629,
                    "longitude": -118.412426,
                    "countryId": "1",
                    "countryCode": "US"
                },
                "originTimeFrame": {
                    "date": {
                        "month": 12,
                        "day": 26,
                        "year": 2014
                    }
                },
                "destinationAddress": {
                    "streetAddress": "there1",
                    "alternateStreetAddress": "",
                    "city": "Austin",
                    "administrativeDivision": "Texas",
                    "administrativeDivisionCode": "TX",
                    "postalCode": "78747",
                    "latitude": 30.11826,
                    "longitude": -97.74954,
                    "countryId": "1",
                    "countryCode": "US"
                },
                "destinationAddressType": "BusinessWithLoadingDockOrForklift",
                "destinationTimeFrame": {
                    "dateLatest": {
                        "month": 1,
                        "day": 15,
                        "year": 2015
                    },
                    "date": {
                        "month": 1,
                        "day": 5,
                        "year": 2015
                    },
                    "timeFrameType": "between"
                },
                "acceptedBidAmount": {
                    "amount": 777.0,
                    "currencyType": "USD"
                },
                "amountPaidByShipper": {
                    "amount": 777.0,
                    "currencyType": "USD"
                },
                "amountDueToServiceProvider": {
                    "currencyType": "USD"
                },
                "isUshipPayments": true,
                "thirdPartyUniqueID": "303030",
                "originContactName": "Origin Name",
                "originContactPhoneNumber": "9725406354",
                "destinationContactName": "Destination Name",
                "destinationContactPhoneNumber": "9725406354"
            }

 

Reference


 

Field Type Description
serviceProviderUserName
String The service provider's uShip username. A user logs into uship.com by supplying their username.
serviceProviderFirstName
String The first name on the account supplied at registration.
serviceProviderLastname
String The last name on the account supplied at registration.
serviceProviderEmailAddress
String The service provider's email address.
serviceProviderPrimaryPhoneNumber
String The main phone number to contact the service provider.
serviceProviderSecondaryPhoneNumber
String An additional phone number supplied for the service provider.
serviceProviderCompanyName
String The name that displays on uShip for the service provider.
paymentCode
String System-generated alphanumeric payment code. See Listing Payment Code.
additionalInformation
String Optional information from the service provider.
paymentMethod
String Obtain the unique 36-character payment method identifier via GET https://api.uship.com/v2/paymentmethods.
paymentTimeframe
String

When the payment will be made.

Valid values returned:

  • BeforePickup = 1
  • AtPickup = 2
  • AtDelivery = 4
  • Other = 8
insurance
String Specified by the service provider in their profile when they register on uShip.com.
listingId
Integer Unique identifier for the listing.
listingTitle
String The descriptive name of the listing.

 

Field Type Description
mcNumber
String The operating authority (MC/FF/MX number) is assigned to interstate for-hire motor carriers and brokers that apply for operating authority. These numbers are also referred to as docket numbers. The FF number is assigned to freight forwarders; the MX number is assigned to carriers domiciled in Mexico; and the MC number is for all other carriers and brokers.The MC number is issued by the Federal Motor Carrier Safety Administration (FMCSA). Verify the Carrier's MC number at http://www.safersys.org/.
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.

  • true - This booked shipment accepts uShip payments.
  • false - This booked shipment accepts another payment method.
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.
alternateStreetAddress
String Additional origin or destination information such as building, suite, unit.
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.
destinationAddressType
String The kind or category of the delivery address.

 

originTimeFrame / destinationTimeFrame object

Field Type Description
date
Container Wrapper for the date(s) that make sense for the time frame type.
dateLatest
Container Wrapper for the date(s) that make sense for 
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.
timeFrameType
String

Valid values:

  • Before
  • Between
  • On
  • After
  • N/A

 

These objects wrap the fields that describe... 

auctionServiceFee

The service fee on the auction. 

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/.