Get a Shipment by ID

get https://apisandbox.tusklogistics.com/v1/shipment/{shipment_id}

Returns a single Shipment

Responses

Response body

object

integer

ID of the Shipment.

external_reference

string

Optional field for providing an identifier of the shipment. This can help identify shipments faster in case of a support issue. This field is limited to 50 characters and no validation of any data is performed on this.

confirmation

string

Confirmation requested for this shipment. Options are: NONE, SIGNATURE, ADULT_SIGNATURE. Defaults to NONE if not specified. A surcharge might apply.

address_to

object

Recipient address.

name

string

Contact person at this address.

company

string

Company name for this address. Required if Is_Residential is false.

is_residential

boolean

Flag indicating whether the address is residential. If omitted, it is assumed to be true.

street1

string

required

First line of the street address.

street2

string

Second line of the street address. May not be needed.

city

string

required

Name of the city.

state

string

required

2-letter abbreviation of the state.

country

string

2-letter country code. Tusk currently only supports US addresses.

postal_code

string

required

Postal code.

phone

string

Phone number of the contact person at this address.

string

Email of the contact person at this address.

address_from

object

Origin address.

name

string

Contact person at this address.

company

string

Company name for this address. Required if Is_Residential is false.

is_residential

boolean

Flag indicating whether the address is residential. If omitted, it is assumed to be true.

street1

string

required

First line of the street address.

street2

string

Second line of the street address. May not be needed.

city

string

required

Name of the city.

state

string

required

2-letter abbreviation of the state.

country

string

2-letter country code. Tusk currently only supports US addresses.

postal_code

string

required

Postal code.

phone

string

Phone number of the contact person at this address.

string

Email of the contact person at this address.

parcels

array of objects

Parcels sent as part of this Shipment.

parcels

object

dimensions

object

required

Package dimensions.

weight

object

required

Package weight.

401

Unauthorized

404

Not Found

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://apisandbox.tusklogistics.com/v1/shipment/shipment_id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

500Internal Server Error