Pack and ship order.

URL Expired

The URL for this request expired after 30 days.

Order Parameters

• orderId
  string, required
  The Shipium-generated order ID (shipiumOrderId) or the partner-provided order ID (partnerOrderId). When using the partnerOrderId, only orders in a non-cancelled state will match. Orders that have been cancelled will not be found by their partnerOrderId.

• tenantId
  string
  Submits order to print label having tenantId passed in.

Packaging Type

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

• totalWeight
  object
  The weight of this type of packaging empty.

Label Parameters

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

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

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

Shipment Parameters

• shipmentParameters
  object
  Shipment parameters for the pack and ship request.

• carrierSelectionOptions
  object
  Options to influence the results of carrier selection.

• splitOrder
  boolean
  When true, this is a signal that the order submit will execute a split shipment...

• splitReferenceId
  string
  When splitOrder is true, this field is used to reference a pre-existing split in the order referenced by this split...

• splitParameters
  object
  When splitOrder is true, this field is used to define a ad hoc runtime split of items from the referenced order...

Response Codes

• 200
  The results of the order submission.

• 400
  Invalid inputs were provided.

Example cURL Request

curl --request POST \
     --url https://api.shipium.com/api/v1/packShip/order/orderId/submit \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Try It!

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

• application/json

• 200

• 400