Order Report

The Order Report (ORT) gives merchants and processing partners detailed information about outstanding authorized orders that can be captured.

Know before you begin

• The report is generated and delivered by PayPal on a 24-hour basis.
• The report is available on the PayPal website and the Secure FTP Server for 45 days after the date of its delivery.
• The report format is either comma-separated value (CSV) or tab-delimited values.
• The character encoding of this report is UTF-8 (8-bit UCS/Unicode Transformation Format).

Distribution and access

Access the ORT from the Secure FTP Server, reports.paypal.com, which requires a separate user account for access to the Order Report. A user account that is enabled for the ORT is also enabled to create user accounts for the Secure Drop-Box. To ensure data security, ORT users must generate their own user accounts for the Secure Drop-Box.

The following steps describe how to set up and access the ORT using the Secure FTP Server:

1. Create a Secure FTP Server user account. Login to PayPal (www.paypal.com) and create a Secure PayPal Reporting FTP Server username and password. Passwords for accessing the Secure FTP Server cannot be reset by PayPal. To obtain a new password, you must create a new Secure FTP Server user account.

2. Grant access to third-party users. You must explicitly grant access to third-parties by contacting their PayPal Account Manager to provide the following information:

   • Third-parties’ PayPal login username

   • Type of permission: reporting access (read)

     The third-party is then notified by email that access to the business partner’s Secure FTP Server has been granted.

3. Access the Secure FTP Server programmatically using an FTP client. The hostname of the Secure FTP Server is reports.paypal.com. A user account on the Secure FTP Server has the /ppreports/outgoing directory structure.

Report file name

The file name naming convention depends on whether or not you are using Multiple Account Management (MAM).

Single account report

The filename of the Order report for a single account follows this naming convention: ORT-yyyymmdd.sequenceNumber.version.format

Multiple account report

The file name of the Multiple Account Management (MAM) follows this naming convention: ORT-yyyymmdd.reportingWindow.sequenceNumber.totalFiles.version.format

New or revised versions

In the future, PayPal will support multiple versions of the ORT. PayPal will notify you regarding the creation of any new version as well as any deprecation of older versions of the report.

If you want to take advantage of a new version, you can receive two versions of the same report concurrently in order to test and integrate the new version. You can also receive nonconsecutive versions of the same report concurrently in order to test and integrate the new version. Contact your PayPal Account Manager to enable different versions and request any changes in report distribution.

Notifications

PayPal operationally monitors the generation and delivery of the ORT on a 24/7 365 basis. PayPal maintains two different user contact points for report notifications:

• A business contact point for all notifications related to data integrity, data delivery, and new reporting features
• A technical contact for all notifications related to data integrity, data delivery, system outages, system updates, and new features.

PayPal notifies you of the following events related to reporting:

• Delays in report delivery
• Errors in report generation
• New version availability
• System outage
• System update/maintenance (pre-announcement)
• New reporting feature releases

Contact your PayPal Account Manager to provide PayPal with the appropriate notification email alias. PayPal strongly recommends that you create a distribution list or email alias that allows multiple parties to receive communication about the ORT.

File structure

The report is delivered as either a comma-separated values or tab-delimited file. This section describes the structure of the data file.

A report file can contain a maximum of 1 million records. If the report contains more than 1 million records, the report is split across multiple files. The report is also organized by section, where each section represents a single PayPal account. If you are not using PayPal Multiple Account Management, the report contains only a single section.

Each row of the report consists of a two letter row type, followed by the details specific to that row type. This table lists the valid row types, along with the sections that describe the data for that row type.

A report file with fewer than 1 million records (a single file) with only one section is organized as follows:

Report Header (RH)
File Header (FH)
Section Header (SH)
Column Header (CH)
Row Data (SB)
...
Row Data (SB)
Section Footer (SF)
Section Record Count (SC)
Report Footer (RF)
Report Record Count (RC)
File Footer (FF)

For report files that are split across multiple files, only the first file has a report header record and only the last file has a report footer and a report record count record. A report with two sections split across two files might be organized as follows:

Section 1: Report data

This section details the columns and related data that is delivered in the report header, report footer, and report record count records.

Report header data

Report header data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Report footer data

Report footer data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Report record count data

Report record count data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Section 2. File data

This section details the columns and related data that is delivered in the file header and file footer records.

File header data

File header data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

File footer data

File footer data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Section 3. Section data

This section details the columns and related data that is delivered in the section header, section footer, and section record count records.

Section header data

All section header data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Section body data

Body data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Before any rows of body data in the report, a column header row lists the name of each of the fields in each body data row. The column header column starts with CH, followed by the Column Name for each body data field (except for the column type field). For example:

"CH","Order ID","Order Action Type","Order Currency","Order Creation Date", Order Payer PayPal Account ID","Order Payer email address","Order Payer Name", "Order Payer Business Name","Shipping Address Line1","Shipping Address City", "Shipping Address State","Shipping Address Zip","Shipping Address Country", "Order Description","Order Memo","Order Custom Field"

Section footer data

Section footer data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Section record count data

Section record count data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

PayPal-supported currencies

For a list of currencies supported for use with payments and as currency balances, see PayPal-supported currencies.

See also

• T-codes