Skip to main content

markFulfillmentShipped

Marks a fulfillment as shipped in the V2 fulfillments state machine.

Marks a fulfillment for orders in the "accepted" state that have been sent. The fulfillment will transition from "sent" to "shipped" state when shipment information is received.

Requirements​

  • User must have mark_fulfillment_shipped permission
  • Valid brand context must be provided (via argument or X-Brand-Id header)
  • Order must exist and be in "accepted" state (for V2 orders)
  • Fulfillment must exist and be in "sent" state
  • Shipment ID, tracking number, and shipped date are required

Arguments​

  • fulfillment_id (required): The ID of the fulfillment to mark as shipped
  • order_id (required): The ID of the order the fulfillment belongs to
  • warehouse_id (required): The ID of the warehouse where the fulfillment is processed
  • fulfillment_integration_id (required): The ID of the fulfillment integration
  • shipment_id (required): The ID of the shipment
  • tracking_number (required): The tracking number for the shipment
  • shipped_date (required): The date when the shipment was shipped
  • tracking_url (optional): The tracking URL for the shipment
  • carrier_id (optional): The ID of the carrier
  • carrier_service_id (optional): The ID of the carrier service
  • external_carrier_code (optional): External carrier code from the integration
  • external_service_code (optional): External service code from the integration
  • weight (optional): The weight of the shipment
  • length (optional): The length of the shipment
  • width (optional): The width of the shipment
  • height (optional): The height of the shipment
  • cost (optional): The cost of the shipment
  • package_type (optional): The type of package
  • metadata (optional): JSON metadata for the shipment
  • external_id (optional): External system reference ID

Behavior​

  • Marks fulfillment with "shipped" status
  • Creates or updates OrderShipment record with shipment information
  • Returns the shipped fulfillment
markFulfillmentShipped(
  input: MarkFulfillmentShippedInput!
): OrderFulfillment!

Arguments​

markFulfillmentShipped.input ● MarkFulfillmentShippedInput! non-null input​

Parameters for MarkFulfillmentShipped

Type​

OrderFulfillment object​

This type represents an order fulfillment. An order can have multiple fulfillments, each one associated with a warehouse and a party that fulfilled the order.