/

1 min

POST

a pure-JSON endpoint for packing requests.

bodyobjectcomplete set of items, boxes, and parameters to pack.

200Successful pack.

400Bad request. Malformed or some other problem occurred processing the request.

422Invalid input. The request was well-formed, but the parameters were contradictory, invalid, or otherwise somehow unable to be processed. More information will be contained in the error details.

429Rate limited. Without an API key, only 10 unique requests are allowed per day for testing or demonstration purposes. Note that a randomized pack repeated is only a single unique request.

500Unexpected error.

curl --request POST \
     --url // \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "corners": true,
     "itemSets": {
     "weight": "",
     "dimensions": {},
     "centerOfMass": {}
     },
     "boxTypes": {
     "weightMax": "",
     "dimensions": {},
     "centerOfMass": {},
     "rateTable": {},
     "propertyConstraints": [
     {
     "aggregate": "sum"
     }
     ]
     },
     "boxTypeGenerators": [
     {
     "boxTypeDefaults": {
     "weightMax": "",
     "dimensions": {},
     "centerOfMass": {},
     "rateTable": {},
     "propertyConstraints": [
     {
     "aggregate": "sum"
     }
     ]
     },
     "options": {
     "xList": {},
     "xRange": {},
     "yList": {},
     "yRange": {},
     "zList": {},
     "zRange": {},
     "priceComponents": [
     {
     "aggregator": "max"
     }
     ]
     }
     }
     ],
     "boxTypeDefaults": {
     "weightMax": "",
     "dimensions": {},
     "centerOfMass": {},
     "rateTable": {},
     "propertyConstraints": [
     {
     "aggregate": "sum"
     }
     ]
     },
     "boxes": {
     "weightMax": "",
     "dimensions": {},
     "centerOfMass": {},
     "rateTable": {},
     "propertyConstraints": [
     {
     "aggregate": "sum"
     }
     ],
     "boxType": {}
     },
     "eye": {},
     "packOrigin": {},
     "rules": [
     {
     "itemMatch": {},
     "targetItemMatch": {},
     "targetBoxMatch": {},
     "operation": ""
     }
     ],
     "seed": true,
     "includeImages": true,
     "imageFormat": "svg",
     "imageScale": {},
     "imageScaleStyle": "fill",
     "placementStyle": "default",
     "itemSort": "combined",
     "itemInitialOrientationPreferred": true,
     "boxTypeChoiceStyle": "actual",
     "boxTypeChoiceGoal": "lowest-cost",
     "valueTiebreaker": "volume"
     }'