Container Number Validator API

API ID 13033

The Container Number Validator API is a robust tool designed to verify the authenticity and format of shipping container numbers. By utilizing standardized algorithms, it checks container numbers against international conventions, ensuring accuracy and compliance for logistics and supply chain operations. Ideal for shipping companies and freight forwarders, this API enhances operational efficiency and reduces errors in container management.

2,760 ms avg response

API Documentation

Endpoints

Request

Validates an ISO 6346 shipping container number. Checks format and check digit, returns owner code, equipment category, serial number, and validation status.

Endpoint ID: 26169
GET https://www.zylalabs.com/api/13033/container+number+validator+api/26169/validate+container+number
INPUT PARAMETERS

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

This endpoint does not require any input parameters.

API EXAMPLE RESPONSE
JSON
{"input":"CSQU3054383","isValid":true,"ownerCode":"CSQ","categoryId":"U","serial":"305438","checkDigit":3,"expectedCheckDigit":3,"category":"freight container","error":null}
Validate Container Number — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/13033/container+number+validator+api/26169/validate+container+number' --header 'Authorization: Bearer YOUR_API_KEY' 


    

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Container Number Validator API simply include your bearer token in the Authorization header.

Headers
Header Description
Authorization Required Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

Simple Transparent Pricing

No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.

(Save 2 months with annual billing 🎉)

🚀 Enterprise Plan
Custom Volume

  • Custom Rate Limit
  • Team & Access Management
  • SLA-backed Uptime
  • Specialized Customer Support
  • Real-Time API Monitoring
  • Enterprise Security & Compliance
Minimum annual contract: USD 10,000

Trusted by leading companies

Overview

The Container Number Validator API is a robust service designed to verify the authenticity and validity of shipping container numbers, adhering to the international ISO 6346 standard. This API serves shipping companies, freight forwarders, and logistics providers by ensuring that container numbers submitted for tracking, shipping, and logistics management are accurate and compliant with international norms. With a seamless integration process, the Container Number Validator API enables users to submit container numbers via a simple HTTP request and receive responses in real-time. The API checks the submitted container number against predefined validation rules, including the structure of the number, check digit calculations, and conformity to the ISO standards. This validation process helps prevent common errors that can lead to shipment delays, lost cargo, and logistical complications. Key features of the Container Number Validator API include: 1. **Comprehensive Validation**: The API checks for the correct length, format, and checksum of container numbers, ensuring they are valid before being processed further in the logistics chain. 2. **User-Friendly Response Format**: Responses are provided in JSON or XML, depending on the developer's preference, making it easy to integrate and utilize within various applications. 3. **High Availability**: Designed for performance, the API is built to handle a high volume of requests simultaneously, making it suitable for large-scale logistics operations. 4. **Error Handling**: The API provides clear error messages when invalid container numbers are submitted, offering descriptive feedback that helps users correct their inputs quickly. 5. **Scalability**: Whether you are a small logistics provider or a multinational shipping corporation, the API's scalable infrastructure supports your operational needs as they grow. 6. **Secure Access**: The API employs secure authentication methods to ensure that only authorized users can access its features, protecting sensitive shipping information. 7. **Documentation and Support**: Comprehensive documentation is available, detailing endpoints, request formats, and examples, along with dedicated support to assist developers in implementation and troubleshooting. The Container Number Validator API is an essential tool for ensuring the accuracy and integrity of shipping operations. By integrating this API, companies enhance their shipping processes, reduce potential errors, and improve overall efficiency in their supply chain management.

Container Number Validator API FAQs

The Validate Container Number endpoint returns data that includes the validity status of the container number, owner code, equipment category, serial number, check digit, expected check digit, and category type. This information helps users confirm the authenticity and compliance of the container number.

The key fields in the response data include "isValid" (boolean), "ownerCode" (string), "categoryId" (string), "serial" (string), "checkDigit" (integer), "expectedCheckDigit" (integer), "category" (string), and "error" (nullable string). These fields provide essential details about the container number's validity.

The response data is organized in a JSON format, structured as key-value pairs. Each key corresponds to a specific attribute of the container number validation, allowing for easy parsing and integration into applications.

The endpoint provides information on the validity of the container number, including its owner code, equipment category, serial number, and check digit details. This information is crucial for logistics and shipping operations to ensure compliance with ISO standards.

Users can customize their data requests by submitting different container numbers in the API call. Each request will validate the specified container number against the ISO 6346 standard, allowing for tailored validation based on user needs.

The data used for validation is based on the international ISO 6346 standard, which governs the structure and format of shipping container numbers. The API employs standardized algorithms to ensure accuracy and compliance with these conventions.

Typical use cases include verifying container numbers during shipping and logistics management, preventing errors in cargo tracking, and ensuring compliance with international shipping standards. This helps reduce delays and improve operational efficiency.

Users can utilize the returned data by integrating it into their logistics systems to automate container number validation. By checking the "isValid" field, users can quickly determine if a container number is legitimate and proceed accordingly, enhancing their operational workflows.

General FAQs

To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.

You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.

The free trial lasts for 7 days and allows you to make up to 50 API requests.

No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.

Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world's most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, refer to the 'X-Zyla-API-Calls-Monthly-Remaining' field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

You can monitor your API usage through the response headers included with every request:

x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.

The 'X-Zyla-RateLimit-Reset' header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.

Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.

Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it's important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

Please have a look at our Refund Policy: https://zylalabs.com/terms#refund


Related APIs