SwiftPOD
  1. Webhook
SwiftPOD
  • Api
    • Webhook
      • List Webhooks
        GET
      • Subscribe to Webhook
        POST
      • Unsubcribe to webhook
        DELETE
      • Webhook Notification - Order Status Change Example
        POST
      • Webhook Notification - Tracking Number Example
        POST
      • Webhook Notification - In Transit and Delivered Status Example
        POST
      • Webhook Notification - Stock Status Change Example
        POST
    • Orders
      GET
    • Create Order
      POST
    • Create Multiple Orders
      POST
    • Get Order
      GET
    • Update Order
      PUT
    • Update Order Status
      PUT
    • Cancel Order
      POST
    • Catalogs
      GET
  • Changelog
  1. Webhook

Webhook Notification - In Transit and Delivered Status Example

POST
https://your.endpoint.here
Data
The data will be sent as a POST call to your webhook url. The data will be formatted as JSON and sent over in the following format
Note__: Some international shipping orders may not return a webhook with a “delivered” status

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json

Example
{
    "event": {
        "uuid": "4e3f192a-c674-4de1-adb1-2f12e1adc62f",
        "tracking": {
            "tracking_number": "9400100109361129278357",
            "tracking_status": "delivered",
            "carrier_code": "USPS",
            "tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
            "shipped_items": [
                {
                    "order_item_id": "28002-A-001",
                    "quantity": 3
                }
            ]
        },
        "name": "shipment_notify",
        "timestamp": "2022-07-08T13:24:00.128774Z"
    },
    "data": {
        "id": 2,
        "order_id": "28002-A",
        "test_order": false,
        "created_at": "2022-01-07T14:11:50.000000Z",
        "updated_at": "2022-07-08T03:16:08.000000Z",
        "status": "shipped",
        "rejected_at": null,
        "cancelled_at": null,
        "address": {
            "name": "John Smith",
            "company": "DEMO",
            "phone": "(330) 638-1331",
            "street1": "4736 Phillips Rice Rd",
            "street2": null,
            "city": "Cortland",
            "state": "OH",
            "country": "US",
            "zip": "44410"
        },
        "line_items": [
            {
                "id": 2,
                "sku": "UNPT1B00M",
                "quantity": 1,
                "order_item_id": "196953049",
                "print_files": [
                    {
                        "key": "front",
                        "url": "https://via.placeholder.com/2400/09f/fff.png"
                    }
                ],
                "preview_files": [
                    {
                        "key": "front",
                        "url": "https://via.placeholder.com/2400/09f/fff.png"
                    }
                ]
            }
        ],
        "trackings": [
            {
                "tracking_number": "9400100109361129278357",
                "tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
                "carrier": "USPS",
                "created_at": "2022-07-21T10:53:46.000000+00:00",
                "status": "delivered",
                "label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240312/e8ab4953a913e64c769e8bd3857943029af9.png",
                "shipped_items": [
                    {
                        "order_item_id": "28002-A-001",
                        "quantity": 3
                    }
                ],
                "primary": true
            },
            {
                "tracking_number": "9400100109361129278358",
                "tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
                "carrier": "USPS",
                "created_at": "2022-07-21T10:55:46.000000+00:00",
                "status": "delivered",
                "label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240312/e8ab4953a913e64c769e8bd3857943029af9.png",
                "shipped_items": [
                    {
                        "order_item_id": "28002-A-002",
                        "quantity": 1
                    },
                    {
                        "order_item_id": "28002-A-003",
                        "quantity": 2
                    }
                ],
                "primary": false
            }
        ],
        "shipping_method": "standard"
    }
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://your.endpoint.here' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event": {
        "uuid": "4e3f192a-c674-4de1-adb1-2f12e1adc62f",
        "tracking": {
            "tracking_number": "9400100109361129278357",
            "tracking_status": "delivered",
            "carrier_code": "USPS",
            "tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
            "shipped_items": [
                {
                    "order_item_id": "28002-A-001",
                    "quantity": 3
                }
            ]
        },
        "name": "shipment_notify",
        "timestamp": "2022-07-08T13:24:00.128774Z"
    },
    "data": {
        "id": 2,
        "order_id": "28002-A",
        "test_order": false,
        "created_at": "2022-01-07T14:11:50.000000Z",
        "updated_at": "2022-07-08T03:16:08.000000Z",
        "status": "shipped",
        "rejected_at": null,
        "cancelled_at": null,
        "address": {
            "name": "John Smith",
            "company": "DEMO",
            "phone": "(330) 638-1331",
            "street1": "4736 Phillips Rice Rd",
            "street2": null,
            "city": "Cortland",
            "state": "OH",
            "country": "US",
            "zip": "44410"
        },
        "line_items": [
            {
                "id": 2,
                "sku": "UNPT1B00M",
                "quantity": 1,
                "order_item_id": "196953049",
                "print_files": [
                    {
                        "key": "front",
                        "url": "https://via.placeholder.com/2400/09f/fff.png"
                    }
                ],
                "preview_files": [
                    {
                        "key": "front",
                        "url": "https://via.placeholder.com/2400/09f/fff.png"
                    }
                ]
            }
        ],
        "trackings": [
            {
                "tracking_number": "9400100109361129278357",
                "tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
                "carrier": "USPS",
                "created_at": "2022-07-21T10:53:46.000000+00:00",
                "status": "delivered",
                "label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240312/e8ab4953a913e64c769e8bd3857943029af9.png",
                "shipped_items": [
                    {
                        "order_item_id": "28002-A-001",
                        "quantity": 3
                    }
                ],
                "primary": true
            },
            {
                "tracking_number": "9400100109361129278358",
                "tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
                "carrier": "USPS",
                "created_at": "2022-07-21T10:55:46.000000+00:00",
                "status": "delivered",
                "label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240312/e8ab4953a913e64c769e8bd3857943029af9.png",
                "shipped_items": [
                    {
                        "order_item_id": "28002-A-002",
                        "quantity": 1
                    },
                    {
                        "order_item_id": "28002-A-003",
                        "quantity": 2
                    }
                ],
                "primary": false
            }
        ],
        "shipping_method": "standard"
    }
}'

Responses

🟢200Success
application/json
Body

Example
{}
Modified at 2025-08-04 03:34:41
Previous
Webhook Notification - Tracking Number Example
Next
Webhook Notification - Stock Status Change Example
Built with