Product Details

The product information.

descriptionstringOptional

The product description.

Match^(.|\r?\n)*$Length1 <= length <= 2000

product_receivedenumOptional

Indicates whether the product was, or was not, received or returned.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"YES"
"NO"
"RETURNED"

product_received_timestring<date_time>Optional

The date and time when product was delivered.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

expected_delivery_datestring<date_time>Optional

The expected delivery date and time of the product.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

sub_reasonsarray<sub_reasons>Optional

An array of sub-reasons for the product issue.

Items1 <= length <= 10

purchase_urlstringOptional

The URL where the customer purchased the product.

Formaturi

return_detailsobject<return_details>Optional

The return details for the product.

return_details properties

5 properties

return_timestring<date_time>Optional

The date and time when the product was returned, [Internet date and time format](http://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

modeenumOptional

The method that the customer used to return the product.

Match^[A-Z_]+$Length1 <= length <= 255

Allowed values

"SHIPPED"
"IN_PERSON"

receiptbooleanOptional

Indicates whether customer has the return receipt.

return_confirmation_numberstringOptional

The confirmation number for the item return.

Match^[A-Za-z0-9:\-]+$Length1 <= length <= 255

returnedbooleanOptional

If `true`, indicates that the item was returned but the seller refused to accept the return and if `false`, indicates the item was not attempted to return.

The product information.

descriptionstringOptional

The product description.

Match^(.|\r?\n)*$Length1 <= length <= 2000

product_receivedenumOptional

Indicates whether the product was, or was not, received or returned.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"YES"
"NO"
"RETURNED"

product_received_timestring<date_time>Optional

The date and time when product was delivered.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

expected_delivery_datestring<date_time>Optional

The expected delivery date and time of the product.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

sub_reasonsarray<sub_reasons>Optional

An array of sub-reasons for the product issue.

Items1 <= length <= 10

purchase_urlstringOptional

The URL where the customer purchased the product.

Formaturi

return_detailsobject<return_details>Optional

The return details for the product.

return_details properties

5 properties

return_timestring<date_time>Optional

The date and time when the product was returned, [Internet date and time format](http://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

modeenumOptional

The method that the customer used to return the product.

Match^[A-Z_]+$Length1 <= length <= 255

Allowed values

"SHIPPED"
"IN_PERSON"

receiptbooleanOptional

Indicates whether customer has the return receipt.

return_confirmation_numberstringOptional

The confirmation number for the item return.

Match^[A-Za-z0-9:\-]+$Length1 <= length <= 255

returnedbooleanOptional

If `true`, indicates that the item was returned but the seller refused to accept the return and if `false`, indicates the item was not attempted to return.

Product Details

return_details properties

Back to top

On this page

On this page

Product Details

return_details properties

Back to top

On this page

Product Details

return_details properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Product Details

return_details properties

Back to top

On this page