Create / update a product

post

https://api.helloextend.com/stores/{storeId}/products

Upserts by referenceId. Omit batch for a single object. Supply ?batch=true and an array for batch upserts; any non-empty batch value enables batch mode, including false. Use batches of about 100 products. Inspect errors and retryable even when the response is 201. Duplicate referenceIds in one batch return 422. Requires one of stores:products:create, stores:products:full, for the store account.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

storeId

string

required

Store owned by the account in the access token.

Query Params

batch

string

Omit for a single product. Set to true for an array of products. Any non-empty value, including false, enables batch mode.

Body Params

brand

string

The Product Brand, Manufacturer or Vendor.

category

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

description

string

length ≤ 2000

The product description.

modelNumber

string

itemDimensions

object

itemWeight

object

condition

string

enum

Allowed:

imageUrl

string

A url pointing to the primary image for the product.

price

object

title

string

required

length between 1 and 255

Product name.

referenceId

string

required

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

parentReferenceId

string

Parent product referenceId for a variant.

reimbursementAmount

object

identifiers

object

mfrWarranty

object

Optional manufacturer warranty details used for warranty matching.

shippable

boolean

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

alternateLanguages

object

unitCost

object

enabled

boolean

Accepted for compatibility, but ignored in merchant requests.

plans

array of strings

Accepted for compatibility, but ignored in merchant requests.

plans

warrantyStatus

string

enum

Accepted for compatibility, but ignored in merchant requests.

Allowed:

shipEnabled

boolean

Accepted for compatibility, but ignored in merchant requests.

settings

object

Accepted for compatibility, but ignored in merchant requests.

extendProductCategoryId

string

Accepted for compatibility, but ignored in merchant requests.

extendProductCategory

string

Accepted for compatibility, but ignored in merchant requests.

resellable

boolean

Accepted for compatibility, but ignored in merchant requests.

marginPercentage

number

Accepted for compatibility, but ignored in merchant requests.

oemStatus

string

enum

Accepted for compatibility, but ignored in merchant requests.

Allowed:

oemPolicyId

string

Accepted for compatibility, but ignored in merchant requests.

oemCoverageId

string

Accepted for compatibility, but ignored in merchant requests.

oemEnabled

boolean

Accepted for compatibility, but ignored in merchant requests.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json