get https://app.ecwid.com/api/v3//profile/shippingOptions
Get information about store shipping options: settings, availability, titles, etc. The same content is provided in Get store profile -> Shipping -> ShippingOptions
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token. |
Response
A JSON array with elements of type 'ShippingOption' with the following fields:
Query parameters
| Name | Type | Description |
|---|---|---|
| lang | string | ISO code of the language you expect to receive JSON data in (e.g. en, fr). Is used for the fields that have translations: title, description, pickupInstruction. |
ShippingOption
| Field | Type | Description |
|---|---|---|
| id | string | Unique ID of shipping option |
| title | string | Title of shipping option in store settings |
| titleTranslated | <Translations> | Available translations for shipping option title. |
| enabled | boolean | true if shipping option is used at checkout to calculate shipping. false otherwise |
| orderby | number | Sort position or shipping option at checkout and in store settings. The smaller the number, the higher the position |
| fulfilmentType | string | Fulfillment type. "pickup" for in-store pickup methods, "delivery" for local delivery methods, "shipping" for everything else |
| minimumOrderSubtotal | number | Order subtotal before discounts. The delivery method won’t be available at checkout for orders below that amount. The field is displayed if the value is not 0 |
| destinationZone | <Zone> | Destination zone set for shipping option. Empty for public token |
| deliveryTimeDays | string | Estimated delivery time in days. Currently, it is equal to the description value. |
| description | string | Shipping method description. Is also shown in the fields deliveryTimeDays (for GET shipping options requests) and estimatedTransitTime (for GET orders requests). |
| descriptionTranslated | <Translations> | Available translations for shipping option description. |
| carrier | string | Carrier used for shipping the order. Is provided for carrier-calculated shipping options |
| carrierMethods | Array <CarrierMethod> | Carrier-calculated shipping methods available for this shipping option |
| carrierSettings | <CarrierSettings> | Carrier-calculated shipping option settings |
| ratesCalculationType | string | Rates calculation type. One of "carrier-calculated", "table", "flat", "app" |
| shippingCostMarkup | number | Shipping cost markup for carrier-calculated methods |
| flatRate | <FlatRate> | Flat rate details |
| ratesTable | <TableRatesDetails> | Custom table rates details |
| appClientId | string | client_id value of the app (for custom shipping apps only) |
| pickupInstruction | string | String of HTML code of instructions on in-store pickup |
| pickupInstructionTranslated | <Translations> | Available translations for pickup instruction. |
| scheduledPickup | boolean | true if pickup time is scheduled, false otehrwise. (Ask for Pickup Date and Time at Checkout option in pickup settings) |
| pickupPreparationTimeHours | number | [Deprecated] Amount of time required for store to prepare pickup (Order Fulfillment Time setting) |
| fulfillmentTimeInMinutes | number | Amount of time (in minutes) required for store to prepare pickup or to deliver an order (Order Fulfillment Time setting) |
| businessHours | string <BusinessHours> | Available and scheduled times to pickup orders |
| pickupBusinessHours | string <BusinessHours> | [Deprecated] Available and scheduled times to pickup orders (duplicates 'businessHours' field) |
| businessHoursLimitationType | string | One of: ALLOW_ORDERS_AND_INFORM_CUSTOMERS - makes it possible to place an order using this delivery method at any time, but if delivery doesn't work at the moment when the order is being placed, a warning will be shown to a customer. DISALLOW_ORDERS_AND_INFORM_CUSTOMERS - makes it possible to place an order using this delivery method only during the operational hours. If delivery doesn't work when an order is placed, this delivery method will be shown at the checkout as a disabled one and will contain a note about when delivery will start working again. ALLOW_ORDERS_AND_DONT_INFORM_CUSTOMERS - makes it possible to place an order using this delivery method at any time. Works only for delivery methods with a schedule. |
| scheduled | boolean | true if "Allow to select delivery date or time at checkout" or "Ask for Pickup Date and Time at Checkout" setting is enabled. false otherwise. |
| scheduledTimePrecisionType | string | Format of how delivery date is chosen at the checkout - date or date and time. One of: DATE, DATE_AND_TIME_SLOT. |
| timeSlotLengthInMinutes | number | Length of the delivery time slot in minutes. |
| allowSameDayDelivery | boolean | true if same-day delivery is allowed. false otherwise. |
| cutoffTimeForSameDayDelivery | string | Orders placed after this time (in a 24-hour format) will be scheduled for delivery the next business day. |
| availabilityPeriod | string | The merchant can specify the maximum possible delivery date for local delivery and pickup shipping options ("Allow choosing pickup date within"). Values: TWO_DAYS, THREE_DAYS, SEVEN_DAYS, ONE_MONTH, THREE_MONTHS, SIX_MONTHS, ONE_YEAR, UNLIMITED.. |
| blackoutDates | array <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. |
| estimatedShippingTimeAtCheckoutSettings | <estimatedShippingTimeAtCheckoutSettings> | Information about estimated shipping time shown at checkout. Same settings can be found in Control Panel, on the shipping method settings page ("Show estimated delivery date at checkout" section). |
Zone
System Settings → Zones
| Field | Type | Description |
|---|---|---|
| name | string | Zone displayed name. |
| countryCodes | Array<string> | Country codes this zone includes . |
| stateOrProvinceCodes | Array<string> | State or province codes the zone includes. Format: [country code]-[state code] Example: shipping zone for Alabama, Arizona, Alaska in United states looks like: ["US-AL","US-AK","US-AZ"]. Please refer to Dictionaries to get right country and state codes |
| postCodes | Array<string> | Postcode (or zip code) templates this zone includes. More details: Destination zones in Ecwid. |
| geoPolygons | Array <GeoPolygons> | Dot coordinates of the polygon (if destination zone is created using Zone on Map). |
GeoPolygons
| Field | Type | Description |
|---|---|---|
| <COORDINATES> | Array of arrays | Each array contains coordinates of a single dot of the polygon. (E.g. [ [37.0365395, -95.66864041664617], [37.0754801, -95.6404782452158], ...]). |
CarrierMethod
| Field | Type | Description |
|---|---|---|
| id | string | Carrier ID and specific method name |
| name | string | Carrier method name |
| enabled | boolean | true if enabled, false otherwise |
| orderBy | number | Position of that carrier method |
CarrierSettings
| Field | Type | Description |
|---|---|---|
| defaultCarrierAccountEnabled | boolean | true if default Ecwid account is enabled to calculate the rates. false otherwise |
| defaultPostageDimensions | <DefaultPostageDimensions> | Default postage dimensions for this shipping option |
DefaultPostageDimensions
| Field | Type | Description |
|---|---|---|
| length | number | Length of postage |
| width | number | Width of postage |
| height | number | Height of postage |
FlatRate
| Field | Type | Description |
|---|---|---|
| rateType | string | One of "ABSOLUTE", "PERCENT" |
| rate | number | Shipping rate |
TableRatesDetails
| Field | Type | Description |
|---|---|---|
| tableBasedOn | string | What is this table rate based on. Possible values: "subtotal", "discountedSubtotal", "weight" |
| rates | Array <TableRate> | Details of table rate |
TableRate
| Field | Type | Description |
|---|---|---|
| conditions | <TableRateConditions> | Conditions for this shipping rate in custom table |
| rate | <TableRateDetails> | Table rate details |
TableRateConditions
| Field | Type | Description |
|---|---|---|
| weightFrom | number | "Weight from" condition value |
| weightTo | number | "Weight to" condition value |
| subtotalFrom | number | "Subtotal from" condition value |
| subtotalTo | number | "Subtotal to" condition value |
| discountedSubtotalFrom | number | "Discounted subtotal from" condition value |
| discountedSubtotalTo | number | "Discounted subtotal from" condition value |
TableRateDetails
| Field | Type | Description |
|---|---|---|
| perOrder | number | Absolute per order rate |
| percent | number | Percent per order rate |
| perItem | number | Absolute per item rate |
| perWeight | number | Absolute per weight rate |
BusinessHours
| Field | Type | Description |
|---|---|---|
| MON | Array time range | Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00'] |
| TUE | Array time range | Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00'] |
| WED | Array time range | Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00'] |
| THU | Array time range | Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00'] |
| FRI | Array time range | Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00'] |
| SAT | Array time range | Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00'] |
| SUN | Array time range | Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00'] |
BlackoutDates
| Field | Type | Description |
|---|---|---|
| fromDate | string | Starting date of the period, e.g. 2022-04-28. |
| toDate | string | The end date of the period, e.g. 2022-04-30. |
| repeatedAnnually | boolean | Specifies whether the period repeats in the following years or not. |
Translations
| Field | Type | Description |
|---|---|---|
| <ISO_LANG_CODE> | string | Translations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings |
estimatedShippingTimeAtCheckoutSettings
| Field | Type | Description |
|---|---|---|
| estimatedDeliveryDateAtCheckoutEnabled | boolean | true if the estimated delivery time is shown at checkout, otherwise false. |
| estimatedTransitTimeInDays | Array<number> | How long it usually takes for the package to be delivered at the shipping address after being handed in to the shipping company. Field uses[from, to] format. The same number can be used, e.g.: [2, 2]. For an approximate time, use different values, e.g.: [2, 6]. |
| fulfillmentTimeInDays | Array<number> | How many days it usually takes you to prepare an order for shipment. That time will be taken into account when calculating the delivery date for customers. Field uses [from, to] format. The same number can be used, e.g.: [2, 2]. For an approximate time, use different values, e.g.: [2, 6]. |
| cutoffTimeForSameDayPacking | string | Local time to pack orders received past this time on the next day in a 24-hour format, e.g.: "13:00"(in this case, orders placed after 13:00 will be scheduled for packing and shipping the next business day). |
| shippingBusinessDays | Array<string> | Days of the week when your orders can be delivered. These days will be taken into account when calculating and displaying the approximate delivery date for customers at checkout. Format: [ "MON", "TUE", "WED", "THU", "FRI", "SUN", "SAT" ] |
| deliveryDays | Array<string> | Days of the week when you pack orders for shipment. Your schedule will be taken into account when calculating the delivery date for customers. Format: [ "MON", "TUE", "WED", "THU", "FRI", "SUN", "SAT" ] |