Transporter basics

Transporter is a Java-based command-line tool that helps you deliver your content to the Apple Books. If you are using Transporter for the first time, review the quick start section in the Transporter User Guide.

You can run Transporter in various modes to help you validate XML files and .itmsp packages before delivery, upload assets and metadata, and monitor your delivery. Review the Run Transporter section in the Transporter User Guide to learn more about each mode, the associated command-line options, and Apple best practices. Refer to the full list of command-line options and values for descriptions.

Common Transporter modes

Here are frequently used modes in Transporter for books:

  • Schema: Retrieve a schema file to validate your XML files before packaging and sending them to Apple.
  • Verify: Verify your .itmsp packages and ensure that metadata and assets meet technical requirements before delivery so potential issues can be addressed before uploading.
  • Upload: Upload assets and metadata to Apple after you verify they are ready to be delivered. Apple recommends to not specify the -t transport when uploading packages and instead allow Transporter to determine the best transport mode for your packages. Apple recommends generating a log file, and using the [-v verbosity] option, every time you upload a package. If you need assistance to troubleshoot delivery issues, provide a copy of the eXtreme log.
  • Status: Monitor the state of an .itmsp file and whether or not the package encountered errors or quality review rejections after upload.
  • Lookup metadata: Retrieve the current metadata for a book you previously uploaded. It is best practice to download the metadata file when you need to make modifications to the XML or assets, as the metadata file will contain Apple IDs for series, contributors and other information to ensure efficient and accurate re-deliveries.
  • Provider: This mode is primarily used by aggregators to obtain a list of providers for which they have permission to upload content and to obtain the provider short name, which is required in the command line.
  • Request report: Retrieve your catalog reports and sales reports. Sales reports and preorder sales reports are available in Transporter at both summary and detail levels and at daily, weekly, monthly or yearly granularities. You will need to hold an admin, sales or finance role in iTunes Connect to retrieve these reports. You will also need the relevant SAP vendor number to request.