API ReferenceHelp CenterAPI Status
API Reference
API ReferenceHelp CenterAPI Status
API Reference

Create Package

post
https://sandbox.api.deliverysolutions.co/api/v2/package

Use this API to define a package and its dimensions. A package is defined at a business level and it's name is unique to a business.

❗️

The name "custom" is reserved and cannot be used to name a package.

Response

PropertyTypeDescription
  • id
StringDelivery Solutions' unique ID for the package.
nameStringName of the Package
packageExternalIdStringIt's a unique id by which your system can identify the packages.
sizeObjectDimension of the package in inches
weightDoubleWeight of the package in pounds
Body Params
string
required

Name of the package. Name needs to be unique within a business. For eg. Small, Medium

string
required

The unique id of the package. This is usually the name maintained in your systems. We recommend providing this value always for easier traceability.

string

Description of the package.

size
object
required

Dimensions of the package (in inches, up to two decimal points)

double
required

Weight of the package in pounds (up to two decimal points)

Responses

Updated about 1 year ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago