API Reference

Creates an order to be packed.

post
https://api.shipium.com/api/v1/packShip/order
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

Fulfillment methodology of the shipment.

Allowed:
string
enum

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

Allowed:
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
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.

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*
shipFromAddress
object

Address details of the sold to party for customs purposes

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

string

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

customsInfo
object

Customs information about the package for international shipping.

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.

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.

Headers
string
Responses

Updated 5 months ago

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

Updated 5 months ago