Skip to main content

Fulfillment

Represents order fulfillment.

type Fulfillment implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
  fulfillmentOrder: Int!
  status: FulfillmentStatus!
  trackingNumber: String!
  created: DateTime!
  lines: [FulfillmentLine!]
  statusDisplay: String
  warehouse: Warehouse
}

Fields​

Fulfillment.id ● ID! non-null scalar​

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

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

Fulfillment.privateMetafield ● String scalar​

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Fulfillment.privateMetafield.key ● String! non-null scalar​

Fulfillment.privateMetafields ● Metadata scalar​

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Fulfillment.privateMetafields.keys ● [String!] list scalar​

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

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

Fulfillment.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Fulfillment.metafield.key ● String! non-null scalar​

Fulfillment.metafields ● Metadata scalar​

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Fulfillment.metafields.keys ● [String!] list scalar​

Fulfillment.fulfillmentOrder ● Int! non-null scalar​

Fulfillment.status ● FulfillmentStatus! non-null enum​

Fulfillment.trackingNumber ● String! non-null scalar​

Fulfillment.created ● DateTime! non-null scalar​

Fulfillment.lines ● [FulfillmentLine!] list object​

List of lines for the fulfillment.

Fulfillment.statusDisplay ● String scalar​

User-friendly fulfillment status.

Fulfillment.warehouse ● Warehouse object​

Warehouse from fulfillment was fulfilled.

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

Member of​

FulfillmentApprove object ● FulfillmentApproved object ● FulfillmentCancel object ● FulfillmentCanceled object ● FulfillmentCreated object ● FulfillmentMetadataUpdated object ● FulfillmentRefundProducts object ● FulfillmentReturnProducts object ● FulfillmentUpdateTracking object ● Order object ● OrderFulfill object

Was this page helpful?