Easyship (Independent Publisher) (Preview)

Easyship provides a powerful service for you to add hassle free worldwide shipping options to your website and end to end shipping functionality to your warehouse, ERP or platform.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://www.easyship.com/
Privacy policy https://www.easyship.com/legal/privacy
Categories Business Management;Commerce

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Access Token (in the format: Bearer APIAccessToken) securestring The API Access Token (in the format: Bearer APIAccessToken) for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Buy a shipment label (V1)

Buy and retrieve information about a shipping label.

Create a shipment

Creates and retrieves the information about a shipment.

Delete a shipment (V1)

Delete and receive confirmation of a shipment deletion.

Get a shipment

Get the details of a shipment.

Get available pickup slots (V1)

Available pickup slots will be calculated for a specific courier, in local time and for the coming 7 days. A pickup can then be requested using the "Request pickup" action.

Get checkpoints

Retrieves details of shipment checkpoints.

Get item categories

Retrieves a list of shipment categories and the slug to use the category.

Get rates and taxes

Retrieve a list of shipping quotes for a prospective shipment.

Get tracking status

Retrieves the tracking status of a shipment.

List all boxes

Retrieves a list of all available courier boxes.

List all shipments

Retrieves a list of all shipments.

Request a pickup (V1)

When a pickup is created, a pickup request will be made directly to the courier, which will return a reference number. The reference number may be used when contacting the customer service of the courier. A pickup slot must be chosen; upcoming pickup slots may be found using the "Get available pickup slots" action.

Update a shipment

Update a shipment details.

Update warehouse state

Update a shipment's warehouse state. Only available for shipments fulfilled at one of the Easyship integrated warehouses.

Buy a shipment label (V1)

Buy and retrieve information about a shipping label.

Parameters

Name Key Required Type Description
Easyship Shipment ID
easyship_shipment_id string

The Easyship shipment unique identifier.

Courier ID
courier_id string

The courier unique identifier.

Returns

Name Path Type Description
Message
message string

The message.

Errors
errors array of

The errors.

Total Cost
total_cost integer

The total cost.

Available Balance
available_balance integer

The available balance.

Labels
labels array of object
Easyship Shipment ID
labels.easyship_shipment_id string

The Easyship shipment unique identifier.

Label State
labels.label_state string

The state of the label.

Label URL
labels.label_url string

The URL address of the label.

Status
labels.status string

The status.

Tracking Number
labels.tracking_number string

The tracking number.

Tracking Page URL
labels.tracking_page_url string

The tracking page URL address.

Create a shipment

Creates and retrieves the information about a shipment.

Parameters

Name Key Required Type Description
Address
line_1 string

The address.

Address Line 2
line_2 string

The address line 2.

State
state string

The state.

City
city string

The city.

Postal Code
postal_code string

The postal code.

Country Code
country_alpha2 string

The country code.

Contact Name
contact_name string

The contact name.

Company Name
company_name string

The company name.

Contact Phone
contact_phone string

The contact phone number.

Contact Email
contact_email string

The contact email address.

Address
line_1 string

The address.

Address Line 2
line_2 string

The address line 2.

State
state string

The state.

City
city string

The city.

Postal Code
postal_code string

The postal code.

Country Code
country_alpha2 string

The country code.

Contact Name
contact_name string

The contact name.

Company Name
company_name string

The company name.

Contact Phone
contact_phone string

The contact phone number.

Contact Email
contact_email string

The contact email address.

Address
line_1 string

The address.

Address Line 2
line_2 string

The address line 2.

State
state string

The state.

City
city string

The city.

Postal Code
postal_code string

The postal code.

Country Code
country_alpha2 string

The country code.

Contact Name
contact_name string

The contact name.

Company Name
company_name string

The company name.

Contact Phone
contact_phone string

The contact phone number.

Contact Email
contact_email string

The contact email address.

Address
line_1 string

The address.

Address Line 2
line_2 string

The address line 2.

State
state string

The state.

City
city string

The city.

Postal Code
postal_code string

The postal code.

Country Code
country_alpha2 string

The country code.

Contact Name
contact_name string

The contact name.

Company Name
company_name string

The company name.

Contact Phone
contact_phone string

The contact phone number.

Contact Email
contact_email string

The contact email address.

Set As Residential
set_as_residential boolean

Whether set as residential.

Consignee Tax ID
consignee_tax_id string

The consignee tax identifier.

EEI Reference
eei_reference string

The EEI reference.

Incoterms
incoterms string

The incoterms.

Is Insured
is_insured boolean

Whether is insured.

Insured Amount
insured_amount integer

The insured amount.

Insured Currency
insured_currency string

The insured currency.

Platform Name
platform_name string

The platform name.

Platform Order Number
platform_order_number string

The platform order number.

Order Tag List
Order Tag List string
Seller Notes
seller_notes string

The seller notes.

Buyer Notes
buyer_notes string

The buyer notes.

Selected Courier ID
selected_courier_id string

The selected courier identifier.

Allow Courier Fallback
allow_courier_fallback boolean

Whether to allow courier fallback.

Apply Shipping Rules
apply_shipping_rules boolean

Whether shipping rules were applied.

Weight
weight string

The weight.

Dimensions
dimensions string

The dimensions.

Format
format string

The format.

Label
label string

The label.

Commercial Invoice
commercial_invoice string

The commercial invoice.

Packing Slip
packing_slip string

The packing slip.

Buy Label
buy_label boolean

Whether label is bought.

Buy Label Synchronous
buy_label_synchronous boolean

Whether label is bought synchronously.

Total Actual Weight
total_actual_weight float

The total actual weight.

Slug
slug string
Length
length integer

The length.

Width
width integer

The width.

Height
height integer

The height.

Description
description string

The description.

Category
category string

The category.

SKU
sku string

The SKU.

Quantity
quantity integer

The quantity.

Length
length string

The length.

Width
width string

The width.

Height
height string

The height.

Actual Weight
actual_weight integer

The actual weight.

Declared Currency
declared_currency string

The declared currency.

Declared Customs Value
declared_customs_value integer

The declared customs value.

Returns

Name Path Type Description
Status
status string

The status.

Errors
errors array of

The errors.

Easyship Shipment ID
shipment.easyship_shipment_id string

The Easyship shipment identifier.

Created At
shipment.created_at string

The created at.

Updated At
shipment.updated_at string

When updated at.

Label Paid At
shipment.label_paid_at string

The label paid at.

Label Generated At
shipment.label_generated_at string

The label generated at.

Order Created At
shipment.order_created_at string

The order created at.

Address
shipment.origin_address.line_1 string

The address.

Address Line 2
shipment.origin_address.line_2 string

The address line 2.

State
shipment.origin_address.state string

The state.

City
shipment.origin_address.city string

The city.

Postal Code
shipment.origin_address.postal_code string

The postal code.

Country Code
shipment.origin_address.country_alpha2 string

The country code.

Contact Name
shipment.origin_address.contact_name string

The contact name.

Company Name
shipment.origin_address.company_name string

The company name.

Contact Phone
shipment.origin_address.contact_phone string

The contact phone number.

Contact Email
shipment.origin_address.contact_email string

The contact email address.

Address
shipment.sender_address.line_1 string

The address.

Address Line 2
shipment.sender_address.line_2 string

The address line 2.

State
shipment.sender_address.state string

The state.

City
shipment.sender_address.city string

The city.

Postal Code
shipment.sender_address.postal_code string

The postal code.

Country Code
shipment.sender_address.country_alpha2 string

The country code.

Contact Name
shipment.sender_address.contact_name string

The contact name.

Company Name
shipment.sender_address.company_name string

The company name.

Contact Phone
shipment.sender_address.contact_phone string

The contact phone number.

Contact Email
shipment.sender_address.contact_email string

The contact email address.

Address
shipment.return_address.line_1 string

The address.

Address Line 2
shipment.return_address.line_2 string

The address line 2.

State
shipment.return_address.state string

The state.

City
shipment.return_address.city string

The city.

Postal Code
shipment.return_address.postal_code string

The postal code.

Country Code
shipment.return_address.country_alpha2 string

The country code.

Contact Name
shipment.return_address.contact_name string

The contact name.

Company Name
shipment.return_address.company_name string

The company name.

Contact Phone
shipment.return_address.contact_phone string

The contact phone number.

Contact Email
shipment.return_address.contact_email string

The contact email address.

Address
shipment.destination_address.line_1 string

The address.

Address Line 2
shipment.destination_address.line_2 string

The address line 2.

State
shipment.destination_address.state string

The state.

City
shipment.destination_address.city string

The city.

Postal Code
shipment.destination_address.postal_code string

The postal code.

Country Code
shipment.destination_address.country_alpha2 string

The country code.

Contact Name
shipment.destination_address.contact_name string

The contact name.

Company Name
shipment.destination_address.company_name string

The company name.

Contact Phone
shipment.destination_address.contact_phone string

The contact phone number.

Contact Email
shipment.destination_address.contact_email string

The contact email address.

Platform Name
shipment.order_data.platform_name string

The platform name.

Platform Order Number
shipment.order_data.platform_order_number string

The platform order number.

Order Tag List
shipment.order_data.order_tag_list array of string

The order tag list.

Seller Notes
shipment.order_data.seller_notes string

The seller notes.

Buyer Notes
shipment.order_data.buyer_notes string

The buyer notes.

Set As Residential
shipment.set_as_residential boolean

Whether set as residential.

Consignee Tax ID
shipment.consignee_tax_id string

The consignee tax identifier.

EEI Reference
shipment.eei_reference string

The EEI reference.

Incoterms
shipment.incoterms string

The incoterms.

Is Insured
shipment.insurance.is_insured boolean

Whether is insured.

Insured Amount
shipment.insurance.insured_amount integer

The insured amount.

Insured Currency
shipment.insurance.insured_currency string

The insured currency.

Parcels Count
shipment.parcels_count integer

The parcels count.

Parcels
shipment.parcels array of object
Total Actual Weight
shipment.parcels.total_actual_weight float

The total actual weight.

Total Customs Value
shipment.parcels.total_customs_value float

The total customs value.

Total Dimensional Weight
shipment.parcels.total_dimensional_weight float

The total dimensional weight.

Total Volumetric Weight
shipment.parcels.total_volumetric_weight float

The total volumetric weight.

ID
shipment.parcels.box.id string

The unique identifier .

Slug
shipment.parcels.box.slug string

The slug.

Length
shipment.parcels.box.length integer

The length.

Width
shipment.parcels.box.width integer

The width.

Height
shipment.parcels.box.height integer

The height.

items
shipment.parcels.items array of object
Description
shipment.parcels.items.description string

The description.

Category
shipment.parcels.items.category string

The category.

SKU
shipment.parcels.items.sku string

The SKU.

Quantity
shipment.parcels.items.quantity integer

The quantity.

Actual Weight
shipment.parcels.items.actual_weight integer

The actual weight.

Dimensional Weight
shipment.parcels.items.dimensional_weight integer

The dimensional weight.

Volumetric Weight
shipment.parcels.items.volumetric_weight integer

The volumetric weight.

Origin Currency
shipment.parcels.items.origin_currency string

The origin currency.

Origin Customs Value
shipment.parcels.items.origin_customs_value integer

The origin customs value.

Declared Currency
shipment.parcels.items.declared_currency string

The declared currency.

Declared Customs Value
shipment.parcels.items.declared_customs_value integer

The declared customs value.

Length
shipment.parcels.items.dimensions.length integer

The length.

Width
shipment.parcels.items.dimensions.width integer

The width.

Height
shipment.parcels.items.dimensions.height integer

The height.

Total Customs Value
shipment.total_customs_value float

The total customs value.

Total Actual Weight
shipment.total_actual_weight float

The total actual weight.

Total Dimensional Weight
shipment.total_dimensional_weight float

The total dimensional weight.

Total Volumetric Weight
shipment.total_volumetric_weight float

The total volumetric weight.

Shipment State
shipment.shipment_state string

The shipment state.

Pickup State
shipment.pickup_state string

The pickup state.

Delivery State
shipment.delivery_state string

The delivery state.

Label State
shipment.label_state string

The label state.

Warehouse State
shipment.warehouse_state string

The warehouse state.

Trackings
shipment.trackings array of object
Tracking Number
shipment.trackings.tracking_number string

The tracking number.

Local Tracking Number
shipment.trackings.local_tracking_number string

The local tracking number.

Alternate Tracking Number
shipment.trackings.alternate_tracking_number string

The alternate tracking number.

Leg Number
shipment.trackings.leg_number integer

The leg number.

Handler
shipment.trackings.handler string

The handler.

Tracking State
shipment.trackings.tracking_state string

The tracking state.

Tracking Page URL
shipment.tracking_page_url string

The tracking page URL.

Shipping Documents
shipment.shipping_documents array of object
Category
shipment.shipping_documents.category string

The category.

Required
shipment.shipping_documents.required boolean

Whether required.

Page Size
shipment.shipping_documents.page_size string

The page size.

Format
shipment.shipping_documents.format string

The format.

Base64 Encoded Strings
shipment.shipping_documents.base64_encoded_strings array of string

The Base64 encoded strings.

URL
shipment.shipping_documents.url string

The URL address.

Currency
shipment.currency string

The currency.

ID
shipment.selected_courier.id string

The unique identifier.

Rates
shipment.rates array of object
Courier ID
shipment.rates.courier_id string

The courier identifier.

Courier Name
shipment.rates.courier_name string

The courier name.

Min Delivery Time
shipment.rates.min_delivery_time integer

The minimum delivery time.

Max Delivery Time
shipment.rates.max_delivery_time integer

The maximum delivery time.

Value For Money Rank
shipment.rates.value_for_money_rank integer

The value for money rank.

Delivery Time Rank
shipment.rates.delivery_time_rank integer

The delivery time rank.

Shipment Charge
shipment.rates.shipment_charge float

The shipment charge.

Fuel Surcharge
shipment.rates.fuel_surcharge float

The fuel surcharge.

Remote Area Surcharge
shipment.rates.remote_area_surcharge integer

The remote area surcharge.

Oversized Surcharge
shipment.rates.oversized_surcharge integer

The oversized surcharge.

Additional Services Surcharge
shipment.rates.additional_services_surcharge integer

The additional services surcharge.

Residential Full Fee
shipment.rates.residential_full_fee integer

The residential full fee.

Residential Discounted Fee
shipment.rates.residential_discounted_fee integer

The residential discounted fee.

Shipment Charge Total
shipment.rates.shipment_charge_total float

The shipment charge total.

Warehouse Handling Fee
shipment.rates.warehouse_handling_fee integer

The warehouse handling fee.

Insurance Fee
shipment.rates.insurance_fee integer

The insurance fee.

Sales Tax
shipment.rates.sales_tax integer

The sales tax.

Provincial Sales Tax
shipment.rates.provincial_sales_tax integer

The provincial sales tax.

DDP Handling Fee
shipment.rates.ddp_handling_fee integer

The DDP handling fee.

Import Tax Charge
shipment.rates.import_tax_charge integer

The import tax change.

Import Duty Charge
shipment.rates.import_duty_charge integer

The import duty charge.

Total Charge
shipment.rates.total_charge float

The total charge.

Is Above Threshold
shipment.rates.is_above_threshold boolean

Whether is above threshold.

Incoterms
shipment.rates.incoterms string

The incoterms.

Estimated Import Tax
shipment.rates.estimated_import_tax integer

The estimated import tax.

Estimated Import Duty
shipment.rates.estimated_import_duty integer

The estimated import duty.

Available Handover Options
shipment.rates.available_handover_options string

The available handover options.

Tracking Rating
shipment.rates.tracking_rating integer

The tracking rating.

Easyship Rating
shipment.rates.easyship_rating integer

The Easyship rating.

Courier Remarks
shipment.rates.courier_remarks string

The courier remarks.

Payment Recipient
shipment.rates.payment_recipient string

The payment recipient.

Code
shipment.rates.discount.code string

The code.

Amount
shipment.rates.discount.amount integer

The amount.

Expires At
shipment.rates.discount.expires_at string

The expires at.

Percentage
shipment.rates.discount.percentage string

The percentage.

Effective Incoterms
shipment.rates.effective_incoterms string

The effective incoterms.

Delete a shipment (V1)

Delete and receive confirmation of a shipment deletion.

Parameters

Name Key Required Type Description
Easyship Shipment ID
easyship_shipment_id True string

The Easyship shipment identifier.

Returns

Name Path Type Description
Status
status string

The status.

Get a shipment

Get the details of a shipment.

Parameters

Name Key Required Type Description
Easyship Shipment ID
easyship_shipment_id True string

The Easyship shipment identifier.

Format
format string

The format.

Label
label string

The label.

Commercial Invoice
commercial_invoice string

The commercial invoice.

Packing Slip
packing_slip string

The packing slip.

Returns

Name Path Type Description
Created At
created_at string

When created at.

Updated At
updated_at string

When update at.

Easyship Shipment ID
easyship_shipment_id string

The Easyship shipment indentifier.

Destination Name
destination_name string

The destination name.

Destination Address
destination_address_line_1 string

The destination address.

Destination Address Line 2
destination_address_line_2 string

The destination address line 2.

Destination City
destination_city string

The destination city.

Destination State
destination_state string

The destination state.

Destination Postal Code
destination_postal_code string

The destination postal code.

Destination Phone Number
destination_phone_number string

The destination phone number.

Destination Email Address
destination_email_address string

The destination email address.

Order Notes
order_notes string

The order notes.

Order Created At
order_created_at string

The order created at.

Platform Name
platform_name string

The platform name.

Platform Order Number
platform_order_number string

The platform order number.

Total Customs Value
total_customs_value float

The total customs value.

Total Actual Weight
total_actual_weight float

The total actual weight.

Total Dimensional Weight
total_dimensional_weight float

The total dimensional weight.

Total Volumetric Weight
total_volumetric_weight float

The total volumetric weight.

Is Insured
is_insured boolean

Whether is insured.

Currency
currency string

The currency.

Warehouse State
warehouse_state string

The warehouse state.

Name
origin_country.name string

The name.

Country Code
origin_country.alpha2 string

The country code.

Name
destination_country.name string

The name.

Country Code
destination_country.alpha2 string

The country code.

Items
items array of object
ID
items.id string

The unique identifier.

Description
items.title string

The description.

SKU
items.sku string

The SKU.

Width
items.width integer

The width.

Length
items.length integer

The length.

Height
items.height integer

The height.

Actual Weight
items.actual_weight float

The actual weight.

Dimensional Weight
items.dimensional_weight float

The dimensional weight.

Volumetric Weight
items.volumetric_weight float

The volumetric weight.

Declared Customs Value
items.declared_customs_value integer

The declared customs value.

Declared Currency
items.declared_currency string

The declared currency.

Origin Customs Value
items.origin_customs_value float

The origin customs value.

Origin Currency
items.origin_currency string

The origin currency.

Category
items.category string

The category.

Name
box.name string

The name.

Length
box.length integer

The length.

Width
box.width integer

The width.

Height
box.height integer

The height.

ID
selected_courier.id string

The unique identifier.

Name
selected_courier.name string

The name.

Min Delivery Time
selected_courier.min_delivery_time integer

The minimum delivery time.

Max Delivery Time
selected_courier.max_delivery_time integer

The maximum delivery time.

Shipment Charge
selected_courier.shipment_charge float

The shipment charge.

Fuel Surcharge
selected_courier.fuel_surcharge float

The fuel surcharge.

Remote Area Surcharge
selected_courier.remote_area_surcharge integer

The remote area surcharge.

Shipment Charge Total
selected_courier.shipment_charge_total float

The shipment charge total.

Warehouse Handling Fee
selected_courier.warehouse_handling_fee integer

The warehouse handling fee.

Insurance Fee
selected_courier.insurance_fee integer

The insurance fee.

Import Tax Charge
selected_courier.import_tax_charge integer

The import tax charge.

Import Duty Charge
selected_courier.import_duty_charge integer

The import duty charge.

DDP Handling Fee
selected_courier.ddp_handling_fee integer

The DDP handling fee.

Total Charge
selected_courier.total_charge float

The total charge.

Is Above Threshold
selected_courier.is_above_threshold boolean

Whether is above threshold.

Effective Incoterms
selected_courier.effective_incoterms string

The effective incoterms.

Estimated Import Tax
selected_courier.estimated_import_tax integer

The estimated imported tax.

Estimated Import Duty
selected_courier.estimated_import_duty integer

The estimated import duty.

Courier Does Pickup
selected_courier.courier_does_pickup boolean

Whether the courier does pickup.

Courier Dropoff URL
selected_courier.courier_dropoff_url string

The courier dropoff URL address.

Courier Remarks
selected_courier.courier_remarks string

The courier remarks.

Payment Recipient
selected_courier.payment_recipient string

The payment recipient.

Required
shipping_documents.label.required boolean

Whether required.

Page Size
shipping_documents.label.page_size string

The page size.

Format
shipping_documents.label.format string

The format.

Base64 Encoded Strings
shipping_documents.label.base64_encoded_strings array of string

The Base64 encoded strings.

URL
shipping_documents.label.url string

The URL address.

Message
shipping_documents.label.message string

The message.

Required
shipping_documents.commercial_invoice.required boolean

Whether required.

Page Size
shipping_documents.commercial_invoice.page_size string

The page size.

Format
shipping_documents.commercial_invoice.format string

The format.

Base64 Encoded Strings
shipping_documents.commercial_invoice.base64_encoded_strings array of

The Base64 encoded strings.

URL
shipping_documents.commercial_invoice.url string

The URL address.

Required
shipping_documents.packing_slip.required boolean

Whether required.

Page Size
shipping_documents.packing_slip.page_size string

The page size.

Format
shipping_documents.packing_slip.format string

The format.

Base64 Encoded Strings
shipping_documents.packing_slip.base64_encoded_strings array of string

The Base64 encoded strings.

URL
shipping_documents.packing_slip.url string

The URL address.

Required
shipping_documents.battery_form.required boolean

Whether required.

Page Size
shipping_documents.battery_form.page_size string

The page size.

Format
shipping_documents.battery_form.format string

The format.

Base64 Encoded Strings
shipping_documents.battery_form.base64_encoded_strings array of

The Base64 encoded strings.

URL
shipping_documents.battery_form.url string

The URL address.

Required
shipping_documents.battery_caution_label.required boolean

Whether required.

Page Size
shipping_documents.battery_caution_label.page_size string

The page size.

Format
shipping_documents.battery_caution_label.format string

The format.

Base64 Encoded Strings
shipping_documents.battery_caution_label.base64_encoded_strings array of

The Base64 encoded strings.

URL
shipping_documents.battery_caution_label.url string

The URL address.

Get available pickup slots (V1)

Available pickup slots will be calculated for a specific courier, in local time and for the coming 7 days. A pickup can then be requested using the "Request pickup" action.

Parameters

Name Key Required Type Description
Courier ID
courier_id True string

The courier identifier.

Returns

Name Path Type Description
Courier ID
courier_id string

The courier identifier.

Courier Name
courier_name string

The courier name.

Message
message string

The message.

Provider Name
pickup.provider_name string

The provider name.

Provider Customer Service Phone
pickup.provider_customer_service_phone string

The provider customer service phone number.

Get checkpoints

Retrieves details of shipment checkpoints.

Parameters

Name Key Required Type Description
Easyship Shipment ID
easyship_shipment_id True string

The Easyship shipment unique identifier.

Platform Order Number
platform_order_number string

The platform order number.

Page
page integer

The page.

Per Page
per_page integer

The number per page.

Returns

Name Path Type Description
Total Page
total_page integer

The total page.

Current Page
current_page integer

The current page.

Shipments
shipments array of object
Easyship Shipment ID
shipments.easyship_shipment_id string

The Easyship shipment unique identifier.

Platform Order Number
shipments.platform_order_number string

The platform order number.

Origin
shipments.origin string

The origin.

Destination
shipments.destination string

The destination.

Status
shipments.status string

The status.

Tracking Number
shipments.tracking_number string

The tracking number.

Tracking Page URL
shipments.tracking_page_url string

The tracking page URL address.

Checkpoints
shipments.checkpoints array of object
Order Number
shipments.checkpoints.order_number integer

The order number.

Handler
shipments.checkpoints.handler string

The handler.

Message
shipments.checkpoints.message string

The message.

Location
shipments.checkpoints.location string

The location.

City
shipments.checkpoints.city string

The city.

Country
shipments.checkpoints.country_name string

The country.

Country Code
shipments.checkpoints.country_iso3 string

The country code.

Coordinates
shipments.checkpoints.coordinates array of

The coordinates.

State
shipments.checkpoints.state string

The state.

Postal Code
shipments.checkpoints.postal_code string

The postal code.

Checkpoint Time
shipments.checkpoints.checkpoint_time string

The checkpoint time.

Primary Status
shipments.checkpoints.primary_status string

The primary status.

Get item categories

Retrieves a list of shipment categories and the slug to use the category.

Returns

Name Path Type Description
Categories
categories array of object
Name
categories.name string

The name.

Slug
categories.slug string

The slug.

Get rates and taxes

Retrieve a list of shipping quotes for a prospective shipment.

Parameters

Name Key Required Type Description
Address
line_1 string

The address.

Address Line 2
line_2 string

The address line 2.

State
state string

The state.

City
city string

The city.

Postal Code
postal_code string

The postal code.

Country Code
country_alpha2 string

The country code.

Address
line_1 string

The address.

Address Line 2
line_2 string

The address line 2.

State
state string

The state.

City
city string

The city.

Postal Code
postal_code string

The postal code.

Country Code
country_alpha2 string

The country code.

Incoterms
incoterms string

The incoterms.

Is Insured
is_insured boolean

Whether is insured.

Insured Amount
insured_amount integer

The insured amount.

Insured Currency
insured_currency string

The insured currency.

Apply Shipping Rules
apply_shipping_rules boolean

Whether shipping rules were applied.

Weight
weight string

The weight.

Dimensions
dimensions string

The dimensions.

Output Currency
output_currency string

The output currency.

Total Actual Weight
total_actual_weight float

The total actual weight.

Slug
slug string

The reference slug.

Length
length integer

The length.

Width
width integer

The width.

Height
height integer

The height.

Description
description string

The description.

Category
category string

The category.

SKU
sku string

The SKU.

Quantity
quantity integer

The quantity.

Length
length string

The length.

Width
width string

The width.

Height
height string

The height.

Actual Weight
actual_weight integer

The actual weight.

Declared Currency
declared_currency string

The declared currency.

Declared Customs Value
declared_customs_value integer

The declared customs value.

Returns

Name Path Type Description
Rates
rates array of object
Courier ID
rates.courier_id string

The courier unique identifier.

Courier Name
rates.courier_name string

The courier name.

Min Delivery Time
rates.min_delivery_time integer

The minimum delivery time.

Max Delivery Time
rates.max_delivery_time integer

The maximum delivery time.

Value For Money Rank
rates.value_for_money_rank integer

The value for money rank.

Delivery Time Rank
rates.delivery_time_rank integer

The delivery time rank.

Shipment Charge
rates.shipment_charge float

The shipment charge.

Fuel Surcharge
rates.fuel_surcharge float

The fuel surcharge.

Remote Area Surcharge
rates.remote_area_surcharge integer

The remote area surcharge.

Shipment Charge Total
rates.shipment_charge_total float

The shipment charge total.

Warehouse Handling Fee
rates.warehouse_handling_fee integer

The warehouse handling fee.

Insurance Fee
rates.insurance_fee integer

The insurance fee.

DDP Handling Fee
rates.ddp_handling_fee integer

The DDP handling fee if incoterm is DDP.

Import Tax Charge
rates.import_tax_charge integer

The import tax charge.

Import Duty Charge
rates.import_duty_charge integer

The import duty charge.

Total Charge
rates.total_charge float

The total charge.

Is Above Threshold
rates.is_above_threshold boolean

Whether is above threshold.

Effective Incoterms
rates.effective_incoterms string

The effective incoterms.

Estimated Import Tax
rates.estimated_import_tax integer

The estimated import tax.

Estimated Import Duty
rates.estimated_import_duty integer

The estimated import duty.

Courier Does Pickup
rates.courier_does_pickup boolean

Whether the courier does pickup.

Courier Dropoff URL
rates.courier_dropoff_url string

The courier dropoff URL address.

Tracking Rating
rates.tracking_rating integer

The tracking rating.

Payment Recipient
rates.payment_recipient string

The payment recipient.

Courier Remarks
rates.courier_remarks string

The courier remarks.

Currency
rates.currency string

The currency.

Name
rates.box.name string

The name.

Length
rates.box.length integer

The length.

Width
rates.box.width integer

The width.

Height
rates.box.height integer

The height.

Minimum Pickup Fee
rates.minimum_pickup_fee integer

The minimum pickup fee.

Description
rates.title string

The description.

Full Description
rates.full_description string

The full description.

Get tracking status

Retrieves the tracking status of a shipment.

Parameters

Name Key Required Type Description
Easyship Shipment IDs
easyship_shipment_id True string

The Easyship shipment identifiers.

Platform Order Number
platform_order_number string

The platform order number.

Page
page integer

The page.

Per Page
per_page integer

The number per page.

Returns

Name Path Type Description
Total Page
total_page integer

The total page.

Current Page
current_page integer

The current page.

Shipments
shipments array of object
Easyship Shipment ID
shipments.easyship_shipment_id string

The Easyship shipment unique identifier.

Platform Order Number
shipments.platform_order_number string

The platform order number.

Origin
shipments.origin string

The origin.

Destination
shipments.destination string

The destination.

Status
shipments.status string

The status.

Tracking Number
shipments.tracking_number string

The tracking number.

Tracking Page URL
shipments.tracking_page_url string

The tracking page URL address.

List all boxes

Retrieves a list of all available courier boxes.

Returns

Name Path Type Description
Boxes
boxes array of object
ID
boxes.id string

The unique identifier.

Courier Umbrella Name
boxes.courier_umbrella_name string

The courier umbrella name.

Name
boxes.name string

The name.

Slug
boxes.slug string

The slug.

Outer Length
boxes.outer_length float

The outer length.

Outer Width
boxes.outer_width float

The outer width.

Outer Height
boxes.outer_height float

The outer height.

Weight
boxes.weight float

The weight.

List all shipments

Retrieves a list of all shipments.

Parameters

Name Key Required Type Description
Easyship Shipment ID
easyship_shipment_id string

The Easyship shipment unique identifier.

Platform Order Number
platform_order_number string

The platform order number.

Page
page integer

The page.

Per Page
per_page integer

The number per page.

Created At From
created_at_from string

The created at from.

Created At To
created_at_to string

The created at to.

Confirmed At From
confirmed_at_from string

The confirmed at from.

Confirmed At To
confirm_at_to string

The confirmed at to.

Label Generate At From
label_generated_at_from string

The label generate at from.

Label Generated At To
label_generated_at_to string

The label generated at to.

Shipment State
shipment_state string

The shipment state.

Pickup State
pickup_state string

The pickup state.

Delivery State
delivery_state string

The delivery state.

Label State
label_state string

The label state.

Warehouse State
warehouse_state string

The warehouse state.

Returns

Name Path Type Description
shipments
shipments array of object
Easyship Shipment ID
shipments.easyship_shipment_id string

The Easyship shipment unique identifier.

Created At
shipments.created_at string

The created at.

Updated At
shipments.updated_at string

The updated at.

Label Paid At
shipments.label_paid_at string

The label paid at.

Label Generated At
shipments.label_generated_at string

The generated at.

Order Created At
shipments.order_created_at string

The order created at.

Address
shipments.origin_address.line_1 string

The address.

Address Line 2
shipments.origin_address.line_2 string

The address line 2.

State
shipments.origin_address.state string

The state.

City
shipments.origin_address.city string

The city.

Postal Code
shipments.origin_address.postal_code string

The postal code.

Country Code
shipments.origin_address.country_alpha2 string

The country code.

Contact Name
shipments.origin_address.contact_name string

The contact name.

Company Name
shipments.origin_address.company_name string

The company name.

Contact Phone
shipments.origin_address.contact_phone string

The contact phone number.

Contact Email
shipments.origin_address.contact_email string

The contact email address.

Address
shipments.sender_address.line_1 string

The address.

Address Line 2
shipments.sender_address.line_2 string

The address line 2.

State
shipments.sender_address.state string

The state.

City
shipments.sender_address.city string

The city.

Postal Code
shipments.sender_address.postal_code string

The postal code.

Country Code
shipments.sender_address.country_alpha2 string

The country code.

Contact Name
shipments.sender_address.contact_name string

The contact name.

Company Name
shipments.sender_address.company_name string

The company name.

Contact Phone
shipments.sender_address.contact_phone string

The contact phone number.

Contact Email
shipments.sender_address.contact_email string

The contact email address.

Address
shipments.return_address.line_1 string

The address.

Address Line 2
shipments.return_address.line_2 string

The address line 2.

State
shipments.return_address.state string

The state.

City
shipments.return_address.city string

The city.

Postal Code
shipments.return_address.postal_code string

The postal code.

Country Code
shipments.return_address.country_alpha2 string

The country code.

Contact Name
shipments.return_address.contact_name string

The contact name.

Company Name
shipments.return_address.company_name string

The company name.

Contact Phone
shipments.return_address.contact_phone string

The contact phone number.

Contact Email
shipments.return_address.contact_email string

The contact email address.

Address
shipments.destination_address.line_1 string

The address.

Address Line 2
shipments.destination_address.line_2 string

The address line 2.

State
shipments.destination_address.state string

The state.

City
shipments.destination_address.city string

The city.

Postal Code
shipments.destination_address.postal_code string

The postal code.

Country Code
shipments.destination_address.country_alpha2 string

The country code.

Contact Name
shipments.destination_address.contact_name string

The contact name.

Company Name
shipments.destination_address.company_name string

The company name.

Contact Phone
shipments.destination_address.contact_phone string

The contact phone number.

Contact Email
shipments.destination_address.contact_email string

The contact email address.

Platform Name
shipments.order_data.platform_name string

The platform name.

Platform Order Number
shipments.order_data.platform_order_number string

The platform order number.

Order Tag List
shipments.order_data.order_tag_list array of string

The order tag list

Seller Notes
shipments.order_data.seller_notes string

The seller notes.

Buyer Notes
shipments.order_data.buyer_notes string

The buyer notes.

Set As Residential
shipments.set_as_residential boolean

Whether set as residential.

Consignee Tax ID
shipments.consignee_tax_id string

The consignee tax identifier.

EEI Reference
shipments.eei_reference string

The EEI reference.

Incoterms
shipments.incoterms string

The incoterms.

Is Insured
shipments.insurance.is_insured boolean

Whether is insured.

Insured Amount
shipments.insurance.insured_amount integer

The insured amount.

Insured Currency
shipments.insurance.insured_currency string

The insured currency.

Parcels
shipments.parcels array of object
Total Actual Weight
shipments.parcels.total_actual_weight float

The total actual weight.

Total Customs Value
shipments.parcels.total_customs_value float

The total customs value.

Total Dimensional Weight
shipments.parcels.total_dimensional_weight float

The total dimensional weight.

Total Volumetric Weight
shipments.parcels.total_volumetric_weight float

The total volumetric weight.

ID
shipments.parcels.box.id string

The unique identifier.

Courier Umbrella Name
shipments.parcels.box.courier_umbrella_name string

The courier umbrella name.

Name
shipments.parcels.box.name string

The name.

Slug
shipments.parcels.box.slug string

The slug.

Outer Length
shipments.parcels.box.outer_length float

The outer length.

Outer Width
shipments.parcels.box.outer_width float

The outer width.

Outer Height
shipments.parcels.box.outer_height float

The outer height.

Weight
shipments.parcels.box.weight integer

The weight.

Items
shipments.parcels.items array of object
Description
shipments.parcels.items.description string

The description.

Category
shipments.parcels.items.category string

The category.

SKU
shipments.parcels.items.sku string

The SKU.

Quantity
shipments.parcels.items.quantity integer

The quantity.

Actual Weight
shipments.parcels.items.actual_weight integer

The actual weight.

Dimensional Weight
shipments.parcels.items.dimensional_weight integer

The dimensional weight.

Volumetric Weight
shipments.parcels.items.volumetric_weight integer

The volumetric weight.

Origin Currency
shipments.parcels.items.origin_currency string

The origin currency.

Origin Customs Value
shipments.parcels.items.origin_customs_value integer

The origin customs value.

Declared Currency
shipments.parcels.items.declared_currency string

The declared currency.

Declared Customs Value
shipments.parcels.items.declared_customs_value integer

The declared customs value.

Length
shipments.parcels.items.dimensions.length integer

The length.

Width
shipments.parcels.items.dimensions.width integer

The width.

Height
shipments.parcels.items.dimensions.height integer

The height.

Total Customs Value
shipments.total_customs_value float

The total customs value.

Total Actual Weight
shipments.total_actual_weight float

The total actual weight.

Total Dimensional Weight
shipments.total_dimensional_weight float

The total dimensional weight.

Total Volumetric Weight
shipments.total_volumetric_weight float

The total volumetric weight.

Shipment State
shipments.shipment_state string

The shipment state.

Pickup State
shipments.pickup_state string

The pickup state.

Delivery State
shipments.delivery_state string

The delivery state.

Label State
shipments.label_state string

The label state.

Warehouse State
shipments.warehouse_state string

The warehouse state.

Trackings
shipments.trackings array of object
Tracking Number
shipments.trackings.tracking_number string

The tracking number.

Local Tracking Number
shipments.trackings.local_tracking_number string

The local tracking number.

Alternate Tracking Number
shipments.trackings.alternate_tracking_number string

The alternate tracking number.

Leg Number
shipments.trackings.leg_number integer

The leg number.

Handler
shipments.trackings.handler string

The handler.

Tracking State
shipments.trackings.tracking_state string

The tracking state.

Tracking Page URL
shipments.tracking_page_url string

The tracking page URL address.

Shipping Documents
shipments.shipping_documents array of

The shipping documents.

Currency
shipments.currency string

The currency.

ID
shipments.selected_courier.id string

The unique identifier.

Rates
shipments.rates array of object
Courier ID
shipments.rates.courier_id string

The courier unique identifier.

Courier Name
shipments.rates.courier_name string

The courier name.

Min Delivery Time
shipments.rates.min_delivery_time integer

The minimum delivery time.

Max Delivery Time
shipments.rates.max_delivery_time integer

The maximum delivery time.

Value For Money Rank
shipments.rates.value_for_money_rank integer

The value for money rank.

Delivery Time Rank
shipments.rates.delivery_time_rank integer

The delivery time rank.

Shipment Charge
shipments.rates.shipment_charge float

The shipment charge.

Fuel Surcharge
shipments.rates.fuel_surcharge float

The fuel surcharge.

Remote Area Surcharge
shipments.rates.remote_area_surcharge integer

The remote area surcharge.

Oversized Surcharge
shipments.rates.oversized_surcharge integer

The oversized surcharge.

Additional Services Surcharge
shipments.rates.additional_services_surcharge integer

The additional services surcharge.

Residential Full Fee
shipments.rates.residential_full_fee integer

The residential full fee.

Residential Discounted Fee
shipments.rates.residential_discounted_fee integer

The residential discounted fee.

Shipment Charge Total
shipments.rates.shipment_charge_total float

The shipment charge total.

Warehouse Handling Fee
shipments.rates.warehouse_handling_fee integer

The warehouse handling fee.

Insurance Fee
shipments.rates.insurance_fee integer

The insurance fee.

Sales Tax
shipments.rates.sales_tax integer

The sales tax.

Provincial Sales Tax
shipments.rates.provincial_sales_tax integer

The provincial sales tax.

DDP Handling Fee
shipments.rates.ddp_handling_fee integer

The DDP handling fee.

Import Tax Charge
shipments.rates.import_tax_charge integer

The import tax charge.

Import Duty Charge
shipments.rates.import_duty_charge integer

The import duty charge.

Total Charge
shipments.rates.total_charge float

The total charge.

Is Above Threshold
shipments.rates.is_above_threshold boolean

Whether is above threshold.

Incoterms
shipments.rates.incoterms string

The incoterms.

Estimated Import Tax
shipments.rates.estimated_import_tax integer

The estimated import tax.

Estimated Import Duty
shipments.rates.estimated_import_duty integer

The estimated import duty.

Available Handover Options
shipments.rates.available_handover_options string

The available handover options.

Tracking Rating
shipments.rates.tracking_rating integer

The tracking rating.

Easyship Rating
shipments.rates.easyship_rating integer

The Easyship rating.

Courier Remarks
shipments.rates.courier_remarks string

The courier remarks.

Payment Recipient
shipments.rates.payment_recipient string

The payment recipient.

Code
shipments.rates.discount.code string

The code.

Amount
shipments.rates.discount.amount integer

The amount.

Expires At
shipments.rates.discount.expires_at string

The expires at.

Percentage
shipments.rates.discount.percentage string

The percentage.

Effective Incoterms
shipments.rates.effective_incoterms string

The effective incoterms.

Request a pickup (V1)

When a pickup is created, a pickup request will be made directly to the courier, which will return a reference number. The reference number may be used when contacting the customer service of the courier. A pickup slot must be chosen; upcoming pickup slots may be found using the "Get available pickup slots" action.

Parameters

Name Key Required Type Description
Courier ID
courier_id string

The courier identifier.

Preferred Date
preferred_date string

The preferred date.

Preferred Max Time
preferred_max_time string

The preferred maximum time.

Preferred Min Time
preferred_min_time string

The preferred minimum time.

Easyship Shipment IDs
Easyship Shipment IDs string

Returns

Name Path Type Description
Courier ID
courier_id string

The courier identifier.

Courier Name
courier_name string

The courier name.

Easyship Shipment IDs
easyship_shipment_ids array of string

The Easyship shipment identifiers.

Easyship Pickup ID
pickup.easyship_pickup_id string

The Easyship pickup identifier.

Preferred Min Time
pickup.preferred_min_time string

The preferred minimum time.

Preferred Max Time
pickup.preferred_max_time string

The preferred maximum time.

Pickup Reference Number
pickup.pickup_reference_number string

The pickup reference number.

Pickup Fee
pickup.pickup_fee string

The pickup fee.

Provider Name
pickup.provider_name string

The provider name.

Provider Customer Service Phone
pickup.provider_customer_service_phone string

The provider customer service phone number.

Shipments Count
pickup.shipments_count string

The shipments count.

Total Actual Weight
pickup.total_actual_weight string

The total actual weight.

Pickup State
pickup.pickup_state string

The pickup state.

Address
pickup.address.line_1 string

The address.

Address Line 2
pickup.address.line_2 string

The address line 2.

Address Line 3
pickup.address.line_3 string

The address line 3.

Postal Code
pickup.address.postal_code string

The postal code.

City
pickup.address.city string

The city.

State
pickup.address.state string

The state.

Country
pickup.address.country string

The country.

Contact Email
pickup.address.contact_email string

The contact email address.

Contact Phone
pickup.address.contact_phone string

The contact phone number.

Company Name
pickup.address.company_name string

The company name.

Contact Name
pickup.address.contact_name string

The contact name.

Update a shipment

Update a shipment details.

Parameters

Name Key Required Type Description
Easyship Shipment ID
easyship_shipment_id True string

The Easyship shipment identifier.

Destination Country Code
destination_country_alpha2 string

The destination country code.

Destination City
destination_city string

The destination city.

Destination Name
destination_name string

The destination name.

Destination Address
destination_address_line_1 string

The destination address.

Destination Phone Number
destination_phone_number string

The destination phone number.

Description
description string

The description.

Actual Weight
actual_weight float

The actual weight.

Height
height integer

The height.

Width
width integer

The width.

Length
length integer

The length.

Category
category string

The category.

Declared Currency
declared_currency string

The declared currency.

Declared Customs Value
declared_customs_value integer

The declared customs value.

SKU
sku string

The SKU.

Platform Name
platform_name string

The platform name.

Platform Order Number
platform_order_number string

The platform order number.

Taxes Duties Paid By
taxes_duties_paid_by string

The taxes and duties paid by.

Is Insured
is_insured boolean

Whether is insured.

Selected Courier ID
selected_courier_id string

The selected courier identifier.

Destination Postal Code
destination_postal_code integer

The destination postal code.

Destination State
destination_state string

The destination state.

Destination Address Line 2
destination_address_line_2 string

The destination address line 2.

Destination Email Address
destination_email_address string

The destination email address.

Returns

Name Path Type Description
Created At
shipment.created_at string

The created at.

Updated At
shipment.updated_at string

When updated at.

Easyship Shipment ID
shipment.easyship_shipment_id string

The Easyship shipment identifier.

Destination Name
shipment.destination_name string

The destination name.

Destination Address
shipment.destination_address_line_1 string

The destination address.

Destination Address Line 2
shipment.destination_address_line_2 string

The destination address line 2.

Destination City
shipment.destination_city string

The destination city.

Destination State
shipment.destination_state string

The destination state.

Destination Postal Code
shipment.destination_postal_code string

The destination postal code.

Destination Phone Number
shipment.destination_phone_number string

The destination phone number.

Destination Email Address
shipment.destination_email_address string

The destination email address.

Platform Name
shipment.platform_name string

The platform name.

Platform Order Number
shipment.platform_order_number string

The platform order number.

Total Customs Value
shipment.total_customs_value float

The total customs value.

Total Actual Weight
shipment.total_actual_weight float

The total actual weight.

Total Dimensional Weight
shipment.total_dimensional_weight float

The total dimensional weight.

Total Volumetric Weight
shipment.total_volumetric_weight float

The total volumetric weight.

Is Insured
shipment.is_insured boolean

Whether is insured.

Currency
shipment.currency string

The currency.

Name
shipment.origin_country.name string

The name.

Country Code
shipment.origin_country.alpha2 string

The country code.

Name
shipment.destination_country.name string

The name.

Country Code
shipment.destination_country.alpha2 string

The country code.

Items
shipment.items array of object
ID
shipment.items.id string

The unique identifier.

Description
shipment.items.description string

The description.

SKU
shipment.items.sku string

The SKU.

Width
shipment.items.width integer

The width.

Length
shipment.items.length integer

The length.

Height
shipment.items.height integer

The height.

Actual Weight
shipment.items.actual_weight float

The actual weight.

Dimensional Weight
shipment.items.dimensional_weight float

The dimensional weight.

Volumetric Weight
shipment.items.volumetric_weight float

The columetric weight.

Declared Customs Value
shipment.items.declared_customs_value integer

The declared customs value.

Declared Currency
shipment.items.declared_currency string

The declared currency.

Origin Customs Value
shipment.items.origin_customs_value float

The origin customs value.

Origin Currency
shipment.items.origin_currency string

The origin currency.

Category
shipment.items.category string

The category.

Name
shipment.box.name string

The name.

Length
shipment.box.length integer

The length.

Width
shipment.box.width integer

The width.

Height
shipment.box.height integer

The height.

ID
shipment.selected_courier.id string

The unique identifier.

Name
shipment.selected_courier.name string

The name.

Min Delivery Time
shipment.selected_courier.min_delivery_time integer

The minimum delivery time.

Max Delivery Time
shipment.selected_courier.max_delivery_time integer

The maximum delivery time.

Shipment Charge
shipment.selected_courier.shipment_charge float

The shipment charge.

Fuel Surcharge
shipment.selected_courier.fuel_surcharge float

The fuel surcharge.

Remote Area Surcharge
shipment.selected_courier.remote_area_surcharge integer

The remote area surcharge.

Shipment Charge Total
shipment.selected_courier.shipment_charge_total float

The shipment charge total.

Warehouse Handling Fee
shipment.selected_courier.warehouse_handling_fee integer

The warehouse handling fee.

Insurance Fee
shipment.selected_courier.insurance_fee integer

The insurance fee.

Import Tax Charge
shipment.selected_courier.import_tax_charge integer

The import tax charge.

Import Duty Charge
shipment.selected_courier.import_duty_charge integer

The import duty charge.

DDP Handling Fee
shipment.selected_courier.ddp_handling_fee integer

The DDP handling fee.

Total Charge
shipment.selected_courier.total_charge float

The total charge.

Is Above Threshold
shipment.selected_courier.is_above_threshold boolean

Whether is above threshold.

Effective Incoterms
shipment.selected_courier.effective_incoterms string

The effective incoterms.

Estimated Import Tax
shipment.selected_courier.estimated_import_tax integer

The estimate import tax.

Estimated Import Duty
shipment.selected_courier.estimated_import_duty integer

The estimated importy duty.

Courier Does Pickup
shipment.selected_courier.courier_does_pickup boolean

Whether the courier does pickup.

Courier Dropoff URL
shipment.selected_courier.courier_dropoff_url string

The courier dropoff URL address.

Courier Remarks
shipment.selected_courier.courier_remarks string

The courier remarks.

Payment Recipient
shipment.selected_courier.payment_recipient string

The payment recipient.

Rates
shipment.rates array of object
Courier ID
shipment.rates.courier_id string

The courier identifier.

Courier Name
shipment.rates.courier_name string

The courier name.

Min Delivery Time
shipment.rates.min_delivery_time integer

The minimum delivery time.

Max Delivery Time
shipment.rates.max_delivery_time integer

The maximum delivery time.

Value For Money Rank
shipment.rates.value_for_money_rank integer

The value for money rank.

Delivery Time Rank
shipment.rates.delivery_time_rank integer

The delivery time rank.

Shipment Charge
shipment.rates.shipment_charge float

The shipment charge.

Fuel Surcharge
shipment.rates.fuel_surcharge float

The fuel surcharge.

Remote Area Surcharge
shipment.rates.remote_area_surcharge integer

The remote area surcharge.

Shipment Charge Total
shipment.rates.shipment_charge_total float

The shipment charge total.

Warehouse Handling Fee
shipment.rates.warehouse_handling_fee integer

The warehouse handling fee.

Insurance Fee
shipment.rates.insurance_fee integer

The insurance fee.

DDP Handling Fee
shipment.rates.ddp_handling_fee integer

The DDP handling fee.

Import Tax Charge
shipment.rates.import_tax_charge integer

The import tax change.

Import Duty Charge
shipment.rates.import_duty_charge integer

The import duty charge.

Total Charge
shipment.rates.total_charge float

The total charge.

Is Above Threshold
shipment.rates.is_above_threshold boolean

Whether is above threshold.

Effective Incoterms
shipment.rates.effective_incoterms string

The effective incoterms.

Estimated Import Tax
shipment.rates.estimated_import_tax integer

The estimated import tax.

Estimated Import Duty
shipment.rates.estimated_import_duty integer

The estimated import duty.

Courier Does Pickup
shipment.rates.courier_does_pickup boolean

Whether the courier does pickup.

Courier Dropoff URL
shipment.rates.courier_dropoff_url string

The courier dropoff URL address.

Tracking Rating
shipment.rates.tracking_rating integer

The tracking rating.

Easyship Rating
shipment.rates.easyship_rating float

The Easyship rating.

Courier Remarks
shipment.rates.courier_remarks string

The courier remarks.

Payment Recipient
shipment.rates.payment_recipient string

The payment recipient.

Update warehouse state

Update a shipment's warehouse state. Only available for shipments fulfilled at one of the Easyship integrated warehouses.

Parameters

Name Key Required Type Description
Easyship Shipment ID
easyship_shipment_id string

The Easyship shipment unique identifier.

Warehouse State
warehouse_state string

The warehouse state.

Message
message string

The message.

Serial Number
serial_number string

The serial number.

Returns

Name Path Type Description
Message
message array of object
Easyship Shipment ID
message.easyship_shipment_id string

The Easyship shipment unique identifier.

Warehouse State Updated
message.warehouse_state_updated string

The updated warehouse state.