Shipment Booking Initiation

{
  "digitalData": {
    "event": [
      {
        "eventInfo": {
          "eventId": "<event_id>",
          "eventName": "begin_checkout",
          "timestamp": "<iso_8601_timestamp>",
          "eventAction": "initiate"
        },
        "attributes": {
          "channel": "<channel>",
          "rate_id": "<rate_id>",
          "agent_id": "<agent_id>",
          "currency": "<iso_4217_currency_code>",
          "incoterm": "<incoterm_code>",
          "language": "<language_code>",
          "platform": "<platform>",
          "quote_id": "<quote_id>",
          "account_id": "<account_id>",
          "page_title": "<page_title>",
          "partner_id": "<partner_id>",
          "promo_code": "<promo_code>",
          "customer_id": "<pseudonymous_customer_id>",
          "pickup_date": "<yyyy-mm-dd>",
          "piece_count": 0,
          "volume_unit": "<volume_unit>",
          "weight_unit": "<weight_unit>",
          "event_source": "<event_source>",
          "login_status": "<logged_in_or_logged_out>",
          "total_volume": 0,
          "total_weight": 0,
          "customer_type": "<customer_type>",
          "delivery_date": "<yyyy-mm-dd>",
          "package_count": 0,
          "page_location": "<page_url>",
          "page_referrer": "<referrer_url>",
          "service_level": "<service_level>",
          "shipment_type": "<shipment_type>",
          "api_request_id": "<api_request_id>",
          "container_type": "<container_type>",
          "origin_country": "<iso_country_code>",
          "transport_mode": "<transport_mode>",
          "booking_channel": "<booking_channel>",
          "container_count": 0,
          "estimated_value": 0,
          "booking_draft_id": "<booking_draft_id>",
          "booking_flow_type": "<booking_flow_type>",
          "commodity_category": "<commodity_category>",
          "hazardous_material": false,
          "origin_location_id": "<origin_location_id>",
          "origin_postal_code": "<origin_postal_code>",
          "destination_country": "<iso_country_code>",
          "temperature_controlled": false,
          "destination_location_id": "<destination_location_id>",
          "destination_postal_code": "<destination_postal_code>",
          "estimated_shipping_cost": 0
        }
      }
    ]
  }
}

{
  "event": "begin_checkout",
  "channel": "<channel>",
  "rate_id": "<rate_id>",
  "agent_id": "<agent_id>",
  "currency": "<iso_4217_currency_code>",
  "event_id": "<event_id>",
  "incoterm": "<incoterm_code>",
  "language": "<language_code>",
  "platform": "<platform>",
  "quote_id": "<quote_id>",
  "ecommerce": {
    "items": [
      {
        "price": 0,
        "coupon": "<promo_code>",
        "item_id": "<rate_id>",
        "quantity": 1,
        "item_name": "Shipment service",
        "item_category": "<transport_mode>",
        "item_category2": "<shipment_type>",
        "item_category3": "<service_level>"
      }
    ],
    "value": 0,
    "currency": "<iso_4217_currency_code>"
  },
  "account_id": "<account_id>",
  "page_title": "<page_title>",
  "partner_id": "<partner_id>",
  "promo_code": "<promo_code>",
  "customer_id": "<pseudonymous_customer_id>",
  "pickup_date": "<yyyy-mm-dd>",
  "piece_count": 0,
  "volume_unit": "<volume_unit>",
  "weight_unit": "<weight_unit>",
  "event_source": "<event_source>",
  "login_status": "<logged_in_or_logged_out>",
  "total_volume": 0,
  "total_weight": 0,
  "customer_type": "<customer_type>",
  "delivery_date": "<yyyy-mm-dd>",
  "package_count": 0,
  "page_location": "<page_url>",
  "page_referrer": "<referrer_url>",
  "service_level": "<service_level>",
  "shipment_type": "<shipment_type>",
  "api_request_id": "<api_request_id>",
  "container_type": "<container_type>",
  "origin_country": "<iso_country_code>",
  "transport_mode": "<transport_mode>",
  "booking_channel": "<booking_channel>",
  "container_count": 0,
  "estimated_value": 0,
  "event_timestamp": "<iso_8601_timestamp>",
  "booking_draft_id": "<booking_draft_id>",
  "booking_flow_type": "<booking_flow_type>",
  "commodity_category": "<commodity_category>",
  "hazardous_material": false,
  "origin_location_id": "<origin_location_id>",
  "origin_postal_code": "<origin_postal_code>",
  "destination_country": "<iso_country_code>",
  "temperature_controlled": false,
  "destination_location_id": "<destination_location_id>",
  "destination_postal_code": "<destination_postal_code>",
  "estimated_shipping_cost": 0
}

{
  "data": {
    "api": {
      "requestId": "<api_request_id>"
    },
    "web": {
      "webReferrer": {
        "URL": "<referrer_url>"
      },
      "webPageDetails": {
        "URL": "<page_url>",
        "name": "<page_title>"
      }
    },
    "user": {
      "agentId": "<agent_id>",
      "language": "<language_code>",
      "accountId": "<account_id>",
      "partnerId": "<partner_id>",
      "customerId": "<pseudonymous_customer_id>",
      "loginStatus": "<logged_in_or_logged_out>",
      "customerType": "<customer_type>"
    },
    "channel": {
      "name": "<channel>",
      "platform": "<platform>",
      "bookingChannel": "<booking_channel>"
    },
    "commerce": {
      "rateId": "<rate_id>",
      "quoteId": "<quote_id>",
      "checkouts": {
        "value": 1
      },
      "promoCode": "<promo_code>",
      "currencyCode": "<iso_4217_currency_code>",
      "estimatedValue": 0,
      "estimatedShippingCost": 0
    },
    "shipment": {
      "incoterm": "<incoterm_code>",
      "pickupDate": "<yyyy-mm-dd>",
      "pieceCount": 0,
      "volumeUnit": "<volume_unit>",
      "weightUnit": "<weight_unit>",
      "totalVolume": 0,
      "totalWeight": 0,
      "deliveryDate": "<yyyy-mm-dd>",
      "packageCount": 0,
      "serviceLevel": "<service_level>",
      "shipmentType": "<shipment_type>",
      "containerType": "<container_type>",
      "originCountry": "<iso_country_code>",
      "transportMode": "<transport_mode>",
      "bookingDraftId": "<booking_draft_id>",
      "containerCount": 0,
      "bookingFlowType": "<booking_flow_type>",
      "originLocationId": "<origin_location_id>",
      "originPostalCode": "<origin_postal_code>",
      "commodityCategory": "<commodity_category>",
      "hazardousMaterial": false,
      "destinationCountry": "<iso_country_code>",
      "destinationLocationId": "<destination_location_id>",
      "destinationPostalCode": "<destination_postal_code>",
      "temperatureControlled": false
    },
    "eventInfo": {
      "eventId": "<event_id>",
      "eventName": "begin_checkout",
      "timestamp": "<iso_8601_timestamp>",
      "eventAction": "initiate",
      "eventSource": "<event_source>"
    }
  },
  "event": "begin_checkout"
}

{
  "web": {
    "webReferrer": {
      "URL": "<referrer_url>"
    },
    "webPageDetails": {
      "URL": "<page_url>",
      "name": "<page_title>"
    }
  },
  "commerce": {
    "checkouts": {
      "value": 1
    },
    "currencyCode": "<iso_4217_currency_code>"
  },
  "eventType": "commerce.checkouts",
  "timestamp": "<iso_8601_timestamp>",
  "environment": {
    "type": "<platform>"
  },
  "identityMap": {
    "accountId": [
      {
        "id": "<account_id>",
        "primary": false,
        "authenticatedState": "<authenticated_or_ambiguous>"
      }
    ],
    "customerId": [
      {
        "id": "<pseudonymous_customer_id>",
        "primary": true,
        "authenticatedState": "<authenticated_or_ambiguous>"
      }
    ]
  },
  "eventMergeId": "<event_id>",
  "_shipmentBooking": {
    "rateId": "<rate_id>",
    "agentId": "<agent_id>",
    "channel": "<channel>",
    "quoteId": "<quote_id>",
    "incoterm": "<incoterm_code>",
    "language": "<language_code>",
    "partnerId": "<partner_id>",
    "promoCode": "<promo_code>",
    "pickupDate": "<yyyy-mm-dd>",
    "pieceCount": 0,
    "volumeUnit": "<volume_unit>",
    "weightUnit": "<weight_unit>",
    "eventSource": "<event_source>",
    "loginStatus": "<logged_in_or_logged_out>",
    "totalVolume": 0,
    "totalWeight": 0,
    "apiRequestId": "<api_request_id>",
    "customerType": "<customer_type>",
    "deliveryDate": "<yyyy-mm-dd>",
    "packageCount": 0,
    "serviceLevel": "<service_level>",
    "shipmentType": "<shipment_type>",
    "containerType": "<container_type>",
    "originCountry": "<iso_country_code>",
    "transportMode": "<transport_mode>",
    "bookingChannel": "<booking_channel>",
    "bookingDraftId": "<booking_draft_id>",
    "containerCount": 0,
    "estimatedValue": 0,
    "bookingFlowType": "<booking_flow_type>",
    "originLocationId": "<origin_location_id>",
    "originPostalCode": "<origin_postal_code>",
    "commodityCategory": "<commodity_category>",
    "hazardousMaterial": false,
    "destinationCountry": "<iso_country_code>",
    "destinationLocationId": "<destination_location_id>",
    "destinationPostalCode": "<destination_postal_code>",
    "estimatedShippingCost": 0,
    "temperatureControlled": false
  },
  "productListItems": [
    {
      "SKU": "<rate_id>",
      "name": "Shipment service",
      "quantity": 1,
      "priceTotal": 0,
      "currencyCode": "<iso_4217_currency_code>",
      "productCategories": [
        {
          "categoryID": "<transport_mode>"
        },
        {
          "categoryID": "<shipment_type>"
        },
        {
          "categoryID": "<service_level>"
        }
      ]
    }
  ]
}

{
  "rate_id": "string - identifier of the carrier rate or pricing option selected at initiation",
  "user_id": "string - authenticated or pseudonymous identifier of the initiating user; must not contain a name or email address",
  "currency": "string - ISO 4217 currency code for the quoted amount",
  "event_id": "string - globally unique identifier for the event activation, used to remove technical duplicates",
  "quote_id": "string - identifier of the selected or originating freight quote when initiation follows quoting",
  "account_id": "string - customer, shipper, or business account identifier associated with the initiation",
  "actor_type": "string - initiating actor classification such as customer, carrier_partner, freight_forwarder, sales_agent, operations_agent, or api_client",
  "booking_id": "string - unique identifier assigned to the booking workflow or draft when available",
  "event_name": "string - canonical event name, expected to be shipment_booking_initiated",
  "session_id": "string - unique digital or agent-assisted interaction session identifier",
  "campaign_id": "string - marketing or commercial campaign identifier credited with the booking initiation when applicable",
  "device_type": "string - device classification such as desktop, mobile, tablet, handheld, server, or unknown",
  "entry_point": "string - workflow location from which booking began, such as dashboard, quote_result, shipment_template, reorder, tracking_page, or direct_api",
  "shipment_id": "string - unique shipment identifier when created at initiation; null if assigned later",
  "volume_unit": "string - unit for total_volume, restricted to a governed value such as m3, ft3, or l",
  "weight_unit": "string - unit for total_weight, restricted to a governed value such as kg, lb, or tonne",
  "sales_region": "string - governed sales or operating region responsible for the customer or shipment",
  "total_volume": "number - total declared shipment volume entered at initiation",
  "total_weight": "number - total declared shipment weight entered at initiation",
  "movement_type": "string - movement scope such as domestic, import, export, cross_border, or intra_regional",
  "package_count": "integer - number of packages, handling units, pallets, or pieces entered at initiation",
  "quoted_amount": "number - pre-tax freight amount presented or selected at initiation; null when pricing is not yet available",
  "service_level": "string - requested logistics service level such as economy, standard, express, same_day, or time_definite",
  "shipment_type": "string - shipment classification such as parcel, less_than_truckload, full_truckload, full_container_load, less_than_container_load, or bulk",
  "booking_status": "string - status immediately after initiation, such as initiated, draft, validation_pending, or quote_selected",
  "container_type": "string - requested container or equipment type such as dry_van, reefer, flatbed, 20ft_standard, or 40ft_high_cube",
  "correlation_id": "string - identifier linking client, API gateway, booking service, and transportation management system records for the same initiation",
  "transport_mode": "string - planned primary transportation mode such as road, air, ocean, rail, parcel, courier, or multimodal",
  "booking_channel": "string - channel used to initiate the booking, such as web, mobile_app, contact_center, branch, EDI, API, or partner_portal",
  "container_count": "integer - number of containers, trailers, or primary equipment units requested",
  "event_timestamp": "string - UTC timestamp in ISO 8601 format when the initiation action was accepted",
  "referral_source": "string - immediate referring source or partner that directed the actor into the booking workflow",
  "customer_segment": "string - governed commercial segment of the associated customer account",
  "initiation_action": "string - qualifying action that started the workflow, such as book_shipment_click, create_draft, accept_quote, duplicate_booking, or api_request",
  "commodity_category": "string - governed high-level category of goods planned for shipment",
  "draft_created_flag": "boolean - indicates whether a persistent booking draft was successfully created",
  "origin_location_id": "string - governed identifier for the planned pickup or shipment-origin location",
  "source_application": "string - application or system that generated the event",
  "application_version": "string - deployed application, portal, mobile app, or API version",
  "origin_country_code": "string - ISO 3166-1 alpha-2 country code for the planned origin",
  "authentication_state": "string - user state at initiation, such as authenticated, guest, delegated, service_account, or unknown",
  "origin_location_type": "string - origin classification such as residence, business, warehouse, store, port, terminal, or supplier",
  "requested_pickup_date": "string - requested pickup date in ISO 8601 date format, interpreted using the origin location time zone",
  "destination_location_id": "string - governed identifier for the planned delivery or shipment-destination location",
  "hazardous_material_flag": "boolean - indicates whether the shipment is declared or expected to contain regulated hazardous materials",
  "requested_delivery_date": "string - requested delivery date in ISO 8601 date format, interpreted using the destination location time zone",
  "destination_country_code": "string - ISO 3166-1 alpha-2 country code for the planned destination",
  "destination_location_type": "string - destination classification such as residence, business, warehouse, store, port, terminal, or customer_site",
  "temperature_controlled_flag": "boolean - indicates whether temperature-controlled transport or storage is requested"
}