Shipment
Shipment is a large set of multiple elements, including the addresses of the sender and recipient, the carrier and details of the services it provides, the packages being shipped, and information in customs forms for cross-border deliveries. Therefore, the shipment request involves multiple objects and parameters.
You will be charged the fee for a shipping label when you create a shipment. You can download and print the label, or you can choose to void the label.
Shipment Object
| Attributes | Definitions |
|---|---|
| carrierCode | usps,ups,fedex |
| serviceCode | Code for carrier services.See the ServiceCodes for all available values |
| shipDate | Shipping Date |
| from | Sender Address See the Address Object |
| to | Recipient Address See the Address Object |
| isTest | Whether the current environment is a testing environment. A label created under testing environment will not be charged and cannot be used for shipments. Values are: true, false |
| labelSize | the size of a label. 1 represents 64, 2 represents 8.511. |
| orderNO | If not provided, the system default will be used. |
| parcels | Aggregated information of the packages(USPS only support single parcel),See the Parcel Object |
| extra | An object holding optional extra services to be requested.See the Shipment Extra |
| customsDeclarations | you need to provide for customs clearance for your international shipments.See the CustomsDeclarations Object |
| actionCode | Only applicable to ITN.Values are String type A (Apply for ITN);D (Cancel ITN); |
| aesUid | Only applicable to cancel ITN |
ShipmentExtra Object
| Attributes | Definitions |
|---|---|
| isStd | Whether requires a Saturday delivery service.Values are true,false |
| signatureOption | Request standard or adult signature confirmation. See the signatureOption for all values. |
| tariffPayType | duties and taxes pay type.Values are INT type 1 (recipient);2 (sender). If the destination is an Amazon FBA warehouse，Customs Duties should be paid by the SENDER. Please apply for the change in Default Setting and choose FedEx International Services |
| reference | Optional text to be printed on the shipping label. Up to 30 characters. |
| reference2 | Optional text to be printed on the shipping label. Up to 30 characters. |
| isFedexOneRate | true/false,FedEx One Rate is only suitable for FedEx 2Day Service. The following Packaging Type will be your choice:FedEx_Envelope,FedEx_Pak_1,fedex_Small_Box |
| einNumber | EIN/SSN. Required for customs declaration or apply for ITN. |
| consigneeType | Ultimate Consignee Type. Values are INT type 1 (Direct Consumer);2 (Government Entity);3 (Other/Unknown);4 (Reseller). |
| batteryType | Values are battery type 1 Cells or batteries ONLY(ICAO/ IATA UN3480, PI965, Section II);2 Cells or batteries ONLY(ICAO / IATA UN3090, PI968, Section II);3 Packed WITH EQUIPMENT(ICAO / IATA UN3481, PI966, Section II);4 Packed WITH EQUIPMENT(ICAO / IATA UN3091, PI969, Section II);5 Contained IN EQUIPMENT(ICAO / IATA UN3481, PI967, Section II);6 Contained IN EQUIPMENT(ICAO / IATA UN3091, PI970, Section II) |
Parcel Object
| Attributes | Definitions |
|---|---|
| packageCode | type of Parcel.See the packageCodes for all available values |
| packageNum | Number of this package.Default 1 |
| length | Length of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
| width | Width of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
| height | Height of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
| distanceUnit | The unit used for length, width and height. Values are 'cm','in' Defaults to 'in' |
| weight | Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
| massUnit | The unit used for weight.Values are 'lb','kg' Defaults to 'lb' |
| extra | An object holding optional extra services to be requested for each parcel in a multi-piece shipment. See the ParcelExtra Object for all available services. |
ParcelExtra Object
| Attributes | Definitions |
|---|---|
| isCod | whether COD service is required (UPS and FedEx only). Values are true,false |
| codAmount | Amount to be collected |
| paymentMethod | Secured funds include money orders, certified cheques and others (see UPS and FedEx for details).Values are 'cash','any' Defaults to 'any') |
| insurance | insured amount |
| dryIceWeight | the weight of dry ice (cannot exceeds the weight of entire package). Unit used is KG (kilogram). |
CustomsDeclarations Object
| Attributes | Definitions |
|---|---|
| contentsType | Type of goods of the shipment.Values are 'Gift','Sample','Return And Repair', 'Commercial','Personal Effects','Personal Use'. |
| otherDescribe | explanation of the types of commodity contained in the shipment. This string required when the contentType is “OTHER” and carrierCode is usps. |
| eelPfc | EEL / PFC type of the shipment. For most shipments from the US to CA, '30.36' is applicable; for most other shipments from the US, '30.37(a)' is applicable. Values are '30.37(a)', '30.37(h)' ,'30.37(f)','30.36' |
| aesItn | AES / ITN reference of the shipment. |
| items | Customs items are distinct items in your international shipment parcel.See the CustomsItem Object |
CustomsItem Object
| Attributes | Definitions |
|---|---|
| description | Text description of your item. |
| quantity | Quantity of this item in the shipment you send. Must be greater than 0. |
| quantityUnit | The unit used for quantity(Cannot exceed 3 characters in length).Defaults to 'EA'.See the quantityUnits for all values |
| weight | Total weight of this item, i.e. quantity * weight per item. |
| massUnit | The unit used for weight.Values are 'lb','kg' Defaults to 'lb' |
| valueAmount | Total value of this item, i.e. quantity * value per item. Currency is USD |
| originCountry | Country of origin of the item. Example: 'US' or 'DE'.All accepted values can be found on the Official ISO Website. |
| tariffNumber | HS Code of the Commodity.See the Schedule B Search Engine for all values |
| aesUnit | Only applicable to ITN.See the Schedule B Search Engine for all UOM values |
EstimateRate
Post a shipment object to EzeeShip API to get an estimated rate.
endpoint : https://ezeeship.com/api/ezeeship-openapi/shipment/estimateRate
EstimateRate sample
POST : https://ezeeship.com/api/ezeeship-openapi/shipment/estimateRate
{
"from": {
"countryCode": "US",
"stateCode": "CA",
"city": "San Francisco",
"addressLine1": "215 Clayton St.",
"addressLine2":"1092,IFC",
"zipCode": "94117"
},
"to": {
"countryCode": "US",
"stateCode": "CA",
"city": "Inglewood",
"addressLine1": "11222 S La Cienega BLVD",
"addressLine2":"1092,IFC",
"zipCode": "90304"
},
"carrierCode": "fedex",
"serviceCode": "fedex_2_day",
"isTest": false,
"parcels": [
{
"packageNum": 1,
"length": "5",
"width": "5",
"height": "5",
"distanceUnit": "in",
"weight": "4",
"massUnit": "lb",
"packageCode": "your_package",
"extra": {
"insurance": 399,
"isCod": true,
"codAmount": 399,
"paymentMethod": "any",
"dryIceWeight": 2
}
}
]
}
Response :
{
"result": "OK",
"message": "",
"data": {
"isSuccess": true,
"rate": 36.36,
"deliveryTime": "3 DAYS"
"feeDetail": {
"DryIce": 5,
"Cod": 13,
"Insurance": 4,
"Fuel": 0.55,
"baseRate": 13.81
}
}
}