V3 API Schema

This page documents the GraphQL schema for the Wing V3 API. The schema defines the Query and Mutation operations available, along with their associated input and return types.

For detailed usage examples and parameter documentation for each operation, please refer to the API Reference section in the sidebar.

Query

The Query type defines the read operations available in the V3 API.

Field	Argument	Type	Description
collects		[Collect!]!	Retrieve a list of collects
input		CollectsInput!
fulfillmentOrder		FulfillmentOrder!	Retrieve a single fulfillment order by ID
input		FulfillmentOrderInput!
fulfillmentOrders		[FulfillmentOrder!]!	Retrieve a list of fulfillment orders
input		FulfillmentOrdersInput!
order		Order!	Retrieve a single order by ID or reference
input		OrderInput!
orders		[Order!]!	Retrieve a list of orders
input		OrdersInput!
organizationExpeditors		[OrganizationExpeditor!]!	Retrieve a list of organization expeditors
input		OrganizationExpeditorsInput!
organizationPickups		[OrganizationPickup!]!	Retrieve a list of organization pickups
input		OrganizationPickupsInput!

Mutation

The Mutation type defines the write operations available in the V3 API.

Field	Argument	Type	Description
addFulfillmentOrdersToCollect		AddFulfillmentOrdersToCollectResult!	Add fulfillment orders to a collect
input		AddFulfillmentOrdersToCollectInput!
cancelFulfillmentOrderParcels		CancelFulfillmentOrderParcelsResult!	Cancel parcels for fulfillment orders
input		CancelFulfillmentOrderParcelsInput!
createFulfillmentOrder		FulfillmentOrder!	Create a new fulfillment order
input		CreateFulfillmentOrderInput!
createFulfillmentParcel		FulfillmentOrder!	Create a parcel for a fulfillment order
input		CreateFulfillmentParcelInput!
createFulfillmentReturnParcel		FulfillmentOrder!	Create a return parcel for a fulfillment order
input		CreateFulfillmentReturnParcelInput!
createOrder		Order!	Create a new order
input		OrderToCreateInput!
createReturnFulfillmentOrder		FulfillmentOrder!	Create a return fulfillment order
input		CreateReturnFulfillmentOrderInput!
mergeFulfillmentOrder		MergeFulfillmentOrderResult!	Merge fulfillment orders
input		MergeFulfillmentOrderInput!
migrateFulfillmentOrder		MigrateFulfillmentOrderResult!	Migrate a fulfillment order
input		MigrateFulfillmentOrderInput!
removeFulfillmentOrdersFromCollect		RemoveFulfillmentOrdersFromCollectResult!	Remove fulfillment orders from a collect
input		RemoveFulfillmentOrdersFromCollectInput!
splitFulfillmentOrder		SplitFulfillmentOrderResult!	Split a fulfillment order
input		SplitFulfillmentOrderInput!
upsertNextCollect		Collect!	Create or update the next collect
input		UpsertNextCollectInput!

Core Types

For detailed documentation on specific types and their fields, please refer to the individual operation pages in the API Reference section. Each operation page includes comprehensive parameter documentation with examples in multiple languages.