Parcel

The dimensions and weight of the package.

Rules (not enforced by JSON schema):

  • You may either: • Provide only id • OR omit id and provide weight (dimensions optional)
  • If any of length, width, or height is provided, all three must be provided.
  • height
    Type: number | null

    Height of the parcel (optional; must be sent with length + width if sent)

  • id
    Type: string | null

    Unique parcel identifier (required if weight is not provided)

  • items
    Type: array object[] | null · LineItem[]

    Line items inside the parcel

    Individual item contained within a parcel

    • description
      Type: string
      required

      Human-readable item description

    • quantity
      Type: integer
      required

      Number of items of this type in the parcel

    • code
      Type: string | null

      Internal or SKU code

    • currency
      Type: string | null

      Currency for declared values

    • external_id
      Type: string | null

      External identifier used by your system

    • hs_tariff_number
      Type: string | null

      Harmonized System tariff number for customs

    • origin_country
      Type: string | null

      Country of origin for customs

    • taxes
      Type: array object[] | null

      Taxes applied to the item

    • unit_value
      Type: number | null

      Declared value of a single item

    • unit_weight
      Type: number | null

      Weight of a single item

    • value
      Type: number | null

      Total declared value of the items

    • weight
      Type: number | null

      Total weight of all items of this type

  • length
    Type: number | null

    Length of the parcel (optional; must be sent with width + height if sent)

  • predefined_package
    Type: string | nullenum

    Carrier-specific predefined package type

    values
    • CARD
    • FEDEX10KGBOX
    • FEDEX25KGBOX
    • FEDEXENVELOPE
    • FEDEXEXTRALARGEBOX
  • weight
    Type: number | null

    Total package weight (required unless id is provided)

  • width
    Type: number | null

    Width of the parcel (optional; must be sent with length + height if sent)