Carrier Manifest

What is Carrier Manifest?

Carrier Manifest is a tool that allows you to generate and manage carrier manifests to close shipping periods. Manifests are official documents that consolidate information from all shipments made with a specific carrier during a given period.

This functionality is essential for meeting carrier requirements that need manifests to process and bill shipments correctly. It allows you to generate manifests for one or multiple carriers, download generated files, and maintain a complete history of all created manifests.

Closing Periods

Manifests are used to close shipping periods with carriers. Once a manifest is generated, the carrier can process all shipments included in that period.

---

Why Use Carrier Manifest?

Carrier Compliance

Generate manifests required by carriers to process and bill shipments. Meet official documentation requirements.

Multiple Carriers

Generate manifests for one or multiple carriers at once. Select individual carriers or process several simultaneously.

Complete History

Maintain a complete record of all generated manifests. View status, files, messages, and timestamps of each manifest.

File Download

Download generated manifest files directly from the interface. Files are automatically saved and available for download.

Status Tracking

Monitor the status of each manifest. See if it’s processing, completed, or if there was an error during generation.

Automatic Integration

Automatically integrates with carrier systems (such as Xenvio) to generate manifests without additional manual intervention.

---

How to Access Carrier Manifest

1. Navigate to Carrier Manifest

   Access /carrier_manifest.php directly or search for “Carrier Manifest” in the navigation menu.

2. Verify your permissions

   Make sure you have Order_List_Processing_A level permissions with list capability. If you don’t have permissions, you’ll be redirected to login.

---

How to Generate a Manifest

Create Manifest for an Individual Carrier

1. Click Create

   At the top of the page, click the Create button.

2. Create Manifest modal opens

   A modal will appear with a list of all active carriers available in your system.

3. Select a carrier

   In the carriers table, click directly on the name of the carrier you want to process. This will automatically select that carrier.

4. Click Proccess Manifest

   Click the Proccess Manifest button to start generating the manifest for the selected carrier.

5. Wait for processing

   You’ll see a “Processing…” message while the system generates the manifest. This may take a few seconds.

6. Review results

   Once completed, you’ll see a success message and a table with results will be displayed. If the manifest was generated correctly, you’ll see a link to download the file.

Create Manifest for Multiple Carriers

1. Click Create

   At the top of the page, click the Create button.

2. Create Manifest modal opens

   A modal will appear with a list of all active carriers available.

3. Select multiple carriers

   Check the boxes next to each carrier you want to process. You can select as many carriers as needed.

4. Or use Select All

   If you want to select all carriers in the list, check the Select All checkbox in the table header.

5. Click Proccess Manifest

   Click the Proccess Manifest button to start generating manifests for all selected carriers.

6. Wait for processing

   The system will process each selected carrier. You’ll see a “Processing…” message during the process.

7. Review results

   Once completed, you’ll see a table with results for each carrier. Successful manifests will show links to download files, while those with errors will show error messages.

---

View Manifest History

The main page displays a table with the complete history of all generated manifests. The table includes the following columns:

• Carrier: Name of the carrier for which the manifest was generated
• Status: Manifest status (generally “Close” for closed manifests)
• File: Generated manifest file (if available)
• Message: Status message or additional information about the manifest
• TimeStamp: Date and time when the manifest was generated

Filter and Search Manifests

1. Use the search field

   At the top of the table, you’ll find a general search field.

2. Filter by Carrier

   Use the text filter in the Carrier column to search for manifests from a specific carrier.

3. Filter by File

   Use the text filter in the File column to search by filename.

4. Filter by date

   Use the date range filter in the TimeStamp column to search for manifests within a specific date range.

5. Click Refresh

   Click the Refresh button to update the table and see the most recent manifests.

Download Manifest Files

1. Locate the manifest

   Find the manifest you want to download in the table using available filters.

2. Click on the filename

   In the File column, click on the manifest filename you want to download.

3. File downloads

   The file will open in a new tab or download automatically, depending on your browser settings.

---

Functionality Details

Manifest Generation Process

When you generate a manifest, the system performs the following steps:

1. Creates a Carrier Open/Close record

   • A record is created in the carrier_open_close table with the carrier code
   • Initial status is “Close” with message “Requesting…”
   • Request timestamp is recorded

2. Requests manifest from carrier system

   • For carriers integrated with Xenvio, a request is made to the API
   • The system waits for the carrier response with manifest files

3. Saves received files

   • Manifest files are saved in API/xenvio/manifests/
   • Records are created in the attachments table linked to the carrier_open_close record

4. Updates status

   • If the manifest is generated correctly, status is updated with available files
   • If there’s an error, the error message is recorded in the Message field

Supported Carrier Types

The system supports different types of carriers:

• Carriers integrated with Xenvio: Manifests are automatically generated through the Xenvio API
• AVC Carrier (Amazon Vendor Central): Has a special process that generates PDF manifests based on recent shipments
• Other carriers: Can be processed through standard integration

Manifest Statuses

Manifests can have the following statuses:

• Close: Manifest closed/completed
• Requesting…: Manifest in generation process
• Error: Error during manifest generation

File Formats

Manifest files can be generated in different formats:

• PDF: For manifests generated locally (such as AVC)
• Other formats: Depending on the carrier and integration, may be generated in other formats specified by the carrier

Integration with Xenvio

For carriers integrated with Xenvio:

• The system sends a request to the Xenvio API with the carrier code
• Xenvio processes the request and generates the manifest
• The manifest is received through a webhook and automatically saved
• Files are available for download once the process is completed

Required Permissions

To use Carrier Manifest you need:

• Permission level: Order_List_Processing_A
• List capability: CanList() - To view manifest history
• Carrier permissions: Access to carriers you want to process

If you don’t have these permissions, you’ll be redirected to login or see messages indicating you don’t have the necessary rights.

---

💡 Best Practices

Generate Manifests Regularly

Generate manifests regularly according to your carrier requirements. Some carriers require daily or weekly manifests.

Check Status Before Generating

Review history before generating new manifests. Verify there are no pending or in-process manifests for the same carrier.

Download and Archive Files

Download manifest files and archive them according to your document retention policies. Manifests are important official documents.

Monitor Error Messages

Review messages in the Message column to identify any problems during manifest generation. Errors may indicate integration or configuration issues.

Process Carriers in Batches

If you need to generate manifests for multiple carriers, use the multiple selection function to process them all at once and save time.

Use Filters to Find Manifests

Use date and carrier filters to quickly find specific manifests in history. This is useful when you need to review previous manifests.

---

Troubleshooting

Manifest doesn’t generate

Problem: I click Proccess Manifest but nothing happens or an error appears.

Solutions:

1. Verify that you have Order_List_Processing_A level permissions
2. Make sure you’ve selected at least one carrier before clicking Proccess Manifest
3. Verify that the carrier is active and configured correctly
4. Review error messages in the Message column after the attempt
5. Try generating the manifest again after a few seconds
6. Contact the administrator if the problem persists

No files appear for download

Problem: The manifest was processed but I don’t see any files available for download.

Solutions:

1. Wait a few seconds - the process may take time depending on the carrier
2. Click Refresh to update the table and see if files appear
3. Review the message in the Message column - it may indicate if there was an error
4. Verify that the integration with the carrier is configured correctly
5. For Xenvio carriers, verify that the webhook is working correctly
6. Contact technical support if the problem persists

An error message appears

Problem: I see an error message in the Message column after generating a manifest.

Solutions:

1. Read the complete error message to understand what went wrong
2. Common messages include:
   • “No shipments to be manifested” - There are no shipments to include in the manifest
   • API errors - Connection or configuration problems with the carrier
3. Verify that there are recent shipments for the selected carrier
4. For Xenvio carriers, verify the integration configuration
5. Try generating the manifest again after verifying configuration
6. Contact technical support with the specific error message

I can’t select carriers

Problem: Carrier checkboxes don’t check or I can’t select carriers.

Solutions:

1. Make sure the Create Manifest modal is fully loaded
2. Verify that there are active carriers available in the list
3. Try clicking directly on the carrier name to select it individually
4. Reload the page and try again
5. Verify that you have permissions to access carriers

Refresh button doesn’t work

Problem: I click Refresh but the table doesn’t update.

Solutions:

1. Wait a few seconds - the update may take time if there are many records
2. Verify your internet connection
3. Try reloading the full page (F5 or Ctrl+R)
4. Clear filters before clicking Refresh
5. Verify that you have permissions to view manifests

I don’t see all manifests

Problem: The table doesn’t show all manifests it should show.

Solutions:

1. Verify that you don’t have active filters hiding results
2. Use the date filter to expand the search range
3. Adjust pagination - there may be more result pages
4. Click Refresh to make sure you have the most recent data
5. Verify that you have permissions to view all manifests

File doesn’t download

Problem: I click on the filename but it doesn’t download.

Solutions:

1. Verify that the file exists - it may have been deleted or moved
2. Try right-clicking and selecting “Open in new tab”
3. Verify your browser download settings
4. Try with a different browser
5. Contact the administrator if the file should be available but doesn’t download

---

Related Links

Next Steps:

• Carriers List - Manage the list of configured carriers
• Carrier Packages - Manage carrier packages and services
• Shipping Labels - Generate shipping labels using carriers
• Shipped Orders - View shipped orders included in manifests
• Order Processing - Process orders before generating manifests