URL Expired

The URL for this request expired after 30 days.

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.

The request params provided.

packagingType
object

Fields describing the physical properties of the package.

packagingType object

totalWeight
object

The weight of this type of packaging empty.

totalWeight object

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

labelParameters object

inlineReturnsLabel
object

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

inlineReturnsLabel object

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.

truefalse

shipmentParameters
object

Shipment parameters for the pack and ship request

shipmentParameters object

carrierSelectionOptions
object

Options to influence the results of carrier selection

carrierSelectionOptions object

splitOrder
boolean

When true, this is a signal that the order submit will execute a split shipment. It is expected that either the splitReferenceId is set pointing to a pre-defined split in the referenced order order.orderFulfillmentParameters.splitParameters[splitReferenceId], or an ad hoc runtime is defined in this object at: splitParameters

truefalse

splitReferenceId
string

When splitOrder is true, this field is used to reference a pre-existing split in the order referenced by this split at order.orderFulfillmentParameters.splitParameters[splitReferenceId]. Note that if both this field and splitParameters are set this field will be used to execute the split.

splitParameters
object

When splitOrder is true, this field is used to define a ad hoc runtime split of items from the referenced order. Once this submit is completed, the information defined will be stored in the order at: order.orderFulfillmentParameters.splitParameters[splitReferenceId]. Note that this field is ignored if the field splitReferenceId is supplied at submit.

splitParameters object

X-DELEGATED-PARTNER-ID
string

`` 200 The results of the order submission.

`` 400 Invalid inputs were provided.

Example Request:

curl --request POST \

--url https://api.shipium.com/api/v1/packShip/order/orderId/submit \

--header 'accept: application/json' \

--header 'content-type: application/json'

Response Codes:

200 - Success
400 - Invalid Inputs