Docs
Management API
Order Settings

Order Settings

Get Global Order Settings

GET /orders/settings

Request

Returns global order settings.

Authentication

  • X-Auth-Token in header
    required

Parameters

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

    The MIME type of the response body.

example

Response

OK

Body

application/json
  • notifications
    object

    Global notification settings.

  • meta
    object

    Response metadata.

  • notifications
    object

    Global notification settings.

  • meta
    object

    Response metadata.

Update Global Order Settings

PUT /orders/settings

Request

Updates global order settings.

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.

Body

object | application/json
  • notifications
    object

    Global notification settings.

EnableMultipleOrderNotifications

DisableOrderPlacedNotificatons

Response

OK

Body

application/json
  • notifications
    object

    Global notification settings.

  • meta
    object

    Response metadata.

  • notifications
    object

    Global notification settings.

  • meta
    object

    Response metadata.

example

Get Channel Order Settings

GET /orders/settings/channels/{channel_id}

Request

Returns order settings for a specific channel.

Authentication

  • X-Auth-Token in header
    required

Parameters

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

    The MIME type of the response body.

  • channel_id in path - string
    required

    Channel ID

example

Response

OK

Body

application/json
  • notifications
    object

    Channel notification settings.

  • meta
    object

    Response metadata.

  • notifications
    object

    Channel notification settings.

  • meta
    object

    Response metadata.

Update Channel Order Settings

PUT /orders/settings/channels/{channel_id}

Request

Updates order settings for a specific channel.

Note: You must override both notifications email_addresses or neither, i.e. either both notification email_addresses are an array of valid email addresses, or both email_addresses must be null. You may not have one set to an array of addresses and the other set to null.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • channel_id in path - string
    required

    Channel ID

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

    The MIME type of the request body.

Body

object | application/json
  • notifications
    object

    Channel notification settings.

OverrideOrderPlacedEmailAddressesAndDisableForwardEmailAddresses

ResetChannelSettings

DisableMultipleNotificatonsForChannels

Response

OK

Body

application/json
  • notifications
    object

    Channel notification settings.

  • meta
    object

    Response metadata.

  • notifications
    object

    Channel notification settings.

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?