Create Brand

Use this API to create a new brand under the specific business. A business can have multiple brands associated with it.

📘

  • A default brand is created under a business when the account is setup by Delivery Solutions.

  • Brand id and external id cannot be changed later once created.

Response

PropertyTypeDescription
  • id
StringUnique ID for the brand assigned by Delivery Solutions
nameStringName of the brand
brandExternalIdStringUnique id of the brand from the customer as setup in their system
addressObjectAddress of the brand
descriptionStringDescription of the brand
activebooleanFlag that specifies whether the brand is enabled or disabled
tenantIdStringtenantId associated with the business
atRiskObjectatRisk settings associated with the brand.
pickupInstructionsStringpickupInstructions associated with the brand
currencyCodeStringcurrency code associated with the brand
isDefaultbooleanspecifies whether the brand is default
createdAtStringThe time when the brand was created in Delivery Solutions in ISO 8601 format
lastUpdatedAtStringThe time when the brand was last updated in ISO 8601 format.
Body Params
string
required

Name of the brand

string

Unique Id of the brand. If not provided, the brandExternalId will be same as name. This field cannot be updated later.

string

Description of the brand

string

Currency code for the brand in ISO 4217 alphabetical format, e.g. USD. If this is not provided, the default currency code from business configuration is used.

address
object
required

Business address for the brand

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json