Skip to main content

Fulfillment

Represents an order fulfillment.

type Fulfillment implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  trackingNumber: String
  trackingUrl: String
  trackingCompany: String
  created: DateTime!
  updated: DateTime!
  shippingLabelUrl: String
  status: FulfillmentStatus!
  statusDisplay: String!
  fulfillmentOrder: Int!
  totalLinesMoney: Money!
  totalLinesQuantity: Int!
  seller: Seller
  lines: [FulfillmentLine!]!
  order: Order
  nauticalOrder: NauticalOrder
  warehouse: Warehouse
  relatedTo: Fulfillment
  user: User
  customFields: [SelectedAttribute!]!
}
Show more ↓

Fields

`Fulfillment.id` ● `ID!` non-null scalar

The Globally Unique ID of this object

`Fulfillment.metadata` ● `[MetadataItem!]!` non-null object

List of public metadata items. Can be accessed without permissions.

`Fulfillment.privateMetadata` ● `[MetadataItem!]!` non-null object

List of private metadata items. Requires proper staff permissions to access.

`Fulfillment.trackingNumber` ● `String` scalar

Fulfillment tracking number

`Fulfillment.trackingUrl` ● `String` scalar

Fulfillment tracking URL

`Fulfillment.trackingCompany` ● `String` scalar

Fulfillment tracking company

`Fulfillment.created` ● `DateTime!` non-null scalar

When the fulfillment was created

`Fulfillment.updated` ● `DateTime!` non-null scalar

When the fulfillment was last updated

`Fulfillment.shippingLabelUrl` ● `String` scalar

URL to the shipping label

`Fulfillment.status` ● `FulfillmentStatus!` non-null enum

Fulfillment status

`Fulfillment.statusDisplay` ● `String!` non-null scalar

User-friendly fulfillment status

`Fulfillment.fulfillmentOrder` ● `Int!` non-null scalar

Fulfillment order number

`Fulfillment.totalLinesMoney` ● `Money!` non-null object

Total value of fulfillment lines

`Fulfillment.totalLinesQuantity` ● `Int!` non-null scalar

Sum of quantities across all lines

`Fulfillment.seller` ● `Seller` object

Seller who made the fulfillment

`Fulfillment.lines` ● `[FulfillmentLine!]!` non-null object

Lines in this fulfillment

`Fulfillment.order` ● `Order` object

Seller order this fulfillment belongs to

`Fulfillment.nauticalOrder` ● `NauticalOrder` object

Marketplace order this fulfillment belongs to

`Fulfillment.warehouse` ● `Warehouse` object

Warehouse the fulfillment was shipped from

`Fulfillment.relatedTo` ● `Fulfillment` object

Related fulfillment (for replacements)

`Fulfillment.user` ● `User` object

User who created this fulfillment

`Fulfillment.customFields` ● `[SelectedAttribute!]!` non-null object

Custom attribute fields for this fulfillment

Interfaces

`Node` interface

An object with a Globally Unique ID

`ObjectWithMetadata` interface

An object that supports metadata.

Member Of

Fulfillment object ● FulfillmentBulkReturn object ● FulfillmentCancel object ● FulfillmentCountableEdge object ● FulfillmentReturn object ● FulfillmentReturnStatusBulkUpdate object ● FulfillmentUpdateTracking object ● NauticalOrder object ● NauticalOrderFulfill object ● Order object ● OrderDeclineFulfillment object ● OrderFulfill object

Fields
Interfaces
Member Of