Pack and ship order.

post

https://api.shipium.com/api/v1/packShip/order/{orderId}/submit

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

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.

Query Params

tenantId

string

Submits order to print label having tenantId passed in.

Body Params

The request params provided.

packagingType

object

Fields describing the physical properties of the package.

totalWeight

object

The weight of this type of packaging empty.

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

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.

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. It is expected that either the splitReferenceId is set pointing to pre-defined split in the referenced order order.orderFulfillmentParameters.splitParameters[splitReferenceId], or a ad hoc runtime is defined in this object at: splitParameters

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.

Headers

X-DELEGATED-PARTNER-ID

string

Responses

200The results of the order submission.

400Invalid inputs were provided.