Skip to main content

shipmentUpdate

Update an existing shipment with new information and status changes.

Modifies shipment details such as expected delivery dates, status updates, and other shipment metadata. This operation supports partial updates where only provided fields are modified, preserving existing values for omitted fields. Essential for tracking shipment progress and updating delivery expectations.

Update capabilities include:

  • Expected delivery date modifications
  • Status transitions (processing, shipped, delivered, etc.)
  • Carrier and tracking information updates
  • Delivery address corrections

Validation requirements:

  • Shipment ID must reference an existing, accessible shipment
  • Status transitions must follow valid shipment lifecycle rules
  • Expected delivery dates must be reasonable and in the future
  • Only authorized users can perform status transitions

The update operation maintains audit trail and triggers appropriate events for downstream systems including customer notifications and inventory updates.

Possible errors:

  • SHIPMENT_UPDATE_ERROR: Failed to update the shipment due to system error
  • SHIPMENT_NOT_FOUND_ERROR: Shipment with specified ID does not exist
  • VALIDATION_ERROR: Input validation failed (invalid dates, status, or references)
  • FORBIDDEN: Insufficient permissions to update shipments

AUTH: Role=[order.OWNER,order.EDITOR]

shipmentUpdate(
  id: String!
  input: ShipmentUpdateInput!
): Shipment!

Arguments​

shipmentUpdate.id ● String! non-null scalar​

Unique UUID identifier of the shipment to update.

Must reference an existing shipment that is accessible to the current user.

shipmentUpdate.input ● ShipmentUpdateInput! non-null input​

Shipment update data with fields to modify.

Only provided fields will be updated - omitted fields remain unchanged. Supports partial updates for flexible shipment management including status changes, delivery date adjustments, and tracking information updates.

Type​

Shipment object​

Shipment entity representing a package or delivery containing order items with tracking and fulfillment information