Get Product Details

This endpoint is used to return information about a particular product to the user.

TIP

The get details endpoint has been implemented in the Product Options Web Component, and It's all setup to save developer's time and effort.

Payload

GetDetailsPayload

product_id

number

required

The id of the product which its details will be returned.

advancedItems

array [object]

required

An array contains a collection of the returned details.

Allowed values:

imagesbrandtagsnotify_availabilityratingdonationoptionssold_quantitycategory

Response

Success

Error

product.getProductDetails.success

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

data

object

Data is available when the success is `true`

optional

number

optional

This field contains the unique identifier for the product.

promotion

object

optional

This field contains information about any current promotions for the product.

sku

string

optional

This field contains the product's SKU (stock keeping unit) number.

mpn

string

optional

This field contains the product's manufacturer part number.

gtin

string

optional

This field contains the product's global trade item number.

type

string

optional

This field contains the type of product.

name

string

optional

This field contains the name of the product.

short_link_code

string

optional

This field contains the short link code for the product.

urls

object

optional

This field contains URLs for the customer-facing and admin-facing pages for the product.

price

object

optional

This field contains the current price of the product.

taxed_price

object

optional

This field contains the price of the product after taxes.

pre_tax_price

object

optional

This field contains the price of the product before taxes.

tax

object

optional

This field contains the amount of taxes applied to the product.

description

string

optional

This field contains a description of the product.

quantity

string

optional

This field contains the quantity of the product available for sale.

status

string

optional

This field contains the status of the product.

is_available

boolean

optional

This field indicates whether the product is currently available for purchase.

views

string

optional

This field contains the number of views the product has received.

sale_price

object

optional

This field contains the sale price of the product, if applicable.

sale_end

string

optional

This field contains the end date of any current sales for the product.

require_shipping

boolean

optional

This field indicates whether the product requires shipping.

cost_price

string

optional

This field contains the cost of the product.

weight

number

optional

This field contains the weight of the product.

weight_type

string

optional

This field contains the type of weight measurement used for the product.

weight_label

string

optional

This field contains the label for the product's weight.

with_tax

boolean

optional

This field indicates whether taxes are included in the product price.

included_tax

boolean

optional

This field indicates whether the tax amount is included in the product price.

url

string

optional

This field contains the URL for the product's page.

main_image

string

optional

This field contains the URL of the product's main image.

images

array[object (images)]

optional

This field contains an array of additional images for the product.

show_purchase_count

string

optional

This field indicates whether the product's purchase count is displayed.

sold_quantity

number

optional

This field contains the number of units of the product that have been sold.

sold_quantity_desc

string

optional

This field contains a description of the product's sold quantity.

rating

object

Rating

optional

This field contains information about the product's rating.

favorite

string

optional

This field contains information about whether the product has been favorited.

has_special_price

boolean

optional

This field indicates whether the product has a special price.

regular_price

object

optional

This field contains the regular price of the product.

features

object

optional

This field contains information about the features of the product.

maximum_quantity_per_order

number

optional

This field contains the maximum quantity of the product that can be ordered per order.

show_in_app

boolean

optional

This field indicates whether the product is shown in the app.

has_size_guide

boolean

optional

This field indicates whether the product has a size guide.

notify_quantity

string

optional

This field contains the quantity at which to notify customers of low stock.

hide_quantity

boolean

optional

This field indicates whether the product quantity is hidden.

unlimited_quantity

boolean

optional

This field indicates whether the product has unlimited stock.

managed_by_branches

boolean

optional

This field indicates whether the product is managed by branches.

services_blocks

object

optional

This field contains information about services associated with the product.

calories

string

optional

This field contains information about the calories in the product.

customized_sku_quantity

boolean

optional

This field indicates whether the SKU quantity for the product is customizable.

options

array[object (Option) {17}]

optional

This field contains an array of options associated with the product.

skus

array [object {14}]

optional

This field contains an array of SKUs associated with the product.

Usage

To perform the action of retrieving product details, the developer may call the method getDetails() as follows:

Events

This endpoint may trigger two events, the onDetailFetched and onDetailFetchFailed events.

onDetailFetched

This event is triggered when the action of retrieving product details is done without having any errors coming back from the backend.

onDetailFetchFailed

This event is triggered when the action of retrieving product details is not completed and an error has occurred.

Payload#

Response#

Usage#

Events#

onDetailFetched#

onDetailFetchFailed#

Payload

Response

Usage

Events

onDetailFetched

onDetailFetchFailed