Respond with shipping and delivery rates

{
    "shippingOptions": [
      {
        "title": "SuperMail First Class",
        "rate": 10.31,
        "transitDays": "1",
        "description": "Courier will come tomorrow between 10AM-12PM.",
        "titleTranslated": {
          "en": "SuperMail First Class",
          "it": "SuperMail di prima classe"
        },
        "descriptionTranslated": {
          "fr": "Courier will come tomorrow between 10AM-12PM.",
          "it": "Il corriere arriverà domani tra le 10:00 e le 12:00."
        }
      }, 
      {
        "title": "SuperMail Regular Delivery",
        "rate": 5.01,
        "transitDays": "5",
        "description": "This method provides tracking number.",
        "fulfilmentType": "SHIPPING",
      },
      {
        "title": "Pick up at store #1",
        "rate": 0,
        "transitDays": "1",
        "description": "Pick you order at 210, 5th West street, New York",
        "fulfilmentType": "PICKUP",
        "scheduled": true,
        "businessHours":"{\"THU\":[[\"09:00\",\"18:00\"]],\"TUE\":[[\"09:00\",\"18:00\"]],\"WED\":[[\"09:00\",\"18:00\"]],\"FRI\":[[\"09:00\",\"18:00\"]],\"MON\":[[\"09:00\",\"18:00\"]]}",
        "fulfillmentTimeInMinutes": 60,
        "blackoutDates": "{blackoutDates:[{intervalStart:\"June 23, 2022, 4:00:00 AM\",intervalEnd:\"June 25, 2022, 12:12:10 PM\",repeatAnnually:true}]}"
      },
      {
        "title": "Pick up at store #2",
        "rate": 2,
        "transitDays": "2",
        "description": "Pick you order at 88, Town street, Chicago",
        "fulfilmentType": "PICKUP",
        "scheduled": false
      },
      {
        "title": "Local delivery Chicago",
        "rate": 5,
        "transitDays": "0",
        "description": "2 hours delivery",
        "fulfilmentType": "DELIVERY",
        "scheduled": false
      }                   
    ] 
}

An array of JSON data of type 'ShippingOptions':

📘

Fields in bold are mandatory.

ShippingOptions

NameTypeDescription
titlestringShipping method name
ratenumberShipping rate amount
transitDaysstringEstimated delivery time. Formats accepted: empty "", number "5", several days estimate "4-9"
descriptionstringShipping method description. Plain text only, HTML is not allowed.
titleTranslated<Translations>Available translations for shipping method name
descriptionTranslated<Translations>Available translations for shipping method description
fulfilmentTypestringFulfillment type. "PICKUP" for in-store pickup methods, "DELIVERY" for local delivery methods, "SHIPPING" for everything else. If the field is not passed, default value is "SHIPPING"
scheduledbooleantrue if "Allow to select delivery date or time at checkout" or "Ask for Pickup Date and Time at Checkout" setting is enabled. false otherwise. Ignored if fulfilmentType has value "SHIPPING".
businessHours<BusinessHours>Should be passed if "scheduled": true. Available and scheduled times to pickup orders.
fulfillmentTimeInMinutesnumberAmount of time (in minutes) required for store to prepare pickup or to deliver an order (Order Fulfillment Time setting)
blackoutDates<BlackoutDates>Dates when the store doesn’t work, so customers can't choose these dates for local delivery. Each period of dates is a JSON object.

BusinessHours

FieldTypeDescription
MONArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
TUEArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
WEDArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
THUArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
FRIArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
SATArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
SUNArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']

BlackoutDates

FieldTypeDescription
fromDatestringStarting date of the period, e.g. 2022-04-28.
toDatestringThe end date of the period, e.g. 2022-04-30.
repeatedAnnuallybooleanSpecifies whether the period repeats in the following years or not.

📘

Important: for new Ecwid accounts, Ecwid uses the description field instead of transitDays. Make sure that your app provides description field as well as transitDays, so both old and new users can see the estimates.

Weight units

Ecwid supports several weigh units that can be passed in the request to your application to provide shipping rates. Below you can see all available units as well as their conversion values for calculation.

NameCodeValue
Caratcarat0.2
Gramgram1
Ounceounce28.35
Poundlbs453.6
Kilogramkg1000

Gram is the main weight unit, from which other units are converted. Merchants can change weight units in Ecwid Control Panel.

Translations

FieldTypeDescription
<ISO_LANG_CODE>stringTranslations for each available language. If no other translations are provided, the default language translation is returned. See available languages in store language settings