QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
REFERENCE
API Overview
v1
Orders
Create an order
post
Get an order
get
Update an order
patch
Products
Create a product
post
Get a product
get
Update a product
patch
Stores
Create a store
post
Get a store
get
Update a store
patch
Webhook Server Overview
v1
GDPR
Receive GDPR webhooks
post
Model
Envelope
Meta
v1
Error
v1
Pagination
v1
Primitive
Address
v1
Customer
v1
Money
v1
Shipment
v1
Weight
v1
StoreAddress
v1
Resource
Order
v1
OrderItem
v1
Product
v1
Store
v1
Support
Contact Support

Update a product

patch
/products/{id}

Update product by ID.

Request

Path Parameters

id
string
required

Product ID

Headers

as-store-id
string

The identifier of your store. It is not the store ID generated by AfterShip.

Body

title
string

The title of the product.

<= 1024 characters
slug
string

URL friendly unique identifier for the product. It is different from the order slug.

<= 1024 characters
categories
array[string]

The categories of a shop.

<= 100 items
tags
array[string]

Tags that are used for filtering and search.

<= 100 items
image_urls
array[string]

URLs of the images.

<= 100 items
url
string

URL of a product.

<= 2048 characters
published
boolean

To indicate whether a product has been published.

description
string

Description of a product.

<= 10240 characters
source_updated_at
string
required

The date and time when the product was last modified. ISO 8601.

Auth
:
Parameters
:
:
Body
preparing...