Transportation release events

Note

These events are for customers that have opted-in to the new Orders (Modern/Next Generation) API. For example, customers with access to Supplier Portal will have access to these transportation release-related event payloads. If you are an existing Shipwell customer and want to migrate to the new Orders (Modern/Generation) API, contact your customer service representative. If you want to learn more as a new Shipwell customer contact sales here.

Background

Transportation releases are created/assigned when an order is added to a shipment . If the transportation release is unassigned then that means that the order is no longer associated with that shipment .
Transportation release items are the items on a shipment associated with particular order items, i.e. which items from the order are or will be fulfilled by the shipment . There may be one or more transportation releases per order to allow for multiple shipments to fulfill an order .
Transportation releases and transportation release items are created as a byproduct of building and releasing shipments related to orders in Orders (Modern/Next Generation) .

transportation_release.assigned

Example

Copy

Copied

{
   "release_type":"TRANSPORTATION",
   "released_to_shipping_plan_id":null,
   "released_to_shipment_id":"shipment_id",
   "released_to_shipment_reference_id":"ABC123",
   "released_to_shipment_origin_stop_id":"shipment_origin_stop_id",
   "released_to_shipment_destination_stop_id":"shipment_destination_stop_id",
   "id":"01HGTW4SST2VRZ37SNW5BXFAY1",
   "created_from_product_order_id":"01HGTW4SQ0NSY61CCG8HN33Y95",
   "items":[
      {
         "released_from_item_id":"01HGTW4SQ6TQ71TJAYSRJ713DZ",
         "released_to_shipping_plan_item_id":null,
         "released_to_shipment_item_id":"shipment_item_id",
         "id":"01HGTW4SSXHDAN426STHREDGMX"
      }
   ],
   "resource_type":"transportation_release",
   "self_link":"/purchase-orders/01HGTW4SQ0NSY61CCG8HN33Y95/releases/01HGTW4SST2VRZ37SNW5BXFAY1"
}

transportation_release.unassigned

Example

Copy

Copied

{
   "release_type":"TRANSPORTATION",
   "released_to_shipping_plan_id":null,
   "released_to_shipment_id":"shipment_id",
   "released_to_shipment_reference_id":"ABC123",
   "released_to_shipment_origin_stop_id":"shipment_origin_stop_id",
   "released_to_shipment_destination_stop_id":"shipment_destination_stop_id",
   "id":"01HGTW4SST2VRZ37SNW5BXFAY1",
   "created_from_product_order_id":"01HGTW4SQ0NSY61CCG8HN33Y95",
   "items":[
      {
         "released_from_item_id":"01HGTW4SQ6TQ71TJAYSRJ713DZ",
         "released_to_shipping_plan_item_id":null,
         "released_to_shipment_item_id":"shipment_item_id",
         "id":"01HGTW4SSXHDAN426STHREDGMX"
      }
   ],
   "resource_type":"transportation_release",
   "self_link":null
}

transportation_release.item.assigned

Example

Copy

Copied

{
   "released_from_item_id":"01HGTW4V5SQ140HSFSY6NBZJD7",
   "released_to_shipping_plan_item_id":null,
   "released_to_shipment_item_id":"shipment_line_item_id",
   "id":"01HGTW4V7RT86023M1EHKDANC5",
   "resource_type":"transportation_item_release",
   "self_link":null,
   "release_id":"01HGTW4V2ZVTE5B5Q6TK0JMA2Z"
}

transportation_release.item.unassigned

Example

Copy

Copied

{
   "released_from_item_id":"01HGTW4V5SQ140HSFSY6NBZJD7",
   "released_to_shipping_plan_item_id":null,
   "released_to_shipment_item_id":"shipment_line_item_id",
   "id":"01HGTW4V7RT86023M1EHKDANC5",
   "resource_type":"transportation_item_release",
   "self_link":null,
   "release_id":"01HGTW4V2ZVTE5B5Q6TK0JMA2Z"
}