v1

latestOpenAPI 3.0.12026-07-243902.3 MB

Line Items

Cancel an Order Line Item

This endpoint enables order line item cancelation using the Extend Line Item ID. Order line items may need to be canceled if only one or several line items have been canceled on the merchant’s order. Line items may also need to be canceled when associated extended warranty or shipping protection Extend contracts need to be canceled.

When an order line item cancelation request is made, a cancelation request will be made to any associated Extend contract on the line item. Here are helpful definitions that could be updated on the order line item status after a cancelation request is made:

canceled - The order line item has been canceled. When a line item is canceled, this will trigger a cancellation of an associated Extend contract on the line item.
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).

post/line-items/{lineItemId}/cancel

Path parameters

lineItemIdstring uuid required

Example:cc957cb3-3d5d-430b-90a2-9ec96ee4c3cf

Unique identifier for an Extend Order Line Item

Headers

Content-Typestring required

Example:application/json

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

X-Extend-Access-Tokenstring required

Example:ExtendAccessToken

An Extend private API key used to authenticate requests.

Acceptstring required

Example:application/json; version=2022-02-01

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.

Response

Successful line item cancelation. Note - This is an example response for an extended warranty contract.

Example response

{
  "lineItems": [
    {
      "contractId": "c57ed096-24ef-49a4-a20a-d1b8bf770980",
      "lineItemTransactionId": "c57ed096-24ef-49a4-a20a-d1b8bf770980",
      "offerId": "7cdabc72-227d-8f76-a9e7-c91de35c2781",
      "offerPlanId": "c57ed096-24ef-49a4-a20a-d1b8bf770980",
      "plan": {
        "id": "10001-misc-elec-adh-replace-1y",
        "purchasePrice": 1999,
        "termsId": "12A",
        "termsVersion": "2",
        "version": "2"
      },
      "product": {
        "deliveryStatus": "shipped",
        "id": "SKU-123-456",
        "purchasePrice": 1999,
        "serialNumber": "123SAD3",
        "purchaseDate": 1652403703000,
        "listPrice": 1999,
        "name": "Shiny Hat 2",
        "mfrWarranty": {
          "url": "https://www.manufacturer.com/warranty"
        },
        "parentReferenceId": "550e8400-e29b-41d4-a716-446655440000"
      },
      "leadToken": "c57ed096-24ef-49a4-a20a-d1b8bf770980",
      "id": "3f87b162-3462-4c0c-bb9c-af2b14e025c3",
      "accountId": "3f87b162-3462-4c0c-bb9c-af2b14e025c3",
      "status": "fulfilled",
      "storeId": "3f87b162-3462-4c0c-bb9c-af2b14e025c3",
      "orderId": "3f87b162-3462-4c0c-bb9c-af2b14e025c3",
      "transactionId": "3f87b162-3462-4c0c-bb9c-af2b14e025c3",
      "isProductWarrantabilityVerified": true,
      "fulfilledAt": 1652402394000,
      "refundedAt": 1652402394000,
      "cancelledAt": 1652402394000,
      "createdAt": 1652402394000,
      "updatedAt": 1652402394000,
      "discountAmount": 399,
      "taxCost": 199,
      "adjustments": {
        "calculatedListPrice": 5999,
        "originalPlanId": "3f87b162-3462-4c0c-bb9c-af2b14e025c3"
      },
      "contractFailedReasons": [
        "Contract line requested more coverage than available quantities on the order for at least one product"
      ],
      "analytics": {
        "fulfillmentMethod": "BOPIS"
      }
    }
  ]
}