createOrder

createOrder

Create a new order in the system.

Parameters

inputrequiredOrderToCreateInput

Order creation input

Returns

Order object with all nested relationships resolved

mutation {
  createOrder(input: {
    ref: "ORD-2024-001"
    recipient: {
      firstName: "John"
      lastName: "Doe"
      email: "john@example.com"
      phone: "+33123456789"
      line1: "123 Main St"
      city: "Paris"
      zip: "75001"
      countryCode: "FR"
    }
    fulfillmentOrders: [
      {
        service: STANDARD
        products: [
          {
            designation: "Product Name"
            sku: "SKU-001"
            quantity: 2
            price: 29.99
            weight: 0.5
          }
        ]
      }
    ]
  }) {
    id
    ref
    status
    fulfillmentOrders {
      id
    }
  }
}

Input Types Details

Click to expand and view the complete structure of nested input types:

RecipientToCreateInput - Delivery recipient information

Recipient delivery information for order creation. Represents the person or entity receiving the shipment.

Field	Type	Required	Description
email	EmailAddress	✓	Email address of the recipient
firstName	String	✓	First name of the recipient
lastName	String	✓	Last name of the recipient
phone	PhoneNumber	✓	Phone number for contact
line1	String	✓	Primary street address
line2	String		Secondary address line (apartment, suite, etc.)
city	String	✓	City name
zip	ZipCode	✓	Postal code
countryCode	CountryCode	✓	ISO 3166-1 alpha-2 country code
company	String		Company name (if applicable)
additional	String		Additional address information
cmsId	String		Customer management system ID

FulfillmentOrderToCreateInput - Fulfillment order input

Fulfillment order input for order creation. Defines shipping method and products to be fulfilled.

Field	Type	Required	Description
products	[ProductInput!]	✓	Products to be fulfilled (see below)
service	WingService	✓	Wing shipping service (e.g., STANDARD, EXPRESS)
carrierPickupId	String		Optional carrier pickup point ID for relay point delivery
carrierPickupName	String		Optional carrier pickup point name
customLocation	String		Custom delivery location instructions
isInsuranceEnabled	Boolean		Enable insurance coverage for this shipment (default: false)
isSignatureEnabled	Boolean		Require signature on delivery (default: false)
isSaturdayDeliveryEnabled	Boolean		Enable Saturday delivery if available (default: false)

ProductInput - Product details within FulfillmentOrder

Product input for order fulfillment. Used to define products when creating fulfillment orders.

Field	Type	Required	Description
designation	String	✓	Product name or description
price	Float	✓	Unit price of the product
quantity	Int	✓	Quantity ordered
weight	Float	✓	Weight per unit in kilograms
sku	String		Product stock keeping unit (SKU)
ean	String		European Article Number (EAN/barcode)
countryOfOrigin	String		Country where the product was manufactured
hsCode	String		HS/Tariff code for customs
length	Float		Product length in centimeters
width	Float		Product width in centimeters
height	Float		Product height in centimeters

Output Structure

The mutation returns an Order object with all nested relationships fully resolved:

• Order contains:
  • recipient: Fully resolved Recipient object
  • fulfillmentOrders: Array of fully resolved FulfillmentOrder objects
    • Each FulfillmentOrder contains:
      • products: Array of resolved OrderProduct objects
      • parcels: Array of resolved FulfillmentParcel objects