Get Purchase Order Release

SecurityAPIKeyHeader
Request
path Parameters
release_id
required
string (Release Id)
order_id
required
string (Order Id)
Responses
200

Successful Response

Response Schema: application/json
release_type
string (Release Type)
Default: "TRANSPORTATION"

Type of the release

Value: "TRANSPORTATION"
released_to_shipping_plan_id
string (Released To Shipping Plan Id)

Shipping plan id onto which this release was released.

released_to_shipment_id
string (Released To Shipment Id) <= 48 characters

Shipment id (v2 Shipment) onto which this release was released.

released_to_shipment_reference_id
string (Released To Shipment Reference Id) <= 6 characters

Shipment reference id (v2 Shipment) onto which this release was released.

released_to_shipment_origin_stop_id
string (Released To Shipment Origin Stop Id) <= 48 characters

Origin stop id of Shipment(v2 Shipment) onto which this release was released.

released_to_shipment_destination_stop_id
string (Released To Shipment Destination Stop Id) <= 48 characters

Destination stop id of Shipment(v2 Shipment) onto which this release was released.

id
required
string (Id)

The id of the Transportation Release

created_from_product_order_id
required
string (Created From Product Order Id)

The id of the Order that this release was created from

transit_status
string (TransitStatus)

An enumeration.

Enum: "DISPATCHED" "IN_TRANSIT" "OUT_FOR_DELIVERY" "DELIVERED"
unassigned_at
string <date-time> (Unassigned At)

Date on which the Transportation Release was disassociated from the Shipment/Shipping Plan

required
Array of objects (Items) non-empty
400

Validation Error

get/purchase-orders/{order_id}/releases/{release_id}
Request samples
Response samples
application/json
{
  • "release_type": "TRANSPORTATION",
  • "released_to_shipping_plan_id": "string",
  • "released_to_shipment_id": "string",
  • "released_to_shipment_reference_id": "string",
  • "released_to_shipment_origin_stop_id": "string",
  • "released_to_shipment_destination_stop_id": "string",
  • "id": "string",
  • "created_from_product_order_id": "string",
  • "transit_status": "DISPATCHED",
  • "unassigned_at": "2019-08-24T14:15:22Z",
  • "items": [
    ]
}
Copyright © Shipwell 2024. All right reserved.