Skip to content

Latest commit

 

History

History
162 lines (115 loc) · 4.69 KB

MerchantsApi.md

File metadata and controls

162 lines (115 loc) · 4.69 KB

Atrium::MerchantsApi

Method HTTP request Description
list_merchant_locations GET /merchants/{merchant_guid}/merchant_locations List merchant locations
list_merchants GET /merchants List merchants
read_merchant GET /merchants/{merchant_guid} Read merchant
read_merchant_location GET /merchants/{merchant_guid}/merchant_locations/{merchant_location_guid} Read merchant location

list_merchant_locations

MerchantLocationsResponseBody list_merchant_locations(merchant_guid, , opts)

List merchant locations

Returns a list of all the merchant locations associated with a merchant, including physical location, latitude, longitude, etc.

Example

# load the gem
require 'atrium-ruby'

client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")

merchant_guid = "MCH-123" # String | The unique identifier for a `merchant`.
opts = { 
  page: 1, # Integer | Specify current page.
  records_per_page: 12 # Integer | Specify records per page.
}

begin
  #List merchant locations
  response = client.merchants.list_merchant_locations(merchant_guid, , opts)
  p response
rescue Atrium::ApiError => e
  puts "Exception when calling MerchantsApi->list_merchant_locations: #{e}"
end

Parameters

Name Type Description Notes
merchant_guid String The unique identifier for a `merchant`.
page Integer Specify current page. [optional]
records_per_page Integer Specify records per page. [optional]

Return type

MerchantLocationsResponseBody

list_merchants

MerchantsResponseBody list_merchants(opts)

List merchants

Returns a list of merchnants.

Example

# load the gem
require 'atrium-ruby'

client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")

opts = { 
  page: 1, # Integer | Specify current page.
  records_per_page: 12 # Integer | Specify records per page.
}

begin
  #List merchants
  response = client.merchants.list_merchants(opts)
  p response
rescue Atrium::ApiError => e
  puts "Exception when calling MerchantsApi->list_merchants: #{e}"
end

Parameters

Name Type Description Notes
page Integer Specify current page. [optional]
records_per_page Integer Specify records per page. [optional]

Return type

MerchantsResponseBody

read_merchant

MerchantResponseBody read_merchant(merchant_guid, )

Read merchant

Returns information about a particular merchant, such as a logo, name, and website.

Example

# load the gem
require 'atrium-ruby'

client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")

merchant_guid = "MCH-123" # String | The unique identifier for a `merchant`.

begin
  #Read merchant
  response = client.merchants.read_merchant(merchant_guid, )
  p response
rescue Atrium::ApiError => e
  puts "Exception when calling MerchantsApi->read_merchant: #{e}"
end

Parameters

Name Type Description Notes
merchant_guid String The unique identifier for a `merchant`.

Return type

MerchantResponseBody

read_merchant_location

MerchantLocationResponseBody read_merchant_location(merchant_guid, merchant_location_guid)

Read merchant location

Retuns a specific location associated with a merchant, including physical location, latitude, longitude, etc.

Example

# load the gem
require 'atrium-ruby'

client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")

merchant_guid = "MCH-123" # String | The unique identifier for a `merchant`.
merchant_location_guid = "MCL-123" # String | The unique identifier for a `merchant_location`.

begin
  #Read merchant location
  response = client.merchants.read_merchant_location(merchant_guid, merchant_location_guid)
  p response
rescue Atrium::ApiError => e
  puts "Exception when calling MerchantsApi->read_merchant_location: #{e}"
end

Parameters

Name Type Description Notes
merchant_guid String The unique identifier for a `merchant`.
merchant_location_guid String The unique identifier for a `merchant_location`.

Return type

MerchantLocationResponseBody