DocumentationAPI ReferenceChangelog
Log In
Documentation

Orders API

Custom preferences

  1. Go to Business Manager → Merchant Tools → Site Preferences → Custom Preferences → Extend: Integration Preferences
  2. Configure the provided Extend credentials in the following fields (refer to Section 2.2 for additional info):
    • Extend Access Token
    • Extend Store ID
  3. Configure the following Orders API specific preferences:
    • Extend Integration Method: set this to Orders API on Order Create (please confirm with the Extend project team before changing versions).

Testing

  1. LeadToken:
    Go to PDP → Choose product variation → Click “Add to Cart” button without an Extend Protection Plan (LeadTokens are only generated for warrantable products if the customer did not elect to protect their purchase originally) → Go to cart → Go to checkout page → Make a purchase.
    Result:
    Go to Merchant Tools → Ordering → Orders → Choose Your Order → Shipment → Choose ProductLineItem → Attributes

  1. Extend Contract ID:
    Go to PDP → Choose product variation → Choose an extension plan → Click “Add to Cart” button with an Extend Protection Plan→ Go to cart → Go to checkout page → Make a purchase.
    Result:
    Go to Merchant Tools → Ordering → Orders → Choose Your Order → Shipment → Choose ExtendLineItem → Attributes

  1. Refund status:
    • Go to Merchant Tools → Ordering → Orders → Choose an Order with at least 1 created Extend Contract ID → Order Status → Choose “Cancelled” → Click “Apply” button.
    • Then Go To Administration → Operations → Jobs → “Create Refund from SFCC” → Click “Run Now” button.
      Result:
      Go to Merchant Tools → Ordering → Orders → Choose Your Order → Shipment → Choose ExtendLineItem → Attributes:

Go to Merchant Tools → Ordering → Orders → Choose Your Order → Attributes:

Refund Statuses:
refund_quoted: Refund amounts have been previewed by merchant/customer at least once, but merchant has not reported that they have refunded the customer yet.
refund_paid: Refund has been reported as paid by the merchant. Contract is canceled. Finance will credit the merchant in the next monthly invoice.
refund_denied: Customer is not eligible for a refund. Customer has consumed all entitlements associated with the contract.Get Refund via Contract ID.
ERROR: service call error.