Skip to main content

markFulfillmentFulfilled

DEPRECATED

Use orderShipmentCreate with shipmentItems to record shipped quantities.

Records completion through the legacy fulfillment API. Deprecated: use orderShipmentCreate with explicit shipment items for new clients.

Marks a fulfillment for orders in the "ordered" or "in_progress" state that have been claimed. The fulfillment will transition from "in_progress" to "fulfilled" state when shipment information is received.

Requirements​

  • User must have mark_fulfillment_fulfilled permission
  • Company context must be provided (via X-Company-Id header)
  • Order must exist and be in "ordered" or "in_progress" state
  • Fulfillment must exist and be in "in_progress" state
  • Tracking number and shipped date are required

Arguments​

  • fulfillment_id (required): The ID of the fulfillment to mark as fulfilled
  • 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
  • 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 "fulfilled" status
  • Creates or updates a shipment through the shared shipment recording path
  • Records remaining fulfillment item quantities without requiring new input fields
  • Returns the fulfilled fulfillment
markFulfillmentFulfilled(
  input: MarkFulfillmentFulfilledInput!
): OrderFulfillment! @deprecated

Arguments​

markFulfillmentFulfilled.input ● MarkFulfillmentFulfilledInput! non-null input common​

Parameters for MarkFulfillmentFulfilled

Type​

OrderFulfillment object orders​

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.