Shipment

Main shipment object containing all necessary data to create a shipment. Either parcel or parcels must be provided, but not both.

  • reference
    Type: string | null

    An optional field that may be used in place of id in other API endpoints

  • from_address
    Type:
    required

    Can be specified by ID or attributes to create a new one, and be verified inline. See Create an Address

    Properties: 11
  • to_address
    Type:
    required

    Can be specified by ID or attributes to create a new one, and be verified inline. See Create an Address

    Properties: 11
  • return_address
    Type: nullable

    The shipper's address, defaults to from_address

    Properties: 11
  • buyer_address
    Type: nullable

    The buyer's address, defaults to to_address

    Properties: 11
  • parcel
    Type: nullable

    The dimensions and weight of the package. Business rule: parcel and parcels MUST NOT both be present.

    Properties: 7
  • parcels
    Type:

    Array of parcels. Business rule: parcel and parcels MUST NOT both be present.

    Properties: 7
  • customs_info
    Type: nullable

    Information for processing the package through international customs

    Properties: 10
  • options
    Type: nullable

    Additional shipment options. If carrier_accounts and service are set and options.create_and_buy is not explicitly false, it is treated as true.

    Properties: 35
  • is_return
    Type: boolean | null

    Set true to create as a return shipment

  • carrier
    Type: string | null

    Carrier to use for the shipment. If omitted along with carrier_accounts, all carriers are considered

  • carrier_accounts
    Type: array of string | null

    List of CarrierAccount IDs

  • service
    Type: string | null

    Requested service level (e.g., Priority, Express, GroundAdvantage)

Previous
Rate