Parcels

Create a parcel

Create a new parcel.

post/v1/parcels

Request

Base URL
https://karrio.io (the document declares no server; this is the origin it was published from)
Auth
- HTTP basic
- or API key in header Authorization
- or OAuth 2
  Authorization code/oauth/authorize/
  Token URL/oauth/token/
- or API key in header Authorization
TypeScript
https://skmtc.dev/karrio/apis/karrio-api/docs/v1/parcels/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

weightnumber double required

The parcel's weight

widthnumber double nullable

The parcel's width

heightnumber double nullable

The parcel's height

lengthnumber double nullable

The parcel's length

packaging_typestring nullable

The parcel's packaging type. Note that the packaging is optional when using a package preset. values: envelope pak tube pallet small_box medium_box your_packaging For carrier specific packaging types, please consult the reference.

package_presetstring nullable

The parcel's package preset. For carrier specific package presets, please consult the reference.

descriptionstring nullable

The parcel's description

contentstring nullable

The parcel's content description

is_documentboolean nullable

Indicates if the parcel is composed of documents only

weight_unit'KG' | 'LB' | 'OZ' | 'G' required

The parcel's weight unit

dimension_unit'CM' | 'IN' | 'null' nullable

The parcel's dimension unit

reference_numberstring nullable

The parcel reference number. (can be used as tracking number for custom carriers)

freight_classstring nullable

The parcel's freight class for pallet and freight shipments.

optionsobject

<details> <summary>Parcel specific options.</summary>

    {
        "insurance": "100.00",
        "insured_by": "carrier",
    }
    </details>

Response

idstring

A unique identifier