Skip to main content

CampaignOrder

An order for one product variant in a presale or crowdfunding campaign. It belongs to a campaign order group.

type CampaignOrder {
allocatedQuantity: Int!
campaign: Campaign!
campaignInventoryItem: CampaignInventoryItem
campaignItem: CampaignItem
campaignOrderGroup: CampaignOrderGroup!
cancelReason: String
cancelledBy: Persona
customer: Customer
financials: CampaignOrderFinancials
fulfilmentStatus: CampaignOrderFulfilmentStatus!
id: GlobalID!
identifier: String!
milestones: CampaignOrderMilestones
originalQuantity: Int!
paymentIntent: PaymentIntent
paymentMethod: PaymentMethod
paymentStatus: CampaignOrderPaymentStatus
product: Product!
productVariant: ProductVariant!
quantity: Int!
sequentialId: Int!
status: CampaignOrderStatus!
}

Fields​

CampaignOrder.allocatedQuantity ● Int! non-null scalar types​

The number of units allocated to the campaign order.

CampaignOrder.campaign ● Campaign! non-null union types​

The campaign the order belongs to.

CampaignOrder.campaignInventoryItem ● CampaignInventoryItem object types​

The campaign inventory item for the ordered product variant.

CampaignOrder.campaignItem ● CampaignItem object types​

The campaign item that covers the ordered product or product variant.

CampaignOrder.campaignOrderGroup ● CampaignOrderGroup! non-null object types​

The group the campaign order belongs to.

CampaignOrder.cancelReason ● String scalar types​

The reason the campaign order was cancelled.

CampaignOrder.cancelledBy ● Persona enum types​

Who cancelled the campaign order.

CampaignOrder.customer ● Customer object types​

The customer who placed the campaign order. Null if the customer has been deleted.

CampaignOrder.financials ● CampaignOrderFinancials object types​

The campaign order's prices, discounts and tax.

CampaignOrder.fulfilmentStatus ● CampaignOrderFulfilmentStatus! non-null enum types​

The campaign order's fulfilment status.

CampaignOrder.id ● GlobalID! non-null scalar types​

The campaign order's ID.

CampaignOrder.identifier ● String! non-null scalar types​

The campaign order's identifier, made from its group's identifier and a letter, such as #1001-A.

CampaignOrder.milestones ● CampaignOrderMilestones object types​

The dates and times of key events for the campaign order.

CampaignOrder.originalQuantity ● Int! non-null scalar types​

The quantity when the campaign order was created, before any decreases.

CampaignOrder.paymentIntent ● PaymentIntent object types​

The campaign order's payment intent. Null when payment is taken for the whole campaign order group.

CampaignOrder.paymentMethod ● PaymentMethod object types​

The campaign order's payment method.

CampaignOrder.paymentStatus ● CampaignOrderPaymentStatus enum types​

The status of the campaign order's payment.

CampaignOrder.product ● Product! non-null object types​

The ordered product.

CampaignOrder.productVariant ● ProductVariant! non-null object types​

The ordered product variant.

CampaignOrder.quantity ● Int! non-null scalar types​

The number of units ordered.

CampaignOrder.sequentialId ● Int! non-null scalar types​

The campaign order's position within its group, starting at 1.

CampaignOrder.status ● CampaignOrderStatus! non-null enum types​

The campaign order's status.

Returned By​

campaignOrder query

Member Of​

CampaignOrderCancelPayload object ● CampaignOrderConnection object ● CampaignOrderDecreaseQuantityPayload object ● CampaignOrderEdge object ● CampaignOrderGroup object ● CampaignOrderRetryFulfilmentPayload object ● CampaignOrderRetryPaymentPayload object