Register an integrated merchant account. [Authenticated; Perm: System Integrator]

post

https://qa-api.giftlocal.com/api/integration/merchant-provisioning/register-account

Body Params

The request.

accountID

uuid

An optional account ID to use when creating a location under an existing account (or just wanting an explicit account id). For new merchants, this should generally be left null / blank.

accountName

string

An optional account name. Use when the root merchant account and location name are different. If not specified, the location name will be used.

adminEmailAddress

string

The email address of the root admin user (required).

adminFirstName

string

The first name of the root admin user (required).

adminLastName

string

The last name of the root admin user (required).

adminMobileNumber

string

An optional mobile number for the root admin user.

adminPassword

string

An optional password for the root admin user. If none is specified, the root admin user will be invited to the account to establish their own password on the giftlocal.com partner portal.

affiliateProgramCode

string

An optional affiliate program code to associate this merchant to a source affiliate. Only a Program Code or ID need to be specified - but not both.

affiliateProgramID

uuid

An optional affiliate program id to associate this merchant to a source affiliate. Only a Program Code or ID need to be specified - but not both.

currentUserIsAdmin

boolean

If the current authenticated user should be an admin of the account. Use for creation of an account from an existing consumer user. Default is false. Additional AdminX fields will be ignored when enabled.

defaultRedemptionPointOfSaleSystemID

int32

The Point of Sale system used by the account and associated locations.

locationAddress

string

The street address of the merchant location.

locationAddress2

string

The street address (line 2) of the merchant location.

locationCity

string

The city the merchant location is located in (required).

locationInstagram

string

An optional instagram handle associated with the merchant location. Exclude any prefix or url parts. Include just the handle portion.

locationMarketID

int32

A market id value as retreived from the market list. Technically optional but used to set currency and timezone information so highly advised.

locationName

string

A name for the merchant location (required).

locationNeighborhoodName

string

An optional neighborhood name where the merchant location is located.

locationPhoneNumber

string

An optional phone number associated with the merchant location.

locationPointOfSaleSystemIdentifier

string

When a Point of Sale system, the system-specific identifier for that location. Can be used with redemption workflows to identify target location.

locationPostalCode

string

The zip code the merchant location is located in.

locationStateProvince

string

The state the merchant location is located in (required).

locationUrlToken

string

An optional explicit url token for the location. If blank, will be automatically created based on the location name.

locationWebsiteUrl

string

An optional website url associated with the merchant location. Start with http.

merchantCategoryID

int32

A required non-parent merchant category id as retreived from the category list.

subscriptions

array of objects

A list of Program subscriptions for each location.

subscriptions

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200OK