Appearance
UpsertShipmentInput
Type: Input
Input for creating or updating a shipment
Fields
| Name | Type | Default | Description |
|---|---|---|---|
| carrierId | CarrierID | Associated carrier ID | |
| currency | CurrencyISO | Currency code | |
| deliveredAt | ISO8601 | Delivered timestamp (ISO8601) | |
| estimatedDeliveryAt | ISO8601 | Estimated delivery timestamp (ISO8601) | |
| id | ShipmentID | Optional ID for updates | |
| notes | String | Optional notes | |
| orderId | OrderID | Associated order ID | |
| shipmentNumber | String | Shipment number | |
| shippedAt | ISO8601 | Shipped timestamp (ISO8601) | |
| shippingAddressId | AddressID | Shipping address ID | |
| shippingCost | Float | Shipping cost | |
| status | ShipmentStatus | Shipment status | |
| totalPackages | Int | Total number of packages | |
| totalWeight | Float | Total weight | |
| trackingNumber | String | Tracking number | |
| trackingUrl | String | Tracking URL |