Brikl Logo

BETA

/
Gear Icon
Admin API

About the Admin API

The Admin API lets you integrate your Brikl store with applications that are important to your business, such as CRM, ERP, and back-office applications.

Use Brikl's GraphQL API to build integrations for reporting and bring data from Brikl to your system.

Requirements

All GraphQL Admin API queries require a valid personal access token (PAT) and a shop ID.

If you don't have an access token, please request one by sending an email to support@brikl.com

You can get your shop ID by logging into your dashboard and copying it from the URL. For example:

https://dashboard.brikl.com/dashboard/63d6af47-5d4d-41cb-92f0-2455f4c3dc6f

In the URL above the shop ID is 63d6af47-5d4d-41cb-92f0-2455f4c3dc6f.

Once you have your access token and shop ID, include both in the request header on all API queries:

{ 
	"Authorization": {personal-access-token}, 
	"X-Brikl-Shop-Id": {shop-id} 
}

Endpoint

All Admin API queries are made on a single GraphQL endpoint, which only accepts POST requests:

https://api.brikl.com/graphql/admin/public

You can explore the Brikl Admin API using GraphQL Explorer.


Queries

GraphQL queries retrieve data from the server. Compared to REST, GraphQL queries operate like GET requests.

Use the queries below to retrieve data about the orders placed in your Brikl store. The data includes payment details, applied discounts, taxes, purchased items, and others.


orderById

Returns an Order resource by ID.

Arguments

idStringRequired

The ID of the Order to return.

Return fields

OrderOrder

Any requested field from the Order object.


orders

Returns a list of orders placed.

Arguments

beforeString

Returns the elements that come before the specified cursor.

afterString

Returns the elements that come after the specified cursor.

firstInt

Returns up to the first n elements from the list.

lastInt

Returns up to the last n elements from the list.

filterOrderFilterInput

Filter orders by available parameters.

Return fields

OrderConnectionOrderConnection!non-null

The connection type for Order.


Mutations

GraphQL mutations change data on the server and fetch the changed data in a single operation. GraphQL mutations are analogous to performing HTTP verbs such as POST, PATCH, and DELETE.

Use the mutations below to update data about the orders placed in your Brikl store.


updateOrder

Updates some of the fields of an order.

updateOrder can update the fields comment, shippingStatus, and paymentStatus. The new content for each field overwrites the current one.

Arguments

inputUpdateOrderInputRequired

The input for the mutation.

Return fields

OrderMutationOutputOrderMutationOutput!non-null

An object that holds the updated order and its ID.


updateOrderMetadata

Updates the meta field of an order.

Arguments

inputUpdateOrderMetadataInputRequired

The input for the mutation.

Return fields

OrderMutationOutputOrderMutationOutput!non-null

An object that holds the updated order and its ID.


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.

Return fields

address1String!non-null

The first line of the address. Typically the street address or PO Box number.

address2String

The second line of the address. Typically the number of the apartment, suite, or unit.

cityString!non-null

The name of the city, district, village, or town.

companyString

The name of the customer's company or organization.

countryCodeString!non-null

The two-letter code for the country of the address.

For example, US for United States, or TH for Thailand.

emailString

The email of the customer.

firstNameString!non-null

The first name of the customer.

idString!non-null

A unique identifier for the address.

isValidAddressBoolean

Whether the customer's address is valid or not.

lastNameString!non-null

The last name of the customer.

latitudeFloat

The latitude coordinate of the customer address.

longitudeFloat

The longitude coordinate of the customer address.

metaJSONObject

Metadata about the resource.

organisationIdID!non-null

The unique identifier of the organization.

phoneString!non-null

The phone number of the customer.

provinceCodeString

The code or name for the region.

A region can be a province, state, or district.

shopIdID!non-null

The unique identifier of the shop.

typeString!non-null

The type of resource to which the address is related.

vatNumberString

The value-added tax (VAT) identification number.

zipString!non-null

The zip or postal code of the address.


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.

Return fields

idString!non-null

A unique identifier for the update.

shopIdString!non-null

The unique identifier of the shop.

resourceIdString!non-null

The unique identifier of the updated resource.

resourceTypeResourceType!non-null

The updated resource. For example, the payment status.

eventTypeAuditLogEventType!non-null

The type of the update. For example, a newly placed order.

payloadTypeAuditLogPayloadType!non-null

The type of payload returned after the status update.

statusAuditLogStatus!non-null

The status of the update.

messageString!non-null

A message or comment about the update.

dataLogData

Information about the update.

visibilityAuditLogVisibility

Information about the visibility of the update.

createdByString!non-null

The ID of the user that updated the order.

createdAtDateTime!non-null

Date and time the audit log was created.

updatedAtDateTime!non-null

The date and time the audit log was modified last.


AuditLogVisibility

Represents the visibility of a status update.

Return fields

idID!non-null

A unique identifier for the audit log visibility.

isHiddenFromUsersBoolean!non-null

Whether the update is visible to the customer or not.

createdAtDateTime!non-null

Date and time the audit log visibility was created.

updatedAtDateTime!non-null

The date and time the audit log visibility was modified last.


BriklOnlySimpleMessageLogData

The data about a Brikl message status update.

Implements

  • LogData

Return fields

typeAuditLogPayloadType!non-null

The type of payload.

dataJSONObject!non-null

Information about the message.


EmailNotificationLogData

The data about an email notification status update.

Implements:

  • LogData

Return fields

typeAuditLogPayloadType!non-null

The type of payload.

dataEmailNotificationPayload!non-null

Information about the email notification.


EmailNotificationPayload

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

Return fields

senderAddressString!non-null

The sender email address.

recipientAddresses[String]!non-null

The list of recipient email addresses.

notificationTypeString!non-null

The type of notification.


FieldUpdatedLogData

Information about the updated fields.

Implements

  • LogData

Return fields

typeAuditLogPayloadType!non-null

The type of payload.

dataFieldUpdatedPayload!non-null

The list of updated fields.


FieldUpdatedPayload

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

Return fields

fields[JSONObject]!non-null

The list of updated fields.

Each field is represented as an object holding the properties key and value.


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.

Return fields

billingAddressIdID!non-null

A unique identifier for the billing address of the customer.

billingAddressAddress

The billing address of the customer.

shippingAddressIdID!non-null

A unique identifier for the mailing address of the customer.

shippingAddressAddress

The mailing address of the customer.

payments[Payment]!non-null

The details of the payment.

appliedDiscounts[OrderDiscount]!non-null

The list of the discounts applied to the order.

briklFeeTotalFloat!non-null

Amount of the fee paid to Brikl.

cartIdString!non-null

A unique identifier for the cart.

cartShippingMethodIdString

The unique identifier of the selected shipping method.

cartShippingMethodNameString

The selected shipping method.

commentString

The customer's comment about the placed order.

createdAtDateTime!non-null

Date and time the order was created in Brikl.

currencyCodeString!non-null

The shop currency when the order was placed.

idString!non-null

A unique identifier for the order.

items[OrderItem]!non-null

A list of the order's items.

languageCodeString!non-null

The language code.

For example, en_UK for British English.

metaJSONObject

Metadata about the resource.

noInt!non-null

The number of the order, incremented by the shop.

notifyToEmailString!non-null

Email to send notifications about order updates.

organisationIdString!non-null

The unique identifier of the organization.

paymentStatusOrderPaymentStatusEnum!non-null

The current status of the payment.

salesChannelIdString!non-null

The unique identifier of the sales channel in which the order was placed.

salesChannelTitleString

The name of the sales channel in which the order was placed.

shippingStatusShippingStatusEnum!non-null

The current status of the shipping.

shippingSubTotalFloat!non-null

The total cost of the shipping. This does not include taxes.

shippingTaxTotalFloat!non-null

The total cost of the shipping tax.

shippingTotalFloat!non-null

The total cost of the shipping. This includes taxes.

shopIdString!non-null

The ID of the shop.

subTotalFloat!non-null

The total price of the order. This does not include taxes.

itemTotalFloat!non-null

The total cost of the items. This includes taxes.

itemSubTotalFloat!non-null

The total cost of the items. This does not include taxes.

taxPercentageFloat!non-null

The percentage of the taxes.

taxProviderTaxProvider!non-null

The provider responsible for calculating sales tax rates.

taxTotalFloat!non-null

The total cost of the taxes.

defaultCurrencyTotalFloat!non-null

The total price of the order in the shop default currency.

taxesJSONObject

A summary of all taxes information.

totalFloat!non-null

The total cost of the order.

updatedAtDateTime!non-null

The date and time the order was modified last.

urlString!non-null

The URL of the order.

userAgentString!non-null

The user agent used to place the order.

For example, the customer's web browser.

notes[OrderNote]!non-null

The list of merchant notes related to the order.

productionStatusProductionStatus

The current status of the production.

shipments[Shipment]!non-null

The list of shipments and their details.

history[AuditLog]

The order's update history.

Arguments: filter OrderTimelineFilterInput!


OrderConnection

The connection type for Order.

Return fields

edges[OrderEdge]!non-null

A list of edges.

pageInfoPageInfo!non-null

Information to aid in pagination.


OrderDiscount

Represents the discount applied to an order.

Return fields

accountingIdString

An identifier for accounting purposes.

amountFloat!non-null

The value of the discount. This includes taxes.

amountBeforeTaxFloat!non-null

The value of the discount before taxes.

taxAmountFloat!non-null

The amount of the tax.

taxPercentageFloat!non-null

The percentage of the tax.

couponCodeString

The code of the discount coupon.

currencyCodeString!non-null

The currency of the discount.

This is a three-letter currency code.

discountIdString!non-null

The unique identifier of the discount.

discountTypeString!non-null

The type of the discount.

enablesFreeShippingBoolean!non-null

Whether the discount enables free shipping or not.

applyBeforeTaxBoolean!non-null

Whether the discount is applied before taxes or not.

idString!non-null

The unique identifier of the discount.

internalNoteString

An internal note added by a store admin.

isUpchargeBoolean!non-null

Whether an upcharge is included or not.

isVisibleToCustomerBoolean!non-null

Whether the discount is visible to the customer or not.

orderIdString!non-null

The ID of the order the discount is related to.

orderItemIdString

The ID of the item the discount is related to.

organisationIdString!non-null

The unique identifier of the organization.

shopIdString!non-null

The unique identifier of the shop.

titleString!non-null

The title of the discount.

percentFloat

The percentage of the discount.


OrderEdge

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

Return fields

nodeOrder!non-null

The item at the end of OrderEdge.

cursorString!non-null

The item at the end of OrderEdge.


OrderItem

Represents a purchased item.

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

Return fields

customizationOptionsOrderItemCustomizationOption!non-null

The customization options a customer has chosen.

customizationTotalFloat

The total cost of the customization.

idString!non-null

A unique identifier for the item.

imageUrlString!non-null

The URL for the item image.

metaJSONObject

Metadata about the resource.

optionValueIdString

The ID of the item's variant option.

orderIdString!non-null

The ID of the order the item is included in.

organisationIdString!non-null

The unique identifier of the organization.

accountingIdString

An identifier for accounting purposes.

productAccountingIdString

The product accounting ID.

productDesignIdString

The product design ID.

productDesignRevisionNoInt

The product design version.

productIdString!non-null

The ID of the product.

productNoString

The internal ID of the product.

productPackageIdString

If the product is part of a package, the package identifier.

quantityInt!non-null

The number of purchased units.

salesChannelGroupIdString

The ID of the sales channel group.

salesChannelGroupTitleString

The title of the sales channel group.

salesChannelIdString

The unique identifier of the sales channel in which the order was placed.

salesChannelOpeningCycleIdString

The ID of the sales channel opening cycle.

A cycle is the time duration that a store will remain open.

salesChannelTargetCategoryIdString

The category ID of the purchased item.

salesChannelTargetCategoryTitleString

The category title of the purchased item.

salesChannelTitleString

The name of the sales channel in which the order was placed.

shopIdString!non-null

The ID of the shop.

skuString!non-null

The stock-keeping unit number.

subTotalFloat!non-null

The total price. This does not include taxes.

taxPercentageFloat!non-null

The percentage of the taxes.

taxTotalFloat!non-null

The total cost of the taxes.

titleString!non-null

The name of the product, as seen in the store.

totalFloat!non-null

The total cost of the purchased items.

This is the unitPrice times the quantity purchased.

unitPriceFloat!non-null

The item price per unit.

variantOptionsOrderItemVariantOption!non-null

The variant options of the item.

For example, the item size and color.

variantTitleString

The title of the chosen variant.

For example, XL for extra large.

weightFloat

The total weight of the purchased items.

weightUnitWeightUnit

The unit used to weigh the item.

productionStatusProductionStatus

The current status of the production.


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.

Return fields

customizationGroupIdString!non-null

The ID of the customization group.

customizationOptionIdString!non-null

The ID of the customization option.

orderItemIdString!non-null

The ID of the item the customization is related to.

organisationIdString!non-null

The unique identifier of the organization.

shopIdString!non-null

The ID of the shop.

titleString!non-null

The type of customization.

For example, one possible customization type is to include the player's name in a football jersey.

valueString!non-null

The customization type value.

For example, if the customization type title is "Player Name," this value can be a name like "RONALDO."

amountFloat!non-null

The cost of the customization.


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.

Return fields

optionValueIdString!non-null

The ID of the item's variant option.

orderItemIdString!non-null

The ID of the item the variant is related to.

organisationIdString!non-null

The unique identifier of the organization.

productIdString!non-null

The ID of the product the variant is related to.

shopIdString!non-null

The ID of the shop.

titleString!non-null

The variant type.

Some possible variant types are color, size, and gender.

valueString!non-null

The variant type value.

For example, if the variant type title is "Size," this value can be a size like "M" or "XL."

variantIdString!non-null

The unique identifier of the variant option title.

variantOptionIdString!non-null

The unique identifier of the variant option value.

productTitleString

The title of the product.


OrderMutationOutput

Represents an updated order.

Return fields

orderOrder

The updated order.

orderIdID!non-null

The ID of the updated order.


OrderNote

Represents an internal note added by a store admin user.

Return fields

createdAtDateTime!non-null

Date and time the note was created.

createdByString!non-null

The ID of the user that added the note.

deletedAtDateTime

Date and time the note was deleted.

idString!non-null

A unique identifier for the note.

metaJSONObject

Metadata about the resource.

noteString!non-null

The note attached to the order.

orderOrder

The order the note is related to.

orderIdString!non-null

The ID of the order the note is related to.

updatedAtDateTime

The date and time the note was modified last.


PageInfo

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

Return fields

hasNextPageBoolean!non-null

Whether there are more pages to fetch following the current page.

hasPreviousPageBoolean!non-null

Whether there are any pages prior to the current page.

startCursorString

The cursor to the first node in edges.

When paginating backwards, the cursor to continue.

endCursorString

The cursor to the last node in edges.

When paginating forwards, the cursor to continue.


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.

Return fields

amountFloat!non-null

The amount of the payment.

createdAtDateTime!non-null

Date and time the payment was made.

currencyCodeString!non-null

The currency of the payment.

This is a three-letter currency code.

idString!non-null

A unique identifier for the payment.

methodPaymentMethod!non-null

The method used to make the payment.

orderIdString!non-null

The ID of the order the payment is related to.

organisationIdString!non-null

The unique identifier of the organization.

providerPaymentProvider!non-null

The provider through which the payment was made.

providerPaymentIdString

A unique identifier for the payment in the payment provider system.

providerPaymentInfoJSONObject

Metadata about the payment.

providerStatusString

The status of the payment provider.

paymentProviderConfigurationIdString

The payment provider configuration ID in Brikl.

shopIdString!non-null

The unique identifier of the shop.

statusPaymentStatus!non-null

The current status of the payment.

isTestModeBoolean!non-null

Whether the payment is a simulation or not.

tokenString

The payment provider authorization token.

updatedAtDateTime!non-null

The date and time the payment was modified last.


S3KeyPathLogData

Information about the Amazon S3 key.

Implements

  • LogData

Return fields

typeAuditLogPayloadType!non-null

The type of payload.

keyPathString!non-null

The Amazon S3 keypath.


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.

Return fields

canceledAtDateTime

Date and time the shipment was canceled.

createdAtDateTime!non-null

Date and time the shipment was created in the Brikl system.

createdByString

The ID of the user that added the shipment data.

idString!non-null

A unique identifier for the shipment.

isTrackingEnabledBoolean

Whether the shipment tracking is enabled or not.

labelFormatString

The shipping label format.

labelIsReturnBoolean

Whether the shipping label allows the customer to return the package if needed.

labelLayoutString

The shipping label layout.

labelUrlString

The shipping label URL.

metaJSONObject

Metadata about the resource.

orderIdString!non-null

The ID of the order the shipment is related to.

orderItemIdsString!non-null

The IDs of the items included in a shipment.

orderItemSizesShipmentOrderItemSize

The dimensions and weight of the items included in a shipment.

organisationIdString!non-null

The unique identifier of the organization.

packageDimensionsHeightFloat

The height of the package.

packageDimensionsLengthFloat

The length of the package.

packageDimensionsUnitShipmentDimensionsUnitEnum

The unit used to measure the package.

packageDimensionsWidthFloat

The width of the package.

packageWeightUnitShipmentWeightUnitEnum!non-null

The unit used to weigh the package.

packageWeightValueFloat!non-null

The weight of the package.

providerShipmentProviderEnum!non-null

The carrier responsible for the shipment.

providerCarrierCodeString

The code used to reference the carrier.

providerCreateRequestJSONObject

Information about the shipment creation request in the carrier system.

providerCreateResponseJSONObject

Information about the shipment creation response in the carrier system.

providerLabelIdString

The ID of the provider label.

providerShipmentIdString

The ID of the shipment provider.

providerTrackingNumberString

The shipment tracking number.

providerTrackingStatusString

The shipment tracking status.

providerTrackingStatusResponseJSONObject

Metadata about the shipment tracking status.

shipFromAddressIdString

The ID of the shipment sender address.

shipToAddressIdString

The ID of the shipment recipient address.

shopIdString!non-null

The ID of the shop.

statusShippingShippingStatusEnum!non-null

The current status of the shipment.

updatedAtDateTime!non-null

The date and time the shipment was modified last.

updatedByString

The ID of the user that last updated the shipment.


ShipmentOrderItemSize

Represents the dimensions and weight of an item.

Return fields

dimensionsHeightFloat

The height of the item.

dimensionsLengthFloat

The length of the package.

dimensionsUnitShipmentDimensionsUnitEnum

The unit used to measure the item.

dimensionsWidthFloat

The width of the package.

idString!non-null

The unique identifier of the order item size.

orderItemIdString!non-null

The ID of the item the shipment is related to.

organisationIdString!non-null

The unique identifier of the organization.

shipmentIdString

The unique identifier of the shipment.

shopIdString!non-null

The ID of the shop.

weightUnitShipmentWeightUnitEnum!non-null

The unit used to weigh the item.

weightValueFloat!non-null

The weight of the item.


SimpleMessageLogData

The data about a message status update.

Implements

  • LogData

Return fields

typeAuditLogPayloadType!non-null

The type of payload.

dataJSONObject!non-null

Information about the message.


Enums

Enums represent a set of possible values for a field.

For example, the Order object has a field called paymentStatus, which is an enum whose possible values are CANCELED, FAILED, PAID, or PENDING.


AuditLogEventType

The type of event that triggered the status update.

Valid values

ORDER_CREATED

An order has been placed.

ORDER_UPDATED

An order has been updated.

PAYMENT_PAID

A payment has been confirmed.

SHIPMENT_CREATED

A shipment has been created.


AuditLogPayloadType

The possible payload types for a status update. AuditLogPayloadType determines the payload structure for the data field in the AuditLog object.

Valid values

S3_KEYPATH

Amazon S3 path payload type. See S3KeyPathLogData object.

EMAIL_NOTIFICATION

Email notification payload type. See EmailNotificationLogData object.

SIMPLE_MESSAGE

Simple message payload type. See SimpleMessageLogData object.

FIELD_UPDATED

Field updated payload type. See FieldUpdatedLogData object.

BRIKL_SIMPLE_MESSAGE

Brikl message payload type. See BriklOnlySimpleMessageLogData object.


AuditLogStatus

The status of an audit log.

Valid values

ERROR

The audit log represents an error.

WARN

The audit log represents a warning.

SUCCESS

The audit log represents a success.

INFO

The audit log represents additional information.


OrderPaymentStatusEnum

The valid values for the status of a payment.

Valid values

CANCELED

The order payment has been canceled.

FAILED

The order payment operation has failed.

PAID

The order has been paid successfully.

PENDING

The order payment is pending.


PaymentMethod

Represents the payment method used to pay for an order.

Valid values

APPLEPAY

Apple Pay has been used.

BANCONTACT

Bancontact has been used.

BANK_TRANSFER

A bank transfer has been used.

CASH

Cash has been used.

CASH_ON_DELIVERY

Cash on delivery has been used.

CREDIT_CARD

A credit card has been used.

IDEAL

iDEAL has been used.

MANUAL

A manual payment has been used.

PROMPTPAY

PromptPay has been used.

PURCHASE_ORDER

A custom method has been used.

SOFORT

Sofort has been used.


PaymentProvider

Represents the platform used for the payment.

Valid values

CUSTOM

A custom platform has been used.

MANUAL

Manual payment has been used.

OMISE

The Omise platform has been used.

PAYGATE

The PayGate platform has been used.

STRIPE

The Stripe platform has been used.

STRIPE_CONNECT

The Strapi Connect platform has been used.


PaymentStatus

Represents the payment status of an order.

Valid values

FAILED

The payment has failed.

PAID

The order has been paid successfully.

PENDING

The payment is pending.

PROCESSING

The payment is being processed.

REFUNDED

The payment has been refunded.

VOIDED

The payment is displayed as voided.


ProductionStatus

Represents the production status of an item.

Valid values

NOT_APPLICABLE

Status is not applicable for the item.

PENDING

The item production was requested and is awaiting an update on its status.

IN_PRODUCTION

The item is in production.

DONE

The item is done.


ResourceType

Represents the type of a resource.

Valid values

ORDER

The resource is an order.

PAYMENT

The resource is a payment.


ShipmentDimensionsUnitEnum

Units of measurement for dimensions.

Valid values

CM

Centimeters.

IN

Inches.


ShipmentProviderEnum

The platform used for shipping and logistics management.

Valid values

CUSTOM

A custom platform or method has been used.

SENDCLOUD

The Sendcloud shipping platform has been used.

SHIPENGINE

The ShipEngine shipping platform has been used.

BPOST

The bpost shipping platform has been used.


ShipmentWeightUnitEnum

Units of measurement for weight.

Valid values

G

G stands for grams. Gram is the basic metric unit of mass.

KG

KG stands for kilogram — 1 kilogram equals 1000 grams.

LB

LB stands for pound — 1 pound equals 16 ounces.

OZ

OZ stands for ounce. Ounce is the imperial metric unit of mass.


ShippingShippingStatusEnum

The valid values for the status of a shipment.

Valid values

CANCELED

The shipment has been canceled.

DELIVERED

The shipment has been delivered successfully.

ERROR

An error occurred while trying to retrieve the shipping status.

FAILED

The shipment has failed.

IN_TRANSIT

The shipment is in transit.

PENDING

The shipment is pending processing.

UNKNOWN

Unknown status.


ShippingStatusEnum

The valid values for the status of a shipment.

Valid values

CANCELED

The shipment has been canceled.

DELIVERED

The shipment has been delivered successfully.

FAILED

The shipment has failed.

PENDING

The shipment is pending.

SHIPPED

The shipment is on its way.


TaxProvider

The platform responsible for sales tax management.

Valid values

BRIKL_TAX_SETTINGS

Brikl tax settings have been applied.

TAXJAR

TaxJar has been used.


WeightUnit

Units of measurement for weight.

Valid values

G

G stands for grams. Gram is the basic metric unit of mass.

KG

KG stands for kilogram — 1 kilogram equals 1000 grams.

LB

LB stands for pound — 1 pound equals 16 ounces.

OZ

OZ stands for ounce. Ounce is the imperial metric unit of mass.


Input objects

GraphQL operations might accept arguments to configure their behavior. These arguments are often scalars or enums, but they sometimes need to represent more complex values.

To configure fields with complex values, we use input objects. Input objects are objects used as arguments.


OrderFilterInput

Specifies the orders to be retrieved when using the orders query.

Return fields

organisationIdID

The unique identifier of the organization.


OrderTimelineFilterInput

Specifies the type of order updates to be retrieved when querying the history field in the Order object.

Return fields

payloadTypes[AuditLogPayloadType]!non-null

The list of payload types to be retrieved.


UpdateOrderInput

Specifies the information to be updated on an order when using the updatedOrder mutation.

Return fields

commentString

The new content for the comment associated with the order. Overwrites the current comment.

orderIdID!non-null

The ID of the order to update.

shippingStatusShippingStatusEnum

The new shipping status for the order. Overwrites the current shipping status.

paymentStatusOrderPaymentStatusEnum

The new payment status for the order. Overwrites the current payment status.

isHiddenFromUsersBoolean

Whether the update is visible to the customer or not.


UpdateOrderMetadataInput

Specifies the information to be updated on an order when using the updateOrderMetadata mutation.

Return fields

metadataJSONObject!non-null

The new metafields to add to the existing meta object for the order. Must be an object with string values.

orderIdID!non-null

The ID of the order to update.


Interfaces

Interfaces are parent objects from which other objects can inherit.

For example, LogData is an interface because both S3KeyPathLogData and EmailNotificationLogData hold data logs.

Objects that implement an interface must have all fields defined by that interface.


LogData

Represents the data of the audit log.

Implemented by:

  • S3KeyPathLogData
  • EmailNotificationLogData
  • SimpleMessageLogData
  • FieldUpdatedLogData

Return fields

typeAuditLogPayloadType!non-null

The type of payload.


Scalars

Scalars are primitive values, like Int, Float, String, Boolean, or ID.

When calling a GraphQL API, you must specify nested subfields until you return only scalars.

For more information, see Scalars in GraphQL spec.


Boolean

Represents true or false values.


DateTime

An ISO-8601 encoded UTC date string.


Float

Represents signed double-precision fractional values as specified by IEEE 754.


ID

Represents a unique identifier. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as M1ugvHj7C==) or integer (such as 7) input value will be accepted as an ID.


Int

Represents a signed 32-bit numeric non-fractional value. Int can represent values between -(2^31) and 2^31 - 1.


JSONObject

The JSONObject scalar type represents JSON objects as specified by ECMA-404.


String

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.