GraphQL API
Organization API
Organization / Brand portals

brandPortalUpdate

Update a brand portal's settings

Arguments

2 arguments
id•ID!

ID of the brand portal.

colorBackground•String

Background color (HEX)

colorPrimary•String

Primary color (HEX)

colorSecondary•String

Secondary color (HEX)

orderReferenceExample•String

Example order reference

orderSearchMode•BrandPortalOrderSearchMode

Order lookup fields used by the portal

EMAIL_AND_REFERENCEREFERENCE_AND_POSTAL_CODE
returnMethods•[ReturnMethod!]

Enabled return methods

DROP_OFF_POINTOWN_CARRIERPICKUPSTORE
returnPaymentIntegrationId•ID

ID of the payment integration used for return shipping payments

returnPaymentProfileReference•String

Profile reference for the return payment integration

returnPeriodInDays•Int

Return period in days used for communication

returnPeriodInDaysHard•Int

Return period in days used to block requests

returnReasonRequired•Boolean

Return reason required

returnRefundTypes•[ReturnRefundType!]

Enabled return refund types

COUPONEXCHANGEGIFT_CARDMONEY
subdomain•String

Subdomain of the portal

Possible return

colorBackground•String

Background color

colorPrimary•String

Primary color

colorSecondary•String

Secondary color

createdAt•DateTimeTz!

When the brand portal was created.

id•ID!

Unique primary key.

orderReferenceExample•String

Example order reference

orderSearchMode•BrandPortalOrderSearchMode!

Order lookup fields used by the portal

EMAIL_AND_REFERENCEREFERENCE_AND_POSTAL_CODE
returnMethods•[ReturnMethod!]

Enabled return methods

DROP_OFF_POINTOWN_CARRIERPICKUPSTORE
returnPaymentProfileReference•String

The profile reference for the used return payment integration

returnPeriodInDays•Int!

Return period in days used for communication

returnPeriodInDaysHard•Int!

Return period in days used to block requests

returnReasonRequired•Boolean!

Return reason required

returnRefundTypes•[ReturnRefundType!]

Enabled return refund types

COUPONEXCHANGEGIFT_CARDMONEY
subdomain•String!

Subdomain of the brand portal

updatedAt•DateTimeTz!

When the brand portal was last updated.

url•String!

URL of the brand portal

field•[String!]
message•String!