comecerodocs
Carts

Retrieve the cart shipping item

GET
/carts/{cart_id}/shipping_item

Returns the shipping line of the cart, made from the selected shipping method. A cart with no shipping is 404. Any token type may call it; a limited token only for a bound cart.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

cart_id*string

The id of the cart.

Query Parameters

show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse

Response Body

The shipping item.

application/json
  1. response

The shipping line of a cart or order, made from the selected shipping method. Inside a cart or order it has no object, product_id, cart_id or product. GET /carts/{cart_id}/shipping_item returns it shaped as a cart item, with object cart_item, product_id null and cart_id. The settlement_ fields, reference_price, reference_currency and tax_code are not returned to a limited token.

object?"cart_item"

Only from GET /carts/{cart_id}/shipping_item. Always cart_item.

Value in"cart_item"
url*string

The full URL of the shipping item.

Formaturi
item_id*string

The shipping_method_id of the selected shipping method.

cross_sell_id?|

Always null for shipping.

up_sell_id?|

Always null for shipping.

bundle_id?|

Always null for shipping.

bundle_group_id?|

Always null for shipping.

date_created*string

When shipping was worked out.

Formatdate-time
date_modified*string

When shipping was last worked out.

Formatdate-time
product_id?null

Only from GET /carts/{cart_id}/shipping_item. Always null.

cart_id?string

Only from GET /carts/{cart_id}/shipping_item. The cart.

name*string

The description of the shipping method.

type*"shipping"

Always shipping.

Value in"shipping"
quantity*number

Always 1.

currency*string

The currency of the cart or order.

price*number

The shipping price with discounts, without tax, in currency.

price_original*number

The shipping price before discounts, in currency.

reference_price?|

Always null for shipping. Not returned to a limited token.

reference_currency?|

Always null for shipping. Not returned to a limited token.

subtotal*number

The shipping price, without tax, in currency.

subtotal_original*number

The shipping price before discounts, without tax, in currency.

discount*number

The shipping discount, in currency.

discount_percent*number

The discount as a fraction of the original price.

tax*number

The tax on shipping, in currency.

tax_original*number

The tax on shipping before discounts, in currency.

total*number

subtotal plus tax, in currency.

total_original*number

subtotal_original plus tax_original, in currency.

tax_rate*number

The tax rate on shipping, as a fraction.

tax_code?string

Always shipping. Not returned to a limited token.

settlement_currency?string

The settlement currency. Not returned to a limited token.

settlement_price?number

price in settlement_currency. Not returned to a limited token.

settlement_price_original?number

price_original in settlement_currency. Not returned to a limited token.

settlement_subtotal?number

subtotal in settlement_currency. Not returned to a limited token.

settlement_subtotal_original?number

subtotal_original in settlement_currency. Not returned to a limited token.

settlement_discount?number

discount in settlement_currency. Not returned to a limited token.

settlement_tax?number

tax in settlement_currency. Not returned to a limited token.

settlement_tax_original?number

tax_original in settlement_currency. Not returned to a limited token.

settlement_total?number

total in settlement_currency. Not returned to a limited token.

settlement_total_original?number

total_original in settlement_currency. Not returned to a limited token.

product?null

Only from GET /carts/{cart_id}/shipping_item. Always null.

subscription_plan?null

Only from GET /carts/{cart_id}/shipping_item. Always null.

subscription_terms?null

Only from GET /carts/{cart_id}/shipping_item. Always null.

meta*||

Always null for shipping.

formatted?

Money amounts and dates as display strings. Only present with formatted=true.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/carts/string/shipping_item'
Example Response
{  "object": "cart_item",  "url": "https://api.comecero.com/api/v1/carts/0091307952465CafhFSTa1/items/standard-us",  "item_id": "standard-us",  "cross_sell_id": null,  "up_sell_id": null,  "bundle_id": null,  "bundle_group_id": null,  "date_created": "2026-11-07T19:21:40Z",  "date_modified": "2026-11-07T19:21:40Z",  "product_id": null,  "cart_id": "0091307952465CafhFSTa1",  "name": "Standard Shipping",  "type": "shipping",  "quantity": 1,  "currency": "USD",  "price": 5,  "price_original": 5,  "reference_price": null,  "reference_currency": null,  "subtotal": 5,  "subtotal_original": 5,  "discount": 0,  "discount_percent": 0,  "tax": 0,  "tax_original": 0,  "total": 5,  "total_original": 5,  "tax_rate": 0,  "tax_code": "shipping",  "settlement_currency": "USD",  "settlement_price": 5,  "settlement_price_original": 5,  "settlement_subtotal": 5,  "settlement_subtotal_original": 5,  "settlement_discount": 0,  "settlement_tax": 0,  "settlement_tax_original": 0,  "settlement_total": 5,  "settlement_total_original": 5,  "product": null,  "subscription_plan": null,  "subscription_terms": null,  "meta": null}

List related products for a cart GET

Lists up to 3 products set as related to the products in the cart. Products already in the cart are left out. One page; it takes no paging parameters. Any token type may call it; a limited token only for a bound cart.

List cart up-sells GET

Returns up-sell offers for the cart: a better product in place of one in the cart, picked from your active up-sell promotions. Each offer says which product it replaces and how much more it costs. To take an offer, add its product with its `up_sell_id`; the replaced item is removed. One page. Any token type may call it; a limited token only for a bound cart.