Create an order.

URL Expired

The URL for this request expired after 30 days.

Fulfillment Type

Type: string
Enum: Fulfillment methodology of the shipment.

Allowed:

• customer
• at_large
• returns
• hundredweight
• reship
• unknown

Order Source

Type: string
Enum: The source of this order whether it is from the shipium system or externally created.

Allowed:

• shipium
• external

Partner Order ID

Type: string
An optional custom identifier that may be used for this order.

Associated Identifiers

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

Tenant ID

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

Ordered Date Time

Type: date-time
Required: The timestamp for when the customer ordered the product. The timestamp must be a valid ISO 8601 timestamp.

Order Item Quantities

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

Ship From Address

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

Origin ID

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

Destination Address

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

Ship Option

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

Customs Info

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

Currency Code

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

Total Declared Value

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

Order Fulfillment Parameters

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

Response Codes

• 200: Order created.
• 400: Invalid inputs were provided for Order creation.

API Request Example

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

### API Response Example

- **Success**: `200`
- **Error**: `400`