Skip to main content

OnboardBrandInput

Autogenerated input type of OnboardBrand

input OnboardBrandInput {
  clientMutationId: String
  companyId: ID
  description: String
  handle: String
  logoUrl: Url
  name: String!
  responsibleId: ID @deprecated
  status: BrandStatusEnum
  warehouseId: ID @deprecated
  websiteUrl: Url
}

Fields​

OnboardBrandInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

OnboardBrandInput.companyId ● ID scalar common​

Party ID of the company that will own the brand.

OnboardBrandInput.description ● String scalar common​

OnboardBrandInput.handle ● String scalar common​

Autogenerated if not provided. A unique human readable identifier for each brand within a company that will be used in UI URLs for brand-specific pages. It should be a maximum of 5 letters. e.g. EC for Endless Commerce

OnboardBrandInput.logoUrl ● Url scalar common​

OnboardBrandInput.name ● String! non-null scalar common​

OnboardBrandInput.responsibleId ● ID deprecated scalar common​

DEPRECATED

This argument is deprecated and will be removed in the future.

Party ID of the person that will be responsible of the brand. This person will be the default contact for the brand and also will be assigned as the admin of the brand.

OnboardBrandInput.status ● BrandStatusEnum enum common​

OnboardBrandInput.warehouseId ● ID deprecated scalar common​

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only entity.

ID of the warehouse that will be associated with the brand. This warehouse will be used as the default warehouse for the brand.

OnboardBrandInput.websiteUrl ● Url scalar common​

Member Of​

onboardBrand mutation