Events

Shipment Shipped

Order shipment has been shipped.
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": "[email protected]",
    "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"
    }
}
{
    "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
        }
    ]
}
{
    "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"
}
{
    "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
    }
]
[
    {
        "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: stringExample
JSON
[
    "Purple"
]
[
    "Purple"
]
﻿
  
shipment.products[].variant_metadata object
Metadata of the product variant
No 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

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

Name	Type	Description
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

Name	Type	Description
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

Shipment Delivered

Signed In