URL Expired

The URL for this request expired after 30 days.

fulfillmentType

string

enum

Fulfillment methodology of the shipment.

customerat_largereturnshundredweightreshipunknown

Allowed:

customer``at_large``returns``hundredweight``reship``unknown

orderSource

string

enum

The source of this order whether it is from the shipium system or externally created

shipiumexternal

Allowed:

shipium``external

partnerOrderId

string

An optional custom identifier that may be used for this order.

associatedIdentifiers

array of strings

Associated identifiers that are indexed to identify this order. This can be an LPN for instance that is bound to the order. Can be searched but not interchangeable with orderId.

associatedIdentifiers ADD string

tenantId

string

Either the shipium tenant ID or the partner provided tenant ID. When present, this is used to indicate the tenant associated with the order.

orderedDateTime

date-time

required

The timestamp for when the customer ordered the product. The timestamp must be a valid ISO 8601 timestamp.

orderItemQuantities

array of objects

required

A list of orderItems comprising the shipment.

orderItemQuantities* ADD object

shipFromAddress

object

Address details of the sold to party for customs purposes

shipFromAddressobject

originId

string

Origin where the order is assigned to. Cannot be assigned if shipFromAddress is also populated

destinationAddress

object

required

Address details of the sold to party for customs purposes

destinationAddressobject

shipOption

string

A high-level shipping option shown to or selected by a customer.

customsInfo

object

Customs information about the package for international shipping.

customsInfoobject

currencyCode

string

Currency used in the transaction resulting in the order.

totalDeclaredValue

object

The total monetary amount of the declared value for the package. This is what will be reimbursed if the package is damaged. If the declared value exceeds the carrier's free threshold, there may a surcharge for passing a declared value.

totalDeclaredValueobject

orderFulfillmentParameters

object

These represent hints that correspond to Shipment Parameters that can be specified ahead of shipment creation on the order. These can be overridden at the time of shipment creation.

orderFulfillmentParametersobject

X-DELEGATED-PARTNER-ID

string

``200 The orchestrated results of the order creation.

``400 Invalid inputs were provided.

Updated 28 days ago

Bearer

xxxxxxxxxx

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

{

"orderFulfillmentParameters": {

"deliveryParameters": {

"applyToSplits": false,

"saturdayDelivery": false

}

}

}

'

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

application/json

200400

Updated28 days ago