Retail Express API 2.1

ProductSalesChannelVM

object
* Additional properties are NOT allowed.
idinteger(int32)

Channel Id.

namestring

Channel Name.

shopify_channelboolean

Shopify Channel.

source_groupobject
* Additional properties are NOT allowed.
Show Child Parameters
enabledboolean

Enabled.

Example

Product

object

Product Model

* Additional properties are NOT allowed.
carton_quantityinteger(int32)

Carton quantity

cogs_exnumber(double)

Cogs ex

cubicnumber(double)

Cubic

direct_costs_exnumber(double)

Direct costs

prevent_disablingboolean

Is product disabled

promotional_price_incnumber(double)

Discount price

promotional_price_expirystring(date-time)

Discount price expiry

freight_incnumber(double)

Freight inc

rrp_incnumber(double)

Rpr inc

sell_price_incnumber(double)

Sell Price, cannot be used along with markup_target

>= -922337203685477.6<= 922337203685477.6

web_price_incnumber(double)

Web price

markup_targetnumber(double)

Markup Target %, cannot be used along with sell_price_inc

breadthnumber(double)

Breadth

>= -9999.9999<= 9999.9999

core_productboolean

Is core product flag

custom_propertiesarray[object]

Custom Property Model

* Additional properties are NOT allowed.
Show Child Parameters
depthnumber(double)

Depth

>= -9999.9999<= 9999.9999

disabledboolean

Disabled

idinteger(int32)

Product id.

lead_timeinteger(int32)

Lead time

lengthnumber(double)

Length

>= -9999.9999<= 9999.9999

loyalty_rationumber(double)

Loyalty Ratio

manufacturer_skustring

Manufacture SKU

product_typeobject

Product Type Model

* Additional properties are NOT allowed.
Show Child Parameters
requires_assemblyboolean

Requires Assembly

shipping_cubicnumber(double)

Shipping Cubic

>= -999999.9999<= 999999.9999

short_descriptionstring

Product description.

supplierobject

Product Supplier model

* Additional properties are NOT allowed.
Show Child Parameters
supplier_buy_exnumber(double)

Supplier Buy Ex

>= -922337203685477.6<= 922337203685477.6

supplier_skustring

Supplier SKU.

supplier_sku2string

Supplier SKU2.

weightnumber(double)

Weight

>= -99999999.9999<= 99999999.9999

buy_price_exnumber(double)

Buy price ex

long_descriptionstring

Long description

voucher_productboolean

Voucher product

max_discount_ruleobject

Max Discount Rule Model

* Additional properties are NOT allowed.
Show Child Parameters
replenishment_methodobject
* Additional properties are NOT allowed.
Show Child Parameters
attributesarray[object]

Product attributes

* Additional properties are NOT allowed.
Show Child Parameters
created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

inventoryarray[object]

Product Inventory Model

* Additional properties are NOT allowed.
Show Child Parameters
sales_channelsarray[object]

Product Sales Chanels

* Additional properties are NOT allowed.
Show Child Parameters
export_to_webboolean

Export To Web

packageboolean

Package

Example

Product.PagingResponse

object
* Additional properties are NOT allowed.
dataarray[object]

Product Model

* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
Example

ProductType.PagingResponse

object
* Additional properties are NOT allowed.
dataarray[object]

Product Type Model

* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
Example

ShipmentType

object

Shipment Type model

* Additional properties are NOT allowed.
idinteger(int32)

Identifier

namestring

name

>= 0 characters<= 50 characters

Example