ShipEngineApi::CarrierAccountsApi

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

Method	HTTP request	Description
v1_connections_carriers_access_worldwide_by_carrier_id_delete	DELETE /v1/connections/carriers/access_worldwide/{carrier_id}	access_worldwide_account_carrier.disconnect_account
v1_connections_carriers_access_worldwide_post	POST /v1/connections/carriers/access_worldwide	access_worldwide_account_carrier.connect_account
v1_connections_carriers_apc_by_carrier_id_delete	DELETE /v1/connections/carriers/apc/{carrier_id}	apc_account_carrier.disconnect_account
v1_connections_carriers_apc_post	POST /v1/connections/carriers/apc	apc_account_carrier.connect_account
v1_connections_carriers_asendia_by_carrier_id_delete	DELETE /v1/connections/carriers/asendia/{carrier_id}	asendia_account_carrier.disconnect_account
v1_connections_carriers_asendia_post	POST /v1/connections/carriers/asendia	asendia_account_carrier.connect_account
v1_connections_carriers_dhl_ecommerce_by_carrier_id_delete	DELETE /v1/connections/carriers/dhl_ecommerce/{carrier_id}	dhl_ecommerce_account_carrier.disconnect_account
v1_connections_carriers_dhl_ecommerce_post	POST /v1/connections/carriers/dhl_ecommerce	dhl_ecommerce_account_carrier.connect_account
v1_connections_carriers_dhl_express_by_carrier_id_delete	DELETE /v1/connections/carriers/dhl_express/{carrier_id}	dhl_express_account_carrier.disconnect_account
v1_connections_carriers_dhl_express_post	POST /v1/connections/carriers/dhl_express	dhl_express_account_carrier.connect_account
v1_connections_carriers_dhl_express_settings_by_carrier_id_get	GET /v1/connections/carriers/dhl_express/{carrier_id}/settings	dhl_express_account_carrier.get_settings
v1_connections_carriers_dhl_express_settings_by_carrier_id_put	PUT /v1/connections/carriers/dhl_express/{carrier_id}/settings	dhl_express_account_carrier.update_settings
v1_connections_carriers_dhl_express_uk_by_carrier_id_delete	DELETE /v1/connections/carriers/dhl_express_uk/{carrier_id}	dhl_express_uk_account_carrier.disconnect_account
v1_connections_carriers_dhl_express_uk_post	POST /v1/connections/carriers/dhl_express_uk	dhl_express_uk_account_carrier.connect_account
v1_connections_carriers_dpd_by_carrier_id_delete	DELETE /v1/connections/carriers/dpd/{carrier_id}	dpd_account_carrier.disconnect_account
v1_connections_carriers_dpd_post	POST /v1/connections/carriers/dpd	dpd_account_carrier.connect_account
v1_connections_carriers_endicia_by_carrier_id_delete	DELETE /v1/connections/carriers/endicia/{carrier_id}	endicia_account_carrier.disconnect_account
v1_connections_carriers_endicia_post	POST /v1/connections/carriers/endicia	endicia_account_carrier.connect_account
v1_connections_carriers_fedex_by_carrier_id_delete	DELETE /v1/connections/carriers/fedex/{carrier_id}	fedex_account_carrier.disconnect_account
v1_connections_carriers_fedex_post	POST /v1/connections/carriers/fedex	fedex_account_carrier.connect_account
v1_connections_carriers_fedex_settings_by_carrier_id_get	GET /v1/connections/carriers/fedex/{carrier_id}/settings	fedex_account_carrier.get_settings
v1_connections_carriers_fedex_settings_by_carrier_id_put	PUT /v1/connections/carriers/fedex/{carrier_id}/settings	fedex_account_carrier.update_settings
v1_connections_carriers_fedex_uk_by_carrier_id_delete	DELETE /v1/connections/carriers/fedex_uk/{carrier_id}	fedex_uk_account_carrier.disconnect_account
v1_connections_carriers_fedex_uk_post	POST /v1/connections/carriers/fedex_uk	fedex_uk_account_carrier.connect_account
v1_connections_carriers_firstmile_by_carrier_id_delete	DELETE /v1/connections/carriers/firstmile/{carrier_id}	first_mile_account_carrier.disconnect_account
v1_connections_carriers_firstmile_post	POST /v1/connections/carriers/firstmile	first_mile_account_carrier.connect_account
v1_connections_carriers_globegistics_by_carrier_id_delete	DELETE /v1/connections/carriers/globegistics/{carrier_id}	globegistics_account_carrier.disconnect_account
v1_connections_carriers_globegistics_post	POST /v1/connections/carriers/globegistics	globegistics_account_carrier.connect_account
v1_connections_carriers_imex_by_carrier_id_delete	DELETE /v1/connections/carriers/imex/{carrier_id}	imex_account_carrier.disconnect_account
v1_connections_carriers_imex_post	POST /v1/connections/carriers/imex	imex_account_carrier.connect_account
v1_connections_carriers_newgistics_by_carrier_id_delete	DELETE /v1/connections/carriers/newgistics/{carrier_id}	newgistics_account_carrier.disconnect_account
v1_connections_carriers_newgistics_post	POST /v1/connections/carriers/newgistics	newgistics_account_carrier.connect_account
v1_connections_carriers_newgistics_settings_by_carrier_id_put	PUT /v1/connections/carriers/newgistics/{carrier_id}/settings	newgistics_account_carrier.update_settings
v1_connections_carriers_ontrac_by_carrier_id_delete	DELETE /v1/connections/carriers/ontrac/{carrier_id}	ontrac_account_carrier.disconnect_account
v1_connections_carriers_ontrac_post	POST /v1/connections/carriers/ontrac	ontrac_account_carrier.connect_account
v1_connections_carriers_royal_mail_by_carrier_id_delete	DELETE /v1/connections/carriers/royal_mail/{carrier_id}	royal_mail_account_carrier.disconnect_account
v1_connections_carriers_royal_mail_post	POST /v1/connections/carriers/royal_mail	royal_mail_account_carrier.connect_account
v1_connections_carriers_rr_donnelley_by_carrier_id_delete	DELETE /v1/connections/carriers/rr_donnelley/{carrier_id}	rr_donnelley_account_carrier.disconnect_account
v1_connections_carriers_rr_donnelley_post	POST /v1/connections/carriers/rr_donnelley	rr_donnelley_account_carrier.connect_account
v1_connections_carriers_stamps_com_by_carrier_id_delete	DELETE /v1/connections/carriers/stamps_com/{carrier_id}	stamps_account_carrier.disconnect_account
v1_connections_carriers_stamps_com_post	POST /v1/connections/carriers/stamps_com	stamps_account_carrier.connect_account
v1_connections_carriers_stamps_com_request_account_url_by_carrier_id_put	PUT /v1/connections/carriers/stamps_com/{carrier_id}/request_account_url	stamps_account_carrier.get_account_url
v1_connections_carriers_ups_by_carrier_id_delete	DELETE /v1/connections/carriers/ups/{carrier_id}	ups_account_carrier.disconnect_account
v1_connections_carriers_ups_post	POST /v1/connections/carriers/ups	ups_account_carrier.connect_account
v1_connections_carriers_ups_settings_by_carrier_id_get	GET /v1/connections/carriers/ups/{carrier_id}/settings	ups_account_carrier.get_settings
v1_connections_carriers_ups_settings_by_carrier_id_put	PUT /v1/connections/carriers/ups/{carrier_id}/settings	ups_account_carrier.update_settings

v1_connections_carriers_access_worldwide_by_carrier_id_delete

v1_connections_carriers_access_worldwide_by_carrier_id_delete(carrier_id)

access_worldwide_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #access_worldwide_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_access_worldwide_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_access_worldwide_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_access_worldwide_post

ConnectAccountResponseBody v1_connections_carriers_access_worldwide_post(body)

access_worldwide_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::AccessWorldwideAccountInformationRequestBody.new # AccessWorldwideAccountInformationRequestBody | 


begin
  #access_worldwide_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_access_worldwide_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_access_worldwide_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	AccessWorldwideAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_apc_by_carrier_id_delete

v1_connections_carriers_apc_by_carrier_id_delete(carrier_id)

apc_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #apc_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_apc_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_apc_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_apc_post

ConnectAccountResponseBody v1_connections_carriers_apc_post(body)

apc_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::AccessWorldwideAccountInformationRequestBody.new # AccessWorldwideAccountInformationRequestBody | 


begin
  #apc_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_apc_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_apc_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	AccessWorldwideAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_asendia_by_carrier_id_delete

v1_connections_carriers_asendia_by_carrier_id_delete(carrier_id)

asendia_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #asendia_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_asendia_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_asendia_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_asendia_post

ConnectAccountResponseBody v1_connections_carriers_asendia_post(body)

asendia_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::AsendiaAccountInformationRequestBody.new # AsendiaAccountInformationRequestBody | 


begin
  #asendia_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_asendia_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_asendia_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	AsendiaAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_dhl_ecommerce_by_carrier_id_delete

v1_connections_carriers_dhl_ecommerce_by_carrier_id_delete(carrier_id)

dhl_ecommerce_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #dhl_ecommerce_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_dhl_ecommerce_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_dhl_ecommerce_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_dhl_ecommerce_post

ConnectAccountResponseBody v1_connections_carriers_dhl_ecommerce_post(body)

dhl_ecommerce_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::DhlEcommerceAccountInformationRequestBody.new # DhlEcommerceAccountInformationRequestBody | 


begin
  #dhl_ecommerce_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_dhl_ecommerce_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_dhl_ecommerce_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	DhlEcommerceAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_dhl_express_by_carrier_id_delete

v1_connections_carriers_dhl_express_by_carrier_id_delete(carrier_id)

dhl_express_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #dhl_express_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_dhl_express_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_dhl_express_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_dhl_express_post

ConnectAccountResponseBody v1_connections_carriers_dhl_express_post(body)

dhl_express_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::DhlExpressAccountInformationRequestBody.new # DhlExpressAccountInformationRequestBody | 


begin
  #dhl_express_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_dhl_express_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_dhl_express_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	DhlExpressAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_dhl_express_settings_by_carrier_id_get

DhlExpressAccountSettings v1_connections_carriers_dhl_express_settings_by_carrier_id_get(carrier_id)

dhl_express_account_carrier.get_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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #dhl_express_account_carrier.get_settings
  result = api_instance.v1_connections_carriers_dhl_express_settings_by_carrier_id_get(carrier_id)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_dhl_express_settings_by_carrier_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

DhlExpressAccountSettings

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_dhl_express_settings_by_carrier_id_put

v1_connections_carriers_dhl_express_settings_by_carrier_id_put(carrier_id, body)

dhl_express_account_carrier.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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 

body = ShipEngineApi::DhlExpressAccountSettings.new # DhlExpressAccountSettings | 


begin
  #dhl_express_account_carrier.update_settings
  api_instance.v1_connections_carriers_dhl_express_settings_by_carrier_id_put(carrier_id, body)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_dhl_express_settings_by_carrier_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String
body	DhlExpressAccountSettings

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_dhl_express_uk_by_carrier_id_delete

v1_connections_carriers_dhl_express_uk_by_carrier_id_delete(carrier_id)

dhl_express_uk_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #dhl_express_uk_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_dhl_express_uk_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_dhl_express_uk_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_dhl_express_uk_post

ConnectAccountResponseBody v1_connections_carriers_dhl_express_uk_post(body)

dhl_express_uk_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::DhlExpressUkAccountInformationRequestBody.new # DhlExpressUkAccountInformationRequestBody | 


begin
  #dhl_express_uk_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_dhl_express_uk_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_dhl_express_uk_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	DhlExpressUkAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_dpd_by_carrier_id_delete

v1_connections_carriers_dpd_by_carrier_id_delete(carrier_id)

dpd_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #dpd_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_dpd_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_dpd_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_dpd_post

ConnectAccountResponseBody v1_connections_carriers_dpd_post(body)

dpd_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::DpdAccountInformationRequestBody.new # DpdAccountInformationRequestBody | 


begin
  #dpd_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_dpd_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_dpd_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	DpdAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_endicia_by_carrier_id_delete

v1_connections_carriers_endicia_by_carrier_id_delete(carrier_id)

endicia_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #endicia_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_endicia_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_endicia_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_endicia_post

ConnectAccountResponseBody v1_connections_carriers_endicia_post(body)

endicia_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::EndiciaAccountInformationRequestBody.new # EndiciaAccountInformationRequestBody | 


begin
  #endicia_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_endicia_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_endicia_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	EndiciaAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_fedex_by_carrier_id_delete

v1_connections_carriers_fedex_by_carrier_id_delete(carrier_id)

fedex_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #fedex_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_fedex_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_fedex_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_fedex_post

ConnectAccountResponseBody v1_connections_carriers_fedex_post(body)

fedex_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::FedexAccountInformationRequestBody.new # FedexAccountInformationRequestBody | 


begin
  #fedex_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_fedex_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_fedex_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	FedexAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_fedex_settings_by_carrier_id_get

UpsAccountSettings v1_connections_carriers_fedex_settings_by_carrier_id_get(carrier_id)

fedex_account_carrier.get_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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #fedex_account_carrier.get_settings
  result = api_instance.v1_connections_carriers_fedex_settings_by_carrier_id_get(carrier_id)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_fedex_settings_by_carrier_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

UpsAccountSettings

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_fedex_settings_by_carrier_id_put

v1_connections_carriers_fedex_settings_by_carrier_id_put(carrier_id, body)

fedex_account_carrier.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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 

body = ShipEngineApi::FedexAccountSettingsRequestBody.new # FedexAccountSettingsRequestBody | 


begin
  #fedex_account_carrier.update_settings
  api_instance.v1_connections_carriers_fedex_settings_by_carrier_id_put(carrier_id, body)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_fedex_settings_by_carrier_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String
body	FedexAccountSettingsRequestBody

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_fedex_uk_by_carrier_id_delete

v1_connections_carriers_fedex_uk_by_carrier_id_delete(carrier_id)

fedex_uk_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #fedex_uk_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_fedex_uk_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_fedex_uk_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_fedex_uk_post

ConnectAccountResponseBody v1_connections_carriers_fedex_uk_post(body)

fedex_uk_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::FedexUkAccountInformationRequestBody.new # FedexUkAccountInformationRequestBody | 


begin
  #fedex_uk_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_fedex_uk_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_fedex_uk_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	FedexUkAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_firstmile_by_carrier_id_delete

v1_connections_carriers_firstmile_by_carrier_id_delete(carrier_id)

first_mile_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #first_mile_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_firstmile_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_firstmile_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_firstmile_post

ConnectAccountResponseBody v1_connections_carriers_firstmile_post(body)

first_mile_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::FirstMileAccountInformationRequestBody.new # FirstMileAccountInformationRequestBody | 


begin
  #first_mile_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_firstmile_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_firstmile_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	FirstMileAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_globegistics_by_carrier_id_delete

v1_connections_carriers_globegistics_by_carrier_id_delete(carrier_id)

globegistics_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #globegistics_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_globegistics_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_globegistics_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_globegistics_post

ConnectAccountResponseBody v1_connections_carriers_globegistics_post(body)

globegistics_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::AccessWorldwideAccountInformationRequestBody.new # AccessWorldwideAccountInformationRequestBody | 


begin
  #globegistics_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_globegistics_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_globegistics_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	AccessWorldwideAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_imex_by_carrier_id_delete

v1_connections_carriers_imex_by_carrier_id_delete(carrier_id)

imex_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #imex_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_imex_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_imex_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_imex_post

ConnectAccountResponseBody v1_connections_carriers_imex_post(body)

imex_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::AccessWorldwideAccountInformationRequestBody.new # AccessWorldwideAccountInformationRequestBody | 


begin
  #imex_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_imex_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_imex_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	AccessWorldwideAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_newgistics_by_carrier_id_delete

v1_connections_carriers_newgistics_by_carrier_id_delete(carrier_id)

newgistics_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #newgistics_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_newgistics_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_newgistics_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_newgistics_post

ConnectAccountResponseBody v1_connections_carriers_newgistics_post(body)

newgistics_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::NewgisticsAccountInformationRequestBody.new # NewgisticsAccountInformationRequestBody | 


begin
  #newgistics_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_newgistics_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_newgistics_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	NewgisticsAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_newgistics_settings_by_carrier_id_put

v1_connections_carriers_newgistics_settings_by_carrier_id_put(carrier_id, body)

newgistics_account_carrier.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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 

body = ShipEngineApi::NewgisticsAccountSettingsRequestBody.new # NewgisticsAccountSettingsRequestBody | 


begin
  #newgistics_account_carrier.update_settings
  api_instance.v1_connections_carriers_newgistics_settings_by_carrier_id_put(carrier_id, body)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_newgistics_settings_by_carrier_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String
body	NewgisticsAccountSettingsRequestBody

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_ontrac_by_carrier_id_delete

v1_connections_carriers_ontrac_by_carrier_id_delete(carrier_id)

ontrac_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #ontrac_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_ontrac_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_ontrac_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_ontrac_post

ConnectAccountResponseBody v1_connections_carriers_ontrac_post(body)

ontrac_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::DpdAccountInformationRequestBody.new # DpdAccountInformationRequestBody | 


begin
  #ontrac_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_ontrac_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_ontrac_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	DpdAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_royal_mail_by_carrier_id_delete

v1_connections_carriers_royal_mail_by_carrier_id_delete(carrier_id)

royal_mail_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #royal_mail_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_royal_mail_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_royal_mail_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_royal_mail_post

ConnectAccountResponseBody v1_connections_carriers_royal_mail_post(body)

royal_mail_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::RoyalMailAccountInformationRequestBody.new # RoyalMailAccountInformationRequestBody | 


begin
  #royal_mail_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_royal_mail_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_royal_mail_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	RoyalMailAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_rr_donnelley_by_carrier_id_delete

v1_connections_carriers_rr_donnelley_by_carrier_id_delete(carrier_id)

rr_donnelley_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #rr_donnelley_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_rr_donnelley_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_rr_donnelley_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_rr_donnelley_post

ConnectAccountResponseBody v1_connections_carriers_rr_donnelley_post(body)

rr_donnelley_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::AccessWorldwideAccountInformationRequestBody.new # AccessWorldwideAccountInformationRequestBody | 


begin
  #rr_donnelley_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_rr_donnelley_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_rr_donnelley_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	AccessWorldwideAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_stamps_com_by_carrier_id_delete

v1_connections_carriers_stamps_com_by_carrier_id_delete(carrier_id)

stamps_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #stamps_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_stamps_com_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_stamps_com_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_stamps_com_post

ConnectAccountResponseBody v1_connections_carriers_stamps_com_post(body)

stamps_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::AccessWorldwideAccountInformationRequestBody.new # AccessWorldwideAccountInformationRequestBody | 


begin
  #stamps_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_stamps_com_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_stamps_com_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	AccessWorldwideAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_stamps_com_request_account_url_by_carrier_id_put

StampsAccountUrlsResponseBody v1_connections_carriers_stamps_com_request_account_url_by_carrier_id_put(carrier_id, body)

stamps_account_carrier.get_account_url

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 

body = ShipEngineApi::StampsAccountUrlsRequestBody.new # StampsAccountUrlsRequestBody | 


begin
  #stamps_account_carrier.get_account_url
  result = api_instance.v1_connections_carriers_stamps_com_request_account_url_by_carrier_id_put(carrier_id, body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_stamps_com_request_account_url_by_carrier_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String
body	StampsAccountUrlsRequestBody

Return type

StampsAccountUrlsResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_ups_by_carrier_id_delete

v1_connections_carriers_ups_by_carrier_id_delete(carrier_id)

ups_account_carrier.disconnect_account

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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #ups_account_carrier.disconnect_account
  api_instance.v1_connections_carriers_ups_by_carrier_id_delete(carrier_id)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_ups_by_carrier_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_ups_post

ConnectAccountResponseBody v1_connections_carriers_ups_post(body)

ups_account_carrier.connect_account

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::CarrierAccountsApi.new

body = ShipEngineApi::UpsAccountInformationRequestBody.new # UpsAccountInformationRequestBody | 


begin
  #ups_account_carrier.connect_account
  result = api_instance.v1_connections_carriers_ups_post(body)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_ups_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	UpsAccountInformationRequestBody

Return type

ConnectAccountResponseBody

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_ups_settings_by_carrier_id_get

UpsAccountSettings v1_connections_carriers_ups_settings_by_carrier_id_get(carrier_id)

ups_account_carrier.get_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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 


begin
  #ups_account_carrier.get_settings
  result = api_instance.v1_connections_carriers_ups_settings_by_carrier_id_get(carrier_id)
  p result
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_ups_settings_by_carrier_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String

Return type

UpsAccountSettings

Authorization

api-key

HTTP request headers

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

v1_connections_carriers_ups_settings_by_carrier_id_put

v1_connections_carriers_ups_settings_by_carrier_id_put(carrier_id, body)

ups_account_carrier.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::CarrierAccountsApi.new

carrier_id = 'carrier_id_example' # String | 

body = ShipEngineApi::UpsAccountSettings.new # UpsAccountSettings | 


begin
  #ups_account_carrier.update_settings
  api_instance.v1_connections_carriers_ups_settings_by_carrier_id_put(carrier_id, body)
rescue ShipEngineApi::ApiError => e
  puts "Exception when calling CarrierAccountsApi->v1_connections_carriers_ups_settings_by_carrier_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
carrier_id	String
body	UpsAccountSettings

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

Files

CarrierAccountsApi.md

Latest commit

History

CarrierAccountsApi.md

File metadata and controls

ShipEngineApi::CarrierAccountsApi

v1_connections_carriers_access_worldwide_by_carrier_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_access_worldwide_post

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_apc_by_carrier_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_apc_post

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_asendia_by_carrier_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_asendia_post

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_dhl_ecommerce_by_carrier_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_dhl_ecommerce_post

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_dhl_express_by_carrier_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_dhl_express_post

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_dhl_express_settings_by_carrier_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_dhl_express_settings_by_carrier_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

v1_connections_carriers_dhl_express_uk_by_carrier_id_delete