/
1 min
POST
//
Body Parameters
- bodyPackDescription
- requestIdstringDescription
- orderIdstringDescription
- layFlatbooleanDescriptionDefaultfalse
- interlockbooleanDescriptionDefaultfalse
- cornersbooleanDescriptionDefaulttrue
- itemSetsItemSet[]Description
- ItemProperties
- refIdintegerDescription
- namestringDescription
- colorstringDescription
- weightnumberrequiredDescription
- sequencestringDescription
- dimensionsobjectrequired
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- centerOfMassobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- virtualbooleanDescriptionDefaultfalse
- propertiesmap<string, string>Example
{ "included-ice-lbs": 0.5, "restricted-qty": 0.1, "item-line-id": "1234-59581ABC-CAFE1909", "wms-fields": { "InternalItemID": 1398401, "SKU": 49831, "Location": "40-8012", "Kit": false, "OtherGenericProperties": "will be passed through and returned on the item." } }Description
- object
- quantityintegerDescription
- dimensionSetsDimensionSet[]Description
- dimensionsobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- axisMultipliersobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- quantityDivisorintegerDescription
- weightnumberDescription
- unitOfMeasurestringDescription
- boxTypesBoxType[]Description
- BoxProperties
- namestringDescription
- refIdintegerDescription
- priceintegerDescription
- weightTarenumberDescription
- weightMaxnumberrequiredDescription
- dimensionsobjectrequired
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- outerobjectDescription
- dimensionsobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- dimensionChangeobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- outerBasedCostbooleanDescriptionDefaultfalse
- centerOfMassobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- reservedSpacenumberExampleDescription
- itemsPerBoxMaxintegerDescription
- itemSetsPerBoxMaxintegerDescription
- itemsInlineMaxinteger[]Example
[ 1, 2, 1 ]
Description - rateTableobject
- RateTable
- carrierstringDescription
- servicestringDescription
- zonestringDescription
- ratesnumber[]Description
- weightsnumber[]Description
- priceIncreaseRatenumberDescription
- basePricenumberDescription
- dimFactornumberDescription
- propertyConstraintsobject[]Description
- keystringDescription
- maxnumberDescription
- aggregatestringDescriptionDefaultsum
- valuenumberDescription
- boxTypeGeneratorsBoxTypeGenerator[]Description
- boxTypeDefaultsobject
- BoxProperties
- namestringDescription
- refIdintegerDescription
- priceintegerDescription
- weightTarenumberDescription
- weightMaxnumberrequiredDescription
- dimensionsobjectrequired
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- outerobjectDescription
- dimensionsobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- dimensionChangeobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- outerBasedCostbooleanDescriptionDefaultfalse
- centerOfMassobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- reservedSpacenumberExampleDescription
- itemsPerBoxMaxintegerDescription
- itemSetsPerBoxMaxintegerDescription
- itemsInlineMaxinteger[]Example
[ 1, 2, 1 ]
Description - rateTableobject
- RateTable
- carrierstringDescription
- servicestringDescription
- zonestringDescription
- ratesnumber[]Description
- weightsnumber[]Description
- priceIncreaseRatenumberDescription
- basePricenumberDescription
- dimFactornumberDescription
- propertyConstraintsobject[]Description
- keystringDescription
- maxnumberDescription
- aggregatestringDescriptionDefaultsum
- valuenumberDescription
- operationstring<cartesian | pack-as-is>Description
- optionsobject
- xListobject
- GeneratorAxisList
- xRangeobject
- GeneratorAxisRange
- minnumberDescription
- maxnumberDescription
- deriveFromItemsbooleanDescriptionDefaultfalse
- fitForFirstItembooleanDescriptionDefaultfalse
- incrementnumberDescription
- yListobject
- GeneratorAxisList
- yRangeobject
- GeneratorAxisRange
- minnumberDescription
- maxnumberDescription
- deriveFromItemsbooleanDescriptionDefaultfalse
- fitForFirstItembooleanDescriptionDefaultfalse
- incrementnumberDescription
- zListobject
- GeneratorAxisList
- zRangeobject
- GeneratorAxisRange
- minnumberDescription
- maxnumberDescription
- deriveFromItemsbooleanDescriptionDefaultfalse
- fitForFirstItembooleanDescriptionDefaultfalse
- incrementnumberDescription
- limitsGeneratorLimit[]Description
- metricMetricDescription
- minnumberDescription
- maxnumberDescription
- priceComponentsGeneratorPriceComponent[]Description
- keystringDescription
- metricMetricDescription
- aggregatorstring<max | product | sum>DescriptionDefaultmax
- thresholdsnumber[]Description
- pricesinteger[]Description
- noTrimToMaxExtentbooleanDescription
- boxTypeDefaultsobject
- BoxProperties
- namestringDescription
- refIdintegerDescription
- priceintegerDescription
- weightTarenumberDescription
- weightMaxnumberrequiredDescription
- dimensionsobjectrequired
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- outerobjectDescription
- dimensionsobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- dimensionChangeobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- outerBasedCostbooleanDescriptionDefaultfalse
- centerOfMassobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- reservedSpacenumberExampleDescription
- itemsPerBoxMaxintegerDescription
- itemSetsPerBoxMaxintegerDescription
- itemsInlineMaxinteger[]Example
[ 1, 2, 1 ]
Description - rateTableobject
- RateTable
- carrierstringDescription
- servicestringDescription
- zonestringDescription
- ratesnumber[]Description
- weightsnumber[]Description
- priceIncreaseRatenumberDescription
- basePricenumberDescription
- dimFactornumberDescription
- propertyConstraintsobject[]Description
- keystringDescription
- maxnumberDescription
- aggregatestringDescriptionDefaultsum
- valuenumberDescription
- boxesBox[]Description
- BoxProperties
- namestringDescription
- refIdintegerDescription
- priceintegerDescription
- weightTarenumberDescription
- weightMaxnumberrequiredDescription
- dimensionsobjectrequired
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- outerobjectDescription
- dimensionsobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- dimensionChangeobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- outerBasedCostbooleanDescriptionDefaultfalse
- centerOfMassobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- reservedSpacenumberExampleDescription
- itemsPerBoxMaxintegerDescription
- itemSetsPerBoxMaxintegerDescription
- itemsInlineMaxinteger[]Example
[ 1, 2, 1 ]
Description - rateTableobject
- RateTable
- carrierstringDescription
- servicestringDescription
- zonestringDescription
- ratesnumber[]Description
- weightsnumber[]Description
- priceIncreaseRatenumberDescription
- basePricenumberDescription
- dimFactornumberDescription
- propertyConstraintsobject[]Description
- keystringDescription
- maxnumberDescription
- aggregatestringDescriptionDefaultsum
- valuenumberDescription
- object
- idinteger
- subspaceSubspace
- originInParentobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- parentBoxIndexintegerDescription
- parentItemIndexintegerDescription
- boxTypeBoxTypeDescription
- BoxProperties
- Circular-Reference
- itemsobject[]
- itemItemDescription
- ItemProperties
- refIdintegerDescription
- namestringDescription
- colorstringDescription
- weightnumberrequiredDescription
- sequencestringDescription
- dimensionsobjectrequired
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- centerOfMassobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- virtualbooleanDescriptionDefaultfalse
- propertiesmap<string, string>Example
{ "included-ice-lbs": 0.5, "restricted-qty": 0.1, "item-line-id": "1234-59581ABC-CAFE1909", "wms-fields": { "InternalItemID": 1398401, "SKU": 49831, "Location": "40-8012", "Kit": false, "OtherGenericProperties": "will be passed through and returned on the item." } }Description
- object
- indexintegerDescription
- globalIdintegerDescription
- packedIndexintegerDescription
- messagestringDescription
- originobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- deltaCostintegerDescription
- uniqueIdstringDescription
- groupPackParentstringDescription
- quantityintegerDescription
- unitOfMeasurestringDescription
- dimensionSetobject
- DimensionSet
- dimensionsobject
- Point
- Max depth limit reached
- axisMultipliersobject
- Point
- Max depth limit reached
- quantityDivisorintegerDescription
- weightnumberDescription
- unitOfMeasurestringDescription
- volumeMaxnumberDescription
- volumeUsednumberDescription
- volumeNetnumberDescription
- volumeRemainingnumberDescription
- volumeReservednumberDescription
- volumeUtilizationnumberDescription
- weightUsednumberDescription
- weightNetnumberDescription
- weightRemainingnumberDescription
- weightUtilizationnumberDescription
- dimensionalWeightnumberDescription
- dimensionalWeightUsedbooleanDescription
- lenItemsintegerDescription
- lenUnitsintegerDescription
- svgstringDescription
- centerOfMassStringstringDescription
- depthOrderinteger[]Description
- depthOrderStringstringDescription
- usableSpacenumberExampleDescription
- reservedSpacenumberExampleDescription
- boxTypeSetsBoxTypeSet[]Description
- eyeobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- packOriginobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- rulesRule[]Description
- itemRefIdintegerDescription
- itemSequencestringDescription
- itemMatchobject
- ItemMatch
- allbooleanDescription
- propertystring<sequence | name>Description
- expressionstringDescription
- expressionsstring[]Description
- negatebooleanDescriptionDefaultfalse
- targetItemRefIdsinteger[]Description
- targetItemSequencesstring[]Description
- targetItemMatchobject
- ItemMatch
- allbooleanDescription
- propertystring<sequence | name>Description
- expressionstringDescription
- expressionsstring[]Description
- negatebooleanDescriptionDefaultfalse
- targetBoxMatchobject
- BoxMatch
- propertystring<name>Description
- expressionstringDescription
- expressionsstring[]Description
- negatebooleanDescriptionDefaultfalse
- targetBoxRefIdsinteger[]Description
- ignoreSubspacesbooleanDescription
- operationstring<exclude | exclude-all | pack-as-is | irregular | lock-orientation | internal-space | alternate-dimensions | fragile | set-properties | group-pack | pack-sequence | bounded-fill>requiredDescription
- optionsobjectDescription
- parametersstring[]Description
- randombooleanDescriptionDefaultfalse
- nintegerDescription
- randomMaxDimensionintegerDescription
- randomMaxWeightintegerDescription
- randomMaxQuantityintegerDescription
- seedbooleanDescriptionDefaulttrue
- seedValueintegerDescription
- seedFromOrderIdbooleanDescription
- imgSizeintegerDescription
- templatestring<demo.tmpl | shipapp.tmpl | boat.tmpl | classic>Description
- includeScriptsbooleanDescriptionDefaultfalse
- includeImagesbooleanExampleDescriptionDefaulttrue
- imageFormatstring<svg | png>DescriptionDefaultsvg
- imageScaleobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- imageScaleStylestring<fill | largest-box | largest-box-type>DescriptionDefaultfill
- coordOrderinteger[]Example
[ 0, 1, 2 ]
Description - cohortPackingbooleanDescriptionDefaultfalse
- cohortMaxintegerDescription
- allowableOverhangnumberDescription
- placementStylestring<default | corner | wedge | mound | orb>DescriptionDefaultdefault
- itemSortstring<default | largest-box-needed | largest-girth | largest-length-plus-girth | longest-dimension | shortest-dimension | largest-cross-section | set-volume | density | weight | combined | all>DescriptionDefaultcombined
- itemSortReversebooleanDescriptionDefaultfalse
- itemSortDualDirectionbooleanDescriptionDefaultfalse
- itemInitialOrientationBestForBoxbooleanDescriptionDefaultfalse
- itemInitialOrientationPreferredbooleanDescriptionDefaulttrue
- itemOrientationSearchDepthintegerDescription
- sequenceSortbooleanDescriptionDefaultfalse
- sequenceHeatMapbooleanDescriptionDefaultfalse
- maxSequenceDistanceintegerDescription
- boxTypeChoiceStylestring<actual | estimated>DescriptionDefaultactual
- boxTypeChoiceLookaheadintegerDescription
- boxTypeChoiceLookbackintegerDescription
- boxTypeChoiceGoalstring<lowest-cost | most-items>DescriptionDefaultlowest-cost
- boxesMaxintegerDescription
- boxesPerItemSetMaxintegerDescription
- boxesPerSequenceMaxintegerDescription
- itemsPerBoxMaxintegerDescription
- itemSetsPerBoxMaxintegerDescription
- itemsInlineMaxinteger[]Example
[ 1, 2, 1 ]
Description - generatedBoxTypesMaxintegerExampleDescription
- valueTiebreakerstring<volume | weight>DescriptionDefaultvolume
- timeoutnumberExampleDescription
Responses
200
- object
- boxesobject[]Description
- boxBoxDescription
- BoxProperties
- namestringDescription
- refIdintegerDescription
- priceintegerDescription
- weightTarenumberDescription
- weightMaxnumberrequiredDescription
- dimensionsobjectrequired
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- outerobjectDescription
- dimensionsobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- dimensionChangeobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- outerBasedCostbooleanDescriptionDefaultfalse
- centerOfMassobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- reservedSpacenumberExampleDescription
- itemsPerBoxMaxintegerDescription
- itemSetsPerBoxMaxintegerDescription
- itemsInlineMaxinteger[]Example
[ 1, 2, 1 ]
Description - rateTableobject
- RateTable
- carrierstringDescription
- servicestringDescription
- zonestringDescription
- ratesnumber[]Description
- weightsnumber[]Description
- priceIncreaseRatenumberDescription
- basePricenumberDescription
- dimFactornumberDescription
- propertyConstraintsobject[]Description
- keystringDescription
- maxnumberDescription
- aggregatestringDescriptionDefaultsum
- valuenumberDescription
- object
- idinteger
- subspaceSubspace
- originInParentobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- parentBoxIndexintegerDescription
- parentItemIndexintegerDescription
- boxTypeBoxTypeDescription
- BoxProperties
- Circular-Reference
- itemsobject[]
- itemItemDescription
- ItemProperties
- refIdintegerDescription
- namestringDescription
- colorstringDescription
- weightnumberrequiredDescription
- sequencestringDescription
- dimensionsobjectrequired
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- centerOfMassobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- virtualbooleanDescriptionDefaultfalse
- propertiesmap<string, string>Example
{ "included-ice-lbs": 0.5, "restricted-qty": 0.1, "item-line-id": "1234-59581ABC-CAFE1909", "wms-fields": { "InternalItemID": 1398401, "SKU": 49831, "Location": "40-8012", "Kit": false, "OtherGenericProperties": "will be passed through and returned on the item." } }Description
- object
- indexintegerDescription
- globalIdintegerDescription
- packedIndexintegerDescription
- messagestringDescription
- originobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- deltaCostintegerDescription
- uniqueIdstringDescription
- groupPackParentstringDescription
- quantityintegerDescription
- unitOfMeasurestringDescription
- dimensionSetobject
- DimensionSet
- dimensionsobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- axisMultipliersobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- quantityDivisorintegerDescription
- weightnumberDescription
- unitOfMeasurestringDescription
- volumeMaxnumberDescription
- volumeUsednumberDescription
- volumeNetnumberDescription
- volumeRemainingnumberDescription
- volumeReservednumberDescription
- volumeUtilizationnumberDescription
- weightUsednumberDescription
- weightNetnumberDescription
- weightRemainingnumberDescription
- weightUtilizationnumberDescription
- dimensionalWeightnumberDescription
- dimensionalWeightUsedbooleanDescription
- lenItemsintegerDescription
- lenUnitsintegerDescription
- svgstringDescription
- centerOfMassStringstringDescription
- depthOrderinteger[]Description
- depthOrderStringstringDescription
- titlestringDescription
- builtstringDescription
- startedAtstringDescription
- versionstringDescription
- lenBoxesintegerDescription
- lenItemsintegerDescription
- lenUnitsintegerDescription
- lenLeftoversintegerDescription
- totalCostintegerDescription
- totalVolumenumberDescription
- totalVolumeNetnumberDescription
- totalVolumeUsednumberDescription
- totalVolumeUtilizationnumberDescription
- totalWeightnumberDescription
- packTimenumberDescription
- renderTimenumberDescription
- totalTimenumberDescription
- leftoversItem[]Description
- ItemProperties
- refIdintegerDescription
- namestringDescription
- colorstringDescription
- weightnumberrequiredDescription
- sequencestringDescription
- dimensionsobjectrequired
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- centerOfMassobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- virtualbooleanDescriptionDefaultfalse
- propertiesmap<string, string>Example
{ "included-ice-lbs": 0.5, "restricted-qty": 0.1, "item-line-id": "1234-59581ABC-CAFE1909", "wms-fields": { "InternalItemID": 1398401, "SKU": 49831, "Location": "40-8012", "Kit": false, "OtherGenericProperties": "will be passed through and returned on the item." } }Description
- object
- indexintegerDescription
- globalIdintegerDescription
- packedIndexintegerDescription
- messagestringDescription
- originobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- deltaCostintegerDescription
- uniqueIdstringDescription
- groupPackParentstringDescription
- quantityintegerDescription
- unitOfMeasurestringDescription
- dimensionSetobject
- DimensionSet
- dimensionsobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- axisMultipliersobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- quantityDivisorintegerDescription
- weightnumberDescription
- unitOfMeasurestringDescription
- itemSortUsedstringDescription
- itemSortReverseUsedbooleanDescription
- boxTypeChoiceGoalUsedstringDescription
- scriptsstringDescription
- stylesstringDescription
- svgsstring[]Description
- orderIdstringDescription
- requestIdstringDescription
- imageScaleobject
- Point
- xnumberDescription
- ynumberDescription
- znumberDescription
- imageScaleStyleUsedstring<fill | largest-box | largest-box-type | override>DescriptionDefaultfill
- imagesImage[]Description
- boxIndexintegerDescription
- formatstring<svg | png>Description
- datastringDescription
- usedKeyStemstringDescription
- warningsstring[]Description
- requestFingerprintstringDescription
- responseFingerprintstringDescription
- packUuidstringDescription
400
- Error
- messagestringrequired
- detailsstring
- codeintegerrequired
422
- Error
- messagestringrequired
- detailsstring
- codeintegerrequired
429
- Error
- messagestringrequired
- detailsstring
- codeintegerrequired
500
- Error
- messagestringrequired
- detailsstring
- codeintegerrequired
curl
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"
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"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"
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("//", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("//")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"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"
})
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "//"
payload = json.dumps({
"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"
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Successful pack.
{
"boxes": [
{
"box": {}
}
],
"title": "",
"built": "",
"startedAt": "",
"version": "",
"lenBoxes": 0,
"lenItems": 0,
"lenUnits": 0,
"lenLeftovers": 0,
"totalCost": 0,
"totalVolume": 0,
"totalVolumeNet": 0,
"totalVolumeUsed": 0,
"totalVolumeUtilization": 0,
"totalWeight": 0,
"packTime": 0,
"renderTime": 0,
"totalTime": 0,
"leftovers": {},
"itemSortUsed": "",
"itemSortReverseUsed": false,
"boxTypeChoiceGoalUsed": "",
"scripts": "",
"styles": "",
"svgs": [
""
],
"orderId": "",
"requestId": "",
"imageScale": {},
"imageScaleStyleUsed": "",
"images": [
{
"boxIndex": 0,
"format": "",
"data": ""
}
],
"usedKeyStem": "",
"warnings": [
""
],
"requestFingerprint": "",
"responseFingerprint": "",
"packUuid": ""
}400
// Bad request. Malformed or some other problem occurred processing the request.
{
"message": "",
"details": "",
"code": 0
}422
// Invalid 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.
{
"message": "",
"details": "",
"code": 0
}429
// Rate 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.
{
"message": "",
"details": "",
"code": 0
}500
// Unexpected error.
{
"message": "",
"details": "",
"code": 0
}