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!
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
status	FulfillmentOrderStatus!	Fulfillment status
order	Order	Associated order
parcels	[FulfillmentParcel!]!	Shipment parcels
createdAt	DateTime!	Creation timestamp

View complete definition: FulfillmentOrder Object Definition

Recipient Type

Customer delivery information.

Field	Type	Description
email	String!	Recipient email
firstName	String!	Given name
lastName	String!	Family name
phone	String	Phone number
address	Address!	Delivery address details

Address Type

Physical address information.

Field	Type	Description
street1	String!	Street address line 1
street2	String	Street address line 2
city	String!	City name
postCode	String!	Postal code
country	String!	Country code

OrderProduct Type

Product details within an order.

Field	Type	Description
id	ID!	Product line item ID
title	String!	Product name
sku	String	Product SKU
quantity	Int!	Ordered quantity
price	Float!	Unit price

Collection Type (Collect)

Batch of orders for carrier pickup.

Field	Type	Description
id	ID!	Collection ID
organizationId	ID!	Organization ID
status	CollectStatus!	Current collection status
fulfillmentOrders	[FulfillmentOrder!]!	Orders in collection
createdAt	DateTime!	Creation timestamp

View complete definition: Collection Object Definition

Expeditor Type

Available carrier/shipper.

Field	Type	Description
id	ID!	Expeditor ID
code	String!	Carrier code
name	String!	Carrier name
services	[ExpeditorService!]!	Available shipping services

View complete definition: Expeditor Object Definition

Pickup Type

Organization pickup location.

Field	Type	Description
id	ID!	Pickup location ID
name	String!	Location name
address	Address	Pickup address
schedule	[PickupSchedule!]!	Availability schedule

View complete definition: Pickup Object Definition

---

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.