Skip to main content

Documentation Portal

ShippingRates

Parameter Name

Type

Description

Mandatory

estimatedDeliveryDays

String

The estimated number of days required for the selected shipping service to deliver to the selected destination country.

This parameter displays the widest range for the aggregated shipping methods available for the submitted values on the pre-checkout page.

Example: 1-3 days.

Two shipping methods are available for the submitted values, one ranging between 1-3 delivery days and the other 4-5 delivery days. Thus, the estimated output range is 1-3 days.

Note: This parameter does NOT include the additional days configured in the Global‑e system for fulfilment.

maxOrderSubtotal

Decimal

Maximum order/product price for a price range (includes 4 decimals)

Example: 15.000

minOrderSubtotal

Decimal

Minimum order/product price for a price range (includes 4 decimals)

Example: 100.0000

shippingCostCurrency

String

The merchant's default currency for the destination (3 letters ISO code)

Example: EUR, USD, ILS

shippingCost

Decimal

The shipping costs for the order/product price range (includes 4 decimals)

Example: 5.0000

shippingPriority

String

The type of shipping service

Shipping types: standard, express, tracked, and more.

Example: Standard, Express Courier (Air)

specialOfferExpiryDate

String

The expiration date and time for the special offer

DATE/TIME

Displayed when the returned shipping object is linked to an active marketing campaign configured in the Global‑e system.

Date/time format: yyyy-mm-ddThh:mm:ss

Example: 2022-11-30T00:00:00

NULL

Displayed for campaigns/ rates without expiration dates and times.