UPDATE: Q4 Updates for Webhooks

SHIPMENT UPDATE WEBHOOK

We updated the shipment update webhook to better reflect those cases where the shipment had more than 1 package/label.

You will now see the package object with an array of packages. Inside each, you will find its contents, the address, the label information, and the box information.

We will keep the old fields for some time so as not to break existing integrations.

{
    "test": "0",
    "webhook_type": "Shipment Update",
    "fulfillment": {
        "shipment_id": 315518042,
        "shipment_uuid": "U2hpcG1lbnQ6MzE1NTE4MDQy",
        "warehouse": "Primary",
        "warehouse_id": 76733,
        "warehouse_uuid": "V2FyZWhvdXNlOjc2NzMz",
        "webhook_type": "Shipment Update",
        "partner_order_id": "test-track-url",
        "order_number": "test-track-url",
        "tracking_number": "15619819718",
        "line_items": [
            {
                "id": "test-track-url-363346570",
                "shiphero_id": 828656700,
                "quantity": 1,
                "sku": "FU2314R",
                "serial_numbers": [],
                "customs_description": "",
                "package": "Package #1",
                "lot_id": null,
                "lot_name": null,
                "lot_expiration": null
            },
            {
                "id": "test-track-url-363343850",
                "shiphero_id": 828656701,
                "quantity": 1,
                "sku": "FU3314R",
                "serial_numbers": [],
                "customs_description": null,
                "package": "Package #2",
                "lot_id": null,
                "lot_name": null,
                "lot_expiration": null
            }
        ],
        "custom_tracking_url": "",
        "package_number": 1,
        "total_packages": 2,
        "shipping_method": "Super Shipping",
        "shipping_carrier": "API - TomasFD",
        "shipping_address": {
            "name": "Tomas Two",
            "address1": "1308 DREXEL AVE",
            "address2": "APT 208",
            "address_city": "MIAMI BEACH",
            "address_zip": "33139-8126",
            "address_state": "FL",
            "address_country": "US"
        },
        "package": {
            "length": 0.39,
            "width": 0.39,
            "height": 0.39,
            "weight": 13.12
        },
        "completed": true,
        "created_at": "2022-12-26 15:29:26",
        "order_uuid": "T3JkZXI6MzI0ODcxNzI5",
        "order_gift_note": ""
    },
    "total_packages": 2,
    "packages": [
        {
            "name": "Package #1",
            "weight_in_oz": 13.12,
            "width": 0.39,
            "length": 0.39,
            "height": 0.39,
            "line_items": [
                {
                    "line_item_id": 828656700,
                    "partner_line_item_id": "test-track-url-363346570",
                    "sku": "FU2314R",
                    "product_name": "FUJIFILM XF 23mm f/1.4 R LM WR Lens",
                    "customs_description": "",
                    "tariff_code": "0",
                    "price": 899,
                    "quantity": 1,
                    "weight": 13.12,
                    "customs_value": 0,
                    "ignore_on_customs": false,
                    "country_of_manufacture": "",
                    "lot_id": null,
                    "lot_name": null,
                    "lot_expiration": ""
                }
            ],
            "shipping_label": {
                "shipping_carrier": "API - TomasFD",
                "shipping_method": "Super Shipping",
                "shipping_name": "Manual Order Shipping Method",
                "cost": 100,
                "tracking_number": "15619819718",
                "tracking_url": "https://trackingurl.com/15619819718"
            },
            "shipping_address": {
                "name": "Tomas Two",
                "address1": "1308 DREXEL AVE",
                "address2": "APT 208",
                "address_city": "MIAMI BEACH",
                "address_zip": "33139-8126",
                "address_state": "FL",
                "address_country": "US"
            },
            "box_code": "",
            "box_id": 0,
            "box_name": null
        },
        {
            "name": "Package #2",
            "weight_in_oz": 12.7,
            "width": 0.39,
            "length": 0.39,
            "height": 0.39,
            "line_items": [
                {
                    "line_item_id": 828656701,
                    "partner_line_item_id": "test-track-url-363343850",
                    "sku": "FU3314R",
                    "product_name": "FUJIFILM XF 33mm f/1.4 R LM WR Lens ",
                    "customs_description": null,
                    "tariff_code": "0",
                    "price": 799,
                    "quantity": 1,
                    "weight": 12.7,
                    "customs_value": 0,
                    "ignore_on_customs": false,
                    "country_of_manufacture": "",
                    "lot_id": null,
                    "lot_name": null,
                    "lot_expiration": ""
                }
            ],
            "shipping_label": {
                "shipping_carrier": "API - TomasFD",
                "shipping_method": "Mega Shipping",
                "shipping_name": "Manual Order Shipping Method",
                "cost": 100,
                "tracking_number": "63721453534",
                "tracking_url": "https://trackingurl.com/63721453534"
            },
            "shipping_address": {
                "name": "Tomas Two",
                "address1": "1308 DREXEL AVE",
                "address2": "APT 208",
                "address_city": "MIAMI BEACH",
                "address_zip": "33139-8126",
                "address_state": "FL",
                "address_country": "US"
            },
            "box_code": "",
            "box_id": 0,
            "box_name": null
        }
    ]
}

PRODUCT UPDATE WEBHOOK.

This is a recently developed webhook

This webhook will trigger anytime a product’s details change. This includes product creation and warehouse product creation.

Given the nature of this webhook, we provide at least one delivery of each event. This means you might get more than one per event, but you will always get the most up-to-date information.

{
    "account_id": 63898,
    "account_uuid": "QWNjb3VudDo2Mzg5OA==",
    "webhook_type": "Product Update",
    "product": [
        {
            "name": "test-inventory-webhook",
            "sku": "test-inventory-webhook",
            "country_of_manufacture": "US",
            "dimensions": {
                "weight": 16,
                "height": 1.18,
                "length": 1.18,
                "width": 1.18
            },
            "tariff_code": "0",
            "kit": false,
            "kit_build": false,
            "customs_description": "",
            "not_owned": false,
            "dropship": false,
            "needs_serial_number": false,
            "created_at": "2022-02-17 14:38:26",
            "updated_at": "2022-08-11 19:17:06",
            "product_note": null,
            "virtual": false,
            "barcode": "2345678965432",
            "packer_note": null,
            "li_ion": 0,
            "dangerous_goods_code": null,
            "ignore_on_invoice": false,
            "ignore_on_customs": false,
            "needs_lot_tracking": false,
            "warehouse_products": [
                {
                    "warehouse_id": 76733,
                    "price": 150,
                    "value": 100,
                    "value_currency": "USD",
                    "no_air": false,
                    "final_sale": false,
                    "active": true,
                    "custom": false,
                    "reorder_level": 0,
                    "reorder_amount": 1,
                    "replenishment_level": 0,
                    "auto_fulfill": false,
                    "customs_value": 0,
                    "created_at": "2022-02-17 14:38:26",
                    "updated_at": "2022-08-11 19:17:05"
                },
                {
                    "warehouse_id": 82748,
                    "price": 0,
                    "value": 100,
                    "value_currency": null,
                    "no_air": false,
                    "final_sale": false,
                    "active": true,
                    "custom": false,
                    "reorder_level": 0,
                    "reorder_amount": 1,
                    "replenishment_level": 0,
                    "auto_fulfill": false,
                    "customs_value": 0,
                    "created_at": "2022-12-06 14:39:51",
                    "updated_at": "2022-12-06 14:39:51"
                },
                {
                    "warehouse_id": 85526,
                    "price": 0,
                    "value": 100,
                    "value_currency": null,
                    "no_air": false,
                    "final_sale": false,
                    "active": true,
                    "custom": false,
                    "reorder_level": 0,
                    "reorder_amount": 1,
                    "replenishment_level": 0,
                    "auto_fulfill": false,
                    "customs_value": 0,
                    "created_at": "2022-12-06 14:39:51",
                    "updated_at": "2022-12-06 14:39:51"
                }
            ]
        }
    ]
}