Listings API V2

BalanceRequest

object

Details of the balance.

amountnumber(double)

The balance amount that will be due after the COD/COP payment is applied.

Default:0

>= 0

Example:300

amountCurrencystring

The currency of the monetary field.

Allowed values:USD

Default:USD

Example:USD

paymentTimestring

The time frame when the balance payment is due.

Allowed values:FIFTEEN_BUSINESS_DAYSFIVE_BUSINESS_DAYSIMMEDIATELYTEN_BUSINESS_DAYSTHIRTY_BUSINESS_DAYSTWO_BUSINESS_DAYS

Default:IMMEDIATELY

Example:IMMEDIATELY

balancePaymentTermsBeginOnstring

The terms for beginning balance payment.

Allowed values:DELIVERYPICKUPRECEIVING_SIGNED_BOL

Default:PICKUP

Example:PICKUP

balancePaymentMethodstring

The payment method with which the balance due payment will be paid.

Allowed values:CASHCERTIFIED_FUNDSCOMCHEKCOMPANY_CHECKTCH

Default:CASH

Example:CASH

Example

BalanceResponse

object

Details of the balance.

amountnumber(double)

The balance amount that will be due after the COD/COP payment is applied.

Example:300

amountCurrencystring

The currency of the monetary field.

Allowed values:USD

Default:USD

Example:USD

paymentTimestring

The time frame when the balance payment is due.

Allowed values:FIFTEEN_BUSINESS_DAYSFIVE_BUSINESS_DAYSIMMEDIATELYTEN_BUSINESS_DAYSTHIRTY_BUSINESS_DAYSTWO_BUSINESS_DAYS

Default:IMMEDIATELY

Example:IMMEDIATELY

balancePaymentTermsBeginOnstring

The terms for beginning balance payment.

Allowed values:DELIVERYPICKUPRECEIVING_SIGNED_BOL

Default:PICKUP

Example:PICKUP

balancePaymentMethodstring

The payment method with which the balance due payment will be paid.

Allowed values:CASHCERTIFIED_FUNDSCOMCHEKCOMPANY_CHECKTCH

Default:CASH

Example:CASH

Example

CodPaymentLocation

string

The location that COD/COP payment is due.

Allowed values:DELIVERYPICKUP

Default:PICKUP

Example

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