Docs
Management API
Shipping V3
Shipping Settings

Shipping Settings

Get Shipping Settings

GET /shipping/settings

Request

Returns the global-level shipping settings.

Authentication

  • X-Auth-Token in header

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

Body

object | application/json

  • data    object

  • meta    object

example

Update Shipping Settings

PUT /shipping/settings

Request

Updates the global-level shipping settings.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • checkout    object

example

Response

Body

object | application/json

  • data    object

  • meta    object

example

Get Shipping Settings per Channel

GET /shipping/settings/channels/{channel_id}

Request

Returns shipping settings for a specific channel.

Authentication

  • X-Auth-Token in header

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

Body

object | application/json

  • data    object

  • meta    object

example

Update Shipping Settings per Channel

PUT /shipping/settings/channels/{channel_id}

Request

Updates shipping settings for a specific channel.

Authentication

  • X-Auth-Token in header

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
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • checkout    object

example

Response

Body

object | application/json

  • data    object

  • meta    object

example

Did you find what you were looking for?
Upsert Customs InformationGet Shipping Settings