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.

Below you'll find all available operations and an interactive reference of core types with links to their complete definitions and usage examples.

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!
deleteFulfillmentOrders		DeleteFulfillmentOrdersResult!	Delete fulfillment orders. Returns successfully deleted items and partial error details. Max 100 IDs per request.
fulfillmentOrderIds		[ID!]!
deleteOrders		DeleteOrdersResult!	Delete orders. Returns successfully deleted items and partial error details. Max 100 IDs per request.
orderIds		[ID!]!
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

This section provides an overview of the main types used throughout the GraphQL API. Each type contains fields that may themselves be complex types - click on any type name to explore its complete definition.

Order Type

The primary object representing a customer order.

Field	Type	Description
id	ID!	Unique order identifier
ref	String!	Order reference number
status	OrderStatus!	Current order status
recipient	Recipient	Delivery recipient details
orderedAt	DateTime!	When the order was placed
orderProducts	[OrderProduct!]!	Products in the order
fulfillmentOrders	[FulfillmentOrder!]!	Associated fulfillment orders

View complete definition: Order Object Definition

FulfillmentOrder Type

Represents fulfillment operations for orders.

Field	Type	Description
id	ID!	Unique fulfillment order ID
orderId	ID!	ID of the parent order
wingRef	String!	Wing system reference
status	FulfillmentOrderStatus!	Fulfillment status
service	WingService!	Wing service used
isReturn	Boolean!	Whether this is a return fulfillment order
order	Order	Associated order
parcels	[Parcel!]!	Shipment parcels
createdAt	DateTime!	Creation timestamp

View complete definition: FulfillmentOrder Object Definition

Recipient Type

Delivery recipient information, embedded in an Order.

Field	Type	Description
id	ID!	Unique recipient identifier
orderId	ID!	ID of the parent order
firstName	String	First name
lastName	String!	Last name
fullName	String!	Full name
email	String	Email address
phone	String!	Phone number
company	String	Company name
line1	String!	Street address line 1
line2	String	Street address line 2
additional	String	Additional address information
city	String!	City
zip	String!	Postal code
countryCode	String!	ISO 3166-1 alpha-2 country code
createdAt	DateTime!	Creation timestamp
order	Order!	The parent order object

OrderProduct Type

Product line item within an order.

Field	Type	Description
orderId	ID!	ID of the parent order
productId	ID!	ID of the product
quantity	Int!	Ordered quantity
createdAt	DateTime!	Creation timestamp
order	Order!	The parent order object
product	Product!	The product object

Collection Type (Collect)

Batch of fulfillment orders grouped for a carrier pickup.

Field	Type	Description
id	ID!	Collection ID
status	CollectStatus!	Current collection status
isPlanned	Boolean!	Whether this collect is planned
shouldStartAt	DateTime!	Scheduled start time
shouldEndAt	DateTime!	Scheduled end time
parcelsCount	Int!	Total number of parcels
receivedParcelsCount	Int!	Number of parcels received by carrier
organizationPickupId	ID!	ID of the associated pickup point
organizationPickup	OrganizationPickup!	The associated pickup point object
createdAt	DateTime!	Creation timestamp

View complete definition: Collection Object Definition

OrganizationExpeditor Type

Carrier/expeditor configured for an organization.

Field	Type	Description
id	ID!	Expeditor ID
organizationId	ID!	Organization that owns this expeditor
company	String!	Company name
email	String!	Contact email
phone	String!	Contact phone
line1	String!	Street address line 1
city	String!	City
zip	String!	Postal code
countryCode	String!	Country code
createdAt	DateTime!	Creation timestamp
organizationPickup	[OrganizationPickup!]!	Pickup points linked to this expeditor

View complete definition: Expeditor Object Definition

OrganizationPickup Type

Pickup point configured for an organization.

Field	Type	Description
id	ID!	Pickup point ID
organizationId	ID!	Organization that owns this pickup
friendlyName	String!	Display name for this pickup point
line1	String!	Street address line 1
city	String!	City
zip	String!	Postal code
countryCode	String!	Country code
phone	String!	Contact phone
email	String!	Contact email
timezone	String!	Timezone for scheduled collects
areMultiDailyCollectsAuthorized	Boolean!	Whether multiple daily collects are allowed
organizationExpeditorId	ID!	Associated expeditor ID
createdAt	DateTime!	Creation timestamp

View complete definition: Pickup Object Definition

Parcel Type

Physical shipment unit associated with a fulfillment order.

Field	Type	Description
id	ID!	Unique parcel identifier
orderId	ID!	ID of the parent order
trackingId	String!	Carrier tracking number
trackingURL	String	URL to track the parcel on the carrier website
labelURL	String!	URL to download the shipping label
status	ParcelStatus!	Current parcel status
carrierService	CarrierService!	Carrier and service used for this parcel
carrierStatus	String	Raw carrier status string
isReturn	Boolean!	Whether this is a return parcel
createdAt	DateTime!	Creation timestamp
organizationExpeditor	OrganizationExpeditor!	Expeditor associated with this parcel
order	Order!	The parent order object
parcelProducts	[ParcelProduct!]!	Products included in this parcel
anomalies	[Anomaly!]!	Anomalies detected for this parcel
parcelEvents	[ParcelEvent]!	Tracking events for this parcel

View complete definition: Parcel Object Definition

DeleteOrdersResult Type

Result returned by the deleteOrders mutation. Supports partial success — orders that could not be deleted are listed in the error field.

Field	Type	Description
orders	[Order!]!	Successfully deleted orders
error	DeleteOrdersError	IDs that could not be deleted

DeleteOrdersError Type

Field	Type	Description
alreadyLabelOrderIds	[ID!]!	Orders that already have a label generated
inCollectOrderIds	[ID!]!	Orders currently in a collect
notFoundOrderIds	[ID!]!	Order IDs not found
withInvalidStatusOrderIds	[ID!]!	Orders with a status that prevents deletion

DeleteFulfillmentOrdersResult Type

Result returned by the deleteFulfillmentOrders mutation. Supports partial success — fulfillment orders that could not be deleted are listed in the error field.

Field	Type	Description
fulfillmentOrders	[FulfillmentOrder!]!	Successfully deleted fulfillment orders
error	DeleteFulfillmentOrdersError	IDs that could not be deleted

DeleteFulfillmentOrdersError Type

Field	Type	Description
alreadyLabelledIds	[ID!]!	Fulfillment orders that already have a label
inCollectIds	[ID!]!	Fulfillment orders currently in a collect
statusNotAllowedIds	[ID!]!	Fulfillment orders with a status that prevents deletion
notFoundIds	[ID!]!	Fulfillment order IDs not found

---

Navigation Tip: Click on any type name (shown in brackets like [Order](#order-type)) to jump to that type's details on this page. Then use the "View complete definition" links to access full documentation including all fields, nested types, and usage examples.