Module: Peddler::Types::SellersV1

Defined in:

lib/peddler/types/sellers_v1/error.rb,
lib/peddler/types/sellers_v1/account.rb,
lib/peddler/types/sellers_v1/address.rb,
lib/peddler/types/sellers_v1/business.rb,
lib/peddler/types/sellers_v1/marketplace.rb,
lib/peddler/types/sellers_v1/participation.rb,
lib/peddler/types/sellers_v1/primary_contact.rb,
lib/peddler/types/sellers_v1/get_account_response.rb,
lib/peddler/types/sellers_v1/marketplace_participation.rb,
lib/peddler/types/sellers_v1/get_marketplace_participations_response.rb

Constant Summary

Error =

Error response returned when the request is unsuccessful.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] A message that describes the error condition in a human-readable form.
  attribute(:message, String)

  # @return [String] Additional details that can help you understand or fix the issue.
  attribute(:details, String)
end

Account =

The response schema for the getAccount operation.

Structure.new do
  # @return [Array<MarketplaceParticipation>]
  attribute(:marketplace_participation_list, [MarketplaceParticipation], from: "marketplaceParticipationList")

  # @return [String] The type of business registered for the seller account.
  attribute(:business_type, String, from: "businessType")

  # @return [String] The selling plan details.
  attribute(:selling_plan, String, from: "sellingPlan")

  # @return [Business]
  attribute(:business, Business)

  # @return [PrimaryContact]
  attribute(:primary_contact, PrimaryContact, from: "primaryContact")
end

Address =

Represents an address

Structure.new do
  # @return [String] Street address information.
  attribute(:address_line1, String, from: "addressLine1")

  # @return [String] Additional street address information.
  attribute(:address_line2, String, from: "addressLine2")

  # @return [String] The country code in two-character ISO 3166-1 alpha-2 format.
  attribute(:country_code, String, from: "countryCode")

  # @return [String] The state or province code.
  attribute(:state_or_province_code, String, from: "stateOrProvinceCode")

  # @return [String] The city.
  attribute(:city, String)

  # @return [String] The postal code.
  attribute(:postal_code, String, from: "postalCode")
end

Business =

Information about the seller's business. Certain fields may be omitted depending on the seller's businessType.

Structure.new do
  # @return [String] The registered business name.
  attribute(:name, String)

  # @return [Address] The registered business address.
  attribute(:registered_business_address, Address, from: "registeredBusinessAddress")

  # @return [String] The seller's company registration number, if applicable. This field will be absent for
  # individual sellers and sole proprietorships.
  attribute(:company_registration_number, String, from: "companyRegistrationNumber")

  # @return [String] The seller's company tax identification number, if applicable. This field will be present for
  # certain business types only, such as sole proprietorships.
  attribute(:company_tax_identification_number, String, from: "companyTaxIdentificationNumber")

  # @return [String] The non-Latin script version of the registered business name, if applicable.
  attribute(:non_latin_name, String, from: "nonLatinName")
end

Marketplace =

Information about an Amazon marketplace where a seller can list items and customers can view and purchase items.

Structure.new do
  # @return [String] The encrypted marketplace value.
  attribute(:id, String)

  # @return [String] The marketplace name.
  attribute(:name, String)

  # @return [String] The ISO 3166-1 alpha-2 format country code of the marketplace.
  attribute(:country_code, String, from: "countryCode")

  # @return [String] The ISO 4217 format currency code of the marketplace.
  attribute(:default_currency_code, String, from: "defaultCurrencyCode")

  # @return [String] The ISO 639-1 format language code of the marketplace.
  attribute(:default_language_code, String, from: "defaultLanguageCode")

  # @return [String] The domain name of the marketplace.
  attribute(:domain_name, String, from: "domainName")
end

Participation =

Information that is specific to a seller in a marketplace.

Structure.new do
  # @return [:boolean] If `true`, the seller participates in the marketplace. Otherwise `false`.
  attribute(:participating, :boolean, from: "isParticipating")

  # @return [:boolean] Specifies if the seller has suspended listings. `true` if the seller Listing Status is set
  # to Inactive, otherwise `false`.
  attribute(:has_suspended_listings, :boolean, from: "hasSuspendedListings")
end

PrimaryContact =

Information about the seller's primary contact.

Structure.new do
  # @return [String] The full name of the seller's primary contact.
  attribute(:name, String)

  # @return [Address] The primary contact's residential address.
  attribute(:address, Address)

  # @return [String] The non-Latin script version of the primary contact's name, if applicable.
  attribute(:non_latin_name, String, from: "nonLatinName")
end

GetAccountResponse =

The response schema for the getAccount operation.

Structure.new do
  # @return [Account]
  attribute(:payload, Account)

  # @return [Array<Error>] The errors encountered by the `getAccount` operation.
  attribute(:errors, [Error])
end

MarketplaceParticipation =

Structure.new do
  # @return [Marketplace]
  attribute(:marketplace, Marketplace)

  # @return [Participation]
  attribute(:participation, Participation)

  # @return [String] The name of the seller's store as displayed in the marketplace.
  attribute(:store_name, String, from: "storeName")
end

GetMarketplaceParticipationsResponse =

The response schema for the getMarketplaceParticipations operation.

Structure.new do
  # @return [Array<MarketplaceParticipation>] The payload for the `getMarketplaceParticipations` operation.
  attribute(:payload, [MarketplaceParticipation])

  # @return [Array<Error>] The errors encountered by the `getMarketplaceParticipations` operation.
  attribute(:errors, [Error])
end