On this page
No Headings
The customer-provided merchandise issue details for the dispute.
objectissue_typestring"PRODUCT", "SERVICE"^[0-9A-Z_]+$The issue type.
product_detailsobjectThe product information.
descriptionstring^(.|\r?\n)*$The product description.
product_receivedstring"YES", "NO", "RETURNED"^[0-9A-Z_]+$Indicates whether the product was, or was not, received or returned.
product_received_timestringppaas_date_time_v3^[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})$The date and time when product was delivered.
expected_delivery_datestringppaas_date_time_v3^[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})$The expected delivery date and time of the product.
sub_reasonsarrayAn array of sub-reasons for the product issue.
itemsstring"DAMAGED", "DIFFERENT", "MISSING_PARTS", "OTHER"^[0-9A-Z_]+$The sub-reason for the product issue.
purchase_urlstringuriThe URL where the customer purchased the product.
return_detailsobjectThe return details for the product.
return_timestringppaas_date_time_v3^[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})$The date and time when the product was returned, Internet date and time format.
modestring"SHIPPED", "IN_PERSON"^[A-Z_]+$The method that the customer used to return the product.
receiptbooleanIndicates whether customer has the return receipt.
return_confirmation_numberstring^[A-Za-z0-9:\-]+$The confirmation number for the item return.
returnedbooleanIf 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.
service_detailsobjectThe service details.
descriptionstring^(.|\r?\n)*$The service description.
service_startedstring"YES", "NO", "CANCELLED"^[0-9A-Z_]+$Indicates whether the service was started or cancelled.
notestring^(.|\r?\n)*$The customer specified note about the service usage.
sub_reasonsarrayAn array of sub-reasons for the service issue.
itemsstring"DAMAGED", "DIFFERENT", "INCOMPLETE", "OTHER"^[0-9A-Z_]+$The sub-reason for the service issue.
purchase_urlstringuriThe URL of the merchant or marketplace site where the customer purchased the service.
cancellation_detailsobjectThe cancellation details.
cancellation_datestringppaas_date_time_v3^[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})$The date and time of the cancellation, in Internet date and time format.
cancellation_numberstring^.*$The cancellation number.
cancelledbooleanIndicates whether the dispute was canceled.
cancellation_modestring"CANCELLED_PAYPAL_BILLING_AGREEMENT", "WEBSITE", "PHONE", "EMAIL", "WRITTEN", "IN_PERSON"^[0-9A-Z_]+$Indicates the mode used for order cancellation.
return_shipping_addressobjectThe return address for the item. Required when the customer must return an item to the merchant for the MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED dispute reason.
address_line_1stringThe first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
address_line_2stringThe second line of the address. For example, suite or apartment number.
address_line_3stringThe third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.
admin_area_4stringThe neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
admin_area_3stringA sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
admin_area_2stringA city, town, or village. Smaller than admin_area_level_1.
admin_area_1stringThe highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
address_detailsobjectThe non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.
street_numberstringThe street number.
street_namestringThe street name. Just Drury in Drury Lane.
street_typestringThe street type. For example, avenue, boulevard, road, or expressway.
delivery_servicestringThe delivery service. Post office box, bag number, or post office name.
building_namestringA named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.
sub_buildingstringThe first-order entity below a named building or location that represents the sub-premises. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.