📖API List
- pack_packages: Optimize Packing into bins for shipping, storage and transport.
🌍Endpoints
Currently, we provide these Endpoints, and RapidAPI will automatically select the nearest Endpoint based on the region.
1. US East(Virginia, USA)
2. Europe(London, UK)
3. Southeast Asia(Singapore)
4. Asia(Hangzhou, China)
⚙️Pack Packages
Optimize Packing into bins for shipping, storage and transport.
Good for Warehousing and Logistics.
Core Features
1. Fast and accurate result
2. Support multi-objective optimization which provides greater flexibility and is more aligned with business needs.
3. For third parties/fourth parties who are unaware of the Bin costs, the optimization target supports optimizing the surface area of packaging materials. Assuming that the material and specifications are not considered, the cost of BIn is linearly related to the surface area.
4. Support custom orientation of items. For example, fragile items can be placed upright, and heavy items can be placed flat. This can prevent damage caused by gravitational shift or compression during transportation.
5. Support the grouping of goods. For example, chemicals and food should not be packed in the same box, and this also facilitates the classification and management of goods.
6. Support independent packaging. Certain items, such as high-value goods, should be packaged independently to prevent damage caused by friction with other items during transportation.
7. Support both final and step-by-step packing guidance. Algorithm provides the order of goods placement and coordinate data, which facilitates data visualization to guide the packing process.
8. Provide detailed data for each package to facilitate verification and reduce the workload of later data processing and subsequent algorithm integration. For example, the volume utilization rate and weight of the package.
9. supports weight capacity to prevent recommending excessively heavy goods for the lightweight plastic packaging bags in the Bin
🚀Application Scenarios
Box Recommend
During warehouse packing operations, the system automatically recommends the most cost-effective packaging materials that can accommodate all items based on product dimensions, weight, orientation, and other factors.
1. Improves packing efficiency by eliminating guesswork: With dozens of packaging options at the packing station, selecting the optimal one can be overwhelming and time-consuming. (save 100% thinking(guesswork) time)
2. Reduces packaging costs by preventing oversized boxes: Relying on experience alone often leads to using excessively large packaging for small items—a common source of material waste in warehouse operations. (save 5%-17% bin costs)
Order Splitting
When an outbound order contains too many items to fit into any single packaging material, it must be split into multiple packages.
1. Precise order splitting cuts labor costs and eliminates the issue of items not fitting even after manual splitting. (save 100% manual work)
2. Automated packaging recommendations boost efficiency and save on packaging costs. (save 5%-17% bin costs)
Optimize Packing into bins for shipping, storage and transport.
Good for Warehousing and Logistics.
1. Fast and accurate result
2. Support multi-objective optimization which provides greater flexibility and is more aligned with business needs.
3. For third parties/fourth parties who are unaware of the Bin costs, the optimization target supports optimizing the surface area of packaging materials. Assuming that the material and specifications are not considered, the cost of BIn is linearly related to the surface area.
4. Support custom orientation of items. For example, fragile items can be placed upright, and heavy items can be placed flat. This can prevent damage caused by gravitational shift or compression during transportation.
5. Support the grouping of goods. For example, chemicals and food should not be packed in the same box, and this also facilitates the classification and management of goods.
6. Support independent packaging. Certain items, such as high-value goods, should be packaged independently to prevent damage caused by friction with other items during transportation.
7. Support both final and step-by-step packing guidance. Algorithm provides the order of goods placement and coordinate data, which facilitates data visualization to guide the packing process.
8. Provide detailed data for each package to facilitate verification and reduce the workload of later data processing and subsequent algorithm integration. For example, the volume utilization rate and weight of the package.
9. supports weight capacity to prevent recommending excessively heavy goods for the lightweight plastic packaging bags in the Bin
When an outbound order contains too many items to fit into any single packaging material, it must be split into multiple packages.
1. Precise order splitting cuts labor costs and eliminates the issue of items not fitting even after manual splitting. (save 100% manual work)
2. Automated packaging recommendations boost efficiency and save on packaging costs. (save 5%-17% bin costs)
Pack Packages - Endpoint Features
| Object | Description |
|---|---|
Request Body |
[Required] Json |
{"code":"SUCCESS","msg":null,"result":{"package_list":[{"bin":{"bin_code":"SMALL_SIZE_BIN","bin_length":10.0,"bin_width":10.0,"bin_height":10.0,"bin_weight":0.5,"bin_weight_capacity":10.0,"bin_cost":0.3,"bin_surface":600.0,"bin_volume":1000.0},"item_list":[{"item_code":"SNEAK","item_length":5.0,"item_width":5.0,"item_height":10.0,"item_num":1,"item_weight":0.5,"item_acceptable_orientation":["width_vertical","height_vertical","length_vertical"],"item_group":"default","item_individual_packing":0,"item_coordinate":{"x_start":0.0,"y_start":0.0,"z_start":0.0,"x_end":5.0,"y_end":5.0,"z_end":10.0},"item_volume":250.0}],"package_volume":1000.0,"item_volume":250.0,"unused_volume":750.0,"package_volume_fill_ratio":25.0,"item_weight":0.5,"bin_weight":0.5,"package_weight":1.0,"package_weight_use_ratio":5.0},{"bin":{"bin_code":"LARGE_SIZE_BIN","bin_length":10.0,"bin_width":30.0,"bin_height":10.0,"bin_weight":0.5,"bin_weight_capacity":15.0,"bin_cost":0.7,"bin_surface":1400.0,"bin_volume":3000.0},"item_list":[{"item_code":"CHEMICAL_ITEM","item_length":10.0,"item_width":10.0,"item_height":10.0,"item_num":1,"item_weight":1.0,"item_acceptable_orientation":["width_vertical","height_vertical","length_vertical"],"item_group":"CHEMICALS","item_individual_packing":0,"item_coordinate":{"x_start":0.0,"y_start":0.0,"z_start":0.0,"x_end":10.0,"y_end":10.0,"z_end":10.0},"item_volume":1000.0},{"item_code":"CHEMICAL_ITEM","item_length":10.0,"item_width":10.0,"item_height":10.0,"item_num":1,"item_weight":1.0,"item_acceptable_orientation":["width_vertical","height_vertical","length_vertical"],"item_group":"CHEMICALS","item_individual_packing":0,"item_coordinate":{"x_start":10.0,"y_start":0.0,"z_start":0.0,"x_end":20.0,"y_end":10.0,"z_end":10.0},"item_volume":1000.0},{"item_code":"CHEMICAL_ITEM","item_length":10.0,"item_width":10.0,"item_height":10.0,"item_num":1,"item_weight":1.0,"item_acceptable_orientation":["width_vertical","height_vertical","length_vertical"],"item_group":"CHEMICALS","item_individual_packing":0,"item_coordinate":{"x_start":20.0,"y_start":0.0,"z_start":0.0,"x_end":30.0,"y_end":10.0,"z_end":10.0},"item_volume":1000.0}],"package_volume":3000.0,"item_volume":3000.0,"unused_volume":0.0,"package_volume_fill_ratio":100.0,"item_weight":3.0,"bin_weight":0.5,"package_weight":3.5,"package_weight_use_ratio":20.0}],"non_packed_item_list":[{"item_code":"TOO_BIG_ITEM","item_length":1000.0,"item_width":1000.0,"item_height":1000.0,"item_num":2,"item_weight":100.0,"item_acceptable_orientation":["width_vertical","height_vertical","length_vertical"],"item_group":"default","item_individual_packing":0,"item_coordinate":null,"item_volume":1000000000.0}]}}
curl --location --request POST 'https://zylalabs.com/api/11237/3d+bin+packer+api/21484/pack+packages' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"param": {
"objective_priority": [
"bin_num",
"bin_cost",
"fill_ratio"
]
},
"data": {
"item_list": [
{
"item_code": "SNEAK",
"item_width": 5,
"item_height": 10,
"item_length": 5,
"item_num": 1,
"item_weight": 0.5,
"item_acceptable_orientation": null,
"item_individual_packing": 0
},
{
"item_code": "CHEMICAL_ITEM",
"item_width": 10,
"item_height": 10,
"item_length": 10,
"item_num": 3,
"item_weight": 1,
"item_group": "CHEMICALS",
"item_acceptable_orientation": null,
"item_individual_packing": 0
},
{
"item_code": "TOO_BIG_ITEM",
"item_width": 1000,
"item_height": 1000,
"item_length": 1000,
"item_num": 2,
"item_weight": 100
}
],
"bin_list": [
{
"bin_code": "SMALL_SIZE_BIN",
"bin_width": 10,
"bin_height": 10,
"bin_length": 10,
"bin_weight": 0.5,
"bin_weight_capacity": 10,
"bin_cost": 0.3
},
{
"bin_code": "MEDIUM_SIZE_BIN",
"bin_width": 20,
"bin_height": 10,
"bin_length": 10,
"bin_weight": 0.5,
"bin_weight_capacity": 12,
"bin_cost": 0.5
},
{
"bin_code": "LARGE_SIZE_BIN",
"bin_width": 30,
"bin_height": 10,
"bin_length": 10,
"bin_weight": 0.5,
"bin_weight_capacity": 15,
"bin_cost": 0.7
}
]
}
}'
| Header | Description |
|---|---|
Authorization
|
[Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed. |
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
The Pack Packages endpoint returns a JSON response containing a list of optimized packaging solutions, including details about the bins and items. Each package includes information such as bin dimensions, weight capacity, item coordinates, and acceptable orientations.
Key fields in the response include `bin_code`, `bin_dimensions`, `item_code`, `item_weight`, `item_group`, and `item_coordinate`. These fields provide essential information for understanding how items are packed into bins.
The response data is structured in a JSON format with a top-level object containing a `package_list`. Each entry in this list details a bin and its corresponding items, allowing users to easily access packing configurations.
Users can customize their requests by specifying parameters such as item dimensions, weights, orientations, and grouping preferences. This allows for tailored packing solutions based on specific needs.
The endpoint provides information on bin specifications, item characteristics, packing orientations, and grouping rules. This comprehensive data helps optimize packing for various logistics scenarios.
Users can leverage the returned data to visualize packing arrangements, verify volume utilization, and ensure compliance with weight limits. This aids in efficient packing and reduces the risk of damage during transport.
Typical use cases include optimizing warehouse packing, automating order splitting, and recommending packaging materials. These applications enhance efficiency and reduce costs in logistics operations.
Data accuracy is maintained through algorithmic optimization and validation checks during the packing process. The API ensures that packing recommendations align with specified constraints and item characteristics.
The Pack Packages endpoint can handle a variety of items, including fragile goods, heavy items, and grouped products like chemicals and food. Users can specify item dimensions, weights, and acceptable orientations to optimize packing based on specific characteristics.
Users can define acceptable orientations for each item in their request. For example, fragile items can be set to be packed upright, while heavy items can be oriented flat to prevent damage during transport.
The API allows users to set grouping rules to prevent incompatible items from being packed together, such as keeping chemicals separate from food. This enhances safety and simplifies inventory management.
Users can specify that certain items, like high-value goods, should be packaged independently. This prevents damage from friction with other items during transport, ensuring the integrity of valuable products.
The API offers both final packing guidance and step-by-step instructions, including the order of item placement and coordinate data. This helps users visualize the packing process and implement it effectively.
The API provides detailed data for each package, including volume utilization rates and weights. Users can analyze this information to evaluate packing efficiency and make necessary adjustments.
If a packing request cannot be fulfilled due to constraints, the API may return partial results or indicate which items could not be packed. Users can then adjust their parameters or item selections accordingly.
The API optimizes packaging materials based on item dimensions, weights, and orientations, recommending the most cost-effective options. This minimizes waste and reduces overall packaging costs in logistics operations.
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.
To see the maximum number of API requests your plan allows, check the 'X-Zyla-RateLimit-Limit' response header. For instance, if your plan includes 1,000 requests per month, this header will display 1,000.
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 plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.
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]
To give you the opportunity to experience our APIs without any commitment, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost. This trial can be used only once, so we recommend applying it to the API that interests you the most. While most of our APIs offer a free trial, some may not. The trial concludes after 7 days or once you've made 50 requests, whichever occurs first. If you reach the 50 request limit during the trial, you will need to "Start Your Paid Plan" to continue making requests. You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab. Alternatively, if you don't cancel your subscription before the 7th day, your free trial will end, and your plan will automatically be billed, granting you access to all the API calls specified in your plan. Please keep this in mind to avoid unwanted charges.
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.
Payout Orders are processed between the 20th and the 30th of each month. If you submit your request before the 20th, your payment will be processed within this timeframe.
Service Level:
100%
Response Time:
13,343ms
Service Level:
100%
Response Time:
406ms
Service Level:
99%
Response Time:
2,360ms
Service Level:
100%
Response Time:
7,295ms
Service Level:
100%
Response Time:
730ms
Service Level:
99%
Response Time:
2,360ms
Service Level:
100%
Response Time:
406ms
Service Level:
99%
Response Time:
2,360ms
Service Level:
100%
Response Time:
406ms
Service Level:
100%
Response Time:
1,159ms
Service Level:
100%
Response Time:
6,083ms
Service Level:
100%
Response Time:
2,237ms
Service Level:
100%
Response Time:
707ms
Service Level:
100%
Response Time:
729ms
Service Level:
100%
Response Time:
1,956ms
Service Level:
100%
Response Time:
3,064ms
Service Level:
100%
Response Time:
716ms
Service Level:
100%
Response Time:
3,976ms
Service Level:
100%
Response Time:
4,017ms
Service Level:
100%
Response Time:
2,938ms