Shipping costs calculator API.

Returns shipping costs for a given item or user and a valid destination zip_code.

collapse allexpand all

{
  "destination": {
    "zip_code": "88010002",
    "city": {
      "id": "TUxCQ0ZMTzMzOGE1",
      "name": "Florianópolis"
    },
    "state": {
      "id": "BR-SC",
      "name": "Santa Catarina"
    },
    "country": {
      "id": "BR",
      "name": "Brasil"
    },
    "extended_attributes": {
      "address": "Rua Felipe Schmidt - de 981/982 ao fim",
      "zip_code_type": {
        "type": "LO",
        "description": "Logradouro"
      },
      "city_type": "CI",
      "city_name": "Florianópolis",
      "neighborhood": "Centro",
      "status": "active"
    }
  },
  "options": [
    {
      "id": 574805183,
      "option_hash": "32f786bffa374fe769525cb04a92b804",
      "name": "Expresso",
      "currency_id": "BRL",
      "list_cost": 26.17,
      "cost": 0,
      "base_cost": 14.9,
      "display": "recommended",
      "shipping_method_id": 182,
      "shipping_method_type": "express",
      "shipping_option_type": "address",
      "estimated_delivery_time": {
        "type": "known_frame",
        "date": "2019-12-11T00:00:00.000-03:00",
        "unit": "hour",
        "offset": {
          "date": "2019-12-12T00:00:00.000-03:00",
          "shipping": 24
        },
        "time_frame": {
          "from": null,
          "to": null
        },
        "pay_before": "2019-12-10T12:00:00.688-03:00",
        "shipping": 24,
        "handling": 24,
        "schedule": null
      },
      "discount": {
        "rate": 1,
        "type": "ratio",
        "promoted_amount": 14.9,
        "show_loyal_benefit": false
      },
      "tags": [
      ]
    },
    {
      "id": 689779052,
      "option_hash": "21a35cfcb947fd516ca974a739339178",
      "name": "Retiro Expresso na agência",
      "currency_id": "BRL",
      "list_cost": 26.17,
      "cost": 0,
      "base_cost": 14.9,
      "display": "always",
      "shipping_method_id": 505945,
      "shipping_method_type": "express",
      "shipping_option_type": "agency",
      "estimated_delivery_time": {
        "type": "known",
        "date": "2019-12-12T00:00:00.000-03:00",
        "unit": "hour",
        "offset": {
          "date": null,
          "shipping": null
        },
        "time_frame": {
          "from": null,
          "to": null
        },
        "pay_before": null,
        "shipping": 48,
        "handling": 24,
        "schedule": null
      },
      "discount": {
        "rate": 1,
        "type": "ratio",
        "promoted_amount": 14.9,
        "show_loyal_benefit": false
      },
      "tags": [
      ]
    }
  ],
  "buyer": {
    "id": null,
    "loyalty_level": null,
    "shipping_level": null
  },
  "custom_message": {
    "reason": "",
    "display_mode": null
  }
}
Allowed methods
Returns shipping costs for this item and destination zip code.
GET
/adapter/items/:item_id/shipping_options?zip_code=:zip_code_to
Multiget by zip code. Returns a map associating each zipcode key with a shipping costs value.
GET
/adapter/items/:item_id/shipping_options?zip_codes=:zc1,:zc2,...,:zcN
Returns shipping costs for this user, dimensions and destination zip code.
GET
/adapter/users/:user_id/shipping_options?zip_code=:zip_code_to&dimensions=:dimension_string
Multiget by zip code. Returns a map associating each zipcode key with a shipping costs value.
GET
/adapter/users/:user_id/shipping_options?zip_code=:zc1,:zc2,...,:zcN&dimensions=:dimension_string
Attributes
destination
Receiver address details.
Attributes
zip_code
Destination zip code.
city
Destination city info.
Attributes
id
Destination city id.
name
Destination city name.
state
Destination state info.
Attributes
id
Destination state id.
name
Destination state name.
country
Destination country info.
Attributes
id
Destination country id.
name
Destination country name.
extended_attributes
Destination address additional info.
Attributes
address
Destination address line.
owner_name
Destination address owner.
zip_code_type
Destination zip code type info.
Attributes
type
Destination zip code type id.
description
Destination zip code type name.
city_type
Destination city type id.
city_name
Destination city name.
version
Internal version of this data in Zipcodes API.
options
Collection of shipping costs for each available shipping method.
Attributes
id
Id of applied shipping rule.
name
Shipping method name.
currency_id
Id of currency used to show shipping costs.
list_cost
Real shipping costs, no free shipping applied.
cost
Final shipping cost, free shipping could apply.
tracks_shipments_status
Indicates how this method may be tracked
Attributes
verified
Can be internally tracked.
not_verified
Tracking information must be provided by seller.
no
Cannot be tracked.
display
Shipping method id for frontend processing.
Attributes
always
Shipping method must be displayed.
optional
Method may not be displayed because there exists a faster and cheaper one.
speed
Delivery speed info.
Attributes
shipping
Average hours for delivery itself.
handling
Average hours for shipment to be shipped by seller.
estimated_delivery
Delivery date info.
Attributes
date
Estimated date for delivery.
pay_before
Deadline for payment to be completed to meet the estimated delivery date.
time_from
Delivery window begin time.
time_to
Delivery window end time.
estimated_delivery_time
Delivery time info.
Attributes
type
(known/unknown/known_frame/unknown_frame) Known/unknown indicates whether information is available to estimate and frame indicates whether the estimation is single value or a range.
date
Estimated date for delivery.
shipping
Time (hours or days) for delivery.
handling
Average time (hours or days) for shipment to be shipped by seller.
unit
Time unit used (hours or days).
offset
Delivery date range information.
Attributes
date
Date up to which the delivery should be made.
shipping
Time (hours or days) from a ranges the initial date up to its final date.
time_frame
Delivery date time window.
Attributes
from
Delivery window begin time.
to
Delivery window end time.
pay_before
Deadline for payment to be completed to meet the estimated delivery date.
discount
Discount applied.
Attributes
rate
Discount rate.
type
Indicates the source of the discount.
promoted_amount
Amount discounted per the loyalty program.
Related resources
/items
/users
/cities
/states
/countries
/countries/:country_id/zip_codes/:zip_code
/currencies
/sites/:site_id/shipping_methods