API Reference
Start typing to search…

Add Line Item to Order

post
https://api.helloextend.com/orders//line-item

This endpoint allows the addition of a single line item to an existing order using the Extend Order ID. Merchants may want to add a line item to an order in the event an order was not completed with a customer or the customer purchased additional products on their existing order. This may also be used in cases where we have to cancel an existing line item because there was an issue or inaccurate data with the original line item and a new line item needs to be created.

Path Params
uuid
required

Unique identifier for an Extend Order

Body Params
string

Unique identifier provided by the merchant for querying.

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.

string

Unique identifier for the offer used for a contract.

plan
object
required

Information about the plan being purchased.

product
object
required

Information about the product purchased. Note - Products can be created and updated directly from the order for configured merchants. Please work with your merchant success manager for more information.

string
enum

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.

integer
≤ 9007199254740991

Quantity of product purchased.

number

Number of products that have been fulfilled.

integer
0 to 9007199254740991

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

integer
0 to 9007199254740991

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

boolean

Indicates whether a return and exchange resolution entitlement should be created.

analytics
object

Contains additional information about an order line item that helps with reporting and analytics.

Headers
string
required

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

string
required

An Extend private API key used to authenticate requests.

uuid
required

Randomly generated string (recommended v4 UUID) to ensure idempotent requests. See Idempotent 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

Updated 7 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago