Update Shipment Info

put

https://api.helloextend.com/line-items/shipments

This endpoint allows existing shipment information associated to an order line item to be updated using the Extend Line Item ID or Line Item Transaction ID (the merchant’s unique identifier for the order line item). There are various changes that can be made to a shipment:

Destination or source location address
Product IDs associated to the shipment
New Tracking ID if the previous one was inaccurate
Shipment date and tracking URL (these fields are updated automatically if a supported shipping provider and valid Tracking ID is provided on the order)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

destination

object

Destination location of the shipment associated to the package.

productIds

array of strings

length ≤ 500

List of Extend Product IDs associated to the shipment.

productIds

shipmentDate

integer

≤ 9007199254740991

Date package was shipped by the shipping provider. NOTE - This will be automatically updated with a valid Shipping Provider and Tracking ID on the shipment.

source

object

Source location of the shipment associated to the package.

trackingId

string

required

Existing tracking number from the shipping provider. Merchants must provide this tracking number to properly track the statuses of the shipment. This will replace the current tracking id.

trackingUrl

string

URL generated by the shipping provider for the associated tracking number. NOTE - This will be automatically updated with a valid Shipping Provider and Tracking ID on the shipment.

newTrackingId

string

New tracking number from the shipping provider. Merchants must provide this tracking number to properly track the statuses of the shipment. This will replace the current tracking id.

lineItemId

string

required

Unique identifier for the Extend order line item.

Headers

Content-Type

string

required

Used to indicate the original media type of the resource (prior to any content encoding applied for sending).

X-Extend-Access-Token

string

required

An Extend private API key used to authenticate requests.

string

required

Indicates which content types, expressed as MIME types, the client is able to understand, as well as identifies which API version to use in the request.

Responses

200Successful shipment info update.

404The specified resource was not found

500Internal server error