Listings API V2

CodPaymentMethod

string

The method for the COD/COP payment.

Allowed values:CASH_CERTIFIED_FUNDSCHECK

Default:CASH_CERTIFIED_FUNDS

Example

CodRequest

object

Details of the cash on delivery or cash on pick-up (COD/COP).

amountnumber(double)

The cash on delivery (COD) or cash on pick up (COP) amount due.

Default:0

>= 0

Example:200

amountCurrencystring

The currency of the monetary field.

Allowed values:USD

Default:USD

Example:USD

paymentMethodstring

The method for the COD/COP payment.

Allowed values:CASH_CERTIFIED_FUNDSCHECK

Default:CASH_CERTIFIED_FUNDS

Example:CASH_CERTIFIED_FUNDS

paymentLocationstring

The location that COD/COP payment is due.

Allowed values:DELIVERYPICKUP

Default:PICKUP

Example:PICKUP

Example

CodResponse

object

Details of cash on delivery or cash on pick up (COD/COP).

amountnumber(double)

The cash on delivery (COD) or cash on pick up (COP) amount due.

Example:200

amountCurrencystring

The currency of the monetary field.

Allowed values:USD

Default:USD

Example:USD

paymentMethodstring

The method for the COD/COP payment.

Allowed values:CASH_CERTIFIED_FUNDSCHECK

Default:CASH_CERTIFIED_FUNDS

Example:CASH_CERTIFIED_FUNDS

paymentLocationstring

The location that COD/COP payment is due.

Allowed values:DELIVERYPICKUP

Default:PICKUP

Example:PICKUP

Example

Currency

string

The currency of the monetary field.

Allowed values:USD

Default:USD

Example

Error

object

Details of an error or issue.

codestring

The code used for the issue.

Example:resource.issue_type

descriptionstring

A detailed message.

Example:The issue happened because something is wrong.

propertystring

The property to which the issue is associated.

Example:person

propertiesobject

Additional properties related to the issue.

Example:{"firstName":"D0nn@","lastName":"Sm!th"}

Example