3.0.0 • Published 5 years ago

@datafire/ebay_sell_account v3.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/ebay_sell_account

Client library for Account API

Installation and Usage

npm install --save @datafire/ebay_sell_account
let ebay_sell_account = require('@datafire/ebay_sell_account').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (the Fulfillment Policy, Payment Policy, and Return Policy), opt in and out of eBay seller programs, configure sales tax tables, and get account information. For details on the availability of the methods in this API, see Account API requirements and restrictions.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

ebay_sell_account.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

ebay_sell_account.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

getFulfillmentPolicies

This method retrieves all the fulfillment policies configured for the marketplace you specify using the marketplace_id query parameter. Marketplaces and locales Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: fr-BE. For details on header values, see HTTP request headers.

ebay_sell_account.getFulfillmentPolicies({
  "marketplace_id": ""
}, context)

Input

Output

createFulfillmentPolicy

This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers. Each policy targets a marketplaceId and categoryTypes.name combination and you can create multiple policies for each combination. Be aware that some marketplaces require a specific fulfillment policy for vehicle listings. A successful request returns the URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies. Marketplaces and locales Policy instructions can be localized by providing a locale in the Accept-Language HTTP request header. For example, the following setting displays field values from the request body in German: Accept-Language: de-DE. Target the specific locale of a marketplace that supports multiple locales using the Content-Language request header. For example, target the French locale of the Canadian marketplace by specifying the fr-CA locale for Content-Language. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: fr-BE. Tip: For details on headers, see HTTP request headers.

ebay_sell_account.createFulfillmentPolicy({
  "body": {}
}, context)

Input

Output

getFulfillmentPolicyByName

This method retrieves the complete details for a single fulfillment policy. In the request, supply both the policy name and its associated marketplace_id as query parameters. Marketplaces and locales Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: fr-BE. For details on header values, see HTTP request headers.

ebay_sell_account.getFulfillmentPolicyByName({
  "marketplace_id": "",
  "name": ""
}, context)

Input

  • input object
    • marketplace_id required string: This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum
    • name required string: This query parameter specifies the user-defined name of the fulfillment policy you want to retrieve.

Output

deleteFulfillmentPolicy

This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the fulfillmentPolicyId path parameter. Note that you cannot delete the default fulfillment policy.

ebay_sell_account.deleteFulfillmentPolicy({
  "fulfillmentPolicyId": ""
}, context)

Input

  • input object
    • fulfillmentPolicyId required string: This path parameter specifies the ID of the fulfillment policy to delete.

Output

Output schema unknown

getFulfillmentPolicy

This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.

ebay_sell_account.getFulfillmentPolicy({
  "fulfillmentPolicyId": ""
}, context)

Input

  • input object
    • fulfillmentPolicyId required string: This path parameter specifies the ID of the fulfillment policy you want to retrieve.

Output

updateFulfillmentPolicy

This method updates an existing fulfillment policy. Specify the policy you want to update using the fulfillment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.

ebay_sell_account.updateFulfillmentPolicy({
  "fulfillmentPolicyId": "",
  "body": {}
}, context)

Input

  • input object
    • fulfillmentPolicyId required string: This path parameter specifies the ID of the fulfillment policy you want to update.
    • body required FulfillmentPolicyRequest

Output

getKYC

This method is used by sellers onboarded for eBay managed payments, or sellers who are currently going through, or who are eligible for onboarding for eBay managed payments. With this method, a seller can discover if there are any action items in regards to providing more documentation and/or information about themselves, their company, or the bank account they are or will be using for seller payouts. These 'action items' are also know as 'Know Your Customer' (or KYC) checks. This method does not require any parameters other than the OAuth user token associated with the seller's account. If the managed payments seller does not currently have any pending 'KYC' action items, only a 204 No Content HTTP status code is returned, and no response payload. Note: This method is not applicable for sellers who are not eligible for eBay managed payments. For sellers who sell on one or more eBay marketplaces that currently support managed payments, they can check on their managed payments onboarding status by using the getPaymentsProgramOnboarding method.

ebay_sell_account.getKYC(null, context)

Input

This action has no parameters

Output

getPaymentPolicies

This method retrieves all the payment policies configured for the marketplace you specify using the marketplace_id query parameter. Marketplaces and locales Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: fr-BE. For details on header values, see HTTP request headers.

ebay_sell_account.getPaymentPolicies({
  "marketplace_id": ""
}, context)

Input

Output

createPaymentPolicy

This method creates a new payment policy where the policy encapsulates seller's terms for purchase payments. Each policy targets a marketplaceId and categoryTypes.name combination and you can create multiple policies for each combination. Be aware that some marketplaces require a specific payment policy for vehicle listings. A successful request returns the URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies. Marketplaces and locales Policy instructions can be localized by providing a locale in the Accept-Language HTTP request header. For example, the following setting displays field values from the request body in German: Accept-Language: de-DE. Target the specific locale of a marketplace that supports multiple locales using the Content-Language request header. For example, target the French locale of the Canadian marketplace by specifying the fr-CA locale for Content-Language. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: fr-BE. Tip: For details on headers, see HTTP request headers.

ebay_sell_account.createPaymentPolicy({
  "body": {}
}, context)

Input

Output

getPaymentPolicyByName

This method retrieves the complete details of a single payment policy. Supply both the policy name and its associated marketplace_id in the request query parameters. Marketplaces and locales Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: fr-BE. For details on header values, see HTTP request headers.

ebay_sell_account.getPaymentPolicyByName({
  "marketplace_id": "",
  "name": ""
}, context)

Input

  • input object

Output

deletePaymentPolicy

This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter. Note that you cannot delete the default payment policy.

ebay_sell_account.deletePaymentPolicy({
  "payment_policy_id": ""
}, context)

Input

  • input object
    • payment_policy_id required string: This path parameter specifies the ID of the payment policy you want to delete.

Output

Output schema unknown

getPaymentPolicy

This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the paymentPolicyId path parameter.

ebay_sell_account.getPaymentPolicy({
  "payment_policy_id": ""
}, context)

Input

  • input object
    • payment_policy_id required string: This path parameter specifies the ID of the payment policy you want to retrieve.

Output

updatePaymentPolicy

This method updates an existing payment policy. Specify the policy you want to update using the payment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.

ebay_sell_account.updatePaymentPolicy({
  "payment_policy_id": "",
  "body": {}
}, context)

Input

  • input object
    • payment_policy_id required string: This path parameter specifies the ID of the payment policy you want to update.
    • body required PaymentPolicyRequest

Output

getPaymentsProgram

This method returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned. Note: Currently, the only supported payments program is eBay Payments. For details, see: Managed Payments on eBay Payments Terms of Use

ebay_sell_account.getPaymentsProgram({
  "marketplace_id": "",
  "payments_program_type": ""
}, context)

Input

  • input object
    • marketplace_id required string: This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.
    • payments_program_type required string: This path parameter specifies the payments program whose status is returned by the call. Currently the only supported payments program is EBAY_PAYMENTS. For details on the program, see Payments Terms of Use.

Output

getPaymentsProgramOnboarding

This method retrieves a seller's onboarding status of eBay managed payments for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned. Presently, the only supported payments program type is EBAY_PAYMENTS. See Managed Payments on eBay and Payments Terms of Use. Note: Managed payments availability: eBay managed payments is presently available in the US and Germany, and will roll out to Canada, UK, and Australia in July 2020.

ebay_sell_account.getPaymentsProgramOnboarding({
  "marketplace_id": "",
  "payments_program_type": ""
}, context)

Input

  • input object
    • marketplace_id required string: The eBay marketplace ID associated with the onboarding status to retrieve. Only enums for marketplaces that support or will soon support eBay managed payments are allowed. Error 20408 is returned for any other eBay marketplace. No response payload is returned with this error.
    • payments_program_type required string: The type of payments program whose status is returned by the call. Presently, the only supported payments program is EBAY_PAYMENTS. For details on the program, see Payments Terms of Use.

Output

getPrivileges

This method retrieves the seller's current set of privileges. The call returns whether or not the seller's eBay registration has been completed, as well as the details of their site-wide sellingLimt (the amount and quantity they can sell on a given day).

ebay_sell_account.getPrivileges(null, context)

Input

This action has no parameters

Output

getOptedInPrograms

This method gets a list of the seller programs that the seller has opted-in to.

ebay_sell_account.getOptedInPrograms(null, context)

Input

This action has no parameters

Output

optInToProgram

This method opts the seller in to an eBay seller program. Currently available programs include the Out of Stock Control and the Selling Policy Management program. When you opt-in to the SELLING_POLICY_MANAGEMENT, eBay can associate the business policies you create with the items you list. Note: It can take up to 24-hours for eBay to process your request to opt-in to a Seller Program. Use the getOptedInPrograms call to check the status of your request after a processing period has passed.

ebay_sell_account.optInToProgram({
  "body": {}
}, context)

Input

Output

  • output object

optOutOfProgram

This method opts the seller out of a seller program to which you have previously opted-in to. Get a list of the seller programs you have opted-in to using the getOptedInPrograms call.

ebay_sell_account.optOutOfProgram({
  "body": {}
}, context)

Input

Output

  • output object

getRateTables

This method retrieves a seller's shipping rate tables for the country specified in the country_code query parameter. If you call this method without specifying a country code, the call returns all the seller's shipping rate tables. The method's response includes a rateTableId for each table defined by the seller. Use a table's ID value in a fulfillment policy to specify the shipping rate table to use for that policy's DOMESTIC or INTERNATIONAL shipping option (make sure the locality of the rate table matches the optionType of the shipping option). This call currently supports getting rate tables related to the following marketplaces: EBAY_AU EBAY_CA EBAY_IT EBAY_US Note: Rate tables created with the Trading API might not have been assigned a rateTableId at the time of their creation. This method can assign and return rateTableId values for rate tables with missing IDs if you make a request using the country_code where the seller has defined rate tables. Sellers can define up to 40 shipping rate tables for their account, which lets them set up different rate tables for each of the marketplaces they sell into. Go to My eBay > Account > Site Preferences to create and maintain the rate tables. For more, see Using shipping rate tables. If you're using the Trading API, use the rate table ID values in the RateTableDetails container of the Add/Revise/Relist calls. If the locality for a rate table is set to DOMESTIC, pass the ID value in the RateTableDetails.DomesticRateTableId field. Otherwise, if locality is INTERNATIONAL, pass the ID value in RateTableDetails.InternationalRateTableId. Note: For regions that are not yet ramped up with multi-rate table support, this method returns an ID that maps to the seller's default rate table for the country specified.

ebay_sell_account.getRateTables({}, context)

Input

  • input object
    • country_code string: This query parameter specifies the two-letter ISO 3166 code of country for which you want shipping-rate table information. If you do not specify a county code, the request returns all the seller-defined rate tables. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum

Output

getReturnPolicies

This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter. Marketplaces and locales Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: fr-BE. For details on header values, see HTTP request headers.

ebay_sell_account.getReturnPolicies({
  "marketplace_id": ""
}, context)

Input

Output

createReturnPolicy

This method creates a new return policy where the policy encapsulates seller's terms for returning items. Use the Metadata API method getReturnPolicies to determine which categories require you to supply a return policy for the marketplace(s) into which you list. Each policy targets a marketplaceId and categoryTypes.name combination and you can create multiple policies for each combination. A successful request returns the URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies. Marketplaces and locales Policy instructions can be localized by providing a locale in the Accept-Language HTTP request header. For example, the following setting displays field values from the request body in German: Accept-Language: de-DE. Target the specific locale of a marketplace that supports multiple locales using the Content-Language request header. For example, target the French locale of the Canadian marketplace by specifying the fr-CA locale for Content-Language. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: fr-BE. Tip: For details on headers, see HTTP request headers.

ebay_sell_account.createReturnPolicy({
  "body": {}
}, context)

Input

Output

getReturnPolicyByName

This method retrieves the complete details of a single return policy. Supply both the policy name and its associated marketplace_id in the request query parameters. Marketplaces and locales Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: fr-BE. For details on header values, see HTTP request headers.

ebay_sell_account.getReturnPolicyByName({
  "marketplace_id": "",
  "name": ""
}, context)

Input

  • input object
    • marketplace_id required string: This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum
    • name required string: This query parameter specifies the user-defined name of the return policy you want to retrieve.

Output

deleteReturnPolicy

This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter. Note that you cannot delete the default return policy.

ebay_sell_account.deleteReturnPolicy({
  "return_policy_id": ""
}, context)

Input

  • input object
    • return_policy_id required string: This path parameter specifies the ID of the return policy you want to delete.

Output

Output schema unknown

getReturnPolicy

This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.

ebay_sell_account.getReturnPolicy({
  "return_policy_id": ""
}, context)

Input

  • input object
    • return_policy_id required string: This path parameter specifies the of the return policy you want to retrieve.

Output

updateReturnPolicy

This method updates an existing return policy. Specify the policy you want to update using the return_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.

ebay_sell_account.updateReturnPolicy({
  "return_policy_id": "",
  "body": {}
}, context)

Input

  • input object
    • return_policy_id required string: This path parameter specifies the ID of the return policy you want to update.
    • body required ReturnPolicyRequest

Output

getSalesTaxes

Use this call to retrieve a sales tax table that the seller established for a specific country. Specify the tax table to retrieve using the country_code query parameter.

ebay_sell_account.getSalesTaxes({
  "country_code": ""
}, context)

Input

Output

deleteSalesTax

This call deletes a tax table entry for a jurisdiction. Specify the jurisdiction to delete using the countryCode and jurisdictionId path parameters.

ebay_sell_account.deleteSalesTax({
  "countryCode": "",
  "jurisdictionId": ""
}, context)

Input

  • input object
    • countryCode required string: This path parameter specifies the two-letter ISO 3166 code for the country whose tax table entry you want to delete.
    • jurisdictionId required string: This path parameter specifies the ID of the sales tax jurisdiction whose table entry you want to delete.

Output

Output schema unknown

getSalesTax

This call gets the current tax table entry for a specific tax jurisdiction. Specify the jurisdiction to retrieve using the countryCode and jurisdictionId path parameters.

ebay_sell_account.getSalesTax({
  "countryCode": "",
  "jurisdictionId": ""
}, context)

Input

  • input object
    • countryCode required string: This path parameter specifies the two-letter ISO 3166 code for the country whose tax table you want to retrieve.
    • jurisdictionId required string: This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry you want to retrieve.

Output

createOrReplaceSalesTax

This method creates or updates a sales tax table entry for a jurisdiction. Specify the tax table entry you want to configure using the two path parameters: countryCode and jurisdictionId. A tax table entry for a jurisdiction is comprised of two fields: one for the jurisdiction's sales-tax rate and another that's a boolean value indicating whether or not shipping and handling are taxed in the jurisdiction. You can set up tax tables for countries that support different tax jurisdictions. Currently, only Canada, India, and the US support separate tax jurisdictions. If you sell into any of these countries, you can set up tax tables for any of the country's jurisdictions. Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API. For details on using this call, see Establishing sales-tax tables. Important! Starting in January 2019, eBay will begin to calculate, collect, and remit sales tax on behalf of sellers for items shipped to customers. This feature is rolling out on specific dates to specific US states as defined on the following page: eBay sales tax collection. Once eBay starts to collect sales tax for a state, no action is required on the seller's part and there will be no charges or fees for eBay automatically calculating, collecting and remitting sales tax. The sales-tax collection process will apply to all the sales in the states that support this feature, whether the seller is located in or outside of the United States. When a buyer purchases an item on eBay, and the ship-to address is one of the states where eBay collects the sales tax, eBay will calculate and add the applicable sales tax at checkout. The buyer will pay both the cost of the item along with the sales tax. eBay will collect and remit the tax.

ebay_sell_account.createOrReplaceSalesTax({
  "countryCode": "",
  "jurisdictionId": "",
  "body": {}
}, context)

Input

  • input object
    • countryCode required string: This path parameter specifies the two-letter ISO 3166 code for the country for which you want to create tax table entry.
    • jurisdictionId required string: This path parameter specifies the ID of the sales-tax jurisdiction for the table entry you want to create.
    • body required SalesTaxBase

Output

Output schema unknown

Definitions

Amount

  • Amount object: A complex type that describes the value of a monetary amount as represented by a global currency.
    • currency string: The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD. Default: The default currency of the eBay marketplace that hosts the listing. For implementation help, refer to eBay API documentation
    • value string: The monetary amount in the specified currency. Required in the amount type.

CategoryType

  • CategoryType object: The category type discerns whether the policy covers the sale of motor vehicles (via eBay Motors), or the sale of everything except motor vehicles. Each business policy can be associated with either or both categories ('MOTORS_VEHICLES' and 'ALL_EXCLUDING_MOTORS_VEHICLES'); however,the 'MOTORS_VEHICLES' category type is not valid for return policies–return policies cannot be used with motor vehicle listings.
    • default boolean: Specifies the default policy for a marketplaceId and categoryTypes.name pair. Sellers can create multiple policies for any marketplaceId and categoryTypes.name combination. For example, you can create multiple fulfillment policies for one marketplace, where they all target the same category type name. However, only one policy can be the default for any marketplaceId and name combination, and eBay designates the first policy created for a combination as the default. If set to true, this policy is the default policy for the associated categoryTypes.name and marketplaceId pair. Note: eBay considers the status of this field only when you create listings through the Web flow. If you create listings using the APIs, you must specifically set the policies you want applied to a listing in the payload of the call you use to create the listing. If you use the Web flow to create item listings, eBay uses the default policy for the marketplace and category type specified, unless you override the default. For more on default policies, see Changing the default policy for a category type.
    • name string: The category type to which the policy applies (motor vehicles or non-motor vehicles). Restrictions: The MOTORS_VEHICLES category type is not valid for return policies. eBay flows do not support the return of motor vehicles. Only the ALL_EXCLUDING_MOTORS_VEHICLES category type is supported for sellers who opt-in to the managed payments program. Managed payments does not currently support the sale of motor vehicles. For implementation help, refer to eBay API documentation

Deposit

  • Deposit object: A container that describes the details of a deposit. Used only with motor listings.
    • amount Amount
    • dueIn TimeDuration
    • paymentMethods array: For deposits (which are applicable to only motor listings), the paymentMethodType must be set to 'PAYPAL' and you must also populate the fields in the recipientAccountReference object. Required if your motor vehicles listing requires a deposit.

Error

  • Error object: A container that defines the elements of error and warning messages.
    • parameters array: This optional list of name/value pairs that contain context-specific ErrorParameter objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.
    • category string: The category type for this error or warning. It is a string that can have one of three values: Application: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency. Business: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors. Request: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.
    • domain string: Name of the domain ,or primary system, of the service or application where the error occurred.
    • errorId integer: A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
    • inputRefIds array: Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.
      • items string
    • longMessage string: A more detailed explanation of the error than given in the message error field.
    • message string: Information on how to correct the problem, in the end user's terms and language where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.
    • outputRefIds array: Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId.
      • items string
    • subdomain string: If present, indicates the subsystem in which the error occurred.

ErrorParameter

  • ErrorParameter object: A complex type that indicates a parameter that caused an error and the value of the parameter which caused the error.
    • name string: Name of the parameter that caused the error.
    • value string: The value of the parameter that caused the error.

FulfillmentPolicy

  • FulfillmentPolicy object: This root response container defines a seller's fulfillment policy for a specific marketplace and category type. fulfillmentPolicy encapsulates a seller's terms for fulfilling an order and includes the shipping carriers and services used for shipment and time the seller takes to ship an order. While each seller must define at least one fulfillment policy for every marketplace into which they sell, sellers can define multiple fulfillment policies for a single marketplace by specifying different configurations for the unique policies.
    • categoryTypes array: The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't. (Currently, each policy can be set to only one categoryTypes value at a time.)
    • description string: An optional seller-defined description of the fulfillment policy for internal use (this value is not displayed to end users). Max length: 250
    • freightShipping boolean: If set to true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs. Default: false
    • fulfillmentPolicyId string: A unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created.
    • globalShipping boolean: If set to true, the seller has opted-in to the eBay Global Shipping Program and that they use that service for their international shipments. Setting this value automatically sets the international shipping service for the policy to International Priority Shipping and the buyer does not need to set any other shipping services for their INTERNATIONAL shipping options (unless they sell items not covered by the Global Shipping Program). If this value is set to false, the seller is responsible for manually specifying the international shipping services, as described in Setting up worldwide shipping. To opt-in to the Global Shipping Program, log in to eBay and navigate to My Account > Site Preferences > Shipping preferences. Default: false
    • handlingTime TimeDuration
    • localPickup boolean: If set to true, no shipping is offered by this policy and the seller offers only local pickup of the item (normally from a non-business location). This option is most often used for customer-to-customer sales and if set, costType should be set to NOT_SPECIFIED. Default: false
    • marketplaceId string: The ID of the eBay marketplace to which this fulfillment policy applies. If this value is not specified, value defaults to the seller's eBay registration site. For implementation help, refer to eBay API documentation
    • name string: A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Max length: 64
    • pickupDropOff boolean: If set to true, the seller offers the "Click and Collect" feature. Click and Collect is supported by the Inventory API, and it can be used with Add/Revise/Relist calls. To enable "Click and Collect", a seller (1) must be eligible for Click and Collect and (2) must set this boolean field to 'true'. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU and UK marketplaces. In addition to setting this field, the merchant must also do the following to enable the "Click and Collect" option on a listing: Have inventory for the product at one or more physical stores tied to the merchant's account. Sellers can use the createInventoryLocaion method in the Inventory API to associate physical stores to their account and they can then can add inventory to specific store locations. Set an immediate payment requirement on the item. The immediate payment feature requires the seller to: Set the immediatePay flag in the payment policy to 'true'. Include only one paymentMethods field in the payment policy and set its value to PAYPAL. Include a valid PayPal contact in the recipientAccountReference.referenceId field of the payment policy. Have a valid store location with a complete street address. When a UK merchant successfully lists an item with Click and Collect, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.Default: false
    • shipToLocations RegionSet
    • shippingOptions array: A list that defines the seller's shipping configurations for DOMESTIC and INTERNATIONAL order shipments. shippingOptions is a list with a single element if the seller ships to only domestic locations. If the seller also ships internationally, the list contains a second element that defines their international shipping options. Shipping options configure the high-level shipping settings that apply to orders, such as flat-rate or calculated shipping, any rate tables the seller wants to associate with the shipping services, plus other details (such as the shippingServices offered for domestic or international shipments).

FulfillmentPolicyRequest

  • FulfillmentPolicyRequest object: This root container defines a seller's fulfillment policy for a specific marketplace and category type. Used when creating or updating a fulfillment policy, fulfillmentPolicyRequest encapsulates a seller's terms for fulfilling an order and includes the shipping carriers and services used for shipment and time the seller takes to ship an order. While each seller must define at least one fulfillment policy for every marketplace into which they sell, sellers can define multiple fulfillment policies for a single marketplace by specifying different configurations for the unique policies. A successful call returns a fulfillmentPolicyId, plus the Location response header contains the URI to the resource. Policy instructions can be localized by providing a locale in the Content-Language HTTP request header. For example: Content-Language: de-DE. Tip: For more on using business policies, see eBay business policies.
    • categoryTypes array: The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't. (Currently, each policy can be set to only one categoryTypes value at a time.)
    • description string: An optional seller-defined description of the fulfillment policy for internal use (this value is not displayed to end users). Max length: 250
    • freightShipping boolean: If set to true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs. Default: false
    • globalShipping boolean: If set to true, the seller has opted-in to the eBay Global Shipping Program and that they use that service for their international shipments. Setting this value automatically sets the international shipping service for the policy to International Priority Shipping and the buyer does not need to set any other shipping services for their INTERNATIONAL shipping options (unless they sell items not covered by the Global Shipping Program). If this value is set to false, the seller is responsible for manually specifying the international shipping services, as described in Setting up worldwide shipping. To opt-in to the Global Shipping Program, log in to eBay and navigate to My Account > Site Preferences > Shipping preferences. Default: false
    • handlingTime TimeDuration
    • localPickup boolean: If set to true, no shipping is offered by this policy and the seller offers only local pickup of the item (normally from a non-business location). This option is most often used for customer-to-customer sales and if set, costType should be set to NOT_SPECIFIED. Default: false
    • marketplaceId string: The ID of the eBay marketplace to which this fulfillment policy applies. If this value is not specified, value defaults to the seller's eBay registration site. For implementation help, refer to eBay API documentation
    • name string: A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Max length: 64
    • pickupDropOff boolean: If set to true, the seller offers the "Click and Collect" feature. Click and Collect is supported by the Inventory API, and it can be used with Add/Revise/Relist calls. To enable "Click and Collect", a seller (1) must be eligible for Click and Collect and (2) must set this boolean field to 'true'. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU and UK marketplaces. In addition to setting this field, the merchant must also do the following to enable the "Click and Collect" option on a listing: Have inventory for the product at one or more physical stores tied to the merchant's account. Sellers can use the createInventoryLocaion method in the Inventory API to associate physical stores to their account and they can then can add inventory to specific store locations. Set an immediate payment requirement on the item. The immediate payment feature requires the seller to: Set the immediatePay flag in the payment policy to 'true'. Include only one paymentMethods field in the payment policy and set its value to PAYPAL. Include a valid PayPal contact in the recipientAccountReference.referenceId field of the payment policy. Have a valid store location with a complete street address. When a UK merchant successfully lists an item with Click and Collect, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.Default: false
    • shipToLocations RegionSet
    • shippingOptions array: A list that defines the seller's shipping configurations for DOMESTIC and INTERNATIONAL order shipments. shippingOptions is a list with a single element if the seller ships to only domestic locations. If the seller also ships internationally, the list contains a second element that defines their international shipping options. Shipping options configure the high-level shipping settings that apply to orders, such as flat-rate or calculated shipping, any rate tables the seller wants to associate with the shipping services, plus other details (such as the shippingServices offered for domestic or international shipments).

FulfillmentPolicyResponse

  • FulfillmentPolicyResponse object: The response payload for requests that return a list of fulfillment policies.
    • fulfillmentPolicies array: A list of the seller's fulfillment policies.
    • href string: The URI of the current page of results from the result set.
    • limit integer: The number of items returned on a single page from the result set.
    • next string: The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set. Max length: 2048
    • offset integer: The number of results skipped in the result set before listing the first returned result. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.
    • prev string: The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set. Max length: 2048
    • total integer: The total number of items retrieved in the result set. If no items are found, this field is returned with a value of 0.

InternationalReturnOverrideType

  • InternationalReturnOverrideType object: This type defines the fields for a seller's international return policy. If a seller does not populate the fields in this complex type, the international return policy defaults to the return policy set for domestic returns.
    • returnMethod string: Valid in the US marketplace only, this optional field indicates additional services (other than money-back) that sellers can offer buyers for remorse returns. As of version 1.2.0, the only accepted value for this field is REPLACEMENT. This field is valid in only the US marketplace, any supplied value is ignored in other marketplaces. For implementation help, refer to eBay API documentation
    • returnPeriod TimeDuration
    • returnShippingCostPayer string: This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER. Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. Required if the internationalOverride.returnsAccepted field is set to true. For implementation help, refer to eBay API documentation
    • returnsAccepted boolean: If set to true, the seller allows international returns. If set to false, the seller does not accept international returns. Required if the seller wants to set an international return policy that differs from their domestic return policy.

KycCheck

  • KycCheck object: This type is used to provide details about any KYC check that is applicable to the managed payments seller.
    • alert string: This field gives a short summary of what is required from the seller. An example might be, 'Upload bank document now.'. The detailMessage field will often provide more details on what is required of the seller.
    • dataRequired string: The enumeration value returned in this field categorizes the type of details needed for the KYC check. More information about the check is shown in the detailMessage and other applicable, corresponding fields. For implementation help, refer to eBay API documentation
    • detailMessage string: This field gives a detailed message about what is required from the seller. An example might be, 'Please upload a bank document by 2020-08-01 to get your account back in good standing.'.
    • dueDate string: The timestamp in this field indicates the date by which the seller should resolve the KYC requirement. The timestamp in this field uses the UTC date and time format described in the ISO 8601 Standard. See below for this format and an example: MM-DD-YYYY HH:MM:SS 06-05-2020 10:34:18
    • remedyUrl string: If applicable and available, a URL will be returned in this field, and the link will take the seller to an eBay page where they can provide the requested information.

KycResponse

  • KycResponse object: This is the base response type of the getKYC method.
    • kycChecks array: This array contains one or more KYC checks required from a managed payments seller. The seller may need to provide more documentation and/or information about themselves, their company, or the bank account they are using for seller payouts. If no KYC checks are currently required from the seller, this array is not returned, and the seller only receives a 204 No Content HTTP status code.

PaymentMethod

  • PaymentMethod object: Container specifying a payment method that is accepted by the seller. Specify multiple payment methods by repeating this container. For more on payment methods, see Accepted payments policy. Note that payment methods are not applicable to classified ad listings – all classified ad payments are handled off of the eBay platform.
    • brands array: It's important to note that the credit card brands Visa and MasterCard must both be listed if either one is listed, as is shown in the following code fragment: "paymentMethods": [{ "brands": VISA, MASTERCARD }] ... Note: Different eBay marketplaces may or may not support this field. Use the Trading API GetCategoryFeatures call with FeatureID set to PaymentMethods and DetailLevel set to ReturnAll to see what credit card brands different marketplaces support. If the GetCategoryFeatures call returns details on credit card brands for the categories in which you sell, then you can use this field to list the credit card brands the seller accepts. If, on the other hand, GetCategoryFeatures does not enumerate credit card brands for your target site (for example, if it returns PaymentMethod set to CCAccepted), then you cannot enumerate specific credit card brands with this field for that marketplace. Required if paymentMethodType is set to CREDIT_CARD. A list of credit card brands accepted by the seller.
      • items string: For implementation help, refer to eBay API documentation
    • paymentMethodType string: The payment method, selected from the supported payment method types. Use GetCategoryFeatures in the Trading API to retrieve the payment methods allowed for a category on a specific marketplace, as well as the default payment method for that marketplace (review the SiteDefaults.PaymentMethod field). For example, the response from GetCategoryFeatures shows that on the US marketplace, most categories allow only electronic payments via credit cards, PayPal, and the like. Also, note that GeteBayDetails does not return payment method information. Note: If you create item listings using the Inventory API, you must set this field to PAYPAL (currently, the Inventory API supports only fixed-prince GTC items where the only supported paymentMethod is PayPal). For implementation help, refer to eBay API documentation
    • recipientAccountReference RecipientAccountReference

PaymentPolicy

  • PaymentPolicy object: Root container that defines the fields for a seller's payment policy. The paymentPolicy encapsulates a seller's payment terms and consists of payment details for the seller, the name and description of the policy, and the marketplace and category group(s) covered by the payment policy. While each seller must define at least one payment policy for every marketplace into which they sell, sellers can define multiple payment policies for a single marketplace by specifying different configurations for the unique policies.
    • categoryTypes array: The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't. (Currently, each policy can be set to only one categoryTypes value at a time.)
    • deposit Deposit
    • description string: An optional seller-defined description of the payment policy for internal use (this value is not displayed to end users). Max length: 250
    • fullPaymentDueIn TimeDuration
    • immediatePay boolean: If set to true, payment is due upon receipt (eBay generates a receipt when the buyer agrees to purchase an item). This boolean must be set in the payment policy if the seller wants to create a listing that has an "immediate payment" requirement. The seller can change the immediate payment requirement at any time during the life cycle of a listing. The following must be true before a seller can apply an immediate payment requirement to an item: The seller must have a PayPal Business account. The Buy It Now price cannot be higher than $60,000 USD. The eBay marketplace on which the item is listed must support PayPal payments. The listing type must be fixed-price, or an auction with a Buy It Now option.To enable the immediate payment requirement, the seller must also perform the following actions via API calls: Provide a valid paymentMethods.recipientAccountReference.referenceId value. Offer PayPal as the only payment method for the item(s). Specify all related costs to the buyer (because the buyer is not be able to use the Buyer Request Total feature in an immediate payment listing); these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges. Include and set the shippingProfileDiscountInfo container values if you are going to use promotional shipping discounts.For more information, see the Understanding immediate payment Help page. Note: Listings created with the Inventory API must reference a payment policy that has immediatePay is set to true. Items listed with the Inventory API must also be fixed-price good-till-canceled (GTC) listings where PayPal is the only supported payment method (paymentMethod must be set to PAYPAL). Default: false
    • marketplaceId string: The ID of the eBay marketplace to which the payment policy applies. If this value is not specified, value defaults to the seller's eBay registration site. For implementation help, refer to eBay API documentation
    • name string: A user-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace. Max length: 64
    • paymentInstructions string: This free-form string field gives sellers the ability add detailed payment instructions to their listings. The payment instructions appear on eBay's View Item and Checkout pages. eBay recommends sellers use this field to clarify payment policies for motor vehicle listings on eBay Motors. For example, sellers can include the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle. The field allows only 500 characters as input, but due to the way the eBay web site UI treats characters, this field can return more than 500 characters in the response. For example, characters like & and ' (ampersand and single quote) count as 5 characters each. Max length: 1000.
    • paymentMethods array: If the seller is not opted-in to managed payments, this container returns a list of the payment methods accepted by the seller. When not opted-in to managed payments, each payment policy must specify at least one payment method. Note: The paymentMethods container is not returned if the seller is opted-in to the managed payments program.
    • paymentPolicyId string: A unique eBay-assigned ID for a payment policy. This ID is generated when the policy is created.

PaymentPolicyRequest

  • PaymentPolicyRequest object: This root container defines a seller's payment policy for a specific marketplace and category type. Used when creating or updating a payment policy, paymentPolicyRequest encapsulates a seller's terms for how buyers can pay for the items they buy. While each seller must define at least one payment policy for every marketplace into which they sell, sellers can define multiple payment policies for a single marketplace by specifying different configurations for the unique policies. A successful call returns a paymentPolicyId, plus the Location response header contains the URI to the resource. Policy instructions can be localized by providing a locale in the Content-Language HTTP request header. For example: Content-Language: de-DE. Tip: For more on using business policies, see eBay business policies.
    • categoryTypes array: The CategoryTypeEnum value to which this policy applies. This container is used to discern accounts that sell motor vehicles from those that do not. Restriction: Currently, each policy can be set to only one categoryTypes value at a time.
    • deposit Deposit
    • description string: An optional seller-defined description of the payment policy for internal use (this value is not displayed to end users). Max length: 250
    • fullPaymentDueIn TimeDuration
    • immediatePay boolean: If set to true, payment is due upon receipt (eBay generates a receipt when the buyer agrees to purchase an item). This boolean must be set in the payment policy if the seller wants to create a listing that has an immediate payment requirement. The seller can change the immediate payment requirement at any time during the life cycle of a listing. The following must be true before a seller can apply an immediate payment requirement to an item: The seller must have a PayPal Business account. The Buy It Now price cannot be higher than $60,000 USD. The eBay marketplace on which the item is listed must support PayPal payments. The listing type must be fixed-price, or an auction with a Buy It Now option. Note: This container can be used for sellers who opt-in to the managed payments program, but some requirements do not apply.To enable the immediate payment requirement, the seller must also perform the following actions via API calls: Provide a valid paymentMethods.recipientAccountReference.referenceId value. Offer PayPal as the only payment method for the item(s). Specify all related costs to the buyer (because the buyer is not able to use the Buyer Request Total feature in an immediate payment listing); these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges. Include and set the shippingProfileDiscountInfo container values if you are going to use promotional shipping discounts.For more information, see the Understanding immediate payment Help page. Note: Listings created with the Inventory API must reference a payment policy that has immediatePay set to true. Items listed with the Inventory API must also be fixed-price, good-till-canceled (GTC) listings where PayPal is the only supported payment method (paymentMethod must be set to PAYPAL).Default: False
    • marketplaceId string: The ID of the eBay marketplace to which this payment policy applies. If this value is not specified, the value defaults to the seller's eBay registration site. Note: A limited number of sellers, on a limited number of eBay marketplaces, are currently opted-in to the eBay managed payments program. To view the eBay marketplaces where managed payments are currently supported, see the managed payments landing page. For implementation help, refer to eBay API documentation
    • name string: A user-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace. Note: eBay will create a new payment policy for sellers who opt-in to the managed payments program.Max length: 64
    • paymentInstructions string: A free-form string field that allows sellers to add detailed payment instructions to their listings. The payment instructions appear on eBay's View Item and Checkout pages. eBay recommends sellers use this field to clarify payment policies for motor vehicle listings on eBay Motors. For example, sellers can include the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle. The field allows only 500 characters as input, but due to the way the eBay web site UI treats characters, this field can return more than 500 characters in the response. For example, characters like & and ' (ampersand and single quote) count as 5 characters each. Restriction: This container is not supported for sellers who opt-in to the managed payments program. Max length: 1000
    • paymentMethods array: A list of the payment methods accepted by the seller. Important: Do not populate this container if you are opted-in to managed payments. To verify whether or not you are opted-in to the managed payments program, call getPaymentsProgram. If you are not opted-in to the managed payments program, each payment policy you create must specify at least one payment method. In addition, if you are not opted-in to managed payments, the listings you create with the Inventory API must reference a payment policy that has this value set to PAYPAL (currently, the Inventory API supports only fixed-prince GTC items with immediate pay (which required payments to be made via PayPal). In order for a buyer to make a full payment on a US or CA motor vehicle, the payment policy must specify at least one of the following as a payment method: CashOnPickup LoanCheck MOCC (money order or cashier's check) PaymentSeeDescription (payment instructions are in the paymentInstructions field) PersonalCheck Note: Each eBay marketplace supports and requires its own set of payment methods and not all marketplaces support the same set of payment methods. Check the specifics of the marketplaces where you list items to ensure your payment policies meet the payment method requirements
datafire
@infinitebrahmanuniverse/nolb-_datafire_e@everything-registry/sub-chunk-221@zalastax/nolb-_datafire_e
3.0.0

5 years ago