Skip to content
Saleor
Esc
↑↓navigate↵open⌘Jpreview

Schema: Saleor 3.23.43Download SDLUpgrade guides

On this page

Invoice Object

Represents an Invoice.

type Invoice implements ObjectWithMetadata & Job & Node {
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
  status: JobStatusEnum!
  createdAt: DateTime!
  updatedAt: DateTime!
  message: String
  id: ID!
  number: String
  externalUrl: String @deprecated(reason: "Use `url` field.")
  url: String
  order: Order
}

Interfaces

ObjectWithMetadata, Job, Node

Fields

privateMetadata

privateMetadata · [MetadataItem!]!

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

privateMetafield

privateMetafield · String

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

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

privateMetafields

privateMetafields · Metadata

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

keys

keys · [String!]

metadata

metadata · [MetadataItem!]!

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

metafield

metafield · String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

metafields

metafields · Metadata

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

keys

keys · [String!]

status

status · JobStatusEnum!

Job status.

createdAt

createdAt · DateTime!

Date and time at which invoice was created.

updatedAt

updatedAt · DateTime!

Date and time at which invoice was updated.

message

message · String

Message associated with an invoice.

id

id · ID!

The ID of the object.

number

number · String

Invoice number.

externalUrl

externalUrl · String

URL to view an invoice.

url

url · String

URL to view/download an invoice.

order

order · Order

Order related to the invoice.

Used by


Schema: Saleor 3.23.43. Download SDL.

Last updated on April 13, 2026

Was this page helpful?