GraphQL API
Organization API
Organization / Types/ object

BrandPortalConnection

A paginated list of BrandPortal edges.

Fields

2 fields
cursorString!

A unique cursor that can be used for pagination.

colorBackgroundString

Background color

colorPrimaryString

Primary color

colorSecondaryString

Secondary color

createdAtDateTimeTz!

When the brand portal was created.

idID!

Unique primary key.

orderReferenceExampleString

Example order reference

orderSearchModeBrandPortalOrderSearchMode!

Order lookup fields used by the portal

EMAIL_AND_REFERENCEREFERENCE_AND_POSTAL_CODE
returnMethods[ReturnMethod!]

Enabled return methods

DROP_OFF_POINTOWN_CARRIERPICKUPSTORE
returnPaymentIntegrationIntegration

Payment integration to use for return portal payments

returnPaymentProfileReferenceString

The profile reference for the used return payment integration

returnPeriodInDaysInt!

Return period in days used for communication

returnPeriodInDaysHardInt!

Return period in days used to block requests

returnReasonRequiredBoolean!

Return reason required

returnRefundTypes[ReturnRefundType!]

Enabled return refund types

COUPONEXCHANGEGIFT_CARDMONEY
shippingServiceMethodOverridesBrandPortalShippingServiceMethodConnection!

Shipping service method overrides

Side images shown by the brand portal

subdomainString!

Subdomain of the brand portal

updatedAtDateTimeTz!

When the brand portal was last updated.

urlString!

URL of the brand portal

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.