Shipping Object

Overview

The shipping object represents a single shipping method or delivery option used in a transaction. An order can have multiple shipping objects when items are shipped separately (split shipments).

Each shipping captures the method name, cost, tax information, and delivery classification.

Complete Reference

shipping[0] object

name string required

info

Shipping method name

name: "Express Delivery"

value number required

info

Shipping cost value

value: 12.99

tax_included boolean recommended

info

Whether shipping cost includes taxes

tax_included: true

tax_percent number recommended

info

Tax percentage for shipping (0-50)

tax_percent: 19

id string

info

Shipping method identifier.

id: "SHIPPING_INTERNAL_ID"

type string

info

Shipping type. Free-form string, use consistent naming (e.g. "standard", "express", "next_day", "pickup", "free").

type: "standard"

currency string required-if-applicable

info

Currency code. Specifies the currency code when it differs from event.currency.

currency: "USD"

exchange_rate number

info

Custom exchange rate for multi-currency. Default has value 1. Specifies when it differs from event.exchange_rate.

exchange_rate: 1

Examples

Standard Shipping

{
  "name": "Standard Ground Shipping",
  "value": 15.99,
  "tax_included": true,
  "tax_percent": 19,
  "id": "SHIP_STD_001",
  "type": "standard"
}

Express Shipping

{
  "name": "Express Next Day Delivery",
  "value": 29.99,
  "tax_included": true,
  "tax_percent": 19,
  "id": "SHIP_EXP_001",
  "type": "express"
}

Free Shipping

{
  "name": "Free Standard Shipping",
  "value": 0.00,
  "tax_included": true,
  "tax_percent": 0,
  "type": "free"
}

Store Pickup

{
  "name": "Store Pickup - Downtown",
  "value": 0.00,
  "tax_included": true,
  "tax_percent": 0,
  "type": "pickup"
}

Split Shipments

[
  {
    "name": "Standard Shipping - Package 1",
    "value": 12.99,
    "tax_included": true,
    "tax_percent": 19,
    "id": "SHIP_PKG1",
    "type": "standard"
  },
  {
    "name": "Express Shipping - Package 2",
    "value": 24.99,
    "tax_included": true,
    "tax_percent": 19,
    "id": "SHIP_PKG2",
    "type": "express"
  }
]

Best Practices

• Accurate costs — ensure shipping values reflect real costs including taxes
• Tax information — include accurate tax calculations; if tax_percent is not provided, the default from your account configuration is used
• Currency — only specify currency and exchange_rate when the shipping currency differs from the event currency
• Type classification — use consistent type values for analytics (e.g. "standard", "express", "next_day", "overnight", "free", "pickup")
• Split shipments — when items ship separately, include each shipment as a separate object in the shipping array