Update shipment by ID
Changed onUpdate a shipment object based on its ID
Request
- Base URL: https://api.shipengine.com
- URL: https://api.shipengine.com/v1/shipments/{shipment_id}
- Auth: API key in header API-Key
Request body
Example request
{
"shipment_id": "se-28529731",
"carrier_id": "se-28529731",
"service_code": "usps_first_class_mail",
"shipping_rule_id": "se-28529731",
"items": [
{
"sales_order_id": "8c1f2a5e-3b7d-4e9a-a6c2-1d4f5e6a7b8c",
"sales_order_item_id": "2e7b9c4d-6a1f-4c3e-8b5d-9f0a1b2c3d4e",
"asin": "B00005N5PF",
"item_id": "1402291169813"
}
],
"ship_date": "2018-09-23T00:00:00.000Z",
"created_at": "2018-09-23T15:00:00.000Z",
"modified_at": "2018-09-23T15:00:00.000Z",
"ship_to": {
"name": "John Doe",
"phone": "+1 204-253-9411 ext. 123",
"email": "example@example.com",
"company_name": "The Home Depot",
"address_line1": "1999 Bishop Grandin Blvd.",
"address_line2": "Unit 408",
"address_line3": "Building #7",
"city_locality": "Winnipeg",
"state_province": "Manitoba",
"postal_code": "78756-3717",
"country_code": "CA",
"address_residential_indicator": "no",
"geolocation": [
{
"type": "what3words",
"value": "cats.with.thumbs"
}
]
},
"ship_from": {
"name": "John Doe",
"phone": "+1 204-253-9411 ext. 123",
"email": "example@example.com",
"company_name": "The Home Depot",
"address_line1": "1999 Bishop Grandin Blvd.",
"address_line2": "Unit 408",
"address_line3": "Building #7",
"city_locality": "Winnipeg",
"state_province": "Manitoba",
"postal_code": "78756-3717",
"country_code": "CA",
"address_residential_indicator": "no",
"geolocation": [
{
"type": "what3words",
"value": "cats.with.thumbs"
}
]
},
"warehouse_id": "se-28529731",
"return_to": {
"name": "John Doe",
"phone": "+1 204-253-9411 ext. 123",
"email": "example@example.com",
"company_name": "The Home Depot",
"address_line1": "1999 Bishop Grandin Blvd.",
"address_line2": "Unit 408",
"address_line3": "Building #7",
"city_locality": "Winnipeg",
"state_province": "Manitoba",
"postal_code": "78756-3717",
"country_code": "CA",
"address_residential_indicator": "no",
"geolocation": [
{
"type": "what3words",
"value": "cats.with.thumbs"
}
]
},
"customs": {
"terms_of_trade_code": "ddp",
"contents": "gift",
"non_delivery": "return_to_sender"
},
"advanced_options": {
"bill_to_country_code": "CA",
"freight_class": "77.5",
"collect_on_delivery": {
"payment_amount": {
"currency": "USD"
}
},
"movement_indicator": "c2c",
"license_number": "514785",
"invoice_number": "IOC56888",
"certificate_number": "784515",
"fragile": true,
"delivery_as_addressed": true,
"return_after_first_attempt": true,
"netstamps_options": {
"row": 1,
"column": 1
},
"suppress_carrier_generated_documents": [
"commercial_invoice"
],
"transparency_codes": [
{
"order_item_id": "12345678901234",
"codes": [
"AZ:XXXXXXXXXXXX"
]
}
]
},
"tags": [
{
"tag_id": 8712,
"name": "Fragile",
"color": "#FF0000"
}
],
"packages": [
{
"shipment_package_id": "se-28529731",
"package_id": "se-28529731",
"package_code": "small_flat_rate_box",
"insured_value": {
"currency": "USD"
},
"content_description": "Hand knitted wool socks",
"products": [
{
"value": {
"currency": "USD"
},
"harmonized_tariff_code": "3926.1",
"country_of_origin": "CA",
"vat_rate": 0.2,
"manufacturer_product_id": "012345678905",
"manufacturer_ns_product_id": "MY-SKU-12345",
"cpsc_certificates": [
{
"certifier_id": "CERT-12345",
"certificate_version_id": "v1.0"
}
],
"cpsc_disclaim": {
"disclaim_code": "B",
"intended_use_code": "130.006"
}
}
]
}
],
"batch_ids": [
"se-9581628",
"se-1935182"
],
"comparison_rate_type": "retail",
"zone": 6
}Response
The request was a success.
Example response
{
"shipment_id": "se-28529731",
"carrier_id": "se-28529731",
"service_code": "usps_first_class_mail",
"shipping_rule_id": "se-28529731",
"items": [
{
"sales_order_id": "8c1f2a5e-3b7d-4e9a-a6c2-1d4f5e6a7b8c",
"sales_order_item_id": "2e7b9c4d-6a1f-4c3e-8b5d-9f0a1b2c3d4e",
"asin": "B00005N5PF",
"item_id": "1402291169813"
}
],
"ship_date": "2018-09-23T00:00:00.000Z",
"created_at": "2018-09-23T15:00:00.000Z",
"modified_at": "2018-09-23T15:00:00.000Z",
"ship_to": {
"name": "John Doe",
"phone": "+1 204-253-9411 ext. 123",
"email": "example@example.com",
"company_name": "The Home Depot",
"address_line1": "1999 Bishop Grandin Blvd.",
"address_line2": "Unit 408",
"address_line3": "Building #7",
"city_locality": "Winnipeg",
"state_province": "Manitoba",
"postal_code": "78756-3717",
"country_code": "CA",
"address_residential_indicator": "no",
"geolocation": [
{
"type": "what3words",
"value": "cats.with.thumbs"
}
]
},
"ship_from": {
"name": "John Doe",
"phone": "+1 204-253-9411 ext. 123",
"email": "example@example.com",
"company_name": "The Home Depot",
"address_line1": "1999 Bishop Grandin Blvd.",
"address_line2": "Unit 408",
"address_line3": "Building #7",
"city_locality": "Winnipeg",
"state_province": "Manitoba",
"postal_code": "78756-3717",
"country_code": "CA",
"address_residential_indicator": "no",
"geolocation": [
{
"type": "what3words",
"value": "cats.with.thumbs"
}
]
},
"warehouse_id": "se-28529731",
"return_to": {
"name": "John Doe",
"phone": "+1 204-253-9411 ext. 123",
"email": "example@example.com",
"company_name": "The Home Depot",
"address_line1": "1999 Bishop Grandin Blvd.",
"address_line2": "Unit 408",
"address_line3": "Building #7",
"city_locality": "Winnipeg",
"state_province": "Manitoba",
"postal_code": "78756-3717",
"country_code": "CA",
"address_residential_indicator": "no",
"geolocation": [
{
"type": "what3words",
"value": "cats.with.thumbs"
}
]
},
"customs": {
"terms_of_trade_code": "ddp",
"contents": "gift",
"non_delivery": "return_to_sender"
},
"advanced_options": {
"bill_to_country_code": "CA",
"freight_class": "77.5",
"collect_on_delivery": {
"payment_amount": {
"currency": "USD"
}
},
"movement_indicator": "c2c",
"license_number": "514785",
"invoice_number": "IOC56888",
"certificate_number": "784515",
"fragile": true,
"delivery_as_addressed": true,
"return_after_first_attempt": true,
"netstamps_options": {
"row": 1,
"column": 1
},
"suppress_carrier_generated_documents": [
"commercial_invoice"
],
"transparency_codes": [
{
"order_item_id": "12345678901234",
"codes": [
"AZ:XXXXXXXXXXXX"
]
}
]
},
"tags": [
{
"tag_id": 8712,
"name": "Fragile",
"color": "#FF0000"
}
],
"packages": [
{
"shipment_package_id": "se-28529731",
"package_id": "se-28529731",
"package_code": "small_flat_rate_box",
"insured_value": {
"currency": "USD"
},
"content_description": "Hand knitted wool socks",
"products": [
{
"value": {
"currency": "USD"
},
"harmonized_tariff_code": "3926.1",
"country_of_origin": "CA",
"vat_rate": 0.2,
"manufacturer_product_id": "012345678905",
"manufacturer_ns_product_id": "MY-SKU-12345",
"cpsc_certificates": [
{
"certifier_id": "CERT-12345",
"certificate_version_id": "v1.0"
}
],
"cpsc_disclaim": {
"disclaim_code": "B",
"intended_use_code": "130.006"
}
}
]
}
],
"batch_ids": [
"se-9581628",
"se-1935182"
],
"comparison_rate_type": "retail",
"zone": 6,
"errors": [
"Parameter value '100000000.00' is out of range."
],
"address_validation": {
"status": "verified",
"original_address": {
"name": "John Doe",
"phone": "+1 204-253-9411 ext. 123",
"email": "example@example.com",
"company_name": "The Home Depot",
"address_line1": "1999 Bishop Grandin Blvd.",
"address_line2": "Unit 408",
"address_line3": "Building #7",
"city_locality": "Winnipeg",
"state_province": "Manitoba",
"postal_code": "78756-3717",
"country_code": "CA",
"address_residential_indicator": "no"
},
"matched_address": {
"name": "John Doe",
"phone": "+1 204-253-9411 ext. 123",
"email": "example@example.com",
"company_name": "The Home Depot",
"address_line1": "1999 Bishop Grandin Blvd.",
"address_line2": "Unit 408",
"address_line3": "Building #7",
"city_locality": "Winnipeg",
"state_province": "Manitoba",
"postal_code": "78756-3717",
"country_code": "CA",
"address_residential_indicator": "no"
},
"messages": [
{
"message": "Invalid Postal Code"
}
]
}
}Changes
- warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - info
added the new optional request property
/// - info
added the optional property
////to the response with the status
- warning
- breaking
added the new required request property
//// - breaking
added the new required request property
//// - breaking
added the new required request property
//// - breaking
added the new required request property
//// - breaking
added the new required request property
//// - breaking
added the new required request property
/// - breaking
added the new required request property
/// - breaking
added the new required request property
/// - breaking
added the new required request property
/// - breaking
added the new required request property
/// - breaking
added the new required request property
/// - breaking
request property
////was restricted to a list of enum values - breaking
request property
/////was restricted to a list of enum values - breaking
request property
///////was restricted to a list of enum values - breaking
request property
/was restricted to a list of enum values - breaking
request property
///was restricted to a list of enum values - breaking
the
//request property's minLength was increased from0to1 - breaking
the
/////request property's minLength was increased from0to1 - breaking
the
/////request property's minLength was increased from0to1 - breaking
the
/////request property's minLength was increased from0to1 - breaking
added the pattern
^se(-[a-z0-9]+)+$to the request property// - breaking
the
/////request property type changed from no type tostring - breaking
the
////request property type changed from no type tostring - breaking
the
/////request property type changed from no type tostring - breaking
the
//request property type changed from no type tostring - breaking
the
///////request property type changed from no type tostring - breaking
the
///request property type changed from no type toobject - breaking
the
///request property type changed from no type toobject - breaking
the
//request property type changed from no type toobject - breaking
the
/request property type changed from no type tostring - breaking
the
//request property type changed from no type toobject - breaking
the
/////request property type changed from no type tostring - breaking
the
/////request property type changed from no type tostring - breaking
the
/////request property type changed from no type tostring - breaking
the
//request property type changed from no type toobject - breaking
the
//request property type changed from no type toobject - breaking
the
///request property type changed from no type tostring - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
/////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
///response's property type changed from no type tostringfor status - breaking
the
////////response's property type changed from no type tostringfor status - breaking
the
////response's property type changed from no type toobjectfor status - breaking
the
////response's property type changed from no type toobjectfor status - breaking
the
///response's property type changed from no type toobjectfor status - breaking
the
//response's property type changed from no type tostringfor status - breaking
the
///response's property type changed from no type toobjectfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
///response's property type changed from no type toobjectfor status - breaking
the
///response's property type changed from no type toobjectfor status - breaking
the
////response's property type changed from no type tostringfor status - breaking
the
///////response's property type changed from no type tostringfor status - breaking
the
////response's property type changed from no type tostringfor status - breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
/response's property type changed from no type toobjectfor status - warning
removed from the
////request propertyallOflist - warning
removed from the
/////request propertyallOflist - warning
removed from the
///request propertyallOflist - warning
removed from the
///request propertyallOflist - warning
removed from the
/request propertyallOflist - warning
removed from the
//request propertyallOflist - warning
removed from the
/////request propertyallOflist - warning
removed from the
/////request propertyallOflist - warning
removed from the
/////request propertyallOflist - warning
removed from the
//request propertyallOflist - warning
removed from the
//request propertyallOflist - warning
removed from the
//request propertyallOflist - warning
removed from the
//request propertyallOflist - warning
removed from the
/////request propertyallOflist - warning
removed from the
///////request propertyallOflist - warning
removed from the
///request propertyallOflist - warning
the
//request property's maxLength was set to25 - warning
added the new
amazon_caenum value to the//response property for the response status - warning
added the new
amazon_usenum value to the//response property for the response status - warning
added the new
anyenum value to the/////response property for the response status - warning
added the new
brightpearlenum value to the//response property for the response status - warning
added the new
cashenum value to the/////response property for the response status - warning
added the new
cash_equivalentenum value to the/////response property for the response status - warning
added the new
channel_advisorenum value to the//response property for the response status - warning
added the new
cratejoyenum value to the//response property for the response status - warning
added the new
ebayenum value to the//response property for the response status - warning
added the new
errorenum value to the////response property for the response status - warning
added the new
etsyenum value to the//response property for the response status - warning
added the new
gramenum value to the//////response property for the response status - warning
added the new
gramenum value to the////////response property for the response status - warning
added the new
gramenum value to the////response property for the response status - warning
added the new
groupon_goodsenum value to the//response property for the response status - warning
added the new
janeenum value to the//response property for the response status - warning
added the new
kilogramenum value to the//////response property for the response status - warning
added the new
kilogramenum value to the////////response property for the response status - warning
added the new
kilogramenum value to the////response property for the response status - warning
added the new
magentoenum value to the//response property for the response status - warning
added the new
noneenum value to the/////response property for the response status - warning
added the new
ounceenum value to the//////response property for the response status - warning
added the new
ounceenum value to the////////response property for the response status - warning
added the new
ounceenum value to the////response property for the response status - warning
added the new
paypalenum value to the//response property for the response status - warning
added the new
poundenum value to the//////response property for the response status - warning
added the new
poundenum value to the////////response property for the response status - warning
added the new
poundenum value to the////response property for the response status - warning
added the new
seller_activeenum value to the//response property for the response status - warning
added the new
shopifyenum value to the//response property for the response status - warning
added the new
squarespaceenum value to the//response property for the response status - warning
added the new
stitch_labsenum value to the//response property for the response status - warning
added the new
three_dcartenum value to the//response property for the response status - warning
added the new
tophatterenum value to the//response property for the response status - warning
added the new
unverifiedenum value to the////response property for the response status - warning
added the new
verifiedenum value to the////response property for the response status - warning
added the new
volusionenum value to the//response property for the response status - warning
added the new
walmartenum value to the//response property for the response status - warning
added the new
warningenum value to the////response property for the response status - warning
added the new
woo_commerceenum value to the//response property for the response status - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
//// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new optional request property
/// - info
added the new
amazon_caenum value to the request property/ - info
added the new
amazon_usenum value to the request property/ - info
added the new
anyenum value to the request property//// - info
added the new
brightpearlenum value to the request property/ - info
added the new
cashenum value to the request property//// - info
added the new
cash_equivalentenum value to the request property//// - info
added the new
channel_advisorenum value to the request property/ - info
added the new
cratejoyenum value to the request property/ - info
added the new
ebayenum value to the request property/ - info
added the new
etsyenum value to the request property/ - info
added the new
gramenum value to the request property///// - info
added the new
gramenum value to the request property/////// - info
added the new
gramenum value to the request property/// - info
added the new
groupon_goodsenum value to the request property/ - info
added the new
janeenum value to the request property/ - info
added the new
kilogramenum value to the request property///// - info
added the new
kilogramenum value to the request property/////// - info
added the new
kilogramenum value to the request property/// - info
added the new
magentoenum value to the request property/ - info
added the new
noneenum value to the request property//// - info
added the new
ounceenum value to the request property///// - info
added the new
ounceenum value to the request property/////// - info
added the new
ounceenum value to the request property/// - info
added the new
paypalenum value to the request property/ - info
added the new
poundenum value to the request property///// - info
added the new
poundenum value to the request property/////// - info
added the new
poundenum value to the request property/// - info
added the new
seller_activeenum value to the request property/ - info
added the new
shopifyenum value to the request property/ - info
added the new
squarespaceenum value to the request property/ - info
added the new
stitch_labsenum value to the request property/ - info
added the new
three_dcartenum value to the request property/ - info
added the new
tophatterenum value to the request property/ - info
added the new
volusionenum value to the request property/ - info
added the new
walmartenum value to the request property/ - info
added the new
woo_commerceenum value to the request property/ - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added to the
////response propertyallOflist for the response status - info
removed from the
////response propertyallOflist for the response status - info
removed from the
/////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
////response propertyallOflist for the response status - info
removed from the
////response propertyallOflist for the response status - info
removed from the
//response propertyallOflist for the response status - info
removed from the
///response propertyallOflist for the response status - info
removed from the
////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
///////response propertyallOflist for the response status - info
removed from the
///response propertyallOflist for the response status - info
removed from the
///response propertyallOflist for the response status - info
removed from the
///response propertyallOflist for the response status - info
removed from the
///response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
////////response propertyallOflist for the response status - info
removed from the
////response propertyallOflist for the response status - info
the
///response's property pattern^se(-[a-z0-9]+)+$was added for the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
////to the response with the status - info
added the required property
////to the response with the status - info
added the required property
////to the response with the status - info
added the required property
////to the response with the status - info
added the required property
////to the response with the status - info
added the required property
////to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status
- breaking