Sign in

v1

latestOpenAPI 3.0.12026-07-243902.3 MB
Line Items

Update Line Item Fulfillment Status

Updates the status of a Line Item to 'fulfilled', if applicable creation of associated contracts is triggered using the product and plan information associated with the Line Item.<div class='wrapper important'><h3>Important:</h3>A Line Item Fulfillment Status can only be updated from 'unfulfilled' to 'fulfilled'. Once updated to 'fulfilled', a Contract is created immediately and can only be undone by refunding the Contract.</div>

post/line-items/fulfill

Query parameters

fulfillAllstring
Example:true

Sending a value of 'true' in this parameter will fulfill all associated line items to a Line Item Transaction ID with a single API request.

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.

Request body

OR

Response

Successful line item fulfillment.

OR
OR
OR
OR
OR
OR
OR

Example response

{
  "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"
  },
  "contract": {
    "accountId": "f36feabf-d024-431f-9506-32bfcada1231",
    "adminContractId": "1001609401",
    "adminSyncError": "Update Error: PcmiError: Contract plan expected price is not set, try re-syncing",
    "adminSyncStatus": "synced",
    "cancelledAt": 1651787627000,
    "createdAt": 1651787624000,
    "coverage": {
      "starts": 1651787621000,
      "ends": 1683323621000
    },
    "customer": {
      "billingAddress": {
        "address1": "535 Mission Street",
        "address2": "11th Floor",
        "city": "San Francisco",
        "countryCode": "US",
        "postalCode": "94526",
        "provinceCode": "CA"
      },
      "email": "bobross@gmail.com",
      "name": "Bob Ross",
      "phone": "123-456-7890",
      "shippingAddress": {
        "address1": "535 Mission Street",
        "address2": "11th Floor",
        "city": "San Francisco",
        "countryCode": "US",
        "postalCode": "94526",
        "provinceCode": "CA"
      },
      "type": "consumer",
      "locale": "en-US",
      "region": "US",
      "subdivision": "CA"
    },
    "formId": "1ADJ",
    "id": "cc957cb3-3d5d-430b-90a2-9ec96ee4c3cf",
    "isProductWarrantabilityVerified": true,
    "limitOfLiabilityAmount": 1999,
    "limitOfLiabilityAmountType": "product_purchase_price",
    "listPrice": 1999,
    "orderId": "9778f161-9530-491a-bfdc-5c45214c0a6c",
    "plan": {
      "id": "10001-misc-elec-adh-replace-1y",
      "skuId": "EXT123",
      "termsId": "154ebea0-6c1b-46a4-b166-032246330526",
      "termsVersion": "1",
      "version": 1
    },
    "product": {
      "fulfillmentDate": 1651787629000,
      "listPrice": 3999,
      "manufacturerWarrantyLengthLabor": 6,
      "manufacturerWarrantyLengthParts": 6,
      "purchaseDate": 1651787629000,
      "purchasePrice": 3999,
      "referenceId": "SKU-123-456",
      "reimbursementAmount": 3999,
      "serialNumber": "ABCD123456",
      "name": "Wireless Headphones",
      "transactionId": "6789876212"
    },
    "purchaseCurrency": "USD",
    "purchaseDate": 1651787620000,
    "purchasePrice": 1999,
    "refundedAt": 1651787679000,
    "resellerMerchant": {
      "id": "154ebea0-6c1b-46a4-b166-032246330526",
      "name": "Acme Reseller Company",
      "domain": "https://acme.reseller.com"
    },
    "sellerId": "598b11f3-5514-42f8-bdd5-e13ae866635a",
    "sellerName": "Quality Crafts",
    "status": "live",
    "transactionId": "123928374327464",
    "type": "pcrs",
    "updatedAt": 1651787679000
  }
}