EXextend
Products

List products

Returns a product array. Follow the next URL in the Link response header with the same Accept and access token headers until Link is absent. Internal OEM/category filters are unavailable to merchant tokens. Requires one of stores:products:view, stores:products:full, stores:products:list, for the store account.

get/stores/{storeId}/products

Request

  • Base URL
    https://api.helloextend.com
  • URL
    https://api.helloextend.com/stores/{storeId}/products
  • Auth
    API key in header X-Extend-Access-Token

Query parameters

limitinteger

Page size. The endpoint defaults to 500.

pageCursorstring

Opaque cursor from the previous Link header. Do not construct cursors.

Response

Success

brandstring

The Product Brand, Manufacturer or Vendor.

categorystring

Product category. Can be any value and may be used by Extend to map the product to warranty plans.

descriptionstring

The product description.

enabledboolean
modelNumberstring
condition'new' | 'used' | 'refurbished'
imageUrlstring

A url pointing to the primary image for the product.

titlestring required

Product name.

referenceIdstring required

Unique product identifier, such as a SKU or variant ID. URL-encode it when using an item endpoint.

parentReferenceIdstring

Parent product referenceId for a variant.

plansstring[]
warrantyStatus'pending' | 'warrantable' | 'non-warrantable' | 'review_required'
shipEnabledboolean

Indicates whether or not the product is enabled for Extend shipping protection coverage. Differs from the shippable property in that it could be a product that is physically shipped but the product type or category is not eligible for Extend shipping protection. Set by Extend.

shippableboolean

Whether the item is physically shipped. Defaults to true. Digital goods and services are ineligible for shipping protection.

storeIdstring required
createdAtnumber

Unix timestamp in milliseconds.

updatedAtnumber

Unix timestamp in milliseconds.

deletedAtnumber nullable
metadataobject
oemStatus'INELIGIBLE' | 'MAPPED' | 'NEEDS_REVIEW'
oemPolicyIdstring
oemCoverageIdstring
planCategoryIdstring
planCategoryNamestring
status'new' | 'updated' | 'active' | 'inactive'

Optional legacy product status, distinct from warrantyStatus.

Changes

No recorded changes to this operation across all 1 revision of this API.