v1

latestOpenAPI 3.1.02026-07-24531573.9 KB
Products

Update a product

Updates a product with the provided product ID.

put/products/{id}

Request body

titlestring

Title of the product.

descriptionstring

Detailed description of the product.

type'physical' | 'digital'

Type of the product.

stockQuantityinteger

Stock quantity of the product.

shippingPayer'sellerPays' | 'buyerPays'

Represents who pays for shipping during dispatch or delivery.

singleOptionboolean

Represents whether a single option or multiple options can be selected during chekout.

customListingboolean

Represents whether the listing is a custom or standard one.

customNotestring

Overrides the placeholder for note to seller field. Used for collecting a custom information from the buyer during checkout.

placementScoreinteger

Placement score of the product. Products with higher values are placed first in the store.

dispatchDurationinteger

Dispatch duration in terms of days from seller to shipping company.

Response

OK

idstring

The ID of the product.

titlestring

Title of the product.

descriptionstring

Detailed description of the product.

type'physical' | 'digital'

Type of the product.

dateCreatedstring

The date and time of the initial product listing. yyyy-MM-ddTHH:mm:ssZ format is used (e.g., 2022-07-21T13:24:51+0300).

dateUpdatedstring

The date and time of the product update. yyyy-MM-ddTHH:mm:ssZ format is used (e.g., 2022-07-21T13:24:51+0300).

urlstring

The URL of the product. (e.g., https://www.shopier.com/696547)

stockStatus'inStock' | 'outOfStock'

Current stock status of the product.

stockQuantityinteger

Current stock quantity of the product.

shippingPayer'sellerPays' | 'buyerPays'

Represents who pays for shipping during dispatch or delivery.

singleOptionboolean

Represents whether a single option or multiple options can be selected during chekout.

customListingboolean

Represents whether the listing is a custom or standard one.

customNotestring

Overrides the placeholder for note to seller field. Used for collecting a custom information from the buyer during checkout.

placementScoreinteger

Placement score of the product. Products with higher values are placed first in the store.

dispatchDurationinteger

Dispatch duration in terms of days from seller to shipping company.