Add Shipment Info

post

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

This endpoint allows shipping information to be added to an existing order by using the Extend Line Item ID or Line Item Transaction ID (the merchant’s unique identifier for the order line item) of the Shipping Protection Contract line from the existing order.

Important:

Shipment information is only required when creating an order for shipping protection contracts. Shipments need to be added to an order for products shipped after order creation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

lineItemId

string

required

Unique identifier for the Extend order line item.

productIds

array of strings

required

length ≤ 500

List of Extend Product IDs associated to the shipment.

productIds*

shipmentDate

integer

required

≤ 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.

shippingProvider

string

required

Shipping provider code associated to the package. Merchants must provide this shipping provider code to properly track the statuses of the shipment. NOTE - This is the current list of codes that we support shipment tracking updates for: 'fedex', 'ups', 'usps'. If a different code value is sent, the shipment will be created but we will not be able to automatically track shipment updates.

trackingId

string

required

Tracking number from the shipping provider. Merchants must provide this tracking number to properly track the statuses of the shipment.

destination

object

Destination location of the shipment associated to the package.

source

object

Source location of the shipment associated to the package.

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.

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 addition.

404The specified resource was not found

500Internal server error