Sign in

v1

latestOpenAPI 3.0.12026-07-2481208369.3 KB
carrier-selection

Run the carrier selection process on a existing partner shipment.

post/api/v1/deliveryexperience/shipment/{shipiumShipmentId}/carrierSelection

Path parameters

shipiumShipmentIdstring required

Request body

currencyCodestring required

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

shippedDateTimestring date-time

Date the shipment is expected to leave the warehouse.

asOfDatestring date-time

Date used to re-create a carrier selection as of a certain point in time. This parameter will prevent the use of caching for this request.

carrierServiceMethodAllowListstring[]

A list of carrierServiceMethodId and/or carriers that should be considered for selection.

ignoreRuleSetsboolean

When "true", rule sets will be ignored during carrier selection.

includeEvaluatedServiceMethodsInResponseboolean

Indicates if the partner passed in a field to expand carrier selection

includeLineItemsInEvaluatedServiceMethodsboolean

When "true" a response will include line item information for the returned evaluated service methods, provided that includeEvaluatedServiceMethodsInResponse is also set to true.

includeInjectionProfilesboolean

When "true", service methods from the configured InjectionProfiles will be considered during carrier selection.

ignoreCarrierMinimumDimensionsboolean

When "true", the minimum dimensions of carriers will effectively be ignored when deciding if a carrier service method is eligible to be considered during costing.

serviceMethodPoBoxAllowListstring[]

A list of serviceMethodIds that will be considered for USPS PO box delivery that otherwise would be filtered out as they don't support USPS PO box delivery for the shipment.

Example request

{
  "packagingType": {
    "packagingMaterial": "box",
    "packagingSizeName": "13x12x10 Box",
    "packagingTypeId": "ebd94f8b-d390-4c9c-987f-b88343f5bf45",
    "linearDimensions": {
      "linearUnit": "in",
      "length": 13,
      "width": 12,
      "height": 10
    },
    "packagingWeight": {
      "weightUnit": "lb",
      "weight": 50
    }
  }
}

Response

CarrierSelection provided.

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"
}