Sign in
Shipments

Update a shipment

This operation allows for updating properties of a shipment including label_type, reference, payment, options and metadata. It is not for editing the parcels of a shipment.

put/v1/shipments/{id}

Path parameters

idstring required

Request body

label_type'PDF' | 'ZPL' | 'PNG'

The shipment label file type.

optionsobject
<details> <summary>The options available for the shipment.</summary> 
    {
        "currency": "USD",
        "insurance": 100.00,
        "cash_on_delivery": 30.00,
        "dangerous_good": true,
        "declared_value": 150.00,
        "sms_notification": true,
        "email_notification": true,
        "email_notification_to": "shipper@mail.com",
        "hold_at_location": true,
        "paperless_trade": true,
        "preferred_service": "fedex_express_saver",
        "shipment_date": "2020-01-01",  # TODO: deprecate
        "shipping_date": "2020-01-01T00:00",
        "shipment_note": "This is a shipment note",
        "signature_confirmation": true,
        "saturday_delivery": true,
        "is_return": true,
        "doc_files": [
            {
                "doc_type": "commercial_invoice",
                "doc_file": "base64 encoded file",
                "doc_name": "commercial_invoice.pdf",
                "doc_format": "pdf",
            }
        ],
        "doc_references": [
            {
                "doc_id": "123456789",
                "doc_type": "commercial_invoice",
            }
        ],
    }
    </details>
referencestring nullable

The shipment reference

metadataobject

User metadata for the shipment

Response

idstring

A unique identifier

object_typestring

Specifies the object type

tracking_urlstring uri nullable

The shipment tracking url

servicesstring[] nullable

The carriers services requested for the shipment.<br/> Please consult the reference for specific carriers services.<br/> Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier.

optionsobject
<details> <summary>The options available for the shipment.</summary> 
    {
        "currency": "USD",
        "insurance": 100.00,
        "cash_on_delivery": 30.00,
        "dangerous_good": true,
        "declared_value": 150.00,
        "sms_notification": true,
        "email_notification": true,
        "email_notification_to": "shipper@mail.com",
        "hold_at_location": true,
        "paperless_trade": true,
        "preferred_service": "fedex_express_saver",
        "shipment_date": "2020-01-01",  # TODO: deprecate
        "shipping_date": "2020-01-01T00:00",
        "shipment_note": "This is a shipment note",
        "signature_confirmation": true,
        "saturday_delivery": true,
        "is_return": true,
        "doc_files": [
            {
                "doc_type": "commercial_invoice",
                "doc_file": "base64 encoded file",
                "doc_name": "commercial_invoice.pdf",
                "doc_format": "pdf",
            }
        ],
        "doc_references": [
            {
                "doc_id": "123456789",
                "doc_type": "commercial_invoice",
            }
        ],
    }
    </details>
referencestring nullable

The shipment reference

label_type'PDF' | 'ZPL' | 'PNG' | '' | 'null' nullable

The shipment label file type.

carrier_idsstring[] nullable

The list of configured carriers you wish to get rates from.<br/> Note that the request will be sent to all carriers in nothing is specified

tracker_idstring nullable

The attached tracker id

created_atstring required

The shipment creation datetime.<br/> Date Format: YYYY-MM-DD HH:MM:SS.mmmmmmz

metadataobject

User metadata for the shipment

status'draft' | 'purchased' | 'cancelled' | 'shipped' | 'in_transit' | 'delivered' | 'needs_attention' | 'out_for_delivery' | 'delivery_failed'

The current Shipment status

carrier_namestring nullable

The shipment carrier

carrier_idstring nullable

The shipment carrier configured identifier

tracking_numberstring nullable

The shipment tracking number

shipment_identifierstring nullable

The shipment carrier system identifier

metaobject nullable

provider specific metadata

servicestring nullable

The selected service

selected_rate_idstring nullable

The shipment selected rate.

test_modeboolean required

Specified whether it was created with a carrier in test mode

label_urlstring uri nullable

The shipment label URL

invoice_urlstring uri nullable

The shipment invoice URL

Changes

No recorded changes to this endpoint across all 1 revision of this API.