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.