---
title: Shipment Delivered
slug: tracking-plan/shipment-delivered
docTags:
createdAt: 2026-01-21T23:00:52.284Z
---
Order shipment has been delivered.
**Suggested source:** server
**Properties**
| Name | Type | Description | Required |
| ----------------- | -------- | --------------------------------------------------- | -------- |
| **email** | `string` | Email address associated with the order
| no |
| **order\_number** | `string` | Order number (for example, "CHORD-000111222")
| no |
| **shipment** | `object` | Shipment details
| no |
**Example**
```json
{
"email": "customer@example.com",
"order_number": "CHORD-000111222",
"shipment": {
"additional_tax_total": 2,
"address": {
"street": "123 Main St",
"city": "Anytown",
"state": "CA",
"country": "USA",
"zip": "12345"
},
"adjustment_total": -5,
"carrier": "ups",
"cost": 15,
"external_tracking_url": "https://example.com/track/your/shipment/here",
"fulfilled_by": "Amazon Fulfillment",
"included_tax_total": 1.5,
"label_url": "https://example.com/shipment/label/here",
"number": "SHIP-000123456",
"products": [
{
"affiliation": "My Plant Store",
"brand": "Green Thumb Nurseries",
"bundle": false,
"category": "Outdoor Plants",
"coupon": "SPRING",
"description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
"image_url": "https://example.com/images/petunia.jpg",
"line_item_id": "234567891",
"name": "Petunia",
"option_values": [
"Purple",
"Red",
"White"
],
"position": 3,
"price": 7.99,
"product_id": "123456789",
"quantity": 2,
"sku": "PETUNIA-001",
"slug": "petunia",
"url": "https://example.com/plants/petunia",
"variant": "Purple",
"variant_metadata": {
"size": "Small"
}
}
],
"promo_total": -10,
"pushed": true,
"state": "shipped",
"tracking": "1Z999AA10123456784",
"tracking_detail": "Delivered, Front Door/Porch"
}
}
```
## shipment object
Shipment details
**Properties**
| Name | Type | Description | Required |
| --------------------------- | ---------- | -------------------------------------------------------------------------------------- | -------- |
| **additional\_tax\_total** | `number` | Shipment additional tax total
| no |
| **address** | `object` | Shipment address
| no |
| **adjustment\_total** | `number` | Adjustment total
| no |
| **carrier** | `string` | Name of carrier (for example, "ups")
| no |
| **cost** | `number` | Cost associated with shipment
| no |
| **external\_tracking\_url** | `string` | Tracking URL for customer to track shipment
| no |
| **fulfilled\_by** | `string` | Name of fulfillment provider
| no |
| **included\_tax\_total** | `number` | Included tax total
| no |
| **label\_url** | `string` | Shipment label url
| no |
| **number** | `string` | Shipment number
| no |
| **products** | `object[]` | Products in the shipment
| no |
| **promo\_total** | `number` | Total discount from promotions
| no |
| **pushed** | `boolean` | Shipment has been successfully fulfilled
| no |
| **state** | `string` | Shipment state (for example, "shipped")
| no |
| **tracking** | `string` | Tracking number for shipment
| no |
| **tracking\_detail** | `string` | Latest tracking update for shipment (for example, "Delivered, Front Door/Porch")
| no |
**Example**
```json
{
"address": {
"address1": "123 Elm Street",
"address2": "Suite 456",
"city": "Springfield",
"company": "Acme Corp",
"country": "USA",
"name": "John Doe",
"phone": "555-1234",
"state": "IL",
"zipcode": "62704"
},
"products": [
{
"affiliation": "My Plant Store",
"brand": "Green Thumb Nurseries",
"bundle": false,
"category": "Outdoor Plants",
"description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
"image_url": "https://example.com/images/petunia.jpg",
"name": "Petunia",
"option_values": [
"Purple",
"Red",
"White"
],
"position": 3,
"price": 7.99,
"product_id": "123456789",
"sku": "PETUNIA-001",
"slug": "petunia",
"url": "https://example.com/plants/petunia",
"variant": "Purple",
"coupon": "SPRING",
"line_item_id": "234567891",
"quantity": 2
}
]
}
```
### shipment.address object
Shipment address
**Properties**
| Name | Type | Description | Required |
| ------------ | -------- | ----------------------------- | -------- |
| **address1** | `string` | Street address (line 1)
| |
| **address2** | `string` | Street address (line 2)
| |
| **city** | `string` | City
| |
| **company** | `string` | Company
| |
| **country** | `string` | Country
| |
| **name** | `string` | Name
| |
| **phone** | `string` | Phone number
| |
| **state** | `string` | State
| |
| **zipcode** | `string` | Zipcode
| |
**Example**
```json
{
"address1": "123 Elm Street",
"address2": "Suite 456",
"city": "Springfield",
"company": "Acme Corp",
"country": "USA",
"name": "John Doe",
"phone": "555-1234",
"state": "IL",
"zipcode": "62704"
}
```
### shipment.products\[] array
Products in the shipment
The product
**Item Properties**
| Name | Type | Description | Required |
| --------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------- | -------- |
| **affiliation** | `string` | Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")
| |
| **brand** | `string` | Brand associated with the product
| |
| **bundle** | `boolean` | Product belongs to a bundle
| |
| **category** | `string` | Product category
| |
| **coupon** | `string` | Coupon code associated with a product (for example, "MAY\_DEALS\_3")
| |
| **description** | `string` | Short description of the product
| |
| **image\_url** | `string` | Image URL of the product
| |
| **name** | `string` | Name of the product
| |
| **option\_values** | `string[]` | Option values of the product variant
| |
| **position** | `integer` | Position in the product list (for example, 3)
| |
| **price** | `number` | Price ($) of the product
| |
| **product\_id** | `string` | Database ID of the product
| |
| **quantity** | `integer` | Quantity of the product
| |
| **sku** | `string` | SKU of the product variant
| |
| **slug** | `string` | Slug of the product, often used in URLs (for example, "product-red")
| |
| **url** | `string` | URL of the product page
| |
| **variant** | `string` | Name of the product variant
| |
| **line\_item\_id** | `string` | Database ID of the line item
| |
| **variant\_metadata** | `object` | Metadata of the product variant
| |
**Example**
```json
[
{
"affiliation": "My Plant Store",
"brand": "Green Thumb Nurseries",
"bundle": false,
"category": "Outdoor Plants",
"description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
"image_url": "https://example.com/images/petunia.jpg",
"name": "Petunia",
"option_values": [
"Purple",
"Red",
"White"
],
"position": 3,
"price": 7.99,
"product_id": "123456789",
"sku": "PETUNIA-001",
"slug": "petunia",
"url": "https://example.com/plants/petunia",
"variant": "Purple",
"coupon": "SPRING",
"line_item_id": "234567891",
"quantity": 2
}
]
```
### shipment.products\[].option\_values\[] array
Option values of the product variant
Option value (for example, "red")
**Item Type:** `string`
**Example**
```json
[
"Purple"
]
```
### shipment.products\[].variant\_metadata object
Metadata of the product variant
**No properties.**