API Reference

Create Shipment

post
https://api.shipium.com/api/v1/deliveryexperience/shipment

Create a shipment from a set of existing Delivery Estimates and quantities.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

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

string

An optional unique identifier that may be used for this shipment.

date-time

The timestamp for when customer placed an order for this product. The timestamp must be a valid ISO 8601 timestamp.

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.

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

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

int32

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

boolean

Forces the packages array to be populated for all non multi parcel shipments.

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.

date-time

The timestamp for when the package was delivered to the customer. The timestamp must be a valid ISO 8601 timestamp.

string

The carrier that was used for delivering the package to your customer.

string

Carrier's tracking identification for the package.

orderItemQuantities
array of objects

A list of orderItems comprising the shipment.

orderItemQuantities
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

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.

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

boolean

Indicates that this shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday

string
enum

The delivery Signature Option to be passed on to the carrier. Defaults to none.

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

string

A shipiumOriginId or partnerOriginId to identify which originthe shipment will be processed at.

string

A string passed to carriers for a delivery note.

string

String passed to carriers as a reference.

string

String passed to carriers as a reference2.

string

String passed to carriers as a reference3.

string

String passed to carriers as a reference4.

string

String passed to carriers as a reference5.

string

Partner supplied string passed to carriers as a reference.

string

Partner supplied string passed to carriers as a reference2.

string

String passed to carriers as a purchase order identifier.

string

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

string

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

string
enum

Fulfillment methodology of the shipment.

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

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.

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.

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

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. If a selected carrier does not have a corresponding third-party billing account in this list and lacks a configuration in the fulfillment context, third-party billing will not be applied for that label. Conversely, if a third-party billing configuration exists in the fulfillment context and this value is provided, the value specified here will take precedence over the configured value.

thirdPartyBillingAccounts
collectBilling
object

Describes the details for a shipment having billing term as Collect.

configurationOverrides
object
payorAccounts
array of objects

Represents the list of payor accounts associated with the shipment Each account corresponds to a specific carrier and is used to determine the entity responsible for shipping charges when billing terms require a designated payor. If a selected carrier does not have a corresponding payor account in this list,standard billing configurations will apply.

payorAccounts
string

Used to correlate parcels to label documents from the carrier.

string
enum

AddressServiceRequested, ForwardingServiceRequested, ChangeServiceRequested, ReturnServiceRequested, CarrierLeaveIfNoResponse

Allowed:
boolean

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

Responses

Updated 6 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 6 months ago