| Time | Status | User Agent |  |
| :-- | :-- | :-- | :-- |
| Make a request to see history. |

#### URL Expired

The URL for this request expired after 30 days.

Request parameters used to create a shipment (not as part of the megaMethod flow).

- **partnerShipmentId**  
  *string*  
  An optional unique identifier that may be used for this shipment.

- **orderedDateTime**  
  *date-time*  
  The timestamp for when customer placed an order for this product. The timestamp must be a valid ISO 8601 timestamp.

- **shippedDateTime**  
  *date-time*  
  The timestamp for when you (or your fulfillment partner) shipped the product from your (or their) warehouse. The timestamp must be a valid ISO 8601 timestamp.

- **desiredDeliveryDate**  
  *string*  
  The string representation of either an ISO-8601 date or a LocalDate: yyyy-mm-dd. The date or datetime the package is intended to arrive to the customer. This will be used to determine the most appropriate service method when generating a label.

- **preferredCarrierDeliveryDateTime**  
  *date-time*  
  The string representation of either an ISO-8601 date. The datetime the package is intended to arrive to the customer. This will be passed through to the carrier.

- **desiredDeliveryDateOptions**  
  *object*  
  Options for how the system will use the desiredDeliveryDate

- **businessDaysOfTransit**  
    *int32*  
    Indicates the number of business days from the ship time by when the shipment needs to be delivered.

- **includePackagesArray**  
    *boolean*  
    Forces the packages array to be populated for all non-multi parcel shipments.

- **ignoreUpgradeSpendLimits**  
    *boolean*  
    Indicates that this shipment can ignore all the partner-configured upgrade limits for the potential upgrade required to deliver the shipment by the desired delivery date.

- **deliveredDateTime**  
  *date-time*  
  The timestamp for when the package was delivered to the customer. The timestamp must be a valid ISO 8601 timestamp.

- **carrierName**  
  *string*  
  The carrier that was used for delivering the package to your customer.

- **carrierTrackingId**  
  *string*  
  Carrier's tracking identification for the package.

- **orderItemQuantities**  
  *array of objects*  
  A list of orderItems comprising the shipment.
  
- **shipFromAddress**  
  *object*  
  required  
  Address details of the sold to party for customs purposes

- **destinationAddress**  
  *object*  
  required  
  Address details of the sold to party for customs purposes

- **returnToAddress**  
  *object*  
  Address details of the sold to party for customs purposes

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

- **packagingType**  
  *object*  
  Fields describing the physical properties of the package.

- **totalWeight**  
  *object*  
  The weight of this type of packaging empty.

- **shipmentTags**  
  *array of strings*  
  A collection of free-form tags that may be added to this shipment.

- **customsInfo**  
  *object*  
  Customs information about the package for international shipping.

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

- **saturdayDelivery**  
  *boolean*  
  Indicates that this shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday.

- **deliverySignatureOption**  
  *string*  
  The delivery Signature Option to be passed on to the carrier. Defaults to none.

- **lastMileDeliveryOptions**  
  *object*  
  A collection of fields used for instructing carriers on how to handle last mile delivery.

- **pickupWindow**  
  *object*  
  A string passed to carriers for a delivery window.

- **deliveryWindow**  
  *object*  
  A string passed to carriers for a delivery window.

- **originId**  
  *string*  
  A shipiumOriginId or partnerOriginId to identify which origin the shipment will be processed at.

- **deliveryNote**  
  *string*  
  A string passed to carriers for a delivery note.

- **referenceIdentifier**  
  *string*  
  String passed to carriers as a reference.

- **partnerReferenceIdentifier**  
  *string*  
  Partner supplied string passed to carriers as a reference.

- **purchaseOrderIdentifier**  
  *string*  
  String passed to carriers as a purchase order identifier.

- **carrierProcessingId**  
  *string*  
  Carrier-provided identifier, supplied when it is needed to process the shipment.

- **fulfillmentContext**  
  *string*  
  When present, this is used to limit carrier selection to carrier accounts that contain a matching fulfillmentContext.

- **fulfillmentType**  
  *string*  
  Fulfillment methodology of the shipment.

- **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 shipment.

- **thirdPartyBillingSetId**  
  *string*  
  Either the shipium third party billing set ID or the partner provided third party billing set ID. When present, this is used to indicate the third party billing set that should be used for the billing of the shipment.

- **forceThirdPartyBilling**  
  *boolean*  
  Indicates that third party billing is a requirement for this shipment, no service method should be selected that does not support third party billing.

- **fulfillmentContextIds**  
  *array of strings*  
  A collection of fulfillmentContextIds or fulfillmentContext aliases to use in the FulfillmentContextDetail search.

- **orderSourceName**  
  *string*  
  Field that is used to determine source of order. This field may be utilized to inform carrier of the source of the order for handling.

- **testMode**  
  *boolean*  
  Indicates that a testMode shipment will be created. Carrier selection will consider carriers and service methods in test mode and label generation will generate a test label.

- **thirdPartyBillingAccounts**  
  *array of objects*  
  deprecated  
  Used to indicate the third-party billing account associated with the shipment. Each account is tied to a specific carrier and will only be used if the associated carrier is selected for label creation.

- **collectBilling**  
  *object*  
  Describes the details for a shipment having billing term as Collect.

- **configurationOverrides**  
  *object*  
  configurationOverrides object

- **payorAccounts**  
  *array of objects*  
  Represents the list of payor accounts associated with the shipment. Each account corresponds to a specific carrier.

- **packageReferenceIdentifier**  
  *string*  
  Used to correlate parcels to label documents from the carrier.

- **endorsementType**  
  *string*  
  enum

Allowed:

`AddressServiceRequested``ForwardingServiceRequested``ChangeServiceRequested``ReturnServiceRequested``CarrierLeaveIfNoResponse`

- **useShipFromAddressInRequest**  
  *boolean*  
  Describes whether or not to use the shipFromAddress in the request (instead of the address which is configured on the origin).

- **emergencyResponseInfo**  
  *object*  
  Emergency Response Info Provider (ERIP) contact details for 24/7 emergency response. Used for hazmat shipments.

- **documentGenerationRequests**  
  *array of objects*  
  A list of document generation requests. Each entry references a document blueprint by its Shipium ID or partner-provided alias.

# `` 200      Shipment ship successful.

# `` 400      Invalid inputs were provided.

# `` 403      Not authenticated / authorized via OAuth.

# `` 404      Unable to find the deliveryEstimateId to update.

Updated 28 days ago

* * *

ShellNodeRubyPHPPython

Bearer
``

xxxxxxxxxx

curl --request POST \

--url https://api.shipium.com/api/v1/deliveryexperience/shipment \

--header 'accept: application/json' \

--header 'content-type: application/json'
``

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

application/json

``200``400``403``404

Updated 28 days ago

* * *