Technical API Reference for the LTL Connect product's rates redirect, Bill of Lading, and reports endpoints. To obtain an API key, visit uShip API Key Generation.
Self-serve Bearer token provided to you at https://www.uship.com/api-key-generation
Listings
Retrieves a listing from the uShip Marketplace by listingId
Allows integrator to retrieve listing information by listing ID
listingId | integer | listingId of the listing that is to be returned |
xxxxxxxxxx
curl --get \
--url 'https://api.uship.com/v2/listings/%7BlistingId%7D' \
--header 'Authorization: Bearer {token}'
OK
object | object | ||
status | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
paymentStatus | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
transitStatus | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
cancellationStatus | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
hasPendingBookingRequest | boolean | ||
gallery | array[string] | ||
isCharitable | boolean | ||
isAuction | boolean | ||
isDutchAuction | boolean | ||
autoAcceptPrice | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
auctionTargetPrice | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
auctionMaxPrice | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
namedPrice | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
offerPrice | object | The details of an offer | |
offerType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
lowestBidPrice | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
acceptedBidPrice | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
totalCost | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
bookingDeposit | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
amountDueToServiceProvider | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
amountToMe | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
priceDetails | object | An aggregate of line items of a transaction | |
items | array[object] | ||
amount | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
description | object | Details of an enum that can be translated | |
value | string | description of the line item | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
commodity | string | ||
parentCommodity | string | ||
topLevelCommodity | string | ||
expiresOn | date-time | ||
questionsAsked | int32 | ||
activeBidsPlaced | int32 | ||
totalBidsPlaced | int32 | ||
imageUrl | string | ||
isDefaultImage | boolean | ||
checksum | string | ||
isWatched | boolean | ||
createdOn | date-time | ||
activatedOn | date-time | ||
lastUpdatedOn | date-time | ||
isBrokered | boolean | ||
bookedOn | date-time | ||
completedOn | date-time | ||
cancelledOn | date-time | ||
archivedOn | date-time | ||
serviceProvider | object | Public representation of a user | |
userId | int32 | Generated Id | |
displayName | string | Short name | |
imageUrl | string | Public profile image | |
profileUrl | string | Public profile URL | |
responseTime | string | Average response time | |
feedback | object | ||
count | int32 | The number of feedback items left | |
percentPositive | number | The percent of feedback that the user has recieved that is positive. If the user has received no feedback, the value is -1. If the user has received only negative feedback, the value is 0, and it is omitted from the serialized object. | |
starRating | number | Rating that determines how many "stars" the user's profile has | |
acceptanceRate | number | The ratio of accepted bids versus total bids | |
trackingEnabled | boolean | Tracking status of user | |
aboutMe | string | User description | |
dateCreated | date-time | Date joined uship.com | |
thirdPartyIdentifier | string | An identifer (email/integer/other) which can uniquely identify this user, set externally | |
thirdPartyProfileLink | string | A link to a page with information about this user on a different site | |
onTimePercentage | number | Calculated percentage of on time shipments shipped by this user | |
rebillPercentage | number | Calculated percentage of rebills on shipments shipped by this user | |
damageToClaimRatio | number | Calculated amount of damage amount/claim amount on shipments shipped by this user | |
pickupInstructionsMaxCharacters | int32 | Maximum number of pickup instruction characters supported for shipments shipped by this user | |
tariffUrl | string | URL that points to this user's tariff (terms and conditions) information | |
isFreightConsolidator | boolean | A flag indicating whether or not a user is an LTL carrier providing consolidated shipments | |
isNetworkAware | boolean | True if carrier has ever been added to a network | |
customFields | object | Variable customer fields | |
companyLocation | object | Output model for general address location | |
majorMunicipality | string | ||
stateProvince | string | ||
directoryCategories | array[object] | Top level commodity categories selected by the user | |
value | string | The code assigned to this class of transportable objects | |
label | string | The human-readable, localized name of the class of objects | |
shortLabel | string | ||
subCommodities | array[CommodityModel] | Sub-types of this class of objects; i.e., further specialized descriptions of the commodity | |
links | array[object] | The resource's links | |
rel | string | The relationship between the current resource and the linked resource | |
verb | string | GET, PUT, POST, DELETE, HEAD | |
href | string | The URI of the resource(s) | |
title | string | The name of the resource; theoretically, this should be the root name of the controller | |
assignedDriver | object | Public representation of a user | |
userId | int32 | Generated Id | |
displayName | string | Short name | |
imageUrl | string | Public profile image | |
profileUrl | string | Public profile URL | |
responseTime | string | Average response time | |
feedback | object | ||
count | int32 | The number of feedback items left | |
percentPositive | number | The percent of feedback that the user has recieved that is positive. If the user has received no feedback, the value is -1. If the user has received only negative feedback, the value is 0, and it is omitted from the serialized object. | |
starRating | number | Rating that determines how many "stars" the user's profile has | |
acceptanceRate | number | The ratio of accepted bids versus total bids | |
trackingEnabled | boolean | Tracking status of user | |
aboutMe | string | User description | |
dateCreated | date-time | Date joined uship.com | |
thirdPartyIdentifier | string | An identifer (email/integer/other) which can uniquely identify this user, set externally | |
thirdPartyProfileLink | string | A link to a page with information about this user on a different site | |
onTimePercentage | number | Calculated percentage of on time shipments shipped by this user | |
rebillPercentage | number | Calculated percentage of rebills on shipments shipped by this user | |
damageToClaimRatio | number | Calculated amount of damage amount/claim amount on shipments shipped by this user | |
pickupInstructionsMaxCharacters | int32 | Maximum number of pickup instruction characters supported for shipments shipped by this user | |
tariffUrl | string | URL that points to this user's tariff (terms and conditions) information | |
isFreightConsolidator | boolean | A flag indicating whether or not a user is an LTL carrier providing consolidated shipments | |
isNetworkAware | boolean | True if carrier has ever been added to a network | |
customFields | object | Variable customer fields | |
companyLocation | object | Output model for general address location | |
majorMunicipality | string | ||
stateProvince | string | ||
directoryCategories | array[object] | Top level commodity categories selected by the user | |
value | string | The code assigned to this class of transportable objects | |
label | string | The human-readable, localized name of the class of objects | |
shortLabel | string | ||
subCommodities | array[CommodityModel] | Sub-types of this class of objects; i.e., further specialized descriptions of the commodity | |
links | array[object] | The resource's links | |
rel | string | The relationship between the current resource and the linked resource | |
verb | string | GET, PUT, POST, DELETE, HEAD | |
href | string | The URI of the resource(s) | |
title | string | The name of the resource; theoretically, this should be the root name of the controller | |
isReadyForPickup | boolean | ||
billOfLadingNumber | int32 | ||
uShipPayments | object | ||
requiredOnBidsLessThan | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
availableOnBidsLessThan | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
minimumBidAmount | object | The details of a price and recommended formatting | |
value | number | Raw value of the price | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
currencyType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
privateNetwork | string | ||
cancellationLink | string | A link to the cancellation process web page | |
quoteRequestId | string | ID that was used for quote request (only for published rates) | |
commodityType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
parentCommodityType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
topLevelCommodityType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
isItineraryMandatory | boolean | ||
thirdParty | object | Some Listings created in uShip are the direct result of data in some external system. For example, a Shipper may have their own TMS, which contains the authoritative, definitive information the cargo, timeframe, pickup, and dropoff associated with a uShip Shipment or Listing. This object stores specifies the provenance, identity, and revision/change information of a uShip Shipment or Listing created from such an external source. | |
identifier | string | canonical identifier of this Listing's most direct counterpart in an external system; can be used to find this Listing in uShip maxLength: 200 | |
version | string | version of this Listing's most direct counterpart in the external system; can be used for optimistic concurrency control via the PUT /v3/markets/:marketId/listings/:listingId endpoint maxLength: 255 | |
checksum | string | The content checksum of this Listing's most direct counterpart in the external system; no logic in the uShip system interacts with this value. Its meaning is known only to API clients. maxLength: 255 | |
source | string | system of record for the Shipment and Itinerary data in this Listing; for example, the planning or TMS software from whence his data originates maxLength: 200 | |
prohibitEditViaUshipUi | boolean | When true, changes to Shipment and Listing content is not
allowed via the uShip web user interface. Content changes
must be made via the web service API. This value is optional
and defaults to | |
prohibitPlanViaUshipUi | boolean | When true, changes to Shipment or Listing planning is not
allowed via the uShip web user interface. Content changes
must be made via the web service API. This value is optional
and defaults to | |
serviceTypes | array[object] | required services for this Shipment's cargo (e.g., blanket wrapping is required) | |
value | string | Enum: | |
label | string | ||
shortLabel | string | ||
isExclusiveListing | boolean | A flag to indicate whether or not a listing is exclusive to any network | |
listingId | int32 | unique, public, numeric identifier of this Shipment | |
title | string | free text, ASCII, maximum of 50 characters | |
description | string | free text, ASCII; maximum of 5000 characters may be empty or absent if none was specified | |
route | object | Container for route destinations and other route information | |
distance | object | Measurement of a large value used for distance | |
kilometers | number | Raw distance in kilometers | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
items | array[object] | Ordered list of route destinations | |
address | object | Details of an address and recommended formatting | |
streetAddress | string | Primary street address | |
alternateStreetAddress | string | Secondary street address | |
majorMunicipality | string | The city or minor governing body | |
postalCode | string | Postal code | |
stateProvince | string | State or governing province code | |
stateProvinceLabel | string | State or governing province | |
country | string | Country code | |
countryLabel | string | Country | |
latitude | number | Geographical latitude | |
longitude | number | Geographical longitude | |
label | string | Recommended formatting | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
type | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
contact | object | Shipper contact information for the route point | |
name | string | maxLength: 50 | |
companyName | string | ||
phoneNumber | string | maxLength: 20 | |
altPhoneNumber | string | maxLength: 20 | |
string | |||
firstName | string | ||
lastName | string | ||
timeFrame | object | The details of a time frame and recommended display | |
label | string | Suggested formatted representation | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
earliestArrival | date-time | Earliest range for arrival for pickup or dropoff | |
latestArrival | date-time | Latest range for arrival for pickup or dropoff | |
localEarliestArrival | date-time | Earliest range for arrival for pickup or dropoff with Timezone offset | |
localLatestArrival | date-time | Latest range for arrival for pickup or dropoff with Timezone offset | |
timeFrameType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
timeZone | string | Specifies the Time Zone in the Zone Info (Olson, TzIdentifier) format | |
terminal | object | A model for freight terminals | |
phoneNumber | string | The phone number for the terminal | |
city | string | The city the terminal is located in | |
state | string | The state the terminal is located in | |
postalCode | string | The postal code of the terminal | |
attributes | object | Attributes associated with a single destination | |
* | object | ||
title | string | ||
value | object | ||
label | string | ||
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
accessorials | array | Collection of service accessorials for this route point | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
lister | object | Public representation of a user | |
userId | int32 | Generated Id | |
displayName | string | Short name | |
imageUrl | string | Public profile image | |
profileUrl | string | Public profile URL | |
responseTime | string | Average response time | |
feedback | object | ||
count | int32 | The number of feedback items left | |
percentPositive | number | The percent of feedback that the user has recieved that is positive. If the user has received no feedback, the value is -1. If the user has received only negative feedback, the value is 0, and it is omitted from the serialized object. | |
starRating | number | Rating that determines how many "stars" the user's profile has | |
acceptanceRate | number | The ratio of accepted bids versus total bids | |
trackingEnabled | boolean | Tracking status of user | |
aboutMe | string | User description | |
dateCreated | date-time | Date joined uship.com | |
thirdPartyIdentifier | string | An identifer (email/integer/other) which can uniquely identify this user, set externally | |
thirdPartyProfileLink | string | A link to a page with information about this user on a different site | |
onTimePercentage | number | Calculated percentage of on time shipments shipped by this user | |
rebillPercentage | number | Calculated percentage of rebills on shipments shipped by this user | |
damageToClaimRatio | number | Calculated amount of damage amount/claim amount on shipments shipped by this user | |
pickupInstructionsMaxCharacters | int32 | Maximum number of pickup instruction characters supported for shipments shipped by this user | |
tariffUrl | string | URL that points to this user's tariff (terms and conditions) information | |
isFreightConsolidator | boolean | A flag indicating whether or not a user is an LTL carrier providing consolidated shipments | |
isNetworkAware | boolean | True if carrier has ever been added to a network | |
customFields | object | Variable customer fields | |
companyLocation | object | Output model for general address location | |
majorMunicipality | string | ||
stateProvince | string | ||
directoryCategories | array[object] | Top level commodity categories selected by the user | |
value | string | The code assigned to this class of transportable objects | |
label | string | The human-readable, localized name of the class of objects | |
shortLabel | string | ||
subCommodities | array[CommodityModel] | Sub-types of this class of objects; i.e., further specialized descriptions of the commodity | |
links | array[object] | The resource's links | |
rel | string | The relationship between the current resource and the linked resource | |
verb | string | GET, PUT, POST, DELETE, HEAD | |
href | string | The URI of the resource(s) | |
title | string | The name of the resource; theoretically, this should be the root name of the controller | |
items | array[object] | details of the cargo(s) to be transported | |
title | string | free text, ASCII, maximum of 1000 characters | |
commodity | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
gallery | array[string] | URIs of images of this item | |
attributes | object | attributes/properties specific to this type of cargo; that is, the keys in this item vary depending on the Commodity field | |
* | object | ||
title | string | ||
value | object | ||
label | string | ||
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
accessorials | array | accessorials required by the Shipper; e.g., the cargo must not be allowed to freeze | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
totalWeightInGrams | object | Weight of an item in grams | |
value | number | Raw weight in grams | |
label | string | Formatted representation of grams | |
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
attributes | object | ||
* | object | ||
title | string | ||
value | object | ||
label | string | ||
shortLabel | string | shortened, localized, human-readable form of the value represented by the other properties of the class | |
nextTransitStatus | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
previousTransitStatus | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
availableTransitStatuses | array | ||
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
referenceNumbers | array[object] | These are identifiers and numbers by which refer to this Shipment or its cargo in some external system. If this Shipment is "owned" by an external system, prefer the ThirdParty property, as those fields are searchable and affect some uShip behavior. | |
number | string | maxLength: 60 | |
type | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
referenceNumberLabel | string | ||
importSource | string | ||
links | array[object] | The resource's links | |
rel | string | The relationship between the current resource and the linked resource | |
verb | string | GET, PUT, POST, DELETE, HEAD | |
href | string | The URI of the resource(s) | |
title | string | The name of the resource; theoretically, this should be the root name of the controller |
xxxxxxxxxx
{
"status": {...},
"paymentStatus": {...},
"transitStatus": {...},
"cancellationStatus": {...},
"hasPendingBookingRequest": "{boolean}",
"gallery": [...],
"isCharitable": "{boolean}",
"isAuction": "{boolean}",
"isDutchAuction": "{boolean}",
"autoAcceptPrice": {...},
"auctionTargetPrice": {...},
"auctionMaxPrice": {...},
"namedPrice": {...},
"offerPrice": {...},
"lowestBidPrice": {...},
"acceptedBidPrice": {...},
"totalCost": {...},
"bookingDeposit": {...},
"amountDueToServiceProvider": {...},
"amountToMe": {...},
"priceDetails": {...},
"commodity": "{string}",
"parentCommodity": "{string}",
"topLevelCommodity": "{string}",
"expiresOn": "{date-time}",
"questionsAsked": "{int32}",
"activeBidsPlaced": "{int32}",
"totalBidsPlaced": "{int32}",
"imageUrl": "{string}",
"isDefaultImage": "{boolean}",
"checksum": "{string}",
"isWatched": "{boolean}",
"createdOn": "{date-time}",
"activatedOn": "{date-time}",
"lastUpdatedOn": "{date-time}",
"isBrokered": "{boolean}",
"bookedOn": "{date-time}",
"completedOn": "{date-time}",
"cancelledOn": "{date-time}",
"archivedOn": "{date-time}",
"serviceProvider": {...},
"assignedDriver": {...},
"isReadyForPickup": "{boolean}",
"billOfLadingNumber": "{int32}",
"uShipPayments": {...},
"minimumBidAmount": {...},
"privateNetwork": "{string}",
"cancellationLink": "{string}",
"quoteRequestId": "{string}",
"commodityType": {...},
"parentCommodityType": {...},
"topLevelCommodityType": {...},
"isItineraryMandatory": "{boolean}",
"thirdParty": {...},
"serviceTypes": [...],
"isExclusiveListing": "{boolean}",
"listingId": "{int32}",
"title": "{string}",
"description": "{string}",
"route": {...},
"lister": {...},
"items": [...],
"accessorials": [...],
"totalWeightInGrams": {...},
"attributes": {},
"nextTransitStatus": {...},
"previousTransitStatus": {...},
"availableTransitStatuses": [...],
"referenceNumbers": [...],
"importSource": "{string}",
"links": [...]
}
Listings Attachments
Retrieves listing attachment information
Allows integrator to retrieve listing attachments by listing ID
listingId | integer | ||
attachmentId | integer |
xxxxxxxxxx
curl --get \
--url 'https://api.uship.com/v2/listings/%7BlistingId%7D/attachments/%7BattachmentId%7D' \
--header 'Authorization: Bearer {token}'
OK
object | object | ||
attachmentId | string | ||
uri | string | ||
fileName | string | ||
fileType | string | ||
fileSize | int64 | ||
dateCreated | date-time | ||
uploaderId | int64 | ||
attachmentType | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
notes | string | ||
links | array[object] | The resource's links | |
rel | string | The relationship between the current resource and the linked resource | |
verb | string | GET, PUT, POST, DELETE, HEAD | |
href | string | The URI of the resource(s) | |
title | string | The name of the resource; theoretically, this should be the root name of the controller |
xxxxxxxxxx
{
"attachmentId": "{string}",
"uri": "{string}",
"fileName": "{string}",
"fileType": "{string}",
"fileSize": "{int64}",
"dateCreated": "{date-time}",
"uploaderId": "{int64}",
"attachmentType": {
"value": "{string}",
"label": "{string}",
"shortLabel": "{string}"
},
"notes": "{string}",
"links": [
{
"rel": "{string}",
"verb": "{string}",
"href": "{string}",
"title": "{string}"
}
]
}
Tracking
Retrieve tracking info
This endpoint allows you to retrieve latitude/longitude values, transit status, and the most recent location or address. If a recent location is not provided, these will be absent from the response.
Authorization | string | Bearer {your password grant bearer token} |
listingId | integer |
xxxxxxxxxx
curl --get \
--url 'https://api.uship.com/v2/listings/%7BlistingId%7D/track' \
--header 'Authorization: {Authorization}' \
--header 'Authorization: Bearer {token}'
OK
object | object | ||
listingGeneratedId | integer | The ID for your listing | |
listingTitle | string | The title of your listing | |
commodityCode | string | Displays CarsLightTrucks | |
shipmentTrackingSummaryModel | object | ||
originAddress | object | The origin location reverse geo-coded to an address. | |
latitude | number | The latitude recorded to two decimal places. | |
longitude | number | The longitude recorded to two decimal places. | |
label | string | A location label created from the coordinates | |
shortLabel | string | A shortened location label created from the coordinates | |
destinationAddress | object | The destination location reverse geo-coded to an address. | |
latitude | number | The latitude recorded to two decimal places. | |
longitude | number | The longitude recorded to two decimal places. | |
label | string | A location label created from the coordinates | |
shortLabel | string | A shortened location label created from the coordinates | |
pickupTimeframe | object | The timeframe for picking up the shipment. | |
date1 | date-time | The first date in the pickup timeframe. | |
date2 | date-time | The last date in the pickup timeframe. | |
date1Offset | date-time | The date offset for the first date. | |
date2Offset | date-time | The date offset for the second date. | |
timeFrameType | object | The type of timeframe | |
value | string | The value of timeframe type. | |
label | string | The label for the type of timeframe. | |
shortLabel | string | The label for the type of timeframe. | |
timeZone | string | The string representation of the timezone. | |
label | string | The full timeframe label with day, month, and year. | |
shortLabel | string | The timeframe with only the month and day. | |
shortLabelWithYear | string | The timeframe with the month, day, and year. | |
deliveryTimeframe | object | The timeframe for deliverying the shipment. | |
date1 | date-time | The first date in the delivery timeframe. | |
date2 | date-time | The last date in the delivery timeframe. | |
date1Offset | date-time | The date offset for the first date. | |
date2Offset | date-time | The date offset for the second date. | |
timeFrameType | object | The type of timeframe | |
value | string | The value of timeframe type. | |
label | string | The label for the type of timeframe. | |
shortLabel | string | The label for the type of timeframe. | |
timeZone | string | The string representation of the timezone. | |
label | string | The full timeframe label with day, month, and year. | |
shortLabel | string | The timeframe with only the month and day. | |
shortLabelWithYear | string | The timeframe with the month, day, and year. | |
currentTransitStatus | object | The current transit status of the listing. | |
value | string | The value for the current transit status | |
label | string | The label for the transit status | |
shortLabel | string | The label for the transit status | |
carrierContactModel | object | The contact information for the carrier | |
name | string | The name of the carrier | |
companyName | string | The carrier's company name. | |
username | string | The carrier's username. | |
user | object | Information about the carrier. | |
userId | integer | The carrier's user ID. | |
displayName | string | The name to display for the carrier | |
imageUrl | string | The url to the carrier's profile image. | |
profileUrl | string | The url to the carrier's profile. | |
feedback | object | The feedback scores for the carrier | |
count | integer | The number of reviews | |
percentPositive | number | The positive score to one decmial place. | |
starRating | number | The overall score from all reviews based on a five star score. The value is to one decimal place. | |
aboutMe | string | The about statement from the carrier's profile. | |
dateCreated | string | The creation date of the carrier account. | |
companyLocation | object | The location of the carrier's company. | |
majorMunicipality | string | The city near the carrier's company. | |
stateProvince | string | The state or province the carrier's company is located. | |
directoryCategories | array[object] | The list of categories the carrier handles. | |
value | string | The value of the category. | |
label | string | The label for the category. | |
shortLabel | string | The label for the category. | |
links | array[object] | The list of available links associated with the carrier. | |
verb | string | HTTP method associated with the link. | |
href | string | The url for the link | |
title | string | label for the link | |
shipmentTrackingStatuses | array[object] | The list of tracking statuses and when they were set | |
status | string | The tracking status. | |
punctuality | object | Whether the status was set by the agreed date. | |
value | string | The value for the punctuality. | |
label | string | The label for the punctuality. | |
shortLabel | string | The shortened label for the punctuality. | |
recorded | string | The date/time when the status was recorded. | |
mostRecentLocation | array[object] | The last recorded location of your shipment. | |
recorded | string | The time the location was noted | |
latitude | number | The latitude recorded to two decimal points | |
longitude | number | The longitude recorded to two decimal points | |
mostRecentAddress | array[object] | The last recorded location reverse geo-coded to an address. Will not be returned if not available. | |
latitude | number | The latitude recorded to two decimal points | |
longitude | number | The longitude recorded to two decimal points | |
label | string | A location label created from the coordinates | |
shortLabel | string | A shortened location label created from the coordinates |
xxxxxxxxxx
{
"listingGeneratedId": "{integer}",
"listingTitle": "{string}",
"commodityCode": "{string}",
"shipmentTrackingSummaryModel": {...},
"carrierContactModel": {...},
"shipmentTrackingStatuses": [...],
"mostRecentLocation": [...],
"mostRecentAddress": [...]
}
Rate Requests
Get list of available rates for a rate request
Authorization | string | Required Authorization header containing access token |
id | string |
development | string |
xxxxxxxxxx
curl --get \
--url 'https://api.uship.com/v2/raterequests/%7Bid%7D/rates' \
--header 'Authorization: {Authorization}' \
--header 'Authorization: Bearer {token}' \
--data development={development}
200 response
v2RateRequestsRatesGet200Response | object | ||
totalCount | number | ||
items | array[object] | List of rates | |
serviceType | object | ||
shortLabel | string | Service Type short label | |
label | string | Service Type label (ex. LTL Standard) | |
value | string | Service Type API name (ex. LtlTransportOnly) | |
additionalInformation | string | Additional information | |
expires | string | Expiration date | |
calculatedPrices | object | ||
ushipServiceCharge | object | ||
ushipServiceCharge | object | ||
currencyType | object | ||
shortLabel | string | Shortened currency name | |
label | string | Currency name (ex. US Dollar) | |
value | string | Currency code (ex. USD) | |
shortLabel | string | Rounded price with currency sign (ex. $400) | |
label | string | Price with currency sign (ex. $399.99) | |
value | number | Numerical price | |
freightCharge | object | ||
currencyType | object | ||
shortLabel | string | Shortened currency name | |
label | string | Currency name (ex. US Dollar) | |
value | string | Currency code (ex. USD) | |
shortLabel | string | Rounded price with currency sign (ex. $400) | |
label | string | Price with currency sign (ex. $399.99) | |
value | number | Numerical price | |
totalPrice | object | ||
currencyType | object | ||
shortLabel | string | Shortened currency name | |
label | string | Currency name (ex. US Dollar) | |
value | string | Currency code (ex. USD) | |
shortLabel | string | Rounded price with currency sign (ex. $400) | |
label | string | Price with currency sign (ex. $399.99) | |
value | number | Numerical price | |
bidder | object | Carrier Information | |
profileUrl | string | Carrier Profile Image URL | |
feedback | object | ||
count | number | Number of reviews | |
starRating | number | Average rating | |
directoryCategories | array[object] | ||
shortLabel | string | Directory Category short label | |
label | string | Directory Category label | |
value | string | Directory Category API name | |
dateCreated | string | Carrier creation date | |
displayName | string | Carrier display name | |
responseTime | string | Carrier response time | |
imageUrl | string | Image URL | |
links | array[object] | ||
rel | string | rel | |
verb | string | HTTP verb | |
href | string | href | |
title | string | Title | |
userId | number | Carrier ID | |
companyLocation | object | ||
majorMunicipality | string | Municipality | |
stateProvince | string | State/Province | |
aboutMe | string | Carrier description | |
tariffUrl | string | Tariff URL | |
created | string | Creation date | |
pickupTimeframe | object | ||
delay | number | Length of transport in number of days | |
timeFrameType | object | ||
shortLabel | string | Timeframe Type short label | |
label | string | Timeframe Type label | |
value | string | Timeframe Type API name | |
carrierTransitDays | number | Carrier transit days | |
deliveryTimeFrame | object | ||
delay | number | Length of transport in number of days | |
timeFrameType | object | ||
shortLabel | string | Timeframe Type short label | |
label | string | Timeframe Type label | |
value | string | Timeframe Type API name | |
ltlServiceLevel | object | ||
shortLabel | string | LTL Service Level short label | |
label | string | LTL Service Level label | |
value | string | LTL Service Level API name | |
amountToCarrierCharges | array[object] | ||
charge | object | ||
currencyType | object | ||
shortLabel | string | Shortened currency name | |
label | string | Currency name (ex. US Dollar) | |
value | string | Currency code (ex. USD) | |
shortLabel | string | Rounded price with currency sign (ex. $400) | |
label | string | Price with currency sign (ex. $399.99) | |
value | number | Numerical price | |
code | string | Charge code | |
description | string | Charge description | |
transportMode | object | ||
shortLabel | string | Transport Mode short label | |
label | string | Transport Mode label | |
value | string | Transport Mode API name | |
links | array[object] | ||
rel | string | rel | |
verb | string | HTTP verb | |
href | string | href | |
title | string | Title | |
id | string | Rate ID | |
carrierBranding | string | Carrier branding | |
vehicleType | object | ||
shortLabel | string | Vehicle Type short label | |
label | string | Vehicle Type label | |
value | string | Vehicle Type API name |
Unauthorized
Forbidden
Internal server error
xxxxxxxxxx
{
"totalCount": "{number}",
"items": [...]
}
Create a rate request
Authorization | string | Required Authorization header containing access token |
development | string |
v2RateRequestsPostRequest | object | ||
route | object | ||
items | array[object] | Route contains two items: (1) pickup information (2) delivery information. Note - pickup information must include a timeFrame, but delivery information cannot. | |
address | object | ||
majorMunicipality | string | Pickup/Delivery municipality | |
country | string | Pickup/Delivery country in two letter form (ex. US) | |
formattedAddress | string | Pickup/Delivery formatted address (ex. Beverly Hills, CA 90210, USA) | |
streetAddress | string | Primary street address | |
postalCode | string | Pickup/Delivery postal code | |
latitude | number | Pickup/Delivery latitude | |
stateProvince | string | Pickup/Delivery state | |
type | string | Valid locations are Residence, BusinessWithLoadingDockOrForklift, BusinessWithoutLoadingDockOrForklift, ConstructionSite, TradeShowOrConvention, Port, StorageFacility, MilitaryBase, Airport, OtherSecuredLocation, School, GovernmentLocation, FarmRanchEstate, ReligiousInstitution, GolfCourseResortPark, DistributionCenter, or Auction Enum: | |
longitude | number | Pickup/Delivery longitude | |
contact | object | ||
firstName | string | Contact first name | |
lastName | string | Contact last name | |
phoneNumber | string | Contact phone number | |
companyName | string | Company name | |
name | string | Contact name | |
string | Contact email | ||
timeFrame | object | ||
earliestArrival | string | Pickup/Delivery earliest date | |
latestArrival | string | Pickup/Delivery latest date | |
timeFrameType | string | Pickup/Delivery timeframe Enum: | |
accessorials | array[string] | Collection of service accessorials for this route point Enum: | |
referenceNumbers | array[object] | Identifiers and numbers by which one can refer to this shipment or its cargo in some external system | |
number | string | The value of the reference number | |
type | string | The type of reference number Enum: | |
items | array[object] | LTL Items | |
commodity | string | Type of commodity | |
stackable | boolean | Indicates if item is stackable | |
heightInMeters | number | Item height in meters | |
unitCount | number | Number of units | |
lengthInMeters | number | Item length in meters | |
weightInGrams | number | Item weight in grams | |
hazardous | boolean | Indicates if item is hazardous | |
widthInMeters | number | Item width in meters | |
handlingUnit | string | Valid types are None, Pallets48x40Inches, Boxes, Crates, Drums, Other, Cartons, Bags, Bales, Bundles, Cans, Cases, Coils, Cylinders, Loose, Pails, Reels, Rolls, TubesPipes Enum: | |
title | string | Item title | |
description | string | Item description | |
gallery | array[string] | List of image URLs | |
integratorId | string | The integrator id for the request. This is required to receive webhooks and custom rates | |
accessorials | array[string] | Collection of service accessorials for this shipment Enum: |
xxxxxxxxxx
curl --request POST \
--url 'https://api.uship.com/v2/raterequests' \
--header 'Authorization: {Authorization}' \
--header 'Authorization: Bearer {token}' \
--data development={development} \
--data '{
"route": {
"items": [
{
"address": {
"majorMunicipality": "{string}",
"country": "{string}",
"formattedAddress": "{string}",
"streetAddress": "{string}",
"postalCode": "{string}",
"latitude": "{number}",
"stateProvince": "{string}",
"type": "{string}",
"longitude": "{number}"
},
"contact": {
"firstName": "{string}",
"lastName": "{string}",
"phoneNumber": "{string}",
"companyName": "{string}",
"name": "{string}",
"email": "{string}"
},
"timeFrame": {
"earliestArrival": "{string}",
"latestArrival": "{string}",
"timeFrameType": "{string}"
},
"accessorials": [
"{array[string]...}"
]
}
]
},
"referenceNumbers": [
{
"number": "{string}",
"type": "{string}"
}
],
"items": [
{
"commodity": "{string}",
"stackable": "{boolean}",
"heightInMeters": "{number}",
"unitCount": "{number}",
"lengthInMeters": "{number}",
"weightInGrams": "{number}",
"hazardous": "{boolean}",
"widthInMeters": "{number}",
"handlingUnit": "{string}",
"title": "{string}",
"description": "{string}",
"gallery": [
"{array[string]...}"
]
}
],
"integratorId": "{string}",
"accessorials": [
"{array[string]...}"
]
}'
201 response
Headers | ||||
Location | string | URL containing the rate request ID |
Bad Request
Unauthorized
Internal server error
xxxxxxxxxx
No example response
Accept a rate
Allows a shipper or an integrator on a shipper’s behalf to accept a rate
Authorization | string | Required Authorization header containing access token |
id | string |
v2RatesAcceptancePostRequest | object | ||
insurance | object | Insurance | |
coverage | object | ||
currencyType | string | Currency type (ex. USD) | |
amount | number | Coverage amount | |
paymentMethodId | string | Payment method ID |
xxxxxxxxxx
curl --request POST \
--url 'https://api.uship.com/v2/rates/%7Bid%7D/acceptance' \
--header 'Authorization: {Authorization}' \
--header 'Authorization: Bearer {token}' \
--data '{
"insurance": {
"coverage": {
"currencyType": "{string}",
"amount": "{number}"
}
},
"paymentMethodId": "{string}"
}'
202 response
Headers | ||||
Location | string | GET acceptance status endpoint | ||
Body | ||||
v2RatesAcceptancePost202Response | object | |||
message | string | Accepted message |
Bad Request
Unauthorized
Forbidden
Internal server error
xxxxxxxxxx
{
"message": "{string}"
}
Retrieves the status of a rate acceptance request
Authorization | string | Required Authorization header containing access token |
executionId | string | ||
id | string |
xxxxxxxxxx
curl --get \
--url 'https://api.uship.com/v2/rates/%7Bid%7D/acceptance/status/%7BexecutionId%7D' \
--header 'Authorization: {Authorization}' \
--header 'Authorization: Bearer {token}'
200 response
v2RatesAcceptanceStatusGet200Response | object | ||
response | string | Stringified JSON response of the rate acceptance request | |
statusCode | number | The API response status code of the rate acceptance request |
201 response
Unauthorized
Forbidden
Not Found
Internal server error
xxxxxxxxxx
{
"response": "{string}",
"statusCode": "{number}"
}
Payment Methods
Get All User's Payment Methods
Authorization | string | Required Authorization header containing access token |
topLevelCommodity | string | Required top level commodity |
xxxxxxxxxx
curl --get \
--url 'https://api.uship.com/v2/paymentmethods' \
--header 'Authorization: {Authorization}' \
--header 'Authorization: Bearer {token}' \
--data topLevelCommodity={topLevelCommodity}
Successfully retrieved payment methods
v2PaymentMethodsGet200Response | object | ||
totalCount | number | ||
items | |||
object | object | Credit Card | |
lastFour | string | Last four digits of credit card number | |
isPrimary | boolean | Indicates if default card or not | |
active | boolean | Indicates whether account is active or not | |
expiration | object | ||
month | number | Expiration month | |
year | number | Expiration year | |
id | string | Unique ID | |
type | object | ||
value | string | Type of payment method Enum: | |
issuer | string | Issuing institution |
Bad Request
Unauthorized
Forbidden
Internal server error
Top level commodity not implemented yet
xxxxxxxxxx
{
"totalCount": "{number}",
"items": [
{
"lastFour": "{string}",
"isPrimary": "{boolean}",
"active": "{boolean}",
"expiration": {
"month": "{number}",
"year": "{number}"
},
"id": "{string}",
"type": {
"value": "{string}"
},
"issuer": "{string}"
}
]
}
Bill Of Lading
Get the preSigned url for bill of lading
Authorization | string | Required Authorization header containing access token |
id | string |
xxxxxxxxxx
curl --get \
--url 'https://api.uship.com/v2/listings/%7Bid%7D/billoflading' \
--header 'Authorization: {Authorization}' \
--header 'Authorization: Bearer {token}'
200 response
v2ListingBillofLadingGet200Response | object | ||
billOfLadingNumber | number | ||
document | object | pre-signed url to access the bill of lading | |
href | string | pre-signed url |
Unauthorized
Forbidden
Not Found
Internal server error
xxxxxxxxxx
{
"billOfLadingNumber": "{number}",
"document": {
"href": "{string}"
}
}
listing booked webhook
webhook sent when a listing is booked through an integration
Information about the booked listing
object | object | ||
specversion | string | The version of the CloudEvents specification which the event uses. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#specversion Enum: | |
source | string | Identifies the context in which an event happened. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1 | |
id | uuid | Identifies the event. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#id | |
time | date-time | Timestamp of when the occurrence happened in ISO-8601 format. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time | |
type | string | Type of event related to the originating occurrence. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type Enum: | |
data | object | ||
href | string | Relative URL of the listing API resource | |
referenceNumbers | array[object] | These are identifiers and numbers by which refer to this Shipment or its cargo in some external system. If this Shipment is "owned" by an external system, prefer the ThirdParty property, as those fields are searchable and affect some uShip behavior. | |
number | string | maxLength: 60 | |
type | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
referenceNumberLabel | string | ||
shipment | object | ||
href | string | Relative URL of the shipment API resource | |
billOfLadingNumber | integer | Identifier for the bill of lading |
xxxxxxxxxx
{
"specversion": "{string}",
"source": "{string}",
"id": "{uuid}",
"time": "{date-time}",
"type": "{string}",
"data": {
"href": "{string}",
"referenceNumbers": [
{
"number": "{string}",
"type": {
"value": "{string}",
"label": "{string}",
"shortLabel": "{string}"
},
"referenceNumberLabel": "{string}"
}
],
"shipment": {
"href": "{string}"
},
"billOfLadingNumber": "{integer}"
}
}
Return a 200 status to indicate that the data was received successfully
No response body |
xxxxxxxxxx
No response
transit status changed webhook
Information about the booked transit status change
object | object | ||
specversion | string | The version of the CloudEvents specification which the event uses. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#specversion Enum: | |
source | string | Identifies the context in which an event happened. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1 | |
id | uuid | Identifies the event. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#id | |
time | date-time | Timestamp of when the occurrence happened in ISO-8601 format. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time | |
type | string | Type of event related to the originating occurrence. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type Enum: | |
data | object | ||
href | string | Relative URL of the shipment API resource | |
referenceNumbers | array[object] | These are identifiers and numbers by which refer to this Shipment or its cargo in some external system. If this Shipment is "owned" by an external system, prefer the ThirdParty property, as those fields are searchable and affect some uShip behavior. | |
number | string | maxLength: 60 | |
type | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
referenceNumberLabel | string | ||
listing | object | ||
href | string | Relative URL of the listing API resource | |
listingId | number | ID of the listing | |
transitStatus | object | ||
value | string | Enum: |
xxxxxxxxxx
{
"specversion": "{string}",
"source": "{string}",
"id": "{uuid}",
"time": "{date-time}",
"type": "{string}",
"data": {
"href": "{string}",
"referenceNumbers": [
{
"number": "{string}",
"type": {
"value": "{string}",
"label": "{string}",
"shortLabel": "{string}"
},
"referenceNumberLabel": "{string}"
}
],
"listing": {
"href": "{string}",
"listingId": "{number}"
},
"transitStatus": {
"value": "{string}"
}
}
}
Return a 200 status to indicate that the data was received successfully
No response body |
xxxxxxxxxx
No response
listing reference number added webhook
Information about the reference number
object | object | ||
specversion | string | The version of the CloudEvents specification which the event uses. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#specversion Enum: | |
source | string | Identifies the context in which an event happened. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1 | |
id | uuid | Identifies the event. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#id | |
time | date-time | Timestamp of when the occurrence happened in ISO-8601 format. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time | |
type | string | Type of event related to the originating occurrence. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type Enum: | |
data | object | ||
href | string | Relative URL of the listing API resource | |
referenceNumbers | array[object] | These are identifiers and numbers by which refer to this Shipment or its cargo in some external system. If this Shipment is "owned" by an external system, prefer the ThirdParty property, as those fields are searchable and affect some uShip behavior. | |
number | string | maxLength: 60 | |
type | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
referenceNumberLabel | string | ||
number | string | maxLength: 60 | |
type | object | ||
value | string | Enum: |
xxxxxxxxxx
{
"specversion": "{string}",
"source": "{string}",
"id": "{uuid}",
"time": "{date-time}",
"type": "{string}",
"data": {
"href": "{string}",
"referenceNumbers": [
{
"number": "{string}",
"type": {
"value": "{string}",
"label": "{string}",
"shortLabel": "{string}"
},
"referenceNumberLabel": "{string}"
}
],
"number": "{string}",
"type": {
"value": "{string}"
}
}
}
Return a 200 status to indicate that the data was received successfully
No response body |
xxxxxxxxxx
No response
listing status changed webhook
Information about the status change
object | object | ||
specversion | string | The version of the CloudEvents specification which the event uses. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#specversion Enum: | |
source | string | Identifies the context in which an event happened. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1 | |
id | uuid | Identifies the event. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#id | |
time | date-time | Timestamp of when the occurrence happened in ISO-8601 format. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time | |
type | string | Type of event related to the originating occurrence. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type Enum: | |
data | object | ||
href | string | Relative URL of the listing API resource | |
referenceNumbers | array[object] | These are identifiers and numbers by which refer to this Shipment or its cargo in some external system. If this Shipment is "owned" by an external system, prefer the ThirdParty property, as those fields are searchable and affect some uShip behavior. | |
number | string | maxLength: 60 | |
type | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
referenceNumberLabel | string | ||
status | object | ||
value | string | Enum: |
xxxxxxxxxx
{
"specversion": "{string}",
"source": "{string}",
"id": "{uuid}",
"time": "{date-time}",
"type": "{string}",
"data": {
"href": "{string}",
"referenceNumbers": [
{
"number": "{string}",
"type": {
"value": "{string}",
"label": "{string}",
"shortLabel": "{string}"
},
"referenceNumberLabel": "{string}"
}
],
"status": {
"value": "{string}"
}
}
}
Return a 200 status to indicate that the data was received successfully
No response body |
xxxxxxxxxx
No response
shipment delivery timeframe updated webhook
Information about the delivery timeframe
object | object | ||
specversion | string | The version of the CloudEvents specification which the event uses. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#specversion Enum: | |
source | string | Identifies the context in which an event happened. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1 | |
id | uuid | Identifies the event. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#id | |
time | date-time | Timestamp of when the occurrence happened in ISO-8601 format. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time | |
type | string | Type of event related to the originating occurrence. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type Enum: | |
data | object | ||
href | string | Relative URL of the shipment API resource | |
referenceNumbers | array[object] | These are identifiers and numbers by which refer to this Shipment or its cargo in some external system. If this Shipment is "owned" by an external system, prefer the ThirdParty property, as those fields are searchable and affect some uShip behavior. | |
number | string | maxLength: 60 | |
type | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
referenceNumberLabel | string | ||
timeFrame | object | required arrival time window | |
localEarliestArrival | date-time | Earliest range for arrival for pickup or dropoff with Timezone offset | |
localLatestArrival | date-time | Latest range for arrival for pickup or dropoff with Timezone offset | |
timeFrameType | object | Indicates the type of timeframe interval | |
value | string | Enum: |
xxxxxxxxxx
{
"specversion": "{string}",
"source": "{string}",
"id": "{uuid}",
"time": "{date-time}",
"type": "{string}",
"data": {
"href": "{string}",
"referenceNumbers": [
{
"number": "{string}",
"type": {
"value": "{string}",
"label": "{string}",
"shortLabel": "{string}"
},
"referenceNumberLabel": "{string}"
}
],
"timeFrame": {
"localEarliestArrival": "{date-time}",
"localLatestArrival": "{date-time}",
"timeFrameType": {
"value": "{string}"
}
}
}
}
Return a 200 status to indicate that the data was received successfully
No response body |
xxxxxxxxxx
No response
listing attachment added webhook
Information about the attachment
object | object | ||
specversion | string | The version of the CloudEvents specification which the event uses. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#specversion Enum: | |
source | string | Identifies the context in which an event happened. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1 | |
id | uuid | Identifies the event. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#id | |
time | date-time | Timestamp of when the occurrence happened in ISO-8601 format. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time | |
type | string | Type of event related to the originating occurrence. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type Enum: | |
data | object | ||
href | string | Relative URL of the listing attachment API resource | |
referenceNumbers | array[object] | These are identifiers and numbers by which refer to this Shipment or its cargo in some external system. If this Shipment is "owned" by an external system, prefer the ThirdParty property, as those fields are searchable and affect some uShip behavior. | |
number | string | maxLength: 60 | |
type | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
referenceNumberLabel | string | ||
listing | object | ||
href | string | Relative URL of the listing API resource | |
uri | string | Location of the downloadable attachment | |
fileName | string | Filename of the attachment | |
fileType | string | File type of attachment | |
dateCreated | date-time | Timestamp when the attachment was created in ISO-8601 format | |
attachmentType | object | ||
value | string | Enum: |
xxxxxxxxxx
{
"specversion": "{string}",
"source": "{string}",
"id": "{uuid}",
"time": "{date-time}",
"type": "{string}",
"data": {
"href": "{string}",
"referenceNumbers": [
{
"number": "{string}",
"type": {
"value": "{string}",
"label": "{string}",
"shortLabel": "{string}"
},
"referenceNumberLabel": "{string}"
}
],
"listing": {
"href": "{string}"
},
"uri": "{string}",
"fileName": "{string}",
"fileType": "{string}",
"dateCreated": "{date-time}",
"attachmentType": {
"value": "{string}"
}
}
}
Return a 200 status to indicate that the data was received successfully
No response body |
xxxxxxxxxx
No response
listing price details updated webhook
Information about the price details
object | object | ||
specversion | string | The version of the CloudEvents specification which the event uses. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#specversion Enum: | |
source | string | Identifies the context in which an event happened. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#source-1 | |
id | uuid | Identifies the event. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#id | |
time | date-time | Timestamp of when the occurrence happened in ISO-8601 format. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#time | |
type | string | Type of event related to the originating occurrence. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#type Enum: | |
data | object | ||
href | string | Relative URL of the listing API resource | |
referenceNumbers | array[object] | These are identifiers and numbers by which refer to this Shipment or its cargo in some external system. If this Shipment is "owned" by an external system, prefer the ThirdParty property, as those fields are searchable and affect some uShip behavior. | |
number | string | maxLength: 60 | |
type | object | Details of an enum that can be translated | |
value | string | This is a stable value suitable for use in logic. Enum: | |
label | string | This is the full, localized, human-readable form of the value. This is a more verbose version of the ShortLabel. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
shortLabel | string | This is the shortened, localized, human-readable form of the value. This is a more terse version of the label. This value should never be used for logic or decisions, because the translated values could be modified at any time in order to clarify meaning, and as a result of a more specific (e.g., idiomatically correct) translation being introduced for users with a specific language preference. | |
referenceNumberLabel | string | ||
totalCost | object | The details of a price | |
value | number | Raw value of the price | |
currencyType | object | Currency code of the price | |
value | string | Enum: | |
priceDetails | object | An aggregate of line items of a transaction | |
items | array[object] | ||
amount | object | The details of a price | |
value | number | Raw value of the price | |
currencyType | object | Currency code of the price | |
value | string | Enum: | |
description | object | ||
value | string | description of the line item |
xxxxxxxxxx
{
"specversion": "{string}",
"source": "{string}",
"id": "{uuid}",
"time": "{date-time}",
"type": "{string}",
"data": {
"href": "{string}",
"referenceNumbers": [
{
"number": "{string}",
"type": {
"value": "{string}",
"label": "{string}",
"shortLabel": "{string}"
},
"referenceNumberLabel": "{string}"
}
],
"totalCost": {
"value": "{number}",
"currencyType": {
"value": "{string}"
}
},
"priceDetails": {
"items": [
{
"amount": {
"value": "{number}",
"currencyType": {
"value": "{string}"
}
},
"description": {
"value": "{string}"
}
}
]
}
}
}
Return a 200 status to indicate that the data was received successfully
No response body |
xxxxxxxxxx
No response