> 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/developers/status-updates/order-status-page-configuration.md).

# Order Status Page Configuration

Configure a fully embedded Order Status page in your shop with all the relevant delivery status information and customizable content to promote your brand.

## How the Order Status page works <a href="#tracking-website" id="tracking-website"></a>

The Order Status Page gives customers access to their order details and delivery updates through a tracking link (for example: from an email or message).

The link can open a parcelLab hosted page or an embedded page on your website. For embedded pages, a JavaScript snippet loads the Order Status page and reads supported order, language, and verification parameters from the website page URL.

## Set up the Order Status page <a href="#tracking-website" id="tracking-website"></a>

Create and manage your Order Status page in the parcelLab App, where you can customize the page design and content.

{% hint style="info" %}
You must publish both the Order Status page and any custom theme you've created in the parcelLab App before the page can be displayed.
{% endhint %}

You can embed the Order Status page on your website, or use the page hosted by parcelLab. The page design, text, and content are managed in the [parcelLab App](https://app.parcellab.com/experience-design/order-status-layouts). The embed identifies your account and page, while the tracking URL identifies the order and any customer or display options.

{% hint style="info" %}
If you're using an [earlier Order Status page version](https://docs.parcellab.com/docs/developers/status-updates/order-status-page-configuration/previous.md) and would like to learn more about upgrading, contact your parcelLab representative.
{% endhint %}

Use this quick guide to create a page, connect it to your shop, and check that customers can open the right delivery details.

{% stepper %}
{% step %}

#### Create an order status page

In the parcelLab App:

1. Create a page in Experience Design > Setup > [Order Status Page](https://app.parcellab.com/experience-design/order-status-layouts).
2. Choose a layout to decide how customers browse deliveries.
3. Select a preset theme or create your own to match your brand’s look and feel.
4. Assign the settings for the order status page, including an internal name, the configured shop, and page key.

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>The page key is required for the tracking snippet.</p></div>
5. In the page's URL setting, enter the address of the page where you’ll add the embed snippet. This allows the Order Status page to load at that address.

{% hint style="info" icon="book" %}

#### Check out the parcelLab guides

For further information on creating an order status page, see our [user guide documentation](https://docs.parcellab.com/guides/experience-design/setup/order-status-page).
{% endhint %}
{% endstep %}

{% step %}

#### Adjust the design and preview

Customize your theme, edit translations, and preview the page with demo orders and your own orders in the App.

{% hint style="success" %}
Leverage the AI assistant to update your design, content or translations by simply describing what you'd like to change.
{% endhint %}
{% endstep %}

{% step %}

#### Publish the order status page

When your Order Status page is ready, publish it along with any custom theme you've created to get the snippet needed to embed the page on your website.

{% hint style="info" %}
You can set your Order Status page to be accessible from different communications, including emails, campaigns, and surveys.
{% endhint %}
{% endstep %}

{% step %}

#### Embed the order status page on your website

Add the following snippet in the `<body/>` of your website page where the order status page should display.

{% hint style="warning" %}
You will need to replace the `account` and `osp_key` (page key set in the App) with your values.
{% endhint %}

{% code overflow="wrap" %}

```html
parcellab-order-status-page-snippet.html
<pl-track-and-trace 
    account="your_account_id" 
    osp_key="my-shop"
    >
</pl-track-and-trace>
<script src="https://orderstatus.parcellab.com/static/track/embed/v1/osp-embed.js"></script>
```

{% endcode %}

The Order Status page uses the full width of the element it's placed in and adapts its layout to that width. To display the page correctly, place the snippet in your website's main content area rather than a narrow column or sidebar and avoid setting a fixed width or height.

If your website's CSS doesn't already handle this, add:

{% code overflow="wrap" %}

```css
pl-track-and-trace {
  display: block;    /* take the full width of the container */
  width: 100%;
  max-width: 1200px; /* optional: limit the width on large screens */
  margin: 0 auto;    /* center it */
}
```

{% endcode %}

To ensure the page displays responsively on mobile devices, include the following viewport meta tag in your website's HTML:

{% code overflow="wrap" %}

```html
<meta name="viewport" content="width=device-width, initial-scale=1">
```

{% endcode %}

{% hint style="info" %}
Alternatively, you can choose to use the parcelLab hosted page at `https://orderstatus.parcellab.com/order-info/<account>/<page-key>/`.
{% endhint %}
{% endstep %}

{% step %}

#### Test the implementation

Open the website page with a test order and check:

* The correct order details are displayed rather than the search form
* The embedded page adjusts its height automatically without an internal scrollbar
* Switching between deliveries scrolls back to the top of the embedded page

If your website uses a sticky header that overlaps the Order Status page, add the following CSS and adjust the value to match your header height:

```css
pl-track-and-trace {
  --pl-track-and-trace-scroll-margin-top: 80px;
}
```

{% endstep %}

{% step %}

#### Update your tracking links

Set your website page as the tracking URL for your shop so customers can access it through parcelLab emails and other communications.
{% endstep %}
{% endstepper %}

## How Customers Access Order Details&#x20;

Customers can open the full Order Status page content in one of the following ways:

* Open a parcelLab email link that contains the order’s security hash
* Verify the order on the Order Status page

{% hint style="info" %}
The page shows delivery status before verification, but protects personal data and other restricted content until the customer is verified.
{% endhint %}

<table><thead><tr><th width="249.546875">Access method</th><th>Page visibility</th></tr></thead><tbody><tr><td>Email link with security hash (<code>s</code>) parameter</td><td>Customers can access the full Order Status page, including personal details and enabled content without additional verification.</td></tr><tr><td>Email link without security hash (<code>s</code>) or direct page access</td><td>Customers can view the delivery status on the Order Status page, but personal details and restricted features remain hidden until they verify their order using their configured email or postal/zip code.</td></tr></tbody></table>

## URL Parameters and Examples

A tracking link combines the page URL with parameters that identify the order or delivery, with options to specify the language or verification method.

For example:

`https://orderstatus.parcellab.com/order-info/1234567/my-shop/?order_number=100123&lang=de&s=9f8e7d6c`

{% hint style="info" %}
For embedded pages, specifiy the account ID in the `account` attribute. For a hosted page, it is included in the URL.
{% endhint %}

The values below are examples. Replace them with the values and placeholders used in your setup.

| Parameter                                    | Purpose                                                                                                                          | Example                                                    |
| -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `order_number`                               | Identifies an order and its associated deliveries.                                                                               | `order_number=100123`                                      |
| `tracking_number` and `courier`              | Identifies a specific delivery rather than an order when both values are provided.                                               | `tracking_number=00340434000000000001&courier=dhl-germany` |
| `osp_key`                                    | Selects a page by its key when you need to identify a specific page.                                                             | `osp_key=my-shop`                                          |
| `s`                                          | A parcelLab generated security hash that can verify the customer for the order.                                                  | `s=9f8e7d6c`                                               |
| `recipient_postal_code` or `recipient_email` | Provides verification information when using the corresponding account setting.                                                  | `recipient_postal_code=80331`                              |
| `lang`                                       | Requests a page language, if that translation is available                                                                       | `lang=fr`                                                  |
| `selected_tracking_number`                   | Selects a delivery within a multi-parcel order.                                                                                  | `selected_tracking_number=00340434000000000002`            |
| `colorScheme`                                | Requests light or dark mode. The shopper's system setting is used unless specified.                                              | `colorScheme=dark`                                         |
| `draft` and `layout`                         | <p>Previews an unpublished page. <br><code>layout</code> can be used with <code>draft=true</code> to preview another layout.</p> | `draft=true&layout=spotlight`                              |

## FAQs

For answers to common questions about configuring and displaying your Order Status page, see our FAQs below.

{% hint style="info" %}
If you have any further questions relating to setup of your Order Status page, please contact your parcelLab representative.
{% endhint %}

<details>

<summary>Why isn't my Order Status page loading on my website?</summary>

Check that the production URL matches your website's domain and that the Order Status page is published in the App.

</details>

<details>

<summary>Why does the search form appear instead of the order details?</summary>

Check that your tracking links use the current URL parameter names (for example: `order_number` instead of `orderNo`).

</details>

<details>

<summary>How can I display the Order Status page in the correct language?</summary>

Set the `lang` parameter and make sure the required translation is configured in the App.

</details>

<details>

<summary>How do I make my latest changes visible to customers?</summary>

Publish your changes to the Order Status page and any custom theme. Only published changes are displayed on your website.

</details>

<details>

<summary>Can I embed the Order Status page on multiple websites?</summary>

Yes, but the page URL setting supports only one website. To use the Order Status page on multiple domains, create a separate page for each domain with its own page URL.

</details>


---

# 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/developers/status-updates/order-status-page-configuration.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.
