diff --git a/docs/index.html b/docs/index.html index 3cb7774..d3e8a13 100644 --- a/docs/index.html +++ b/docs/index.html @@ -355,7 +355,7 @@ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">

ShipEngine API (1.1.202410091410)

Download OpenAPI specification:Download

ShipEngine Sales & Support: sales@shipengine.com URL: https://www.shipengine.com/contact/ Terms of Service

ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices.

+ " fill="currentColor">

ShipEngine API (1.1.202410092110)

Download OpenAPI specification:Download

ShipEngine Sales & Support: sales@shipengine.com URL: https://www.shipengine.com/contact/ Terms of Service

ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices.

Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service.

ShipEngine's documentation is designed to help you start shipping as quickly as possible. With easy-to-follow tutorials, detailed reference docs, and ready-made recipes for common use cases, you'll see real results in no time at all.

Getting Started

If you're new to REST APIs then be sure to read our introduction to REST to understand the basics. Learn how to authenticate yourself to ShipEngine, and then use our sandbox environment to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the error handling guide for tips.

@@ -813,7 +813,7 @@

This error will automatically be reported to our engineers.

-
post/v1/labels
https://api.shipengine.com/v1/labels

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ship_to_service_point_id": "614940",
  • "ship_from_service_point_id": "614940",
  • "shipment":
    {
    },
  • "is_return_label": true,
  • "rma_number": "string",
  • "charge_event": "carrier_default",
  • "outbound_label_id": "se-28529731",
  • "test_label": false,
  • "validate_address": "no_validation",
  • "label_download_type": "url",
  • "label_format": "pdf",
  • "display_scheme": "label",
  • "label_layout": "4x6",
  • "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipment":
    {
    },
  • "is_return_label": true,
  • "rma_number": "string",
  • "charge_event": "carrier_default",
  • "label_format": "pdf",
  • "display_scheme": "label",
  • "label_layout": "4x6",
  • "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK"
}

Get Label By External Shipment ID

Find a label by using the external shipment id that was used during label creation

+
post/v1/labels
https://api.shipengine.com/v1/labels

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ship_to_service_point_id": "614940",
  • "ship_from_service_point_id": "614940",
  • "shipment":
    {
    },
  • "is_return_label": true,
  • "rma_number": "string",
  • "charge_event": "carrier_default",
  • "outbound_label_id": "se-28529731",
  • "test_label": false,
  • "validate_address": "no_validation",
  • "label_download_type": "url",
  • "label_format": "pdf",
  • "display_scheme": "label",
  • "label_layout": "4x6",
  • "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Get Label By External Shipment ID

Find a label by using the external shipment id that was used during label creation

Authorizations:
api_key
path Parameters
external_shipment_id
required
string
Example: 0bcb569d-1727-4ff9-ab49-b2fec0cee5ae
query Parameters
label_download_type
string (label_download_type)
Enum: "url" "inline"
Example: label_download_type=url

There are two different ways to download a label:

@@ -838,7 +838,7 @@

This error will automatically be reported to our engineers.

-
get/v1/labels/external_shipment_id/{external_shipment_id}
https://api.shipengine.com/v1/labels/external_shipment_id/{external_shipment_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipment":
    {
    },
  • "is_return_label": true,
  • "rma_number": "string",
  • "charge_event": "carrier_default",
  • "label_format": "pdf",
  • "display_scheme": "label",
  • "label_layout": "4x6",
  • "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK"
}

Purchase Label with Rate ID

When retrieving rates for shipments using the /rates endpoint, the returned information contains a rate_id property that can be used +

get/v1/labels/external_shipment_id/{external_shipment_id}
https://api.shipengine.com/v1/labels/external_shipment_id/{external_shipment_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Purchase Label with Rate ID

When retrieving rates for shipments using the /rates endpoint, the returned information contains a rate_id property that can be used to generate a label without having to refill in the shipment information repeatedly.

Authorizations:
api_key
path Parameters
rate_id
required
string (se_id) [ 1 .. 25 ] characters ^se(-[a-z0-9]+)+$
Example: se-28529731

Rate ID

Request Body schema: application/json
validate_address
string
Enum: "no_validation" "validate_only" "validate_and_clean"

The possible validate address values

@@ -889,7 +889,7 @@

This error will automatically be reported to our engineers.

-
post/v1/labels/rates/{rate_id}
https://api.shipengine.com/v1/labels/rates/{rate_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "validate_address": "no_validation",
  • "label_layout": "4x6",
  • "label_format": "pdf",
  • "label_download_type": "url",
  • "display_scheme": "label"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipment":
    {
    },
  • "is_return_label": true,
  • "rma_number": "string",
  • "charge_event": "carrier_default",
  • "label_format": "pdf",
  • "display_scheme": "label",
  • "label_layout": "4x6",
  • "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK"
}

Purchase Label with Shipment ID

Purchase a label using a shipment ID that has already been created with the desired address and +

post/v1/labels/rates/{rate_id}
https://api.shipengine.com/v1/labels/rates/{rate_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "validate_address": "no_validation",
  • "label_layout": "4x6",
  • "label_format": "pdf",
  • "label_download_type": "url",
  • "display_scheme": "label"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Purchase Label with Shipment ID

Purchase a label using a shipment ID that has already been created with the desired address and package info.

Authorizations:
api_key
path Parameters
shipment_id
required
string (se_id) [ 1 .. 25 ] characters ^se(-[a-z0-9]+)+$
Example: se-28529731

Shipment ID

Request Body schema: application/json
validate_address
string
Enum: "no_validation" "validate_only" "validate_and_clean"

The possible validate address values

@@ -940,7 +940,7 @@

This error will automatically be reported to our engineers.

-
post/v1/labels/shipment/{shipment_id}
https://api.shipengine.com/v1/labels/shipment/{shipment_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "validate_address": "no_validation",
  • "label_layout": "4x6",
  • "label_format": "pdf",
  • "label_download_type": "url",
  • "display_scheme": "label"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipment":
    {
    },
  • "is_return_label": true,
  • "rma_number": "string",
  • "charge_event": "carrier_default",
  • "label_format": "pdf",
  • "display_scheme": "label",
  • "label_layout": "4x6",
  • "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK"
}

Get Label By ID

Retrieve information for individual labels.

+
post/v1/labels/shipment/{shipment_id}
https://api.shipengine.com/v1/labels/shipment/{shipment_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "validate_address": "no_validation",
  • "label_layout": "4x6",
  • "label_format": "pdf",
  • "label_download_type": "url",
  • "display_scheme": "label"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Get Label By ID

Retrieve information for individual labels.

Authorizations:
api_key
path Parameters
label_id
required
string (se_id) [ 1 .. 25 ] characters ^se(-[a-z0-9]+)+$
Example: se-28529731

Label ID

query Parameters
label_download_type
string (label_download_type)
Enum: "url" "inline"
Example: label_download_type=url

There are two different ways to download a label:

@@ -966,7 +966,7 @@

This error will automatically be reported to our engineers.

-
get/v1/labels/{label_id}
https://api.shipengine.com/v1/labels/{label_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipment":
    {
    },
  • "is_return_label": true,
  • "rma_number": "string",
  • "charge_event": "carrier_default",
  • "label_format": "pdf",
  • "display_scheme": "label",
  • "label_layout": "4x6",
  • "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK"
}

Create a return label

Create a return label

+
get/v1/labels/{label_id}
https://api.shipengine.com/v1/labels/{label_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Create a return label

Create a return label

Authorizations:
api_key
path Parameters
label_id
required
string (se_id) [ 1 .. 25 ] characters ^se(-[a-z0-9]+)+$
Example: se-28529731

Label ID

Request Body schema: application/json
charge_event
string
Enum: "carrier_default" "on_creation" "on_carrier_acceptance"

The label charge event.

label_layout
string
Default: "4x6"
Enum: "4x6" "letter"

The layout (size) that you want the label to be in. The label_format determines which sizes are allowed. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.

@@ -997,7 +997,7 @@

This error will automatically be reported to our engineers.

-
post/v1/labels/{label_id}/return
https://api.shipengine.com/v1/labels/{label_id}/return

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "charge_event": "carrier_default",
  • "label_layout": "4x6",
  • "label_format": "pdf",
  • "label_download_type": "url",
  • "display_scheme": "label",
  • "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipment":
    {
    },
  • "is_return_label": true,
  • "rma_number": "string",
  • "charge_event": "carrier_default",
  • "label_format": "pdf",
  • "display_scheme": "label",
  • "label_layout": "4x6",
  • "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK"
}

Get Label Tracking Information

Retrieve the label's tracking information

+
post/v1/labels/{label_id}/return
https://api.shipengine.com/v1/labels/{label_id}/return

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "charge_event": "carrier_default",
  • "label_layout": "4x6",
  • "label_format": "pdf",
  • "label_download_type": "url",
  • "display_scheme": "label",
  • "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Get Label Tracking Information

Retrieve the label's tracking information

Authorizations:
api_key
path Parameters
label_id
required
string (se_id) [ 1 .. 25 ] characters ^se(-[a-z0-9]+)+$
Example: se-28529731

Label ID

Responses

200

The request was a success.

400

The request contained errors.

@@ -1171,7 +1171,7 @@

This error will automatically be reported to our engineers.

-
post/v1/rates
https://api.shipengine.com/v1/rates

Request samples

Content type
application/json
Example
shipment_id_request
Copy
 Expand all Collapse all
{
  • "shipment_id": "se-28529731",
  • "rate_options":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipment_id": "se-28529731",
  • "carrier_id": "se-28529731",
  • "service_code": "usps_first_class_mail",
  • "shipping_rule_id": "se-28529731",
  • "external_order_id": "string",
  • "items": [ ],
  • "tax_identifiers":
    [
    ],
  • "external_shipment_id": "string",
  • "shipment_number": "string",
  • "ship_date": "2018-09-23T00:00:00.000Z",
  • "created_at": "2018-09-23T15:00:00.000Z",
  • "modified_at": "2018-09-23T15:00:00.000Z",
  • "shipment_status": "pending",
  • "ship_to":
    {
    },
  • "ship_from":
    {
    },
  • "warehouse_id": "se-28529731",
  • "return_to":
    {
    },
  • "is_return": false,
  • "confirmation": "none",
  • "customs":
    {
    },
  • "advanced_options":
    {
    },
  • "insurance_provider": "none",
  • "tags": [ ],
  • "order_source_code": "amazon_ca",
  • "packages":
    [
    ],
  • "total_weight":
    {
    },
  • "comparison_rate_type": "retail",
  • "rate_response":
    {
    }
}

Get Bulk Rates

Get Bulk Shipment Rates

+
post/v1/rates
https://api.shipengine.com/v1/rates

Request samples

Content type
application/json
Example
shipment_id_request
Copy
 Expand all Collapse all
{
  • "shipment_id": "se-28529731",
  • "rate_options":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipment_id": "se-28529731",
  • "carrier_id": "se-28529731",
  • "service_code": "usps_first_class_mail",
  • "shipping_rule_id": "se-28529731",
  • "external_order_id": "string",
  • "items": [ ],
  • "tax_identifiers":
    [
    ],
  • "external_shipment_id": "string",
  • "shipment_number": "string",
  • "ship_date": "2018-09-23T00:00:00.000Z",
  • "created_at": "2018-09-23T15:00:00.000Z",
  • "modified_at": "2018-09-23T15:00:00.000Z",
  • "shipment_status": "pending",
  • "ship_to":
    {
    },
  • "ship_from":
    {
    },
  • "warehouse_id": "se-28529731",
  • "return_to":
    {
    },
  • "is_return": false,
  • "confirmation": "none",
  • "customs":
    {
    },
  • "advanced_options":
    {
    },
  • "insurance_provider": "none",
  • "tags": [ ],
  • "order_source_code": "amazon_ca",
  • "packages":
    [
    ],
  • "total_weight":
    {
    },
  • "comparison_rate_type": "retail",
  • "rate_response":
    {
    }
}

Get Bulk Rates

Get Bulk Shipment Rates

Authorizations:
api_key
Request Body schema: application/json
One of
  • rate_request_by_shipment_ids
  • rate_request_by_shipments
shipment_ids
required
Array of strings

The array of shipment IDs

rate_options
required
object

The rate options

Responses

200

The request was a success.

@@ -1201,7 +1201,7 @@

This error will automatically be reported to our engineers.

-
post/v1/rates/estimate
https://api.shipengine.com/v1/rates/estimate

Request samples

Content type
application/json
Example
rate_estimate_by_carrier_id
Copy
 Expand all Collapse all
{
  • "carrier_id": "se-28529731",
  • "from_country_code": "CA",
  • "from_postal_code": "78756-3717",
  • "from_city_locality": "Austin",
  • "from_state_province": "Austin",
  • "to_country_code": "CA",
  • "to_postal_code": "78756-3717",
  • "to_city_locality": "Austin",
  • "to_state_province": "Houston",
  • "weight":
    {
    },
  • "dimensions":
    {
    },
  • "confirmation": "none",
  • "address_residential_indicator": "unknown",
  • "ship_date": "2018-09-23T15:00:00.000Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Rate By ID

Retrieve a previously queried rate by its ID

+
post/v1/rates/estimate
https://api.shipengine.com/v1/rates/estimate

Request samples

Content type
application/json
Example
rate_estimate_by_carrier_id
Copy
 Expand all Collapse all
{
  • "carrier_id": "se-28529731",
  • "from_country_code": "CA",
  • "from_postal_code": "78756-3717",
  • "from_city_locality": "Austin",
  • "from_state_province": "Austin",
  • "to_country_code": "CA",
  • "to_postal_code": "78756-3717",
  • "to_city_locality": "Austin",
  • "to_state_province": "Houston",
  • "weight":
    {
    },
  • "dimensions":
    {
    },
  • "confirmation": "none",
  • "address_residential_indicator": "unknown",
  • "ship_date": "2018-09-23T15:00:00.000Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Rate By ID

Retrieve a previously queried rate by its ID

Authorizations:
api_key
path Parameters
rate_id
required
string (se_id) [ 1 .. 25 ] characters ^se(-[a-z0-9]+)+$
Example: se-28529731

Rate ID

Responses

200

The request was a success.

400

The request contained errors.

@@ -1210,7 +1210,7 @@

This error will automatically be reported to our engineers.

-
get/v1/rates/{rate_id}
https://api.shipengine.com/v1/rates/{rate_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rate_id": "se-28529731",
  • "rate_type": "check",
  • "carrier_id": "se-28529731",
  • "shipping_amount":
    {
    },
  • "insurance_amount":
    {
    },
  • "confirmation_amount":
    {
    },
  • "other_amount":
    {
    },
  • "requested_comparison_amount":
    {
    },
  • "tax_amount":
    {
    },
  • "rate_details":
    [
    ],
  • "zone": 6,
  • "package_type": "package",
  • "delivery_days": 5,
  • "guaranteed_service": true,
  • "estimated_delivery_date": "2018-09-23T00:00:00.000Z",
  • "carrier_delivery_days": "string",
  • "ship_date": "2024-10-09T14:21:27Z",
  • "negotiated_rate": true,
  • "service_type": "string",
  • "service_code": "string",
  • "trackable": true,
  • "carrier_code": "string",
  • "carrier_nickname": "string",
  • "carrier_friendly_name": "string",
  • "validation_status": "valid",
  • "warning_messages":
    [
    ],
  • "error_messages":
    [
    ]
}

Service Points

List Service Points

List carrier service points by location

+
get/v1/rates/{rate_id}
https://api.shipengine.com/v1/rates/{rate_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rate_id": "se-28529731",
  • "rate_type": "check",
  • "carrier_id": "se-28529731",
  • "shipping_amount":
    {
    },
  • "insurance_amount":
    {
    },
  • "confirmation_amount":
    {
    },
  • "other_amount":
    {
    },
  • "requested_comparison_amount":
    {
    },
  • "tax_amount":
    {
    },
  • "rate_details":
    [
    ],
  • "zone": 6,
  • "package_type": "package",
  • "delivery_days": 5,
  • "guaranteed_service": true,
  • "estimated_delivery_date": "2018-09-23T00:00:00.000Z",
  • "carrier_delivery_days": "string",
  • "ship_date": "2024-10-09T21:50:27Z",
  • "negotiated_rate": true,
  • "service_type": "string",
  • "service_code": "string",
  • "trackable": true,
  • "carrier_code": "string",
  • "carrier_nickname": "string",
  • "carrier_friendly_name": "string",
  • "validation_status": "valid",
  • "warning_messages":
    [
    ],
  • "error_messages":
    [
    ]
}

Service Points

List Service Points

List carrier service points by location

Authorizations:
api_key
Request Body schema: application/json
One of
  • get_service_points_request_body
address_query
string

Unstructured text to search for service points by.

address
object

Structured address to search by.

providers
required
Array of objects

An array of shipping service providers and service codes

@@ -1258,7 +1258,7 @@

This error will automatically be reported to our engineers.

-
get/v1/shipments
https://api.shipengine.com/v1/shipments

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipments":
    [
    ],
  • "total": 1990,
  • "page": "????",
  • "pages": 1,
  • "links":
    {}
}

Create Shipments

Create one or multiple shipments.

+
get/v1/shipments
https://api.shipengine.com/v1/shipments

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipments":
    [
    ],
  • "total": 1990,
  • "page": "????",
  • "pages": 1,
  • "links":
    {}
}

Create Shipments

Create one or multiple shipments.

Authorizations:
api_key
Request Body schema: application/json
shipments
required
Array of objects non-empty

An array of shipments to be created.

Responses

200

The requested object creation was a success.

400

The request contained errors.

@@ -1274,7 +1274,7 @@

This error will automatically be reported to our engineers.

-
get/v1/shipments/external_shipment_id/{external_shipment_id}
https://api.shipengine.com/v1/shipments/external_shipment_id/{external_shipment_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "carrier_id": "se-28529731",
  • "service_code": "usps_first_class_mail",
  • "shipping_rule_id": "se-28529731",
  • "external_order_id": "string",
  • "items": [ ],
  • "tax_identifiers":
    [
    ],
  • "external_shipment_id": "string",
  • "shipment_number": "string",
  • "ship_date": "2018-09-23T00:00:00.000Z",
  • "ship_to":
    {
    },
  • "ship_from":
    {
    },
  • "warehouse_id": "se-28529731",
  • "return_to":
    {
    },
  • "is_return": false,
  • "confirmation": "none",
  • "customs":
    {
    },
  • "advanced_options":
    {
    },
  • "insurance_provider": "none",
  • "order_source_code": "amazon_ca",
  • "packages":
    [
    ],
  • "comparison_rate_type": "retail"
}

Parse shipping info

The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more.

+
get/v1/shipments/external_shipment_id/{external_shipment_id}
https://api.shipengine.com/v1/shipments/external_shipment_id/{external_shipment_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipment_id": "se-28529731",
  • "carrier_id": "se-28529731",
  • "service_code": "usps_first_class_mail",
  • "shipping_rule_id": "se-28529731",
  • "external_order_id": "string",
  • "items": [ ],
  • "tax_identifiers":
    [
    ],
  • "external_shipment_id": "string",
  • "shipment_number": "string",
  • "ship_date": "2018-09-23T00:00:00.000Z",
  • "created_at": "2018-09-23T15:00:00.000Z",
  • "modified_at": "2018-09-23T15:00:00.000Z",
  • "shipment_status": "pending",
  • "ship_to":
    {
    },
  • "ship_from":
    {
    },
  • "warehouse_id": "se-28529731",
  • "return_to":
    {
    },
  • "is_return": false,
  • "confirmation": "none",
  • "customs":
    {
    },
  • "advanced_options":
    {
    },
  • "insurance_provider": "none",
  • "tags": [ ],
  • "order_source_code": "amazon_ca",
  • "packages":
    [
    ],
  • "total_weight":
    {
    },
  • "comparison_rate_type": "retail"
}

Parse shipping info

The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more.

Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label.

Note: Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.

@@ -1299,7 +1299,7 @@

This error will automatically be reported to our engineers.

-
get/v1/shipments/{shipment_id}
https://api.shipengine.com/v1/shipments/{shipment_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "carrier_id": "se-28529731",
  • "service_code": "usps_first_class_mail",
  • "shipping_rule_id": "se-28529731",
  • "external_order_id": "string",
  • "items": [ ],
  • "tax_identifiers":
    [
    ],
  • "external_shipment_id": "string",
  • "shipment_number": "string",
  • "ship_date": "2018-09-23T00:00:00.000Z",
  • "ship_to":
    {
    },
  • "ship_from":
    {
    },
  • "warehouse_id": "se-28529731",
  • "return_to":
    {
    },
  • "is_return": false,
  • "confirmation": "none",
  • "customs":
    {
    },
  • "advanced_options":
    {
    },
  • "insurance_provider": "none",
  • "order_source_code": "amazon_ca",
  • "packages":
    [
    ],
  • "comparison_rate_type": "retail"
}

Update Shipment By ID

Update a shipment object based on its ID

+
get/v1/shipments/{shipment_id}
https://api.shipengine.com/v1/shipments/{shipment_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipment_id": "se-28529731",
  • "carrier_id": "se-28529731",
  • "service_code": "usps_first_class_mail",
  • "shipping_rule_id": "se-28529731",
  • "external_order_id": "string",
  • "items": [ ],
  • "tax_identifiers":
    [
    ],
  • "external_shipment_id": "string",
  • "shipment_number": "string",
  • "ship_date": "2018-09-23T00:00:00.000Z",
  • "created_at": "2018-09-23T15:00:00.000Z",
  • "modified_at": "2018-09-23T15:00:00.000Z",
  • "shipment_status": "pending",
  • "ship_to":
    {
    },
  • "ship_from":
    {
    },
  • "warehouse_id": "se-28529731",
  • "return_to":
    {
    },
  • "is_return": false,
  • "confirmation": "none",
  • "customs":
    {
    },
  • "advanced_options":
    {
    },
  • "insurance_provider": "none",
  • "tags": [ ],
  • "order_source_code": "amazon_ca",
  • "packages":
    [
    ],
  • "total_weight":
    {
    },
  • "comparison_rate_type": "retail"
}

Update Shipment By ID

Update a shipment object based on its ID

Authorizations:
api_key
path Parameters
shipment_id
required
string (se_id) [ 1 .. 25 ] characters ^se(-[a-z0-9]+)+$
Example: se-28529731

Shipment ID

Request Body schema: application/json
carrier_id
string [ 1 .. 25 ] characters ^se(-[a-z0-9]+)+$

The carrier account that is billed for the shipping charges

service_code
string ^[a-z0-9]+(_[a-z0-9-]+)* ?$

The carrier service used to ship the package, such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.

@@ -1360,7 +1360,7 @@

This error will automatically be reported to our engineers.

-
get/v1/shipments/{shipment_id}/rates
https://api.shipengine.com/v1/shipments/{shipment_id}/rates

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rates":
    [
    ],
  • "invalid_rates": [ ],
  • "rate_request_id": "se-28529731",
  • "shipment_id": "se-28529731",
  • "created_at": "se-28529731",
  • "status": "working",
  • "errors":
    [
    ]
}

Update Shipments Tags

Update Shipments Tags

+
get/v1/shipments/{shipment_id}/rates
https://api.shipengine.com/v1/shipments/{shipment_id}/rates

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rates":
    [
    ],
  • "invalid_rates": [ ],
  • "rate_request_id": "se-28529731",
  • "shipment_id": "se-28529731",
  • "created_at": "se-28529731",
  • "status": "working",
  • "errors":
    [
    ]
}

Update Shipments Tags

Update Shipments Tags

Authorizations:
api_key
Request Body schema: application/json
shipments_tags
Array of objects

Responses

204

NoContent

400

The request contained errors.

404

The specified resource does not exist.

@@ -1582,7 +1582,7 @@
delete/v1/environment/webhooks/{webhook_id}
https://api.shipengine.com/v1/environment/webhooks/{webhook_id}

Response samples

Content type
text/plain
No sample