JM Shipping SolutionShipments

Save shipments without purchasing

Saves one or more shipments under a reference key without buying labels. Use this to stage shipments for later review or bulk purchase. Retrieve or purchase saved shipments using the reference.

Path parameters

referencestringRequired

Headers

AuthorizationstringRequired

EX: “Basic dXNlcm5hbWU6cGFzc3dvcmQ=”

API_KEYstringRequired

EX: “B30BBEC3-8086-49B6-9893-2FCD31FA2BBF”

Request

List of Shipments to Save.
ApprovalContactobjectOptional
Required details that must be submitted on the buy if approval is required for the shipment Approval required is returned with the quote or as an error on the buy, shipment should be resubmitted with these details included
ApprovalOverLimitbooleanOptional
Returns true if a shipments value is too high to be approved
ApprovalRequiredbooleanOptional
Is an approval required for this shipment
ApprovalRequiredMessagestringOptional
Specific message related to ApprovalRequired
CargoenumOptional

Cargo type of this shipment NONE_SELECTED=0; WATCHES=1; ART_WORK=2; HANDGUNS=3; FIREARMS_NOT_HANDGUNS=4; CELL_PHONES=5; CURRENCY=6; GEMS_AND_JEWELERY=7; GENERAL_CARGO=8; NUMISMATIC_COINS=9; CHECKS_STOCKS_BONDS_ETC=10; ELECTRONICS=11; DESIGN_PROTOTYPES=12; DESIGNER_CLOTHING_AND_ACCESSORIES=13; SILVER_AND_SILVER_JEWELRY=14; PRECIOUS_METALS_NOT_SILVER=15; DOCUMENTS=16; LUGGAGE_PERSONAL_EFFECTS=17; RARE_BOOKS=18; MEDICAL_DIAGNOSTIC_EQUIPMENT=19; AUTO=20; FIREARMS_ANTIQUE=21; PRECIOUS_METALS=22; WINE=23; CHECK=24; STOCKS_AND_BONDS=25; ART_WORK_FRAGILE=26; ART_WORK_NOT_FRAGILE=27; BOOKS=28; ELECTRONICS_PHONE_COMPUTER=29; FURNITURE=30; GENERAL_CARGO_FRAGILE=31; GENERAL_CARGO_NOT_FRAGILE=32; HOUSEWARE_FRAGILE=33; HOUSEWARE_NOT_FRAGILE=34; MEMORABILIA_COLLECTIBLES=35; SCULPTURE=36; STAMPS_TRADING_CARDS=37; OTHER=100;

Carrierslist of enumsOptional

List of carriers to quote or ship with. 0 = NONE_SELECTED, 1 = DHL_EXPRESS, 2 = EASTERN_CONNECTION, 3 = FEDEX, 4 = LONESTAR, 5 = NEWGISTICS, 6 = ONTRAC, 7 = UPS, 8 = DHL_GM, 9 = USPS, 10 = PUROLATOR, 100 = OTHER

ClientIdintegerOptional
Client id to purchase this shipment for. This will be defaulted to authenticated user if omitted.
CodSelectedbooleanOptional
Set to true to include COD service for this shipment. CodService will be required.
CodServiceobjectOptional

class required for COD shipments FedExRemittanceAddress is optional and designates and address to return collected amount to. If FedExRemittanceAddress_Selected is true, Remittance address is expected

DeclaredValuedoubleOptional
Declared value for this shipment, this can vary from DeclaredValueEntered if block policy rules were applied
DeclaredValueEntereddoubleOptional
Declared value as it was entered
DeliveryDatestringOptional
Expected delivery date for this shipment, ignore if passed in on quote or purchase
EStoreDetailobjectOptional
ExtClaimWindowbooleanOptional
Extended Insurance Claim Window selected
ExtClaimWindowChgdoubleOptional
Additional Amount for Extended Insurance Claim Window
FromAddressobjectOptional
Standard address object used for Origin address, Destination address and COD Remittance address
GidstringOptional

REQUIRED - Guid unique identifier for this shipment

ZingIdstringOptional
For internal use only.
IdintegerOptional
Confirmation number returned for a successful shipment purchase or a return from the get.
IgnoreBlockRulesbooleanOptional
Set to true to ignore block policy rules for the shipment and process for the full declared value
InsuranceOnlybooleanOptional
Set to true to purchase insurance only for previously purchased postage
InternationalDetailobjectOptional
InternationalDescriptionstringOptional
This should match the HTC format of a 10 character number followed by a space followed by the description, this is currently not supported in production environment.
InvoiceValuedoubleOptional
The value for this shipment as it would appear on an invoice
LabelTypeenumOptional

Allows for labels to be returned as a .pdf file or a .txt file if zpl is selected PDF=0; ZPL=1;

NoForbiddenWordsPerUserAgreementbooleanOptional

Set to true to indicate that any forbidden words included in the label are within User Agreement requirements such as Contact = Ruby Smith

PackageobjectOptional
All necessary details to determine packaging, type can be of a carrier type or custom if custom type is selected all dimensions must be greater than zero
PrintConfigobjectOptional
Use this to customize the label layout, default layout suitable for most consumers will be returned if omitted.
Reference1stringOptional0-50 characters
Reference field to identify this shipment, this will be included on the label
Reference2stringOptional0-50 characters
Reference field to identify this shipment, this will be included on the label for some carriers
Reference3stringOptional0-50 characters
Reference field to identify this shipment, this will be included on the label for some carriers
Reference4stringOptional0-50 characters
Reference field to identify this shipment, this will be not be included on the label
Reference5stringOptional0-50 characters
Reference field to identify this shipment, this will be not be included on the label
RegisteredMailbooleanOptional
Identifies this shipment as Registered Mail along with a valid carrier and service combination
RegisteredMailNumberstringOptional0-25 characters
Registered mail number should be included if available.
SaturdayDeliverybooleanOptional
Set to true if you would like this shipment to be delivered on Saturday, does not apply to USPS
Seal1stringOptional0-12 characters
Indicate package seal number if applicable or required for current shipment
Seal2stringOptional0-12 characters
Indicate second package seal number if applicable
SecurityenumOptional

Security should be indicated here, STANDARD = 1 for most shipments, TURTLE_OR_FRAUD_STOPPER = 2 if used, NONE_SELECTED = 0 will default to standard NONE_SELECTED=0; STANDARD=1; TURTLE_OR_FRAUD_STOPPER=2;

Serviceslist of enumsOptional

List of services to quote or ship with. 0 = NONE_SELECTED, 1 = NEXT_DAY_EARLY_AM, 2 = NEXT_DAY_AM, 3 = NEXT_DAY_PM, 4 = TWO_DAY_AM, 5 = TWO_DAY_PM, 6 = THIRD_DAY, 7 = GROUND_OR_FIRST_CLASS, 8 = PARCEL_SELECT, 9 = INTERNATIONAL_1, 10 = INTERNATIONAL_2, 11 = INTERNATIONAL_3, 12 = INTERNATIONAL_4

ShipDatedatetimeOptional
Ship date should indicate the date you will tender the package to the carrier. Future ship date is permitted in most cases
CarrierShipDatedatetimeOptional
This value will be returned on a GET if package has been shipped.
CarrierDeliveryDatedatetimeOptional
This value will be returned on a GET if package has been delivered.
Signatureslist of enumsOptional

List of signature services. 0 = NONE_SELECTED, 1 = SIGNATURE_NONE, 2 = DELIVERY_CONFIRMATION, 3 = SIGNATURE_CONFIRMATION, 4 = ADULT_SIGNATURE_CONFIRMATION, 5 = RESTRICTED_DELIVERY, 6 = ADULT_RESTRICTED_DELIVERY

ToAddressobjectOptional
Standard address object used for Origin address, Destination address and COD Remittance address
ThirdPartyDetailobjectOptional
Required details to process a third party shipment. If ups or fedex is not selected this element is invalid
ThirdPartySelectedbooleanOptional
Set this value to true if you will be providing ThirdPartyDetails for billing freight to a third party
TrackingNumberstringOptional0-60 characters
TrackingNumber should only be provided for insurance only shipment quotes or purchase. Tracking number will be returned for a purchase or a GET.
TrackingStatusenumOptional

This field will indicate the most recent tracking status for your shipment if available. Forwarded=10; Exception=20; StaleTracking=21; LeftNotice=30; Undeliverable=40; Returned=50; Unknown=60; Unscanned=70; Enroute=80; OutForDelivery=89; Delivered=90; Unavailable=100; Finalized=110; ManualClose=111; NotChecked=-1;

TransactionTimedatetimeOptional
This value will be returned on a purchase or a get and indicates the purchase completion time
VoidedOndatetimeOptional
If this shipment has been voided, the VoidedOn date will be set
VoidIdintegerOptional
WeightOzDecimaldoubleOptional
WeightOzDecimal will be the decimal weight in oz. WeightOz is obsolete and this is the preferred field
WeightOzintegerOptional
WeightOz will be round up to 1 decimal place for USPS shipments. This field is obsolete. Use WeightOzDecimal instead
ZplTopMarginintegerOptional
ZplLeftMarginintegerOptional
PurchaseSourcestringOptional
Internal use only
IsBoomerangbooleanOptional
Set to true if this is a Boomerang shipment.
FullRunTracestringOptional
Internal use only
ScanBasedBillingbooleanOptional
Whether this is a scan based billing. This field may be returned with a shipment as true or false and will be ignored if provided on a quote or purchase.
IsReturnShipmentbooleanOptional
Whether this is a scan based return. This field may be returned with a shipment as true or false and will be ignored if provided on a quote or purchase.
ScanBaseBilledbooleanOptional
Scan based billing date. This field may be returned with a shipment as true or false and will be ignored if provided on a quote or purchase.
IsReconciledbooleanOptional
Flag to indicate shipment is reconciled
warningMsgstringOptional
JMTraceIDstringOptional
HazMatCodeenumOptional

NotHazMat=0; Class9LithiumBatteryMarkedGround=816; Class9LithiumBatteryReturns=817; Class9LithiumBatteriesMarked=818; Class9LithiumBatteriesUnmarked=820;

IsFedExOneRatebooleanOptional
IsHoldForPickupbooleanOptional
Indicator if shipment is being hold for pickup
HFPULocationIDstringOptional
hold for pickup location ID

Response

Returned if there are no http error. ShipmentReturn Error should still be verified as null or empty.
Shipmentobject
class for passing in all requirements to quote or buy a shipment
ShipmentStatusenum

Indicates whether a shipment has been SAVED = 0, or CREATED = 1 SAVED=0; CREATED=1;

Statusenum

Was the request for this shipment successful, you will general see SUCCESS or FAILURE, NOTE and WARNING are rarely used. FAILURE = 0, SUCCESS = 1, WARNING = 2, NOTE = 3 FAILURE=0; SUCCESS=1; WARNING=2; NOTE=3;

StatusMessageslist of strings
Message should be expected if Status is FAILURE
Errorlist of objects
Error will be empty or NULL if no error was encountered
Rateslist of objects
List of rates returned for a quote or purchase
Purchaseobject
ForbiddenWordslist of objects
If forbidden words were found on a shipment they will be returned here
IsPendingboolean
Used to prevent duplicate shipments and send friendly info to caller.

Errors

400
Bad Request Error