Brikl Logo

BETA

/
Gear Icon

Reference

Introduction

Queries

Mutations

Objects

Enums

Input objects

Interfaces

Scalars

Objects

Objects in GraphQL represent the resources you can access. An object can contain a list of named fields, which are specifically typed.

For example, the Order object has a field called currencyCode typed as String.


Address

Represents a customer address.

For example, a billing address and a mailing address are both represented as an Address object.


AuditLog

Represents a status update of an order.

The AuditLog object holds all details about the status update of an order, such as the type of the update, the new status, and the date and time it happened.


AuditLogVisibility

Represents the visibility of a status update.


BriklOnlySimpleMessageLogData

The data about a Brikl message status update.

Implements

  • LogData

EmailNotificationLogData

The data about an email notification status update.

Implements:

  • LogData

EmailNotificationPayload

The payload for status updates of type EMAIL_NOTIFICATION. See AuditLogPayloadType.


FieldUpdatedLogData

Information about the updated fields.

Implements

  • LogData

FieldUpdatedPayload

The payload for status updates of type FIELD_UPDATED. See AuditLogPayloadType.


Order

Represents a customer's request to purchase one or more products from a shop.

The Order object holds all details about a placed order, such as purchased items, payment, taxes, and others.


OrderConnection

The connection type for Order.


OrderDiscount

Represents the discount applied to an order.


OrderEdge

An object that holds one Order and a cursor for use in pagination.


OrderItem

Represents a purchased item.

The OrderItem object holds details about a purchased item, such as quantity, price, taxes, customization options, and selected variants.


OrderItemCustomizationOption

Represents a customization option for a purchased item.

A customization is an option a customer can select during the buying process. For example, the name one wants to add to a football jersey.


OrderItemVariantOption

Represents the variant option of a purchased item.

A product variant is an option a customer can select during the buying process, such as the size and color of a t-shirt.


OrderMutationOutput

Represents an updated order.


OrderNote

Represents an internal note added by a store admin user.


PageInfo

Returns information about pagination in a connection, in accordance with the Relay specification.


Payment

Represents a customer's payment for an order.

The Payment object holds details about one payment, such as the amount paid, the payment method, and the payment status.


S3KeyPathLogData

Information about the Amazon S3 key.

Implements

  • LogData

Shipment

Represents the shipment of an order.

The Shipment object holds details about an order shipment, such as the package dimensions and weight, the shipment provider and tracking number, the shipment status, and other information.


ShipmentOrderItemSize

Represents the dimensions and weight of an item.


SimpleMessageLogData

The data about a message status update.

Implements

  • LogData