Skip to main content

Store Orders

ListStoreOrders Query

This query retrieves a list of orders for a specific store with pagination and filtering capabilities. It provides comprehensive information about each order including customer data, payment details, shipping status, and product information.

Parameters​

  • $storeId: ID! - Required store identifier for retrieving orders
  • $connection: OrdersConnectionInput - Pagination and sorting parameters:
    • first: Number of items to retrieve (e.g., 20)
    • offset: Starting position in the result set
    • sortBy: Field to sort by (e.g., "createdAt")
    • sortOrder: Order direction ("asc" or "desc")
  • $filter: OrdersFilterInput - Filter criteria for narrowing results:
    • isArchived: Filter by archive status
    • date: Date range with from and to timestamps
    • Additional filters for status, payment method, etc.

Response Structure​

The query returns an orders object with:

  • totalCount - Total number of orders matching the filter criteria
  • nodes - Array of order objects containing detailed order information
  • __typename - GraphQL type information ("OrderConnection")

Order Fields Detail​

Each order in the nodes array includes:

Basic Information​

  • id - Unique order identifier
  • storeId - Store this order belongs to
  • orderSerial - Human-readable order number
  • createdAt - Order creation timestamp

Status Information​

  • isArchived - Whether the order has been archived
  • isCanceled - Whether the order has been canceled
  • isViewed - Whether the order has been viewed by merchant
  • fulfillmentStatus - Current fulfillment status
  • paymentStatus - Current payment status

Shipping Information​

  • shippingStatus - Current shipping status
  • wuiltShipmentProvider - Shipping provider used
  • shippingAddress - Complete delivery address (see Address fragment)
  • shippingRateCost - Cost of shipping (see Money fragment)
  • shipmentDetails - Additional shipping information:
    • trackingURL - URL to track the shipment
    • shippedWith - Shipping carrier
    • airWayBill - Air waybill number
    • orderTrackingNumber - Tracking number
    • trials - Number of shipping attempts

Return Information​

  • returnShipmentDetails - Information about returned orders:
    • shippingStatus - Status of the return shipment
    • orderTrackingNumber - Return tracking number

Customer Information​

  • customer - Customer details (see GuestInfo fragment):
    • name - Customer's full name
    • email - Customer's email address
    • phone - Customer's phone number
    • isSubscribedToNewsLetter - Newsletter subscription status
  • customerId - Unique customer identifier

Payment Information​

  • paymentIntent - Payment processing details:
    • provider - Payment processing service
    • paymentProvider - Specific payment method
  • cod - Cash on delivery information:
    • amount - COD amount with currency

Order Items​

  • items - Products in the order:
    • id - Item identifier
    • quantity - Number of items ordered
    • title - Item title/name
    • productSnapshot - Product details at time of order:
      • id, title, type - Basic product info
      • images - Product images (see Image fragment)
    • For SimpleItem types:
      • variantSnapshot - Variant details
      • selectedOptions - Options chosen by customer

Financial Details​

  • receipt (OrderReceipt fragment):
    • subtotal - Pre-tax, pre-discount amount
    • discount - Applied discounts
    • tax - Applied taxes
    • shipping - Shipping costs
    • total - Final order amount
    • automaticDiscount - System-applied discounts

Packaging Details​

  • packagingDetails - Information about package dimensions/weight:
    • extraWeight - Additional weight beyond base
    • extraVolumetricWeight - Additional volumetric weight
    • shippingCostDetails - Cost calculation factors:
      • baseCost - Base shipping cost
      • extraWeightCost - Cost for additional weight
      • baseWeightLimit - Weight included in base cost
      • extraWeightStep - Weight increment for charges
      • insurancePercentage - Insurance cost as percentage

Tagging​

  • tags - Order tags for organization/filtering (see OrderTag fragment):
    • id - Tag identifier
    • name - Tag name
    • color - Tag color code
    • description - Tag description

Fragments Used​

  • GuestInfo - Customer contact information and preferences
  • Money - Monetary amount with currency code
  • OrderTag - Order categorization and labeling metadata
  • Address - Complete shipping address with area information
  • OrderReceipt - Detailed financial breakdown of the order
  • Image - Product image information including source URL and dimensions

GraphQL Endpoint​

https://graphql.wuilt.com

Operation: ListStoreOrders​

Try It Out​

Query​

query ListStoreOrders(
$storeId: ID!
$connection: OrdersConnectionInput
$filter: OrdersFilterInput
) {
orders(storeId: $storeId, connection: $connection, filter: $filter) {
  totalCount
  nodes {
    id
    storeId
    isArchived
    isCanceled
    fulfillmentStatus
    paymentStatus
    isViewed
    orderSerial
    shippingStatus
    wuiltShipmentProvider
    customer {
      ...GuestInfo
      __typename
    }
    cod {
      amount {
        ...Money
        __typename
      }
      __typename
    }
    customerId
    shippingRateCost {
      ...Money
      __typename
    }
    tags {
      ...OrderTag
      __typename
    }
    paymentIntent {
      provider
      paymentProvider
      __typename
    }
    packagingDetails {
      extraWeight
      extraVolumetricWeight
      shippingCostDetails {
        baseCost
        extraWeightCost
        baseWeightLimit
        extraWeightStep
        insurancePercentage
        __typename
      }
      __typename
    }
    shippingAddress {
      ...Address
      __typename
    }
    shipmentDetails {
      trackingURL
      shippedWith
      shippingStatus
      airWayBill
      orderTrackingNumber
      trials
      __typename
    }
    returnShipmentDetails {
      shippingStatus
      orderTrackingNumber
      __typename
    }
    receipt {
      ...OrderReceipt
      __typename
    }
    items {
      id
      quantity
      title
      __typename
      productSnapshot {
        id
        title
        type
        images {
          ...Image
          __typename
        }
        __typename
      }
      ... on SimpleItem {
        variantSnapshot {
          id
          sku
          title
          image {
            ...Image
            __typename
          }
          __typename
        }
        selectedOptions {
          value
          name
          __typename
        }
        __typename
      }
    }
    createdAt
    __typename
  }
  __typename
}
}

fragment GuestInfo on Customer {
name
email
phone
isSubscribedToNewsLetter
__typename
}

fragment Money on Money {
amount
currencyCode
__typename
}

fragment OrderTag on OrderTag {
id
name
color
description
__typename
}

fragment Address on Address {
notes
addressLine1
addressLine2
phone
secondPhone
postalCode
areaSnapshot {
  countryName
  stateName
  cityName
  regionName
  __typename
}
__typename
}

fragment OrderReceipt on OrderReceipt {
subtotal {
  ...Money
  __typename
}
discount {
  ...Money
  __typename
}
tax {
  ...Money
  __typename
}
shipping {
  ...Money
  __typename
}
total {
  ...Money
  __typename
}
automaticDiscount {
  ...Money
  __typename
}
__typename
}

fragment Image on Image {
id
src
altText
status
width
height
__typename
}

Query Variables

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Note: Make sure to change the storeId with your store ID. For guidance on how to get your store ID, reference the Store ID guide.

Authentication​

To use this query, you will need an API key. Click the "API Key" button in the navigation bar to enter your credentials.