---
title: "Order"
description: >
  An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
doc_type: graphql
doc_category: storefront
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/storefront-api/common-objects/objects/order'
  md: 'https://developer.shopline.com/docs/storefront-api/common-objects/objects/order.md'
---
# Order

An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.

- **API Version:** v20270301
- **API Type:** Storefront
- **API Protocol:** GraphQL
- **Operation Type:** Object

## Type Signature

`Order`

## Fields

* `billingAddress`

  [OrderShippingAddress](https://developer.shopline.com/docs/storefront-api/common-objects/objects/order-shipping-address.md)

  The address associated with the payment method.

* `buyerNote`

  [String](https://developer.shopline.com/docs/storefront-api/common/scalars/string.md)

  Buyer notes added to the order.

* `cancelReason`

  [String](https://developer.shopline.com/docs/storefront-api/common/scalars/string.md)

  Cancellation reason for the order.

* `canceledAt`

  [Date](https://developer.shopline.com/docs/storefront-api/common/scalars/date.md)

  The date and time when the order was canceled. Returns null if the order wasn't canceled.

* `customer`

  [Customer](https://developer.shopline.com/docs/storefront-api/customers/objects/customer.md)

  customer

* `email`

  [String](https://developer.shopline.com/docs/storefront-api/common/scalars/string.md)

  The customer's email address.

* `financialStatus`

  [OrderFinancialStatus](https://developer.shopline.com/docs/storefront-api/common-objects/enums/order-financial-status.md)

  Represents the order's current financial status.

* `fulfillmentStatus`

  [OrderFulfillmentStatus](https://developer.shopline.com/docs/storefront-api/common-objects/enums/order-fulfillment-status.md)

  Shipment status

* `id`

  [ID!](https://developer.shopline.com/docs/storefront-api/common/scalars/id.md)

  A globally-unique ID.

* `lineItems`

  [[OrderLineItem]](https://developer.shopline.com/docs/storefront-api/common-objects/objects/order-line-item.md)

  List of the order’s line items.

* `name`

  [String](https://developer.shopline.com/docs/storefront-api/common/scalars/string.md)

  Merchant's custom order number, starting from 1001. It can be the same across different stores, and it is not necessarily unique within the same store.

* `phone`

  [String](https://developer.shopline.com/docs/storefront-api/common/scalars/string.md)

  The customer's phone number for receiving SMS notifications.

* `processedAt`

  [Date](https://developer.shopline.com/docs/storefront-api/common/scalars/date.md)

  Order fulfillment time (the actual business time of the order when it was imported).

* `shippingAddress`

  [OrderShippingAddress](https://developer.shopline.com/docs/storefront-api/common-objects/objects/order-shipping-address.md)

  The address to where the order will be shipped.

* `shippingDiscountAllocations`

  [[OrderDiscountAllocation]](https://developer.shopline.com/docs/storefront-api/common-objects/objects/order-discount-allocation.md)

  The discounts that have been allocated onto the shipping line by discount applications.

* `statusUrl`

  [URI](https://developer.shopline.com/docs/storefront-api/common/scalars/uri.md)

  The unique URL for the order's status page.

* `subtotalPrice`

  [Money](https://developer.shopline.com/docs/storefront-api/common-objects/objects/money.md)

  Price of the order before shipping and taxes.

* `successfulFulfillments`

  [[Fulfillment]](https://developer.shopline.com/docs/storefront-api/common-objects/objects/fulfillment.md)

  List of the order’s successful fulfillments.

* `totalDuties`

  [Money](https://developer.shopline.com/docs/storefront-api/common-objects/objects/money.md)

  The total customs duty for the order, including the edited order items.

* `totalPrice`

  [Money](https://developer.shopline.com/docs/storefront-api/common-objects/objects/money.md)

  The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).

* `totalShippingPrice`

  [Money](https://developer.shopline.com/docs/storefront-api/common-objects/objects/money.md)

  Total shipping cost of the order, including shipping discounts.

* `totalTax`

  [Money](https://developer.shopline.com/docs/storefront-api/common-objects/objects/money.md)

  The total tax and fees for the order, including editing the order items.

## Schema Definition

```graphql
type Order { 
	billingAddress: OrderShippingAddress
	buyerNote: String
	cancelReason: String
	canceledAt: Date
	customer: Customer
	email: String
	financialStatus: OrderFinancialStatus
	fulfillmentStatus: OrderFulfillmentStatus
	id: ID!
	lineItems: [OrderLineItem]
	name: String
	phone: String
	processedAt: Date
	shippingAddress: OrderShippingAddress
	shippingDiscountAllocations: [OrderDiscountAllocation]
	statusUrl: URI
	subtotalPrice: Money
	successfulFulfillments: [Fulfillment]
	totalDuties: Money
	totalPrice: Money
	totalShippingPrice: Money
	totalTax: Money 
}
```

## Field from

* [OrderConnection](https://developer.shopline.com/docs/storefront-api/common-objects/objects/order-connection.md).nodes

  A list of the nodes contained in OrderEdge.

* [OrderEdge](https://developer.shopline.com/docs/storefront-api/common-objects/objects/order-edge.md).node

  The item at the end of OrderEdge.

* [Query](https://developer.shopline.com/docs/storefront-api/common-objects/queries/proxy-node-order.md).proxyNodeOrder

  当前接口即将下线，新增接入将无法直接使用。如需申请使用权限，请通过工单系统联系平台。

## Error Handling

For detailed information about common codes, see [Status and error codes](https://developer.shopline.com/docs/apps/api-instructions-for-use/storefront-api/overview.md#status-and-error-codes).