paccurate
Version:
Reduce fulfillment costs and wasted material by finding the optimal way to pack every shipment, in real time.
296 lines • 12.7 kB
TypeScript
import type { Body } from './types';
export declare class Paccurate {
private apiKey;
private apiUrl;
/**
* @param apiKey - Paccurate API key.
* @param apiUrl - Paccurate API endpoint.
*/
constructor(apiKey: string, apiUrl?: string);
/**
* Finds the optimal way to pack a shipment.
*
* @param body - Packing configuration.
* @param url - Paccurate API endpoint.
* @returns - Pack response.
*/
pack(body: Body, url?: string): Promise<{
boxes?: {
box?: {
name?: string | undefined;
refId?: number | undefined;
price?: number | undefined;
weightTare?: number | undefined;
weightMax?: number | undefined;
dimensions?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
outer?: {
dimensions?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
dimensionChange?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
} | undefined;
outerBasedCost?: boolean | undefined;
centerOfMass?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
reservedSpace?: number | undefined;
itemsPerBoxMax?: number | undefined;
itemSetsPerBoxMax?: number | undefined;
itemsInlineMax?: number[] | undefined;
rateTable?: {
carrier?: string | undefined;
service?: string | undefined;
zone?: string | undefined;
rates?: number[] | undefined;
weights?: number[] | undefined;
priceIncreaseRate?: number | undefined;
basePrice?: number | undefined;
dimFactor?: number | undefined;
} | undefined;
propertyConstraints?: {
key?: string | undefined;
max?: number | undefined;
aggregate?: string | undefined;
value?: number | undefined;
}[] | undefined;
id?: number | undefined;
subspace?: {
originInParent?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
parentBoxIndex?: number | undefined;
parentItemIndex?: number | undefined;
} | undefined;
boxType?: {
name?: string | undefined;
refId?: number | undefined;
price?: number | undefined;
weightTare?: number | undefined;
weightMax?: number | undefined;
dimensions?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
outer?: {
dimensions?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
dimensionChange?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
} | undefined;
outerBasedCost?: boolean | undefined;
centerOfMass?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
reservedSpace?: number | undefined;
itemsPerBoxMax?: number | undefined;
itemSetsPerBoxMax?: number | undefined;
itemsInlineMax?: number[] | undefined;
rateTable?: {
carrier?: string | undefined;
service?: string | undefined;
zone?: string | undefined;
rates?: number[] | undefined;
weights?: number[] | undefined;
priceIncreaseRate?: number | undefined;
basePrice?: number | undefined;
dimFactor?: number | undefined;
} | undefined;
propertyConstraints?: {
key?: string | undefined;
max?: number | undefined;
aggregate?: string | undefined;
value?: number | undefined;
}[] | undefined;
} | undefined;
items?: {
item?: {
refId?: number | undefined;
name?: string | undefined;
color?: string | undefined;
weight?: number | undefined;
sequence?: string | undefined;
dimensions?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
centerOfMass?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
virtual?: boolean | undefined;
properties?: {
[x: string]: {} | undefined;
} | undefined;
index?: number | undefined;
globalId?: number | undefined;
packedIndex?: number | undefined;
message?: string | undefined;
origin?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
deltaCost?: number | undefined;
uniqueId?: string | undefined;
groupPackParent?: string | undefined;
quantity?: number | undefined;
unitOfMeasure?: string | undefined;
dimensionSet?: {
dimensions?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
axisMultipliers?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
quantityDivisor?: number | undefined;
weight?: number | undefined;
unitOfMeasure?: string | undefined;
} | undefined;
} | undefined;
}[] | undefined;
volumeMax?: number | undefined;
volumeUsed?: number | undefined;
volumeNet?: number | undefined;
volumeRemaining?: number | undefined;
volumeReserved?: number | undefined;
volumeUtilization?: number | undefined;
weightUsed?: number | undefined;
weightNet?: number | undefined;
weightRemaining?: number | undefined;
weightUtilization?: number | undefined;
dimensionalWeight?: number | undefined;
dimensionalWeightUsed?: boolean | undefined;
lenItems?: number | undefined;
lenUnits?: number | undefined;
svg?: string | undefined;
centerOfMassString?: string | undefined;
depthOrder?: number[] | undefined;
depthOrderString?: string | undefined;
} | undefined;
}[] | undefined;
title?: string | undefined;
built?: string | undefined;
startedAt?: string | undefined;
version?: string | undefined;
lenBoxes?: number | undefined;
lenItems?: number | undefined;
lenUnits?: number | undefined;
lenLeftovers?: number | undefined;
totalCost?: number | undefined;
totalVolume?: number | undefined;
totalVolumeNet?: number | undefined;
totalVolumeUsed?: number | undefined;
totalVolumeUtilization?: number | undefined;
totalWeight?: number | undefined;
packTime?: number | undefined;
renderTime?: number | undefined;
totalTime?: number | undefined;
leftovers?: {
refId?: number | undefined;
name?: string | undefined;
color?: string | undefined;
weight?: number | undefined;
sequence?: string | undefined;
dimensions?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
centerOfMass?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
virtual?: boolean | undefined;
properties?: {
[x: string]: {} | undefined;
} | undefined;
index?: number | undefined;
globalId?: number | undefined;
packedIndex?: number | undefined;
message?: string | undefined;
origin?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
deltaCost?: number | undefined;
uniqueId?: string | undefined;
groupPackParent?: string | undefined;
quantity?: number | undefined;
unitOfMeasure?: string | undefined;
dimensionSet?: {
dimensions?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
axisMultipliers?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
quantityDivisor?: number | undefined;
weight?: number | undefined;
unitOfMeasure?: string | undefined;
} | undefined;
}[] | undefined;
itemSortUsed?: string | undefined;
itemSortReverseUsed?: boolean | undefined;
boxTypeChoiceGoalUsed?: string | undefined;
scripts?: string | undefined;
styles?: string | undefined;
svgs?: string[] | undefined;
orderId?: string | undefined;
requestId?: string | undefined;
imageScale?: {
x?: number | undefined;
y?: number | undefined;
z?: number | undefined;
} | undefined;
imageScaleStyleUsed?: "fill" | "largest-box" | "largest-box-type" | "override" | undefined;
images?: {
boxIndex?: number | undefined;
format?: "svg" | "png" | undefined;
data?: string | undefined;
}[] | undefined;
usedKeyStem?: string | undefined;
warnings?: string[] | undefined;
requestFingerprint?: string | undefined;
responseFingerprint?: string | undefined;
packUuid?: string | undefined;
properties?: {
[x: string]: {} | undefined;
} | undefined;
}>;
}
//# sourceMappingURL=Paccurate.d.ts.map