Sent when a new tracker is received by Shipup

Whenever a new tracker is created on Shipup, you will receive a notification via the activated webhook. Below is an example of the payload.

{
  "id": 3123333,
  "created_at": 1530213415,
  "livemode": true,
  "object": "webhook_event",
  "type": "tracker.new",
  "retry_count": 0,
  "webhook_setting_id": 335777,
  "data": {
    "object": {
      "id": 345666,
      "object": "tracker",
      "carrier": {
        "name": "Colissimo",
        "code": "colissimo"
      },
      "carrier_service": {
        "code": "base",
        "name": "Base"
      },
      "carrier_code": "colissimo",
      "carrier_tracking_url": "http://www.laposte.fr/outils/suivre-vos-envois?code=AZ123456789BE",
      "created_at": 1530213415,
      "custom_variables": {
      },
      "delivered_at": null,
      "delivery_status_code": "pending",
      "shipped_at": null,
      "first_delivery_attempted_at": null,
      "displayable_expected_delivery_date": null,
      "displayable_expected_delivery_datetime": null,
      "displayable_expected_delivery_kind": null,
      "tracking_number": "AZ123456789BE",
      "uuid": "00000000-0000-0000-0000-000000000000",
      "fulfillment": {
        "id": 36789,
        "object": "fulfillment",
        "merchant_id": "internal_id_1234",
        "fulfillment_number": "XYZABCD_1",
        "custom_variables": {
        },
        "order": {
          "id": 311111,
          "object": "order",
          "order_number": "ABCD123",
          "merchant_id": "internal_id_9876",
          "email": "[email protected]",
          "phone": null,
          "uuid": "00000000-0000-0000-0000-000000000000",
          "ordered_at": 1529867815,
          "custom_variables": {
          }
        },
        "shipping_address": {
          "id": 322222,
          "object": "address",
          "comment": null,
          "city": "Paris",
          "country": "France",
          "country_code": "FR",
          "state": null,
          "address1": "1, rue de Rivoli",
          "address2": null,
          "zip": "75001",
          "company_title": "ACME Corp",
          "first_name": "John",
          "last_name": "Doe",
          "name": "John Doe"
        }
      },
      "pickup_point": {
        "opening_hours": {
          "tue": "06:30-19:00"
        },
        "closed_dates": {
          "01/05/2021": true,
          "25/12/2021": true
        },
        "special_openings": {
        },
        "phone": "+33612345678",
        "address": {
          "id": 77333,
          "object": "address",
          "comment": null,
          "city": "Paris",
          "country": "France",
          "country_code": "FR",
          "state": null,
          "address1": "1 place du 11 novembre 1918",
          "address2": null,
          "zip": "75010",
          "company_title": null,
          "first_name": null,
          "last_name": null,
          "name": null
        },
        "map": {
          "banner_url": "https://shipup-assets-prod.s3.eu-west-1.amazonaws.com/pickup_point_banners/colissimo/CONSIGNE PICKUP GARE DE L EST/097095.jpg",
          "google_maps_link": "https://www.google.com/maps/search/?api=1&query=48.876932%2C2.359989"
        }
      }
    },
    "reason": {
      "kind": "new",
      "tracker_id": 345666
    }
  }
}

At the first level, you'll find general technical information about the webhook. Within the data field, you'll find detailed information about the tracker. If you need further details about any tracker fields, refer to the documentation here. Additionally, you'll find objects related to the carrier, such as the order object and fullfilment, based on the information available at the time the tracker is created.