ShipEngineApi::MarketplaceAccountsApi

All URIs are relative to https://api.shipengine.com

Method	HTTP request	Description
v_beta_connections_marketplaces_amazon_deactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/amazon/{store_id}/deactivate	amazon_account.deactivate
v_beta_connections_marketplaces_amazon_post	POST /v-beta/connections/marketplaces/amazon	amazon_account.connect
v_beta_connections_marketplaces_amazon_reactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/amazon/{store_id}/reactivate	amazon_account.reactivate
v_beta_connections_marketplaces_amazon_settings_by_store_id_put	PUT /v-beta/connections/marketplaces/amazon/{store_id}/settings	amazon_account.update_settings
v_beta_connections_marketplaces_amazon_test_by_store_id_get	GET /v-beta/connections/marketplaces/amazon/{store_id}/test	amazon_account.test
v_beta_connections_marketplaces_channeladvisor_deactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/channeladvisor/{store_id}/deactivate	channel_advisor_account.deactivate
v_beta_connections_marketplaces_channeladvisor_post	POST /v-beta/connections/marketplaces/channeladvisor	channel_advisor_account.connect
v_beta_connections_marketplaces_channeladvisor_reactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/channeladvisor/{store_id}/reactivate	channel_advisor_account.reactivate
v_beta_connections_marketplaces_channeladvisor_settings_by_store_id_put	PUT /v-beta/connections/marketplaces/channeladvisor/{store_id}/settings	channel_advisor_account.update_settings
v_beta_connections_marketplaces_channeladvisor_test_by_store_id_get	GET /v-beta/connections/marketplaces/channeladvisor/{store_id}/test	channel_advisor_account.test
v_beta_connections_marketplaces_ebay_access_token_post	POST /v-beta/connections/marketplaces/ebay/access_token	ebay_account.connect_access_token
v_beta_connections_marketplaces_ebay_deactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/ebay/{store_id}/deactivate	ebay_account.deactivate
v_beta_connections_marketplaces_ebay_reactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/ebay/{store_id}/reactivate	ebay_account.reactivate
v_beta_connections_marketplaces_ebay_settings_by_store_id_put	PUT /v-beta/connections/marketplaces/ebay/{store_id}/settings	ebay_account.update_settings
v_beta_connections_marketplaces_ebay_test_by_store_id_get	GET /v-beta/connections/marketplaces/ebay/{store_id}/test	ebay_account.test
v_beta_connections_marketplaces_etsy_access_token_post	POST /v-beta/connections/marketplaces/etsy/access_token	etsy_account.connect
v_beta_connections_marketplaces_etsy_deactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/etsy/{store_id}/deactivate	etsy_account.deactivate
v_beta_connections_marketplaces_etsy_reactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/etsy/{store_id}/reactivate	etsy_account.reactivate
v_beta_connections_marketplaces_etsy_settings_by_store_id_put	PUT /v-beta/connections/marketplaces/etsy/{store_id}/settings	etsy_account.update_settings
v_beta_connections_marketplaces_etsy_test_by_store_id_get	GET /v-beta/connections/marketplaces/etsy/{store_id}/test	etsy_account.test
v_beta_connections_marketplaces_magento_deactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/magento/{store_id}/deactivate	magento_account.deactivate
v_beta_connections_marketplaces_magento_post	POST /v-beta/connections/marketplaces/magento	magento_account.connect
v_beta_connections_marketplaces_magento_reactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/magento/{store_id}/reactivate	magento_account.reactivate
v_beta_connections_marketplaces_magento_settings_by_store_id_put	PUT /v-beta/connections/marketplaces/magento/{store_id}/settings	magento_account.update_settings
v_beta_connections_marketplaces_magento_test_by_store_id_get	GET /v-beta/connections/marketplaces/magento/{store_id}/test	magento_account.test
v_beta_connections_marketplaces_shopify_access_token_post	POST /v-beta/connections/marketplaces/shopify/access_token	shopify_account.connect_access_token
v_beta_connections_marketplaces_shopify_deactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/shopify/{store_id}/deactivate	shopify_account.deactivate
v_beta_connections_marketplaces_shopify_reactivate_by_store_id_put	PUT /v-beta/connections/marketplaces/shopify/{store_id}/reactivate	shopify_account.reactivate
v_beta_connections_marketplaces_shopify_settings_by_store_id_put	PUT /v-beta/connections/marketplaces/shopify/{store_id}/settings	shopify_account.update_settings
v_beta_connections_marketplaces_shopify_test_by_store_id_get	GET /v-beta/connections/marketplaces/shopify/{store_id}/test	shopify_account.test

v_beta_connections_marketplaces_amazon_deactivate_by_store_id_put

v_beta_connections_marketplaces_amazon_deactivate_by_store_id_put(store_id)

amazon_account.deactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #amazon_account.deactivate
  api_instance.v_beta_connections_marketplaces_amazon_deactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_amazon_deactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_amazon_post

ConnectMarketplaceResponseBody v_beta_connections_marketplaces_amazon_post(body)

amazon_account.connect

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

body = ShipEngineApi::AmazonAccountInformationRequestBody.new # AmazonAccountInformationRequestBody | 


begin
  #amazon_account.connect
  result = api_instance.v_beta_connections_marketplaces_amazon_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_amazon_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	AmazonAccountInformationRequestBody

Return type

ConnectMarketplaceResponseBody

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_amazon_reactivate_by_store_id_put

v_beta_connections_marketplaces_amazon_reactivate_by_store_id_put(store_id)

amazon_account.reactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #amazon_account.reactivate
  api_instance.v_beta_connections_marketplaces_amazon_reactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_amazon_reactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_amazon_settings_by_store_id_put

v_beta_connections_marketplaces_amazon_settings_by_store_id_put(store_id, body)

amazon_account.update_settings

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 

body = ShipEngineApi::DefaultAccountSettingsRequestBody.new # DefaultAccountSettingsRequestBody | 


begin
  #amazon_account.update_settings
  api_instance.v_beta_connections_marketplaces_amazon_settings_by_store_id_put(store_id, body)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_amazon_settings_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String
body	DefaultAccountSettingsRequestBody

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_amazon_test_by_store_id_get

v_beta_connections_marketplaces_amazon_test_by_store_id_get(store_id)

amazon_account.test

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #amazon_account.test
  api_instance.v_beta_connections_marketplaces_amazon_test_by_store_id_get(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_amazon_test_by_store_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_channeladvisor_deactivate_by_store_id_put

v_beta_connections_marketplaces_channeladvisor_deactivate_by_store_id_put(store_id)

channel_advisor_account.deactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #channel_advisor_account.deactivate
  api_instance.v_beta_connections_marketplaces_channeladvisor_deactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_channeladvisor_deactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_channeladvisor_post

ConnectMarketplaceResponseBody v_beta_connections_marketplaces_channeladvisor_post(body)

channel_advisor_account.connect

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

body = ShipEngineApi::ChannelAdvisorAccountInformationRequestBody.new # ChannelAdvisorAccountInformationRequestBody | 


begin
  #channel_advisor_account.connect
  result = api_instance.v_beta_connections_marketplaces_channeladvisor_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_channeladvisor_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	ChannelAdvisorAccountInformationRequestBody

Return type

ConnectMarketplaceResponseBody

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_channeladvisor_reactivate_by_store_id_put

v_beta_connections_marketplaces_channeladvisor_reactivate_by_store_id_put(store_id)

channel_advisor_account.reactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #channel_advisor_account.reactivate
  api_instance.v_beta_connections_marketplaces_channeladvisor_reactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_channeladvisor_reactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_channeladvisor_settings_by_store_id_put

v_beta_connections_marketplaces_channeladvisor_settings_by_store_id_put(store_id, body)

channel_advisor_account.update_settings

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 

body = ShipEngineApi::DefaultAccountSettingsRequestBody.new # DefaultAccountSettingsRequestBody | 


begin
  #channel_advisor_account.update_settings
  api_instance.v_beta_connections_marketplaces_channeladvisor_settings_by_store_id_put(store_id, body)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_channeladvisor_settings_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String
body	DefaultAccountSettingsRequestBody

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_channeladvisor_test_by_store_id_get

v_beta_connections_marketplaces_channeladvisor_test_by_store_id_get(store_id)

channel_advisor_account.test

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #channel_advisor_account.test
  api_instance.v_beta_connections_marketplaces_channeladvisor_test_by_store_id_get(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_channeladvisor_test_by_store_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_ebay_access_token_post

ConnectMarketplaceResponseBody v_beta_connections_marketplaces_ebay_access_token_post(body)

ebay_account.connect_access_token

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

body = ShipEngineApi::EbayAccessTokenRequestBody.new # EbayAccessTokenRequestBody | 


begin
  #ebay_account.connect_access_token
  result = api_instance.v_beta_connections_marketplaces_ebay_access_token_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_ebay_access_token_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	EbayAccessTokenRequestBody

Return type

ConnectMarketplaceResponseBody

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_ebay_deactivate_by_store_id_put

v_beta_connections_marketplaces_ebay_deactivate_by_store_id_put(store_id)

ebay_account.deactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #ebay_account.deactivate
  api_instance.v_beta_connections_marketplaces_ebay_deactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_ebay_deactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_ebay_reactivate_by_store_id_put

v_beta_connections_marketplaces_ebay_reactivate_by_store_id_put(store_id)

ebay_account.reactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #ebay_account.reactivate
  api_instance.v_beta_connections_marketplaces_ebay_reactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_ebay_reactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_ebay_settings_by_store_id_put

v_beta_connections_marketplaces_ebay_settings_by_store_id_put(store_id, body)

ebay_account.update_settings

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 

body = ShipEngineApi::DefaultAccountSettingsRequestBody.new # DefaultAccountSettingsRequestBody | 


begin
  #ebay_account.update_settings
  api_instance.v_beta_connections_marketplaces_ebay_settings_by_store_id_put(store_id, body)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_ebay_settings_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String
body	DefaultAccountSettingsRequestBody

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_ebay_test_by_store_id_get

v_beta_connections_marketplaces_ebay_test_by_store_id_get(store_id)

ebay_account.test

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #ebay_account.test
  api_instance.v_beta_connections_marketplaces_ebay_test_by_store_id_get(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_ebay_test_by_store_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_etsy_access_token_post

ConnectMarketplaceResponseBody v_beta_connections_marketplaces_etsy_access_token_post(body)

etsy_account.connect

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

body = ShipEngineApi::EtsyAccessTokenRequestBody.new # EtsyAccessTokenRequestBody | 


begin
  #etsy_account.connect
  result = api_instance.v_beta_connections_marketplaces_etsy_access_token_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_etsy_access_token_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	EtsyAccessTokenRequestBody

Return type

ConnectMarketplaceResponseBody

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_etsy_deactivate_by_store_id_put

v_beta_connections_marketplaces_etsy_deactivate_by_store_id_put(store_id)

etsy_account.deactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #etsy_account.deactivate
  api_instance.v_beta_connections_marketplaces_etsy_deactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_etsy_deactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_etsy_reactivate_by_store_id_put

v_beta_connections_marketplaces_etsy_reactivate_by_store_id_put(store_id)

etsy_account.reactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #etsy_account.reactivate
  api_instance.v_beta_connections_marketplaces_etsy_reactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_etsy_reactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_etsy_settings_by_store_id_put

v_beta_connections_marketplaces_etsy_settings_by_store_id_put(store_id, body)

etsy_account.update_settings

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 

body = ShipEngineApi::DefaultAccountSettingsRequestBody.new # DefaultAccountSettingsRequestBody | 


begin
  #etsy_account.update_settings
  api_instance.v_beta_connections_marketplaces_etsy_settings_by_store_id_put(store_id, body)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_etsy_settings_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String
body	DefaultAccountSettingsRequestBody

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_etsy_test_by_store_id_get

v_beta_connections_marketplaces_etsy_test_by_store_id_get(store_id)

etsy_account.test

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #etsy_account.test
  api_instance.v_beta_connections_marketplaces_etsy_test_by_store_id_get(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_etsy_test_by_store_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_magento_deactivate_by_store_id_put

v_beta_connections_marketplaces_magento_deactivate_by_store_id_put(store_id)

magento_account.deactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #magento_account.deactivate
  api_instance.v_beta_connections_marketplaces_magento_deactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_magento_deactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_magento_post

ConnectMarketplaceResponseBody v_beta_connections_marketplaces_magento_post(body)

magento_account.connect

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

body = ShipEngineApi::MagentoAccountInformationRequestBody.new # MagentoAccountInformationRequestBody | 


begin
  #magento_account.connect
  result = api_instance.v_beta_connections_marketplaces_magento_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_magento_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	MagentoAccountInformationRequestBody

Return type

ConnectMarketplaceResponseBody

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_magento_reactivate_by_store_id_put

v_beta_connections_marketplaces_magento_reactivate_by_store_id_put(store_id)

magento_account.reactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #magento_account.reactivate
  api_instance.v_beta_connections_marketplaces_magento_reactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_magento_reactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_magento_settings_by_store_id_put

v_beta_connections_marketplaces_magento_settings_by_store_id_put(store_id, body)

magento_account.update_settings

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 

body = ShipEngineApi::DefaultAccountSettingsRequestBody.new # DefaultAccountSettingsRequestBody | 


begin
  #magento_account.update_settings
  api_instance.v_beta_connections_marketplaces_magento_settings_by_store_id_put(store_id, body)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_magento_settings_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String
body	DefaultAccountSettingsRequestBody

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_magento_test_by_store_id_get

v_beta_connections_marketplaces_magento_test_by_store_id_get(store_id)

magento_account.test

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #magento_account.test
  api_instance.v_beta_connections_marketplaces_magento_test_by_store_id_get(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_magento_test_by_store_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_shopify_access_token_post

ConnectMarketplaceResponseBody v_beta_connections_marketplaces_shopify_access_token_post(body)

shopify_account.connect_access_token

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

body = ShipEngineApi::ShopifyAccessTokenRequestBody.new # ShopifyAccessTokenRequestBody | 


begin
  #shopify_account.connect_access_token
  result = api_instance.v_beta_connections_marketplaces_shopify_access_token_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_shopify_access_token_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	ShopifyAccessTokenRequestBody

Return type

ConnectMarketplaceResponseBody

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_shopify_deactivate_by_store_id_put

v_beta_connections_marketplaces_shopify_deactivate_by_store_id_put(store_id)

shopify_account.deactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #shopify_account.deactivate
  api_instance.v_beta_connections_marketplaces_shopify_deactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_shopify_deactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_shopify_reactivate_by_store_id_put

v_beta_connections_marketplaces_shopify_reactivate_by_store_id_put(store_id)

shopify_account.reactivate

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #shopify_account.reactivate
  api_instance.v_beta_connections_marketplaces_shopify_reactivate_by_store_id_put(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_shopify_reactivate_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_shopify_settings_by_store_id_put

v_beta_connections_marketplaces_shopify_settings_by_store_id_put(store_id, body)

shopify_account.update_settings

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 

body = ShipEngineApi::DefaultAccountSettingsRequestBody.new # DefaultAccountSettingsRequestBody | 


begin
  #shopify_account.update_settings
  api_instance.v_beta_connections_marketplaces_shopify_settings_by_store_id_put(store_id, body)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_shopify_settings_by_store_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String
body	DefaultAccountSettingsRequestBody

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

v_beta_connections_marketplaces_shopify_test_by_store_id_get

v_beta_connections_marketplaces_shopify_test_by_store_id_get(store_id)

shopify_account.test

Example

# load the gem
require 'shipengine_api'
# setup authorization
ShipEngineApi.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'
end

api_instance = ShipEngineApi::MarketplaceAccountsApi.new

store_id = 'store_id_example' # String | 


begin
  #shopify_account.test
  api_instance.v_beta_connections_marketplaces_shopify_test_by_store_id_get(store_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling MarketplaceAccountsApi->v_beta_connections_marketplaces_shopify_test_by_store_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

MarketplaceAccountsApi.md

Latest commit

History

MarketplaceAccountsApi.md

File metadata and controls

ShipEngineApi::MarketplaceAccountsApi

v_beta_connections_marketplaces_amazon_deactivate_by_store_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_amazon_post

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_amazon_reactivate_by_store_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_amazon_settings_by_store_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_amazon_test_by_store_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_channeladvisor_deactivate_by_store_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_channeladvisor_post

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_channeladvisor_reactivate_by_store_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_channeladvisor_settings_by_store_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_channeladvisor_test_by_store_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_ebay_access_token_post

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_ebay_deactivate_by_store_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

v_beta_connections_marketplaces_ebay_reactivate_by_store_id_put