/
[v2.6] TransportationTender

[v2.6] TransportationTender

Owned by Megan Stanage
Sept 10, 2024

Overview

This endpoint allows a user to create and update transportation tenders in SCC. 

POST /TransportationTender


 Request Body
 transportationTender

Represents the transportation tender structure.

PropertyData TypeNotes
carrierGroupNamestring

Gets or sets the carrier group name.

carrierServiceNamestring

Gets or sets the carrier service.

equipmentCodestring

Gets or sets the equipment code.

weightnumber

Gets or sets the weight.

  • decimal
weightUomenum

Gets or sets the weight UOM.

  • Lb
  • Oz
  • Kg
dimensionnumber

Gets or sets the dimension.

  • decimal
distancenumber

Gets or sets the distance.

  • decimal
distanceUomenum

Gets or sets the distance UOM.

  • Mi
  • Km
requestedRatenumber

Gets or sets the requested rate.

  • decimal
confirmedRatenumber

Gets or sets the confirmed rate.

  • decimal
requestedPickupDateTimestring

Gets or sets the requested pickup date time.

  • date-time
confirmedPickupDateTimestring

Gets or sets the confirmed pickup date time.

  • date-time
requestedDeliveryDateTimestring

Gets or sets the requested delivery date time.

  • date-time
borderCrossingDateTimestring

Gets or sets the border crossing date time.

  • date-time
actualPickupDateTimestring

Gets or sets the actual pickup date time.

  • date-time
actualDeliveryDateTimestring

Gets or sets the actual delivery date time.

  • date-time
borderCrossingLocationstring

Gets or sets the border crossing location.

loadstring

Gets or sets the load.

movementReferenceNumberstringGets or sets the movement reference number.
currencyCodeenum

Gets or sets the currency code.

USD, CAD, AUD, GBP, EUR, DKK, SEK, NOK, CZK, CHF, HUF, PLN, MXN, PHP, SAR, JPY, AFN, ALL, DZD, AOA, XCD, ARS, AMD, AWG, AZN, BSD, BHD, BDT, BBD, BYN, BZD, XOF, BMD, INR, BTN, BOB, BOV, BAM, BWP, BRL, BND, BGN, BIF, CVE, KHR, XAF, KYD, CLP, CLF, CNY, COP, COU, KMF, CDF, NZD, CRC, CUP, CUC, ANG, DJF, DOP, EGP, SVC, ERN, SZL, ETB, FKP, FJD, XPF, GMD, GEL, GHS, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, ISK, IDR, XDR, IRR, IQD, ILS, JMD, JOD, KZT, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, ZAR, LRD, LYD, MOP, MKD, MGA, MWK, MYR, MVR, MRU, MUR, XUA, MXV, MDL, MNT, MAD, MZN, MMK, NAD, NPR, NIO, NGN, OMR, PKR, PAB, PGK, PYG, PEN, QAR, RON, RUB, RWF, SHP, WST, STN, RSD, SCR, SLL, SLE, SGD, XSU, SBD, SOS, SSP, LKR, SDG, SRD, CHE, CHW, SYP, TWD, TJS, TZS, THB, TOP, TTD, TND, TRY, TMT, UGX, UAH, AED, USN, UYU, UYI, UYW, UZS, VUV, VES, VED, VND, YER, ZMW, ZWL, XBA, XBB, XBC, XBD, XTS, XXX, XAU, XPD, XPT, XAG

stopCountinteger

Gets or sets the stop count.

  • int32
carrierBookingNumberstringGets or sets the carrier booking number.
deliveryInstructionsstring

Gets or sets the delivery instructions.

deliveryNotesstring

Gets or sets the delivery notes.

bidTypeenum

Gets or sets the bid type.

  • Spot
  • Ranked
  • Direct
originLocationNamestring

Gets or sets the origin location name.

fixedRouteNamestring

Gets or sets the fixed route name.


 originAddress

Gets or sets the origin address.

PropertyData TypeNotes
name
stringmax length: 100
companystringmax length: 150
attentionTostringmax length: 150
addressLinesstring
citystringmax length: 150
postalCodestringmax length: 15
stateProvinceCodestringmax length: 5
countrystring
countryCodestringmax length: 5
phoneNumberstringmax length: 20
residentialboolean
taxIdstring
emailAddressstringmax length: 400
county

string

max length: 30


 identificationNumbers
PropertyData TypeNotes
vatstring
eoristring
 destinationAddress

Gets or sets the destination address.

PropertyData TypeNotes
name
stringmax length: 100
companystringmax length: 150
attentionTostringmax length: 150
addressLinesstring
citystringmax length: 150
postalCodestringmax length: 15
stateProvinceCodestringmax length: 5
countrystring
countryCodestringmax length: 5
phoneNumberstringmax length: 20
residentialboolean
taxIdstring
emailAddressstringmax length: 400
county

string

max length: 30


 identificationNumbers
PropertyData TypeNotes
vatstring
eoristring
 routes

Gets or sets the list of associated routes.

PropertyData TypeNotes
carrierNamestringGets or sets the carrier name.
carrierServiceNamestringGets or sets the carrier service name.
distancenumber

Gets or sets the distance.

  • decimal
distanceUomenum

Gets or sets the distance UOM.

  • Mi
  • Km
stopCountinteger

Gets or sets the stop count.

  • int32
requestedRatenumber

Gets or sets the requested rate.

  • decimal
currencyCodeenum

Gets or sets the currency code.

USD, CAD, AUD, GBP, EUR, DKK, SEK, NOK, CZK, CHF, HUF, PLN, MXN, PHP, SAR, JPY, AFN, ALL, DZD, AOA, XCD, ARS, AMD, AWG, AZN, BSD, BHD, BDT, BBD, BYN, BZD, XOF, BMD, INR, BTN, BOB, BOV, BAM, BWP, BRL, BND, BGN, BIF, CVE, KHR, XAF, KYD, CLP, CLF, CNY, COP, COU, KMF, CDF, NZD, CRC, CUP, CUC, ANG, DJF, DOP, EGP, SVC, ERN, SZL, ETB, FKP, FJD, XPF, GMD, GEL, GHS, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, ISK, IDR, XDR, IRR, IQD, ILS, JMD, JOD, KZT, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, ZAR, LRD, LYD, MOP, MKD, MGA, MWK, MYR, MVR, MRU, MUR, XUA, MXV, MDL, MNT, MAD, MZN, MMK, NAD, NPR, NIO, NGN, OMR, PKR, PAB, PGK, PYG, PEN, QAR, RON, RUB, RWF, SHP, WST, STN, RSD, SCR, SLL, SLE, SGD, XSU, SBD, SOS, SSP, LKR, SDG, SRD, CHE, CHW, SYP, TWD, TJS, TZS, THB, TOP, TTD, TND, TRY, TMT, UGX, UAH, AED, USN, UYU, UYI, UYW, UZS, VUV, VES, VED, VND, YER, ZMW, ZWL, XBA, XBB, XBC, XBD, XTS, XXX, XAU, XPD, XPT, XAG

deliveryInstructionsstring

Gets or sets the delivery instructions.

hostSystemRoutingDetailsstring

Gets or sets the blob url host system routing details.

externalReferencestring

Gets or sets the external reference.


 segments

Gets or sets the list of route segments.

PropertyData TypeNotes
distancenumber

Gets or sets the distance.

  • decimal
transitTimeinteger

Gets or sets the transit time.

  • int32


 originAddress

Gets or sets the origin address.

PropertyData TypeNotes
name
stringmax length: 100
companystringmax length: 150
attentionTostringmax length: 150
addressLinesstring
citystringmax length: 150
postalCodestringmax length: 15
stateProvinceCodestringmax length: 5
countrystring
countryCodestringmax length: 5
phoneNumberstringmax length: 20
residentialboolean
taxIdstring
emailAddressstringmax length: 400
county

string

max length: 30


 identificationNumbers
PropertyData TypeNotes
vatstring
eoristring
 destinationAddress

Gets or sets the destination address.

PropertyData TypeNotes
name
stringmax length: 100
companystringmax length: 150
attentionTostringmax length: 150
addressLinesstring
citystringmax length: 150
postalCodestringmax length: 15
stateProvinceCodestringmax length: 5
countrystring
countryCodestringmax length: 5
phoneNumberstringmax length: 20
residentialboolean
taxIdstring
emailAddressstringmax length: 400
county

string

max length: 30


 identificationNumbers
PropertyData TypeNotes
vatstring
eoristring
 transportationTenderRates

Gets or sets the list of transportation tender rates.

PropertyData TypeNotes
chargeAmountnumber

Gets or sets the charge amount.

  • decimal
externalCodestring

Gets or sets the external code.

freightBillClassstring

Gets or sets the freight bill class.

freightLineTypestring

Gets or sets the freight line type.

rateIdstring

Gets or sets the rate ID.

rateNotestring

Gets or sets the rate note.

stopNumberinteger

Gets or sets the stop number.

  • int32
unitstring

Gets or sets the unit.

unitRatenumber

Gets or sets the unit rate.

  • decimal
 shipments

Gets or sets the list of shipment route segments.

PropertyData TypeNotes
referenceNumstring

Gets or sets the reference number.

 systemAttributes

Gets or sets the list of associated system attributes.

PropertyData TypeNotes
attributeNamestringGets or sets the attribute name.
attributeDescriptionstringGets or sets the attribute description.
valuestringGets or sets the system attribute value.
 transaction

Defines the transportation tender transaction data structure.

PropertyData TypeNotes
workflowTransactionCodestring

Gets or sets the workflow transaction code.

referenceNumstringGets or sets the reference number.
externalReferenceNumstring
Gets or sets the external reference number.
notestring

Gets or sets the note.

reasonCodestringGets or sets the reason code.
transactionTypestringGets or sets the transaction type.
businessTransactionTypeenum
  • PurchaseOrder
  • Shipment
  • TransportationTender
  • FreightInvoice


 tradingPartners

Gets or sets the list of business transaction partners.

PropertyData TypeNotes
name
stringGets or sets the name.
typeenum

Gets or sets the trading partner type.

  • Vendor
  • Carrier
isPrimarybooleanGets or sets a value indicating whether the business transaction partner is primary.
 Response
PropertyData TypeNotes
businessTransactionReferenceNumstring
businessTransactionStatusstring



Feedback

Submit feedback.