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.

Responses

Response body

object

quoteId

string

required

Unique identifier for the quote provided when a shipping protection offer is made.

premium

number

≥ 0

Purchase price or premium of shipping protection

shipmentInfo

array of objects

required

length ≤ 500

shipmentInfo*

object

destination

object

Destination location of the shipment associated to the package.

lineItemId

string

Unique identifier for the Extend order line item.

lineItemTransactionId

string

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

number

required

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.

source

object

Source location of the shipment associated to the package.

trackingId

string

required

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

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.

contractId

string

Unique identifier associating a generated contract to a line item. This field can be optionally generated by the merchant as a GUID. NOTE: You must be an approved merchant to send a unique identifier for Extend contracts. Please reach out to your merchant success manager for more details.

charitableDonation

object

An object that stores data related to a charitable donation that a customer made.

string

required

Unique identifier for the charity organization.

donationAmount

number

required

≥ 0

Amount donated to the charity organization.

Should be expressed in terms of the smallest currency unit.

$19.99 would be 1999
1.234,56 € would be 123456
£ 1,999.99 would be 199999

name

string

Name of the charity organization.

lineItemTransactionId

string

Unique identifier from the merchant’s system for the order line item.

discountAmount

number

≥ 0

Discount amount applied for the product line item. NOTE - If you have multiple quantities for this line item, only provide the amount for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit.

$19.99 would be 1999
1.234,56 € would be 123456
£ 1,999.99 would be 199999

taxCost

number

≥ 0

Tax cost associated to the product line item. NOTE - If you have multiple quantities for this line item, only provide the cost for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit.

$19.99 would be 1999
1.234,56 € would be 123456
£ 1,999.99 would be 199999

type

string

required

contract lead non_warrantable shipments

lineItemIds

array of strings

lineItemIds

offerId

string

Unique identifier of the offer made for a product or cart identifier for the order line item. This will be be used for analytics like AB testing experiments.

offerPlanId

string

Unique identifier for the offer used for a contract.

accountId

string

Unique identifier for the account associated with the order line item creation.

orderId

string

Unique identifier provided by merchant for transaction associated to Extend order.

string

Unique identifier for line item in Extend's system.

transactionId

string

Unique identifier provided by merchant for transaction associated to Extend order.

storeId

string

Unique identifier for merchant’s store in Extend’s system.

status

string

Status of the line item.

canceled - The order line item has been canceled. When a line item is canceled, a cancellation of an associated Extend contract will be triggered.
cancel_failed - The attempt to cancel the order line item has failed. This is typically due to logic in Extend’s system preventing the cancelation (e.g. attempt to cancel a line item when there is an associated shipment).
contract_failed - The attempt to create an Extend contract from the order line item has failed. This is typically due to expected fields or values being invalid or incorrect on the order line item, specifically at the product, plan, or offers level.
contract_pending - A contract that will be created from the order line item is pending a wait period provided on the order.
fulfilled - The product on the order line item has been fulfilled. Once an order line item is in the fulfilled status, any associated Extend contract to the line item will be created.
lead_failed - The attempt to create an Extend lead contract from the order line item has failed. This is typically due to expected fields or values being invalid or incorrect on the order line item.
quote_failed - The attempt to create a shipping protection contract from the order line item has failed. This is typically due to expected fields or values being invalid or incorrect on the order line item.
pending - An order line item that has been created where the order has a wait period value. This is typically used to create an order that requires a certain time period to pass before it is considered a valid order.
refunded - A successful refund has been made by the merchant to the customer on the order line item.
unfulfilled - An order line item has been created but the product associated has not been fulfilled yet.

canceled cancel_failed contract_failed contract_pending fulfilled lead_failed quote_failed pending refunded unfulfilled

fulfilledAt

number

Date the line item was fulfilled. NOTE - This field is formatted as a 13 digit Epoch timestamp

createdAt

number

Date the line item was created. NOTE - This field is formatted as a 13 digit Epoch timestamp

updatedAt

number

Date the line item was updated. NOTE - This field is formatted as a 13 digit Epoch timestamp

adjustments

object

Contains different fields related to adjustments made that should be tracked for analytics purposes.

adjustedQuoteId

string

A new Quote ID that was generated by the Orders service when a product mismatch or other discrepancy was detected from the original Quote ID.

calculatedListPrice

number

The calculated expected list price for a contract on the order that may need to be referenced during order line item fulfillment.

isCreateQuote

boolean

A flag that indicates no Quote ID was provided for a shipping protection contract and one was generated automatically by the Orders service.

previousContracts

array of strings

previousContracts

productsRemoved

array of objects

productsRemoved

object

quantity

number

referenceId

string

newPremium

number

Premium of new shipping quote if partially refunded.

isCreateQuote

boolean

A flag that indicates no Quote ID was provided for a shipping protection contract and one was generated automatically by the Orders service.

contractFailedReasons

array of strings

List of reasons of why the contract failed to be created.

contractFailedReasons

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.helloextend.com/line-items/shipments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful shipment info addition.

404The specified resource was not found

500Internal server error