Docs
Management API
Store Profile

Store Profile

Get Store Profile Settings

GET /settings/store/profile

Request

Returns store profile settings.

  • Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only.

  • null indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • channel_id in query - integer

    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

example

Response

OK. null indicates that a particular field has not been overridden on a channel level when channel level settings are requested

Body

object | application/json
  • data
    object

    The basic profile settings for a store, used to give the shopper information about the business from which they are purchasing.

  • meta
    object

    Response metadata.

example

Update Store Profile Settings

PUT /settings/store/profile

Request

Updates store profile settings.

  • Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only.

  • null should be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied with null value in order to delete overrides per channel.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

  • channel_id in query - integer

    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

Body

object | application/json

The basic profile settings for a store, used to give the shopper information about the business from which they are purchasing.

  • store_address
    string

  • store_address_type
    string

    Only supports manipulation on a global level.

    Allowed: Home Office | Commercial Office | Retail | Warehouse

    Default: Home Office

  • store_email
    string

  • store_name
    string

  • store_phone
    string

example

Response

Body

object | application/json
  • data
    object

    The basic profile settings for a store, used to give the shopper information about the business from which they are purchasing.

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?