Least Cost Fulfillment
POST
/
lcf

For a shipment, find the lowest cost and fasest shipping option based on provided parameters.

Request
This endpoint expects an object.
orderId
string

A unique identifier for the shipment. This is used for future reference and must be unique.

shipTo
object

The address the shipment is being shipped to.

Show 7 properties
deliveryCommitment
optional integer

The time-in-transit limit for a shipment. If no limit, set as null or don't set at all.

package
optional object

The dimensions and weight of the package being shipped. Add this object if you do not want String to find a package size for you.

Show 2 properties
items
optional set of objects

The items included in the order you're shipping. Add this array to the order object if you want to find the smallest package based on items you're shipping.

Show 4 properties
Response
This endpoint returns an object.
orderId
string
shipTo
object
Show 7 properties
tags
set of strings

Returns 'LEAST COST FULFILLMENT' if the shipment is the least cost fulfillment option. Returns 'NEEDS MANUAL PROCESSING' if String failed to find a shipping configuration.

comments
set of strings

An array of comments with detailed information about the prediction String just made. First comment includes the carrier, service code, account, cost, and package

service
object
Show 7 properties
parcel
object
Show 3 properties
Pack Order
POST
/
pack

Find the smallest package(s) all items in an order can fit into.

Request
This endpoint expects an object.
orderId
string

A unique identifier for the shipment. This is used for future reference and must be unique.

items
set of objects

The items included in the order you want String to pack.

Show 4 properties
Response
This endpoint returns an object.
id
string

The unique identifier you specified for the request.

packages
set of objects

An array of packages that can fit all items in the order. Right now, String will only return one package. In the future, String will return multiple packages if the order requires it.

Show 3 properties
Packing