API Reference

Create / update a product

post
https://api.helloextend.com/stores//products

This will create a product if it doesn't exist or update a product that does.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier for a store on Extend

Query Params
boolean

Use the value true if passing a batch of products.

Body Params
string

The Product Brand, Manufacturer or Vendor.

string

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

subCategories
array

An array of additional product categories.

subCategories
string
length ≤ 2000

The product description.

string
itemDimensions
object
itemWeight
object
string
enum
Allowed:
string

A url pointing to the primary image for the product.

price
object

The base retail price of the product (in cents for USD). Price is required to sell warranties on a product.

string
required
length between 1 and 255

Product name.

string
required

This is the unique identifier that identifies the product. This can be a product SKU, or variant id. A referenceId may contain special characters except for the following: %, \, ". Special characters should not be at the end of a referenceId.

string

This is the id of the parent product, if there is one. This allows nesting of a single parent product with multiple variants (such as multiple color options for the same product).

reimbursementAmount
object
identifiers
object
mfrWarranty
object

Information about the manufacturer's warranty. This is optional, but if you can provide it please do as it can significantly speed up the warranty matching process.

boolean

Designates items that are physically shipped to your customers. Items that are not shipped, like digital goods or services, are not eligible for shipping protection. Defaults to true if not explicitly set.

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.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago