[v2.6] Ship

Overview

This endpoint enables users to get carrier-generated labels, documents, and rates.

Depending on the carrier's needs, this endpoint will also send a default pickup date.

The user can define containers, addresses, payment information, and other required data to ship their parcel shipments.

POST /Ship

Request Body

Property	Data Type	Notes
transactionHistoryProcess	enum	This field is used internally for tracking in Supply Chain Cloud. Use API if integrating directly to the API. ApiPackStation Api
includeTransactionXmls	boolean	True or false. Indicates whether the API requests and responses sent to the carrier are stored on the response. This will greatly increase the size of the response.
freightTerm	enum	Indicates which party is responsible for paying for the shipment's costs. Shipper Receiver Consignee ThirdParty
splitVat	boolean
termsOfTrade	enum	These are the incoterms for the shipment. Applicable for international freight. Ddp Dap Dtp
dutiesAndTaxesChargeTerms	enum	Indicates which party will pay the duties and taxes on the shipment. Receiver Consignee ThirdParty
customerAccount	string	Key used to assign the proper accounts if using Supply Chain Cloud's account assignment.
thirdPartyAccountNumber	string	If freightTerms are receiver, consignee, or third party, this account is used for payment of freight charges.
carrierGroup	string	Not applicable.
shipFromReferenceId	string	Key to reference origin location specific configurations. See Origin Locations for more information.
transactionId	string

carriers

Property	Data Type	Notes
isProduction	boolean	Controls whether the API request will go to production or test servers.
name	string	Name of the carrier. To look up the proper name, use the Carrier endpoint.
carrierServiceCodes	string	Name of the external code. To look up the proper name, use the Carrier endpoint.
carrierServiceNames	string	Name of the carrier service. To look up the proper name, use the Carrier endpoint.

accountAssignment

Property	Data Type	Notes
accountNumber	string	The account number to charge for the shipment. This is the shipper's account number. If charging third party, use thirdPartyAccountNumber.
additionalAccountNumber	string	If the carrier requires another account number, use this.
accessKey	string	Used to authenticate to carrier APIs.
userName	string	Used to authenticate to carrier APIs.
password	string	Used to authenticate to carrier APIs.

shipment

Property	Data Type	Notes
description	string	Description of the shipment.
orderNumber	string	Order number associated to the shipment.
proNumber	string	PRO number associated with the shipment.
currencyCode	enum	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
intrastatCode	string	This is another place to define incoterms for the shipment.
purchaseOrderNumber	string	PO number associated to the shipment.
reasonForExport	string	Reason for export.
ltlClass	number	Freight class.
weight	number	Total shipment weight.
value	number	The total value of the shipment.
hazMatEmergencyContact	string	The emergency contact for hazardous shipping.
hazMatEmergencyPhone	string	Contact's phone number.
hazMatOfferor	string	Offeror of hazmat.
hazMatSignatoryContact	string	The signor for the hazardous goods.
hazMatSignatoryTitle	string	The signor's title.
hazMatSignatoryPlace	string	Where the shipment's signor is located.
hazMatRegulationSet	string	ADR, IATA, DOT, CFR
inBondCode	string

accessorials

Property

Data Type

Notes

accessorialType

enum

Saturday
Cod
NotificationDeliver
NotificationShip
NotificationException
Insurance
ReturnLabel
Signature
DryIce
AdultSignature
AdditionalHandling
CarbonNeutral
DirectDelivery
BrokerDeclaration

creationMethod

enum

Manual
Automatic

Manual is applicable in most scenarios.

containerId

string

The container that the accessorial is applied to.

appliedAccessorialValues

Property	Data Type	Notes
key	string	Reach out to your Accenture technical resource for assistance on these values.
value	string

ltlAccessorials

cod

Property	Data Type	Notes
enabled	boolean	True or false.
amount	number	Amount to be collected upon delivery.

insurance

Property	Data Type	Notes
enabled	boolean	True or false.
additionalInsuranceAmount	number	Additional insurance on top of the shipment value.
shipmentValue	number	Total value of the shipment.

notificationDeliver

Property	Data Type	Notes
enabled	boolean	True or false.

appointmentRequiredAtDelivery

Property	Data Type	Notes
enabled	boolean	True or false.

appointmentRequiredAtPickup

Property	Data Type	Notes
enabled	boolean	True or false.

hazardousMaterial

Property	Data Type	Notes
enabled	boolean	True or false.

insideDelivery

Property	Data Type	Notes
enabled	boolean	True or false.

insidePickup

Property	Data Type	Notes
enabled	boolean	True or false.

liftGateRequiredAtDelivery

Property	Data Type	Notes
enabled	boolean	True or false.

liftGateRequiredAtPickup

Property	Data Type	Notes
enabled	boolean	True or false.

limitedAccessDelivery

Property	Data Type	Notes
enabled	boolean	True or false.

limitedAccessPickup

Property	Data Type	Notes
enabled	boolean	True or false.

oversized

Property	Data Type	Notes
enabled	boolean	True or false.

residentialPickup

Property	Data Type	Notes
enabled	boolean	True or false.

residentialDelivery

Property	Data Type	Notes
enabled	boolean	True or false.

securedLimitedAccessDelivery

Property	Data Type	Notes
enabled	boolean	True or false.

securedLimitedAccessPickup

Property	Data Type	Notes
enabled	boolean	True or false.

sortAndSegregate

Property	Data Type	Notes
enabled	boolean	True or false.
pieces	integer	Number of pieces to sort.

markedOrTagged

Property	Data Type	Notes
enabled	boolean	True or false.
count	integer	Number of marked or tagged handling units.

guaranteedRate

Property	Data Type	Notes
enabled	boolean	True or false.

containers

Property	Data Type	Notes
codApportionedValue	number	decimal
codOverrideValue	number	decimal
containerId	string	Identifier of the container in the host system.
containerName	string	Name of container (if applicable).
description	string	Description of container's contents.
freightClass	number	If the container is a pallet for LTL shipping, this should include freight class.
harmonizedCode	string	The harmonized code for the container.
height	number	Container height.
length	number	Container length.
lengthUom	enum	Inch Cm
masterTrackingNumber	string	If this container is part of a multiple container shipment that already has a tracking number to group by, use it here.
packageType	string	Type of package.
quantity	number	Number of pieces that are of the same dimensions and details as this container. For example, if you have two identical boxes, put quantity 2 on this container. Alternatively, you can define each container separately.
rateShopContainer	boolean	Indicates whether this container aligns with the rate shop container in SCC.
trackingNumber	string	If the user has a tracking number beforehand, they can use this field. It is not recommended.
value	number	Monetary value of the container.
weight	number	Container weight.
weightUom	enum	Lb Oz Kg
width	number	Container width.
hazMatPackagingType	string	Example: Fiberboard box.
hazMatPackagingQuantity	integer	Number of hazmat packages in this container.
hazMatPackagingUnit	string	kg, oz, lb
childContainerCount	integer	Not applicable.
containerTypeExternalCode	enum	FedExEnvelope, FedExBox, FedExSmallBox, FedExMediumBox, FedExLargeBox, FedExExtraLargeBox, FedEx10KgBox, FedEx25KgBox, FedExPak, FedExTube, FedExYourPackaging, UpsExpressBoxSmall, UpsExpressBoxMedium, UpsExpressBoxLarge, Ups10KgBox, Ups25KgBox, UpsEnvelopeLetter, UpsTube, UpsExpressPak

lines

Property	Data Type	Notes
countryManufactured	string
currencyCode	enum	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
description	string	Description of line item.
freightClass	number	Class of line item.
harmonizedCode	string	Commodity code for the line item.
height	number	Height of the item.
identifier	string	ID for the item in the host system.
length	number	Length of the item.
lengthUom	enum	Inch Cm
lineNumber	string	ID for the line.
nmfc	string	NMFC code for the line item. This is not the freight class.
quantity	number	Number of items in the container.
shippableContainerType	string	Not applicable.
value	number	Total monetary value for the line item.
weight	number	Total weight of the line.
weightUom	enum	Lb Oz Kg
width	number	Width of the item.
quantityUom	string	Quantity UoM (e.g., pcs).
shippableUnit	boolean	Not applicable.
hazMatClass	string	HazMat Class.
hazMatDivision	string	HazMat Division.
hazMatProperShippingName	string	HazMat PSN.
hazMatTechnicalName	string	HazMat Technical Name.
hazMatId	string	HazMat ID (UNXXXX).
hazMatLabelText	string	HazMat Label Text, if applicable.
hazMatPackingInstructions	string	HazMat packing instructions, if applicable.
hazMatRegulationSet	string	HazMat regulation set (IATA, DOT, ADR, CFR).
hazMatPackingGroup	string	HazMat Packing Group (I, II, III).
hazMatQuantity	number	Quantity of the hazmat material for the line.
hazMatUom	string	Quantity UoM.
hazMatCargoOnly	boolean	CAO indicator.
hazMatTransportationMode	string	ex: Ground, Air
hazMatTransportCategory	string
hazMatRegulationCode	string	ex: 49 CFR, ADR, IATA
stackable	boolean	True or false. Applicable to SMC3 LTL integrations only.
lithiumBatteryType	enum	None: Not a battery shipment. Battery: Shipment is marked as containing a battery without indicating it is a hazardous amount of lithium. HazMatBattery: Shipment is a fully regulated lithium battery shipment.

refFields

Property	Data Type	Notes
ref1	string	These reference fields map to label reference fields. The result will vary by carrier.
ref2	string
ref3	string
ref4	string

genericAdditionalData

Property	Data Type	Notes
key	string

genericAdditionalDataDetails

Property	Data Type	Notes
key	string
value	string

additionalInformation

Property	Data Type	Notes
key	string
value	string

genericAdditionalData

Property	Data Type	Notes
key	string

genericAdditionalDataDetails

Property	Data Type	Notes
key	string
value	string

lines

Property	Data Type	Notes
countryManufactured	string	Country the item was originally manfactured in.
currencyCode	enum	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
description	string	Description of the line item.
freightClass	number	Freight class of the item.
harmonizedCode	string	Commodity code of the item.
height	number	Heigh of the item.
identifier	string	Host system ID for the item.
length	number	Length of the item.
lengthUom	enum	Inch Cm
lineNumber	string	ID for the line.
nmfc	string	NMFC code of the item. ex: 37860
quantity	number	Quantity of the item on the line.
shippableContainerType	string	Not applicable.
value	number	Total value of the line.
weight	number	Total weight of the line.
weightUom	enum	Lb Oz Kg
width	number	Width of the line item.
quantityUom	string	Quantity unit of measurement
shippableUnit	boolean	Not applicable.
hazMatClass	string	HazMat Class.
hazMatDivision	string	HazMat Division.
hazMatProperShippingName	string	HazMat PSN.
hazMatTechnicalName	string	HazMat Technical Name.
hazMatId	string	HazMat ID (UNXXXX).
hazMatLabelText	string	Use if text required on label.
hazMatPackingInstructions	string	Packing instructions for the commodity.
hazMatRegulationSet	string	CFR, DOT, ADR IATA
hazMatPackingGroup	string	I, II, III
hazMatQuantity	number	Quantity of the hazmat item per UoM.
hazMatUom	string	Unit of measure for the hazmat item.
hazMatCargoOnly	boolean	CAO Indicator.
hazMatTransportationMode	string	Ground, Air
hazMatTransportCategory	string
hazMatRegulationCode	string	CFR, DOT, ADR, IATA
stackable	boolean	True or false. Applicable to SMC3 API integrations only.
lithiumBatteryType	enum	None: Not a battery shipment. Battery: Shipment is marked as containing a battery without indicating it is a hazardous amount of lithium. HazMatBattery: Shipment is a fully regulated lithium battery shipment.

shipmentDates

Property	Data Type	Notes
shipDate	string	ex: 2024-08-28T20:07:12
deliverOn	string	ex: 2024-08-28T20:07:12
deliverBy	string	ex: 2024-08-28T20:07:12
deliverAfter	string	ex: 2024-08-28T20:07:12

refFields

Property	Data Type	Notes
ref1	string	These reference fields map to label reference fields. The result will vary by carrier. At the shipment level, these apply to all containers.
ref2	string
ref3	string
ref4	string

internalCarrierAccessorials

Property	Data Type	Notes
name	string	Not applicable.
carrierName	string

additionalInformation

Property	Data Type	Notes
key	string
value	string

electronicExportInformation

Property	Data Type	Notes
value	string	The ID number referenced by type below.
type	enum	InternationalTransactionNumber ExemptionCode
statementType	enum	DepartmentOfCommerce DepartmentOfState

shipper

Property	Data Type	Notes
name	string	Name of party responsible for shipment. max length: 100
company	string	Company of the shipper. max length: 150
attentionTo	string	Attention to for the shipper. max length: 150
addressLines	string	Street Number, Street Name, Suite Number, etc.
city	string	City of shipper. max length: 150
postalCode	string	Postal code of shipper. max length: 15
stateProvinceCode	string	State or province code. Typically, just two characters (e.g., IN). max length: 5
country	string	Country of shipper (e.g., United States of America).
countryCode	string	Example: US max length: 5
phoneNumber	string	max length: 20
residential	boolean	True or false.
taxId	string	The tax identifier for the shipper. This can be an EORI, VAT, or exporter ID.
emailAddress	string	max length: 400
county	string	Optional. max length: 30

identificationNumbers

Property	Data Type	Notes
vat	string	This is a place for the VAT number, if required.
eori	string	This is a place for the EORI number, if required.

shipFrom

Property	Data Type	Notes
name	string	Name of origin for shipment. max length: 100
company	string	Company at the origin. max length: 150
attentionTo	string	Attention To at the origin. This will be used for returns if necessary. max length: 150
addressLines	string	Street Number, Street Name, Suite Number, etc.
city	string	City of shipment origin. max length: 150
postalCode	string	Postal code of shipment origin. max length: 15
stateProvinceCode	string	State/Province code of shipment origin. max length: 5
country	string	Full name of country.
countryCode	string	Country code at origin. max length: 5
phoneNumber	string	max length: 20
residential	boolean	True or false.
taxId	string	The tax identifier for the party at origin. This can be an EORI, VAT, or exporter ID.
emailAddress	string	max length: 400
county	string	Optional. max length: 30

identificationNumbers

Property	Data Type	Notes
vat	string	This is a place for the VAT number, if required.
eori	string	This is a place for the EORI number, if required.

shipTo

Property	Data Type	Notes
name	string	Name of receiver of shipment. max length: 100
company	string	Company at the destination. max length: 150
attentionTo	string	Attention to at the destination. max length: 150
addressLines	string	Street Number, Street Name, Suite Number, etc.
city	string	City of shipment destination. max length: 150
postalCode	string	Postal code of shipment destination. max length: 15
stateProvinceCode	string	State/Province code of shipment destination. max length: 5
country	string	Full name of country.
countryCode	string	Country code at destination. max length: 5
phoneNumber	string	max length: 20
residential	boolean	True or false.
taxId	string	The tax identifier for the party at destination. This can be an EORI, VAT, or exporter ID.
emailAddress	string	max length: 400
county	string	Optional. max length: 30

identificationNumbers

Property	Data Type	Notes
vat	string	This is a place for the VAT number, if required.
eori	string	This is a place for the EORI number, if required.

broker

Property	Data Type	Notes
name	string	Name of customs broker for the shipment. max length: 100
company	string	Company name for broker. max length: 150
attentionTo	string	Attention To for the broker. max length: 150
addressLines	string	Street Number, Street Name, Suite Number, etc.
city	string	City of broker. max length: 150
postalCode	string	Postal code of broker. max length: 15
stateProvinceCode	string	State/Province code of broker. max length: 5
country	string	Full name of country.
countryCode	string	Country code of broker. max length: 5
phoneNumber	string	max length: 20
residential	boolean	True or false.
taxId	string	The tax identifier for the broker. This can be an EORI, VAT, or exporter ID.
emailAddress	string	max length: 400
county	string	Optional. max length: 30
accountNumber	string	Account number of broker.
type	enum	Broker type: EXPORT IMPORT

identificationNumbers

Property	Data Type	Notes
vat	string	This is a place for the VAT number, if required.
eori	string	This is a place for the EORI number, if required.

customer

Property	Data Type	Notes
name	string	Name of customer for the shipment. max length: 100
company	string	Company name for the customer. max length: 150
attentionTo	string	Attention To for the customer. max length: 150
addressLines	string	Street Number, Street Name, Suite Number, etc.
city	string	City of customer. max length: 150
postalCode	string	Postal code of the customer. max length: 15
stateProvinceCode	string	State/Province code of customer. max length: 5
country	string	Full name of country.
countryCode	string	Country code of customer. max length: 5
phoneNumber	string	max length: 20
residential	boolean	True or false.
taxId	string	The tax identifier for the customer. This can be an EORI, VAT, or exporter ID.
emailAddress	string	max length: 400
county	string	Optional. max length: 30

identificationNumbers

Property	Data Type	Notes
vat	string	This is a place for the VAT number, if required.
eori	string	This is a place for the EORI number, if required.

return

Property	Data Type	Notes
name	string	Name of the return address for the shipment. max length: 100
company	string	Company name for return. max length: 150
attentionTo	string	Attention To for the return. max length: 150
addressLines	string	Street Number, Street Name, Suite Number, etc.
city	string	City of return. max length: 150
postalCode	string	Postal code of return. max length: 15
stateProvinceCode	string	State/Province code of return. max length: 5
country	string	Full name of country.
countryCode	string	Country code of return. max length: 5
phoneNumber	string	max length: 20
residential	boolean	True or false.
taxId	string	The tax identifier for the return address. This can be an EORI, VAT, or exporter ID.
emailAddress	string	max length: 400
county	string	Optional. max length: 30

identificationNumbers

Property	Data Type	Notes
vat	string	This is a place for the VAT number, if required.
eori	string	This is a place for the EORI number, if required.

Response

Property	Data Type	Notes
runTime	integer	int64
transactionId	string	System generated.

shipResultDto

transactionHistoryInterfaces

Property	Data Type	Notes
carrierRequest	string	Request sent to carrier API.
carrierResponse	string	Response sent from carrier API.
sccRequest	string	Not applicable.
sccResponse	string	Not applicable.
carrierTransactionId	string	Carrier-generated transaction ID.

parcelErrors

Property	Data Type	Notes
class	string
method	string
message	string

shipResult

Property	Data Type	Notes
carrier	string	Carrier of the request.
carrierServiceExternalCode	string	External code of the request.
carrierServiceName	string	Name of the service of the request.
ratedCarrier	string	If using broker pricing, this is the carrier that rated the shipment.
ratedCarrierServiceName	string	If using broker pricing, this is the carrier service of the shipment.
totalRateDisplay	number	Total rate.
hasTotalRate	boolean	Not applicable.
deliverByDateTime	string	date-time
deliverByDateTimeCalculated	boolean	Ship date and time in transit if date is not provided by the carrier.
businessDaysInTransit	integer	Number of days in transit.
saturday	boolean	If shipment will be delivered on a Saturday. True or false
apportionedNegotiated	boolean	If the shipment's negotiated charges are apportioned. True or false
apportionedList	boolean	If the shipment's list charges are apportioned. True or false
parcelErrors	string
meetsDeliveryWindow	boolean	If the shipment is in the request delivery window. True or false
billingWeightUom	string	Weight UoM.
proNumber	string	PRO number if shipping LTL.

carrierService

Property	Data Type	Notes
name	string	Name of carrier service.
externalCode	string	Code used in carrier system.

totalRateNegotiated

Property	Data Type	Notes
rate	number	Negotiated rate using account information.
currencyCode	enum	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
discountedRate	number	If a discount is configured, the resulting rate is here.

totalRateList

Property	Data Type	Notes
rate	number	List rate.
currencyCode	enum	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
discountedRate	number	If discount is applied to list rate, that is displayed here.

containerShipResults

Property	Data Type	Notes
weight	number	Weight of container.
weightUom	number	Weight UoM.
billingWeight	enum	Weight the container is rated at by the carrier.
billingWeightUom	enum	Lb Oz Kg
containerTypeName	string	If the container has a type in SCC.
containerId	string	System-defined ID.
rateShopContainer	boolean	If the container is the rate shop container in SCC, this is true.
trackingNumber	string	Tracking number for the container.
masterTrackingNumber	string	Master tracking number for the shipment.
trackingNumberReturn	string	Tracking number for the return shipment of the container.

parcelErrors

Property	Data Type	Notes
class	string
method	string
message	string

totalRateNegotiated

Property	Data Type	Notes
rate	number	Negotiated rate using account information.
currencyCode	enum	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
discountedRate	number	If a discount is configured, the resulting rate is here.

totalRateList

Property	Data Type	Notes
rate	number	Total list rate.
currencyCode	enum	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
discountedRate	number	If there is an applicable discount, it is displayed here.

containerRateDetailsNegotiated

Property	Data Type	Notes
rate	number	Detailed negotiated rate.
currencyCode	enum	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
discountedRate	number	If there is an applicable discount, it is displayed here.
chargeType	enum	Freight Accessorial Fuel Total

containerRateDetailsList

Property	Data Type	Notes
rate	number	Detailed list rate.
currencyCode	enum	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
discountedRate	number	If there is an applicable discount, it is displayed here.
chargeType	enum	Freight Accessorial Fuel Total

containerItemizedRateNegotiated

Property	Data Type	Notes
rate	number	Itemized negotiated rate.
currencyCode	enum	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
discountedRate	number	If there is an applicable discount, it is displayed here.
chargeType	enum	Freight Accessorial Fuel Total
description	string	Description of the itemized rate.

containerItemizedRateList

Property	Data Type	Notes
rate	number	Itemized list rate.
currencyCode	enum	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
discountedRate	number	If there is an applicable discount, it is displayed here.
chargeType	enum	Freight Accessorial Fuel Total
description	string	Description of itemized rate.

documents

Property	Data Type	Notes
type	enum	ShippingLabel ShippingLabelReturn Bol DangerousGoods CommercialInvoice HazardousMaterialCertification HazardousShippingPaper AirWaybillLabel Other Manifest
format	enum	ZPL PDF PNG GIF Other
data	string	The encoded data for the label is stored here.
documentName	string	Name of the document.

additionalInformation

Property	Data Type	Notes
key	string
format	string

documents

Property	Data Type	Notes
type	enum	ShippingLabel ShippingLabelReturn Bol DangerousGoods CommercialInvoice HazardousMaterialCertification HazardousShippingPaper AirWaybillLabel Other Manifest
format	enum	ZPL PDF PNG GIF Other
data	string	The encoded data for the document is stored here.
documentName	string	Name of the document.

genericAdditionalData

Property	Data Type	Notes
key	string
genericAdditionalDataDetails	string

genericAdditionalDataDetails

Property	Data Type	Notes
key	string
value	string

additionalInformation

Property	Data Type	Notes
key	string
value	string

Ship + Buy + Tender + Orchestrate

[v2.6] Ship

Overview

POST /Ship

Feedback