Create a product - AfterShip Commerce API

Create a product.

If you receive an error message stating "Precondition failed, the store not found.", please first create a store using the Create a store API.

Request

Security: API Key

Headers

as-store-id

string

required

The unique store identifier is generated by AfterShip. You can obtain this id by making a GET /stores call to get existing stores or a POST /stores to create a new store.

Body

source_id

string

required

A unique identifier for the product.

<= 32 characters

Example:

546735673

title

string

required

The title of the product.

<= 1024 characters

Example:

Power Mobile Phone

slug

string

URL friendly unique identifier for the product.

<= 1024 characters

Example:

power-mobile-phone

tags

array[string]

The tags associated with the product, used for filtering and search purposes.

<= 100 items

image_urls

array[string]

required

URLs of the product images.

<= 100 items

url

string

The URL of the product page in your online storefront.

<= 2048 characters

Example:

https://example.com/product/

published

boolean

To indicate whether the product has been published.

Default:

true

description

string

Description of the product.

<= 10240 characters

variants

array[object]

required

Product variant information.

>= 1 items<= 500 items

source_id

string

required

A unique identifier for the product variant.

<= 32 characters

Example:

5634477687

available_quantity

integer

Available quantity.

Example:

sku

string

required

The product SKU of the product variant.

<= 256 characters

title

string

required

The title of the product variant

<= 1024 characters

Example:

Power Mobile Phone

price

string

required

The price of the product variant.

<= 100 characters

Example:

image_urls

array[string]

The product image URL of the product variant.

<= 100 items

compare_at_price

string

The original price of the item before an adjustment or a sale.

weight

Weight

The weight information of the product variant.

Example:

{"unit":"kg","value":10}

allow_backorder

boolean

To specify whether customers are permitted to place an order for this out-of-stock product variant.

options

array[object]

The custom product variant properties, such as size, color, and material.

>= 1 items

source_created_at

string

The date and time, formatted in ISO 8601, indicating when the product was created in your e-commerce system.

Example:

2021-04-15T20:02:09Z

source_updated_at

string

The date and time, formatted in ISO 8601, indicating when the product was updated in your e-commerce system.

Example:

2021-04-15T20:02:09Z