Sign in

v1

latestOpenAPI 3.0.12026-07-2481208369.3 KB
carrier-selection

Retrieve a existing carrier selection.

get/api/v1/deliveryexperience/shipment/{shipiumShipmentId}/carrierSelection/{carrierSelectionId}

Path parameters

shipiumShipmentIdstring required
carrierSelectionIdstring required

Query parameters

includeCancelledboolean

Headers

X-DELEGATED-PARTNER-IDstring

Response

CarrierSelection retrieved.

carrierSelectionIdstring

Unique id of the carrier selection for later lookup.

shipiumShipmentIdstring

The unique identifier for this shipment.

partnerShipmentIdstring

The optional unique identifier that may be used for this shipment.

shipiumTenantIdstring

The shipium generated tenant ID. When present, this is used to indicate the tenant associated with the shipment.

partnerTenantIdstring

The partner provided tenant ID. When present, this is used to indicate the tenant associated with the shipment.

costAdjustConfigIdstring

If specified, this is the dynamic costing config applied for the carrier selection

carrierSelectionDateTimestring date-time

ISO-8601 formatted date when the carrier selection decision was made.

carrierSelectionExpirationstring date-time

ISO-8601 formatted date defining the point in time when the carrier selection details expire and cannot be acted upon.

cancellationDateTimestring date-time

The timestamp for when a carrier selection was cancelled. This field will default to null when the carrier selection is not cancelled. A carrier selection cannot be cancelled if it is associated with an active label

currencyCodestring

Currency in which all the rates for shipping carrier selection costs were calculated in.

Example response

{
  "carrierDecision": {
    "injectionDetails": {
      "injectionCostDetails": {
        "injectionLineItemRate": 2.3,
        "injectionLineItemCurrencyCode": "usd"
      }
    },
    "currencyCode": "USD"
  },
  "laneMatch": {
    "laneId": "asdqwdq-qwd123ds-123asdwd-123asd",
    "partnerLaneId": "custom partner provided id"
  },
  "cancellationDateTime": "2024-10-31T10:50:11.123456Z",
  "currencyCode": "USD"
}