Skip to main content
Available to all Perform.AI customers. Several steps need the Administrator role. This guide takes a new account from first sign-in to the first shipments, tracking page and notifications. Each step links to the page that covers it in depth.

​
1. Sign in

Open the portal sign-in page. It shows a Password tab and, if your organization has single sign-on configured, an SSO tab that sends you to your company’s identity provider. Which tabs you see depends on how your organization is set up. See User Management for the sign-in rules.

​
2. Add your team

Only Administrators can manage users.
  1. Go to Settings > Users.
  2. Select Add user, enter the person’s email address and select Continue.
  3. Choose a role for the user and select Add.
Roles decide what each user can see and do. See User Management.

​
3. Configure your carriers

Carriers must be configured before you upload shipments, so that Perform.AI can assign each shipment to its carrier straight away.
  1. Go to Settings > Carriers and select Add Carrier.
  2. Select the Carrier Name and enter a Carrier Reference. The reference is a unique ID for that carrier in your account; it cannot be reused for another carrier, and one carrier can have several references.
  3. The new reference appears in the list with the status Active. Use it as the carrier_reference whenever you create shipments.
Shipments created without a carrier reference make Perform.AI identify the carrier from the tracking number, which takes longer. See Carrier Integration.

​
4. Connect your shipment data

Choose the method that fits your systems. All of them end up in the same Shipment Overview.

​
Through the API

  1. Go to Integrations > API and select Configure. Select Request Credentials if your account has none yet. The credentials are a Client ID and a Client Secret.
  2. Generate a bearer access token with them. Tokens are valid for one hour; several can be in use at once. See Authentication.
  3. Create your first shipment. See Create a shipment.

​
By file upload

  1. Go to Shipment Overview and select Add Parcels.
  2. Choose File Upload, download the template with Create Shipment Template, fill one row per shipment with at least shipment[shipment_id] and shipment[tracking_number], and upload the CSV.
For single parcels or a list of tracking numbers, use Create Single Parcel or Create Multiple Parcels in the same dialog. See File Upload.

​
From Shopify

  1. Go to Integrations and select Add Store on the Shopify tile.
  2. Enter your store URL, create the Shopify app, paste its Client ID and Secret as the API Key and API Secret Key, save and activate.
See Shopify.

​
Other methods

SFTP file drops, incoming webhooks and connections to your own or your carrier’s API are set up with your account team. See Data Integration.

​
5. Check your shipments

Go to Shipment Overview. Use Filters to narrow the list, Edit columns to choose the data you see (up to 20 columns), Save as bookmark to keep a view, and Export to receive a CSV by email. See Shipment Overview.

​
6. Set up a Tracking Page

A Tracking Page is the branded page where your shoppers follow a shipment, and the design your notifications adopt. Create one, then link your shipments to it: on the Shopify integration, through the shipment’s tracking_page_reference, or by selecting it in the store details. See Tracking Page.

​
7. Switch on notifications

  1. Go to Post-Purchase > Notifications and select Add Notification.
  2. Choose the channel: email, SMS, webhook or Klaviyo.
  3. Enter a name (up to 32 characters), pick a trigger, add any carrier, Tracking Page or tag filters, and select Save, then Activate.
For webhooks, configure the endpoint under Integrations > Webhooks first. See Delivery Notifications, Webhooks and Klaviyo.

​
8. Ask your AI assistant

Connect the assistant your team already uses to Perform.AI through MCP and ask about your shipments in plain language. See MCP installation.

​
Next steps