Updates an order to be packed.

URL Expired

The URL for this request expired after 30 days.

Order Parameters

• orderId

  • Type: string
  • Required
  • Description: 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

  • Type: string
  • Description: Updates order having tenantId passed in.

• fulfillmentType

  • Type: string
  • Enum: Fulfillment methodology of the shipment.

• associatedIdentifiers

  • Type: array of strings
  • Description: 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

  • Type: array of objects
  • Required
  • Description: A list of orderItems comprising the shipment.

• shipFromAddress

  • Type: object
  • Description: Address details of the sold to party for customs purposes.

• originId

  • Type: string
  • Description: Origin where the order is assigned to. Cannot be assigned if shipFromAddress is also populated.

• destinationAddress

  • Type: object
  • Required
  • Description: Address details of the sold to party for customs purposes.

• shipOption

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

• customsInfo

  • Type: object
  • Description: Customs information about the package for international shipping.

• currencyCode

  • Type: string
  • Description: Currency used in the transaction resulting in the order.

• totalDeclaredValue

  • Type: object
  • Description: 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

  • Type: object
  • Description: 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

• X-DELEGATED-PARTNER-ID
  • Type: string

Response Codes

• 200 - The orchestrated results of the order creation.
• 400 - Invalid inputs were provided.

Example 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  
    }  
  }  
}  
'  

API Response