diff --git a/docs/index.html b/docs/index.html index 66b4b47..9ccaff6 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.202411081111)

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.202411131511)

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.

@@ -841,9 +841,9 @@
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
custom_field_1
string

Optional - Value will be saved in the shipment's advanced_options > custom_field1

-
custom_field_2
string

Optional - Value will be saved in the shipment's advanced_options > custom_field2

-
custom_field_3
string

Optional - Value will be saved in the shipment's advanced_options > custom_field3

+
Request Body schema: application/json
custom_field1
string

Optional - Value will be saved in the shipment's advanced_options > custom_field1

+
custom_field2
string

Optional - Value will be saved in the shipment's advanced_options > custom_field2

+
custom_field3
string

Optional - Value will be saved in the shipment's advanced_options > custom_field3

validate_address
string
Enum: "no_validation" "validate_only" "validate_and_clean"

The possible validate address values

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

The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.

label_format
string
Default: "pdf"
Enum: "pdf" "png" "zpl"

The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.

@@ -892,7 +892,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
{
  • "custom_field_1": "string",
  • "custom_field_2": "string",
  • "custom_field_3": "string",
  • "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 +

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
{
  • "custom_field1": "string",
  • "custom_field2": "string",
  • "custom_field3": "string",
  • "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

@@ -1174,7 +1174,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.

@@ -1204,7 +1204,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.

@@ -1213,7 +1213,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-11-09T01:33:53Z",
  • "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-11-13T16:05:35Z",
  • "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

@@ -1363,7 +1363,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.

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

Response samples

Content type
text/plain
No sample