URL Expired

The URL for this request expired after 30 days.

Parameters

• shipiumShipmentId
  string
  required
  Parameters used in the carrier selection create request.

• currencyCode
  string
  required
  Currency in which all the rates for shipping carrier selection costs will be calculated in.

• shippedDateTime
  date-time
  Date the shipment is expected to leave the warehouse.

• packagingType
  object
  Fields describing the physical properties of the package.

• asOfDate
  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.

• carrierServiceMethodAllowList
  array of strings
  A list of carrierServiceMethodId and/or carriers that should be considered for selection.

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

• includeEvaluatedServiceMethodsInResponse
  boolean
  Indicates if the partner passed in a field to expand carrier selection.

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

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

• injectionParameters
  array of objects
  A list of Injection Profile and/or Injection Profile/Site tuples that should be considered during carrier selection. If an InjectionSite is specified, it must be accompanied by an InjectionProfile.

• ignoreCarrierMinimumDimensions
  boolean
  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.

• serviceMethodPoBoxAllowList
  array of strings
  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.

Response

• 200 CarrierSelection provided.
• 400 Invalid inputs were provided.

Example

curl --request POST \
     --url https://api.shipium.com/api/v1/deliveryexperience/shipment/shipiumShipmentId/carrierSelection \
     --header 'accept: application/json' \ 
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200
400