URL Expired

The URL for this request expired after 30 days.

Order Information

• 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
  Updates order having tenantId passed in.

• fulfillmentType
  string
  enum
  Fulfillment methodology of the shipment.

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

• orderItemQuantities
  array of objects
  required
  A list of orderItems comprising the shipment.

• shipFromAddress
  object
  Address details of the sold to party for customs purposes

• 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

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

• customsInfo
  object
  Customs information about the package for international shipping.

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

• X-DELEGATED-PARTNER-ID
  string

Responses

• 200
  The orchestrated results of the order creation.

• 400
  Invalid inputs were provided.

Sample API Request

curl --request PATCH \
     --url https://api.shipium.com/api/v1/packShip/order/orderId \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '  
{
  "orderFulfillmentParameters": {
    "deliveryParameters": {
      "applyToSplits": false,
      "saturdayDelivery": false
    }
  }
}
'  

Try It!

To start a request and see the response, choose an example:

• application/json
• Responses:
  • 200
  • 400