Carriers List

What is Carriers List?

Carriers List is a management view that allows you to manage all carriers configured in your system. From this view you can add new carriers, edit existing information, search for specific carriers, and maintain all contact and configuration information needed for your shipping operations.

This functionality is essential for configuring and maintaining information about carriers you use to ship orders, including contact details, addresses, and API codes for integrations.

Centralized Management

Carriers List centralizes all carrier information in one place. Keep your carrier data organized and updated for efficient shipping operations.

---

Why Use Carriers List?

Complete Carrier Management

Manage all carriers from a single view. Add, edit, and maintain complete information for each carrier.

Complete Contact Information

Store complete contact information including email, phone, names, company, and full address for each carrier.

Inline Editing

Edit information directly in the list without needing to open separate forms. Update data quickly.

Search and Filtering

Search carriers by any field. Quickly find the carrier you need using basic or advanced search.

API Codes

Manage API codes for integrations with carrier systems. Maintain information needed for automated connections.

Special Carriers

Mark carriers as special when you need to treat them differently in your shipping processes.

---

How to Access Carriers List

1. Navigate to Carriers List

   Access /Carriers_Listlist.php directly or search for “Carriers List” in the navigation menu.

2. Verify your permissions

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

---

How to Use Carriers List

View the Carriers List

The page automatically displays all configured carriers in a table with the following columns:

• shipping carrier id: Unique carrier ID
• shipping carrier name: Carrier name (required)
• shipping carrier description: Carrier description
• shipping carrier URL WEB: Carrier website URL (required)
• Email: Email address
• Phone: Phone number
• FirstName: Contact first name
• LastName: Contact last name
• Company: Company name
• Address1: Address line 1
• Address2: Address line 2
• City: City
• State: State/Province
• Zip: Postal code
• Country: Country
• SpecialCarrier: Indicates if it’s a special carrier (Yes/No)
• Api Code: API code for integrations

Search Carriers

1. Use the search field

   At the top of the page, you’ll find a basic search field.

2. Enter your search term

   Type any term related to the carrier you’re looking for. The search looks in all fields.

3. Select the search type

   Choose between:

   • Exact phrase: Searches for the exact phrase
   • All words: Searches for carriers containing all words
   • Any word: Searches for carriers containing any of the words

4. Click Search

   The list will automatically filter showing only carriers that match your search.

5. Clear search

   Click “Show all” to see all carriers again.

Sort the List

1. Click on column header

   Click on any column header to sort by that field.

2. Toggle between ascending and descending

   Click again on the same header to toggle between ascending and descending order.

3. Sort by any field

   You can sort by ID, name, description, URL, email, phone, address, or any other field.

Add a New Carrier

1. Click Inline Add

   At the top of the table, click the “Inline Add” link.

2. A new editable row appears

   A new row will be added at the end of the table with editable fields.

3. Complete required fields

   Enter at least:

   • shipping carrier name: Carrier name (required)
   • shipping carrier URL WEB: Valid website URL (required)

4. Complete optional fields

   You can add:

   • Description
   • Email
   • Phone
   • Contact information (first name, last name, company)
   • Complete address
   • API code
   • Mark as Special Carrier

5. Save the new carrier

   Click the save button or confirm the action. The system will validate that required fields are complete and that the URL is valid.

6. Confirm the result

   You’ll see a confirmation message and the new carrier will appear in the list.

Edit an Existing Carrier

1. Click on the carrier you want to edit

   Click on the carrier row or look for the inline edit button.

2. The row changes to edit mode

   Fields will become editable text fields.

3. Modify the fields you need

   You can change any field: name, description, URL, contact information, address, etc.

4. Validate changes

   The system will automatically validate:

   • That the carrier name is not empty
   • That the URL is valid (correct format)

5. Save changes

   Click the save button or confirm the action.

6. Confirm the result

   You’ll see a confirmation message and changes will be saved.

Mark a Carrier as Special

1. Edit the carrier

   Enter edit mode for the carrier you want to mark as special.

2. Change the SpecialCarrier field

   The SpecialCarrier field toggles between “Yes” and “No” when you edit it.

3. Save changes

   The system will save the carrier’s special status.

Navigate Between Pages

1. Use pagination controls

   At the bottom of the table, you’ll find pagination controls.

2. Navigate between pages

   Use the “First”, “Previous”, “Next”, “Last” buttons or click directly on page numbers.

3. Adjust records per page

   Use the “Records Per Page” dropdown to change how many carriers are shown per page (10, 20, 50, 100, 200, 500, or All).

---

Functionality Details

Required Fields

The following fields are mandatory when adding or editing a carrier:

• shipping carrier name: The carrier name cannot be empty
• shipping carrier URL WEB: The URL must be valid and cannot be empty

URL Validation

The system automatically validates that the entered URL has a valid format:

• Must follow standard URL format (http://, https://, or ftp://)
• Validated using a regular expression that verifies correct format
• If the URL is not valid, you’ll see an error message and won’t be able to save until corrected

Contact Information

You can store complete contact information for each carrier:

• Email: Email address for communication
• Phone: Contact phone number
• FirstName/LastName: Full name of primary contact
• Company: Carrier company name

Address Information

Each carrier can have a complete address stored:

• Address1: Primary address (line 1)
• Address2: Secondary address (line 2, optional)
• City: City
• State: State or province
• Zip: Postal code
• Country: Country

Special Carrier

The SpecialCarrier field allows marking carriers that need special treatment:

• Can be “Yes” or “No”
• Automatically toggles when you edit the field
• Useful for identifying carriers that require special processes or configurations

API Code

The Api Code field stores API codes for integrations:

• Useful for systems that connect directly with carrier APIs
• Can be any code or identifier needed for the integration
• Stored as text and can be used by other systems or modules

Inline Editing

Inline editing functionality allows:

• Editing directly in the list without opening separate forms
• Viewing all fields while editing
• Saving changes quickly
• Canceling edits if you change your mind

Required Permissions

To use Carriers List you need:

• Permission level: Carriers_List
• List capability: CanList() - To view the list
• Add capability: CanAdd() - To add new carriers
• Edit capability: CanEdit() - To edit existing carriers

If you don’t have these permissions, you’ll see messages indicating you don’t have the necessary rights.

---

💡 Best Practices

Keep Information Updated

Regularly review and update carrier contact and address information. Updated information facilitates communication and management.

Use Descriptive Names

Use clear and descriptive carrier names. This facilitates quick identification when selecting carriers for shipments.

Validate URLs Correctly

Make sure URLs include the correct protocol (http:// or https://). The system validates the format but it’s better to include the complete protocol.

Complete Contact Information

Complete all available contact information. This facilitates communication when you need to contact carriers.

Mark Special Carriers

Use the SpecialCarrier field to identify carriers that require special processes or different configurations.

Document API Codes

If you use integrations with carrier APIs, document API codes in the corresponding field. This facilitates maintenance and configuration.

---

Troubleshooting

I can’t add a new carrier

Problem: The “Inline Add” button doesn’t appear or doesn’t work.

Solutions:

1. Verify that you have add permissions (CanAdd)
2. Verify that you’re logged in correctly
3. Reload the page and try again
4. Contact the administrator if the problem persists

The URL is not accepted as valid

Problem: The system rejects the URL I enter even though it seems correct.

Solutions:

1. Make sure to include the protocol (http:// or https://)
2. Verify that the URL doesn’t have spaces or incorrect special characters
3. Try with a simple URL first (for example, https://www.example.com)
4. Verify that the URL follows standard URL format
5. Review the specific error message for more details

I can’t edit a carrier

Problem: I can’t enter edit mode or changes don’t save.

Solutions:

1. Verify that you have edit permissions (CanEdit)
2. Make sure to complete required fields (name and URL)
3. Verify that the URL is valid before saving
4. Review specific error messages
5. Try reloading the page and editing again

The SpecialCarrier field doesn’t change correctly

Problem: The SpecialCarrier field doesn’t toggle between Yes and No as I expect.

Solutions:

1. The field automatically toggles when you edit it
2. If the field is empty, it keeps the previous value
3. Make sure to click on the field and change its value explicitly
4. Save changes for them to apply

I can’t search carriers

Problem: The search doesn’t find carriers I know exist.

Solutions:

1. Verify that you don’t have active filters hiding results
2. Try with simpler search terms
3. Use “Any word” instead of “Exact phrase” for broader searches
4. Click “Show all” to clear filters and see all carriers
5. Verify that you have permissions to view the carriers you’re searching for

Changes don’t save

Problem: I edit a carrier but changes don’t save.

Solutions:

1. Verify that you’ve completed all required fields
2. Make sure the URL is valid
3. Click explicitly on the save button or confirm the action
4. Review specific error messages
5. Verify that you have edit permissions
6. Try reloading the page and editing again

I don’t see all carriers

Problem: The list doesn’t show all carriers it should show.

Solutions:

1. Verify that you don’t have active search filters
2. Click “Show all” to clear all filters
3. Verify pagination - there may be more pages
4. Adjust “Records Per Page” to “All” to see all records
5. Verify that you have permissions to view all carriers

---

Related Links

Next Steps:

• Carrier Packages - Manage carrier packages and services
• Carrier Manifest - Generate and manage carrier manifests
• Carrier Open/Close - Open and close carrier periods
• Shipping Labels - Generate shipping labels using carriers
• Order Processing - Process orders with configured carriers
• Shipping Configuration - General shipping configuration