Struct Shipments

Source

pub struct Shipments { /* private fields */ }

Expand description

Shipment operations for order fulfillment and delivery tracking

Implementations§

Source §

impl Shipments

Source

pub fn create(&self, input: CreateShipment) -> Result<Shipment>

Create a new shipment for an order

§Example

use stateset_embedded::{Commerce, CreateShipment, CreateShipmentItem, OrderId, ShippingCarrier};

let commerce = Commerce::new("./store.db")?;

let shipment = commerce.shipments().create(CreateShipment {
    order_id: OrderId::new(),
    carrier: Some(ShippingCarrier::Ups),
    recipient_name: "John Doe".into(),
    recipient_email: Some("john@example.com".into()),
    shipping_address: "456 Oak Ave, Town, ST 67890".into(),
    items: Some(vec![CreateShipmentItem {
        sku: "PROD-001".into(),
        name: "Product A".into(),
        quantity: 1,
        ..Default::default()
    }]),
    ..Default::default()
})?;

Source

pub fn get(&self, id: ShipmentId) -> Result<Option<Shipment>>

Get a shipment by ID

Source

pub fn get_by_number(&self, shipment_number: &str) -> Result<Option<Shipment>>

Get a shipment by shipment number

Source

pub fn get_by_tracking(&self, tracking_number: &str) -> Result<Option<Shipment>>

Find a shipment by tracking number

Source

pub fn update(&self, id: ShipmentId, input: UpdateShipment) -> Result<Shipment>

Update a shipment

Source

pub fn list(&self, filter: ShipmentFilter) -> Result<Vec<Shipment>>

List shipments with optional filtering

Source

pub fn for_order(&self, order_id: OrderId) -> Result<Vec<Shipment>>

Get all shipments for an order

An order may have multiple shipments for partial fulfillment.

Source

pub fn mark_processing(&self, id: ShipmentId) -> Result<Shipment>

Mark shipment as processing (being prepared)

Source

pub fn mark_ready(&self, id: ShipmentId) -> Result<Shipment>

Mark shipment as ready to ship

Source

pub fn ship( &self, id: ShipmentId, tracking_number: Option<String>, ) -> Result<Shipment>

Ship the order (hand off to carrier)

§Example

use stateset_embedded::{Commerce, ShipmentId};

let commerce = Commerce::new("./store.db")?;

// Ship with a tracking number
let shipment = commerce.shipments().ship(
    ShipmentId::new(),
    Some("1Z999AA10123456784".into())
)?;

println!("Tracking URL: {:?}", shipment.tracking_url);

Source

pub fn mark_in_transit(&self, id: ShipmentId) -> Result<Shipment>

Mark shipment as in transit

Source

pub fn mark_out_for_delivery(&self, id: ShipmentId) -> Result<Shipment>

Mark shipment as out for delivery

Source

pub fn mark_delivered(&self, id: ShipmentId) -> Result<Shipment>

Mark shipment as delivered

This records the delivery timestamp and marks the shipment complete.

Source

pub fn mark_failed(&self, id: ShipmentId) -> Result<Shipment>

Mark shipment as failed delivery

Source

pub fn hold(&self, id: ShipmentId) -> Result<Shipment>

Put shipment on hold

Source

pub fn cancel(&self, id: ShipmentId) -> Result<Shipment>

Cancel a shipment

Source

pub fn add_item( &self, shipment_id: ShipmentId, item: CreateShipmentItem, ) -> Result<ShipmentItem>

Add an item to a shipment

Source

pub fn remove_item(&self, item_id: Uuid) -> Result<()>

Remove an item from a shipment

Source

pub fn get_items(&self, shipment_id: ShipmentId) -> Result<Vec<ShipmentItem>>

Get items in a shipment

Source

pub fn add_event( &self, shipment_id: ShipmentId, event: AddShipmentEvent, ) -> Result<ShipmentEvent>

Add a tracking event to the shipment history

§Example

use stateset_embedded::{Commerce, AddShipmentEvent, ShipmentId};

let commerce = Commerce::new("./store.db")?;

commerce.shipments().add_event(ShipmentId::new(), AddShipmentEvent {
    event_type: "departed_facility".into(),
    location: Some("Chicago, IL".into()),
    description: Some("Package departed sorting facility".into()),
    event_time: None, // Uses current time
})?;