API Reference

All in one mega endpoint which allows end users to create a shipment, run carrier selection, and have the carrier generate a label based on the service level selected.

post
https://api.shipium.com/api/v1/shipment/carrierselection/label
Body Params
string
required

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

multiParcelShipmentParameters
object

Used for multi parcel shipment requests; mutually exclusive with createUsingExistingShipment and shipmentParameters. Details of the shipment plus each of its packages, including weight, package type, items, tags, and to/from addresses.

shipmentParameters
object

Request parameters used to create a shipment (not as part of the megaMethod flow).

createUsingExistingShipment
object

Used to reference an existing shipment; mutually exclusive with shipmentParameters and multiParcelShipmentParameters. Pass in a partnerShipmentId or shipiumShipmentId and we will look to see if the shipment exists. If both are supplied and point to the same shipment then we will continue on. If both are supplied and are not referencing the same shipment we will throw and error.

createUsingExistingOrder
object

Used to reference an existing order; fields required to complete the shipment should be passed in shipmentParameters. Pass in a partnerOrderId or shipiumOrderIand we will look to see if the shipment exists. If both are supplied and point to the same shipment then we will continue on. If both are supplied and are not referencing the same shipment we will throw and error.

boolean

When "true" a request to the selected carrier will be sent to generate a label for the shipment based on the information provided in the "labelParameters" field of this object. When "false"this step is skipped and the system will record what carrier service method would have generated a label for.

boolean

When "true" a request will expand information on the response to include unselected service methods that made it through filtering.

boolean

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

labelParameters
object

Information on the types of labels to be generated by the carrier, as will as if a manifest for the shipment is generated. This field is ignored if the "generateLabel" field is set to "false".

carrierServiceMethodAllowList
array of strings

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

carrierServiceMethodAllowList
boolean

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

boolean

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

injectionParameters
array of objects

A list of Injection Profiles 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.

injectionParameters
inlineReturnsLabel
object

Details of the shipment to be returned and its corresponding destination addresses, contact and fulfillmentContext details.

customerForwardLabels
array of objects

List of forward shipments originating from the customer. Each entry contains details about the individual package

customerForwardLabels
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 carrier selection.

Headers
string
string
Responses

Updated 5 months ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago