Product - AfterShip Commerce API

The Product model represents an individual item of your store. It includes essential attributes such as product title, price, variants, SKU, and so on. This model is crucial for cataloging and managing the store's inventory effectively.

string

read-onlyrequired

The unique identifier of the product. If a custom ID was provided in the request, that value is used; otherwise, a system-generated UUID is assigned. You can use this ID to manage this resource in related API calls.

Example:

fbc7245f23494576829c4b00609cf1ab

store

object

Indicate which store the product belongs to.

string

read-only

The store ID by AfterShip. Please refer to the store resource for the details.

Example:

0ecb8ff7efa84d7d8f763ed7b21851d1

title

string

required

The title of the product.

Example:

Power Mobile Phone

slug

string

URL friendly unique identifier for the product.

Example:

power-mobile-phone

tags

array[string]

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

image_urls

array[string]

required

URLs of the product images.

url

string

The URL of the product page in your online storefront.

Example:

https://example.com/product/image.png

published

boolean

To indicate whether the product has been published.

Default:

true

description

string

Description of the product.

variants

array[product_variant.v1]

required

Product variant information.

>= 1 items

string

A unique identifier for the product variant in your system.

<= 32 characters

Example:

5634477687

available_quantity

integer

Available quantity of the product variant.

Example:

sku

string

The product SKU of the product variant.

<= 1024 characters

Example:

SKU001

title

string

The title of the product variant.

<= 1024 characters

Example:

Power Mobile Phone

price

string

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.

<= 100 characters

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

created_at

string

The date and time, formatted in ISO 8601, indicating when the product was created in AfterShip system.

Example:

2021-04-15T20:02:09Z

updated_at

string

The date and time, formatted in ISO 8601, indicating when the product was updated in AfterShip system.

Example:

2021-04-15T20:02:09Z