> For the complete documentation index, see [llms.txt](https://docs.parcellab.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parcellab.com/docs/platform/app-store/apple-wallet.md).

# Apple Wallet Order Tracking

parcelLab offers Apple Wallet Order Tracking integration to allow your customers to easily track their orders directly through Apple Wallet.

## Overview

With this integration, you can offer customers a fully branded experience to track the status of their orders, seamlessly embedded in Apple Wallet. Shoppers can track their orders, view product details, and receive real-time updates through push notifications.

It’s straightforward to implement. Simply send the necessary event data along with the relevant Apple Wallet details (see [below](#configuring-the-apple-wallet-order-tracking-integration)) to parcelLab and a digital pass is automatically created and updated in the customer’s Apple Wallet, making it simple to monitor the order status at a glance. This in turn helps reduce support inquiries, improve customer satisfaction, and drive stronger engagement after purchase.

<figure><img src="https://1156682959-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LPf1Lv1YUuLYva6LrXQ%2Fuploads%2F2UiaYz63F84ojo03plHN%2FAppleWalletParkers.png?alt=media&amp;token=53d32990-3d74-48f7-a643-2440ea85debb" alt="Apple Wallet notification, order placed and order on its way status images"><figcaption></figcaption></figure>

### Key Benefits

Using parcelLab’s Apple Wallet Order Tracking integration leads to a number of benefits, including:

* Enhanced customer experience with order tracking information available directly in their Apple Wallet
* Real-time updates to keep customers informed of order status changes via push notifications
* Seamless integration with your existing parcelLab tracking solution
* Reduced support inquiries through proactive status updates
* Increased brand engagement with your logo and contact information shown directly in the customer’s Apple Wallet

## Configuring the Apple Wallet Order Tracking Integration

The following sections describe the configuration required for the Apple Wallet Order Tracking integration with parcelLab.

### Customer Requirements

For successful configuration of the Apple Wallet Order Tracking integration, the following requirements must be met:

* Apple Developer account with Admin or Account Holder access
* Apple Wallet support (iOS 15 devices and above)
* Active parcelLab account
* You must provide tracking data with required metadata (for example: order status and tracking URL)
* Branded assets (for example: logo)

### Enabling the Apple Wallet Order Tracking Integration

This section describes how you can enable the Apple Wallet Order Tracking integration with parcelLab.

{% stepper %}
{% step %}

#### Enroll in Apple Developer Program

* Make sure your organization has an active Apple Developer Program membership, and that you have Admin or Account Holder access.
  {% endstep %}

{% step %}

#### Register an Order Type Identifier

1. Sign into [developer.apple.com](https://developer.apple.com/) and open **Certificates, Identifiers & Profiles**.
2. In the sidebar, select **Identifiers**, and then click **+**.
3. Select **Order Type IDs**, and then click **Continue**.
4. Do the following:
   1. Enter a name for the order type ID in the **Name** field (for example: "YourBrand Order Pass").
   2. Enter the unique identifier in reverse-DNS format in the **Identifier** field (for example: `order.com.yourbrand.store`).
5. Click **Register**.
   {% endstep %}

{% step %}

#### Create an Order Type ID Certificate

1. Under **Certificates**, click **+**.
2. Select **Order Type ID Certificate**, and then click **Continue**.
3. Upload your Certificate Signing Request (CSR).
4. Download the generated .cer file (this is your order type ID certificate).
   {% endstep %}

{% step %}

#### Export the Private Key

1. Open **Keychain Access** on macOS.
2. Under **My Certificates**, find your new order type ID certificate and expand it to reveal its private key.
3. Select both the order type ID certificate and the corresponding private key, and then click **File → Export Items**.
4. Select .**p12** format, set an export password, and then click **Save**.
5. If needed, convert the .p12 to PEM format using `openssl pkcs12`.
   {% endstep %}

{% step %}

#### Register a Merchant Identifier for Apple Pay

1. In **Certificates, Identifiers & Profiles → Identifiers**, click **+**.
2. Select **Merchant IDs**, and then click **Continue**.
3. Do the following:
   1. Enter a name for the merchant identifier in the **Name** field (for example: "YourBrand Apple Pay").
   2. Enter the unique identifier (for example: `merchant.com.yourbrand.applepay`).
4. Click **Register**.
   {% endstep %}

{% step %}

#### Create an Apple Pay Payment Processing Certificate

1. Under **Certificates**, click **+**.
2. Select **Apple Pay Payment Processing Certificate** for your merchant ID.
3. Upload a new CSR.
4. Download the resulting .cer file.
   {% endstep %}

{% step %}

#### Provide Assets to parcelLab

Provide your parcelLab integration lead with:

* Order Type Identifier (for example: `order.com.yourbrand.store`)
* Order Type ID Certificate (.cer)
* Private Key (.p12 or PEM)
* Merchant ID (for example: `merchant.com.yourbrand.applepay`)
* Apple Pay Payment Processing Certificate (.cer)

{% hint style="info" %}
Handle all sensitive files securely (for example: via encrypted file transfer).
{% endhint %}
{% endstep %}

{% step %}

#### Checkout Integration Snippet

Your shop system will have to call the parcelLab API during the Apple Pay payment completion process. As part of the payment completion, information about the wallet pass has to be sent back to the client. To retrieve the information from the parcelLab API, use the [Fetch Apple Wallet Order Tracking API request](https://github.com/parcelLab/gitbook-documentation/tree/main/developers/status-updates/apple-wallet.md#fetch-apple-wallet-order-data) detailed in our developer documentation.

{% hint style="info" %}
For further details on Apple Pay, please refer to [Apple's documentation](https://developer.apple.com/documentation/applepayontheweb/applepaysession/completepayment).
{% endhint %}
{% endstep %}
{% endstepper %}

Apple Wallet Order Tracking is built for seamless integration via API. When you send the relevant tracking data to parcelLab, including specific identifiers for Apple Wallet, parcelLab generates and updates a pass in the customer’s Apple Wallet automatically, allowing them to easily keep track of their order.

{% hint style="info" %}
For more information on the technical requirements of this integration, please see our [API reference](https://github.com/parcelLab/gitbook-documentation/tree/main/developers/status-updates/apple-wallet.md).
{% endhint %}

### Add Apple Wallet Order Tracking from Emails

This section describes how you can include an Apple Wallet button in emails to allow shoppers to add eligible orders directly to Apple Wallet.

{% hint style="info" %}
This option does not require an Apple Pay checkout integration, but Apple Wallet must be configured for your parcelLab account. For further details on the scope and requirements of adding Apple Wallet Order Tracking from emails, please contact your parcelLab representative.
{% endhint %}

{% stepper %}
{% step %}

#### Add the Apple Wallet button to an email

1. In the parcelLab App, open the message you want to update.
2. Add the `{{appleWalletOrderTrackingButton}}` placeholder to the message where you want the Apple Wallet button to display.\
   The placeholder displays a localized Add to Apple Wallet button linked to the order.

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>The language for the button follows the message language, with English as a fallback.</p></div>
3. Preview the message to check the button displays as intended.

   <div align="left"><figure><img src="https://1156682959-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LPf1Lv1YUuLYva6LrXQ%2Fuploads%2FBqABN9f8u2zuvFmAqR0c%2FAppleWalletEmailAddButton.png?alt=media&amp;token=430af304-5990-487a-af3a-97462a4748e4" alt="Add to Apple Wallet button in email preview" width="375"><figcaption></figcaption></figure></div>
4. Click **Save**.

The Add to Apple Wallet button is added to the email. When shoppers open the email and select the button, they can add the order pass to their Apple Wallet, which includes a Track button that opens the Order Status page to track the progress of the order.

<div align="left"><figure><img src="https://1156682959-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LPf1Lv1YUuLYva6LrXQ%2Fuploads%2F4Mdms6YNlFL0RU7teyU0%2FAppleWalletTrackButton.png?alt=media&amp;token=1e9bbf34-57c5-4d86-8d6a-2fcf8414656b" alt="Order pass in Apple Wallet with Track button linking to the Order Status page" width="250"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

#### Use a custom link

If you prefer to create your own button or link, use the `{{appleWalletOrderTrackingUrl}}` placeholder.

For example:

```html
<a href="{{appleWalletOrderTrackingUrl}}">
	Add order to Apple Wallet
</a>
```

{% endstep %}

{% step %}

#### Check Apple Wallet availability

Use the `{{appleWalletOrderTrackingAvailable}}` placeholder to check whether the required tracking information is available (that is: account ID, order number and tracking security hash). It returns `true` or `false` and if required tracking information is missing, the button and URL placeholders return empty values.

{% hint style="info" %}
The placeholder does not check whether Apple Wallet is configured for your account so you will need to verify the account setup separately.
{% endhint %}
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parcellab.com/docs/platform/app-store/apple-wallet.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
