Items


An Item usually refers a physical item that Merchant sell to the Consumer. In Bespoke, it can mean an item object, for example a physical product, a classified listing and a service listing without calendar etc. If your Item needs a calendar engine attached to it, like a hotel booking, rental space booking - any service which involves time - please do refer to our Item (Spacetime).


Arcadier Item resources allow you and your Merchants to create products in Marketplace.


Items in Bespoke can posses various variants, which are basically different “models” of the same item. (Example: Size, Color, etc.). You can also add or update images to your items, as well as prices, shipping methods, pickup methods, and every detail a buyer would want to have about an item.


Admins and merchants have access inventory details about their items, like identification numbers, stock numbers, visibility, purchasability.



Property Table

Items Properties

Property Names Property Type Description
ID

Optional

integer

"ID": 5501

Unique identification number of the specific endpoint. Please refer to the specific endpoint for better clarification.

ItemId

Optional

integer

'ItemId': 5501

Unique identification number of the item.

SKU

Optional

string

"SKU": "1319446"

Stock keeping unit (SKU) is a product or service identification code for a product, often displayed as a machine-readable bar. This can be used to integrate with other stock keeping systems.

ItemName

Optional

string

"ItemName": "Nike Epic React Flynit"

The name of the item.

BuyerDescription

Optional

string

"BuyerDescription": "The Nike Epic React Flyknit Men's Running Shoe provides crazy comfort that lasts as long as you can run."

The description of the item product.

Description

Optional

string

"Description": "The Nike Epic React Flyknit Men's Running Shoe provides crazy comfort that lasts as long as you can run."

The description of the item.

CategoryId

Optional

integer

"CategoryId": 4581

The item category unique identification number.

CategoryName

Optional

string

"CategoryName": "Men's Shoes"

The item category name.

SubCategoryId

Optional

integer

"SubCategoryId": 45812

The item sub category unique identification number.

SubCategoryName

Optional

string

"SubCategoryName": "Sports Shoes"

The item sub category name.

Please note that concerning Arcadier’s categories, “Child” and “Sub” mean the same thing.

FileIds

Optional

Array[integer]

"FileIds": [ "4590", "4591"]

The list of image id of the item.

Images

Optional

Array[ImageObject]

"Images": [
{
  "FileId": 4590,
  "Image": "images/items/items-7781-epicreact.jpg"
}
]

The list of item image object.

Please refer to Images Properties for more information.

Images

Optional

Array[string]

"Images": [
 "images/items/items-7781-epicreact.jpg"
]

The list of item images

CurrencyCode

Optional

string

"CurrencyCode": "USD"

The currency code of the item price based on ISO 4217
(https://en.wikipedia.org/wiki/ISO_4217)

AverageRating

Optional

number

"AverageRating": 5

The average rating of the item. Range of rating from 1 to 5.
1 means Unsatisfied while 5 means Excellent.

ShippingMethods

Optional

Array[ShippingMethod Object]

"ShippingMethods": [
 {
    "Id": 6601,
    "Description": "Q-Express",
    "CurrencyCode": "USD",
    "Price": 4,
    "CombinedPrice": 3,
    "DeliveryType": "delivery"
    "Active": true
}
]

The shipping methods is a list of shipping options that are provided for the item.

Please refer to ShippingMethod Properties for more information.  

PickupAddresses

Optional

Array[PickupAddress Object]

"PickupAddresses": [
{
  "Id": 8010,
  "Address": "26 Rosewood St. Malden, MA 02148",
  "DeliveryType": "pickup"
}
]

The pickup addresses is a list of pickup address option for the item.

Please refer to PickupAddresses Properties for more information.  

IsVisibleToCustomer

Optional

boolean

"IsVisibleToCustomer": true

If the value is set to true, then the item is visible to customer on the marketplace.


When value is false, the item will not be shown to customer on the marketplace.

IsAvailable

Optional

boolean

"IsAvailable":  true

If stock quantity is equal to 0 then the value is false. If stock quantity is more than 0 the the value is true

Active

Optional

boolean

"Active": true

if item is soft deleted, the value is false. Value is true if it is not deleted.

Soft delete is the deletion of data in the marketplace but information is still kept in the database.

IsLocked

Optional

boolean

"IsLocked": false

If the value is set to true, only Admin have the rights to set the item to be visible or purchasable. When value is false, the Merchants is able to set the item to be visible or purchasable.

This is used when both Admin and Merchants have the purchasable toggle in their respective portal. When Admin make the item non-purchasable, the item will be locked. This is to ensure Merchant do not overwrite Admin’s decision without their consent.

StockLimited

Optional

boolean

"StockLimited": false

The stock of the item is unlimited when value is false while it is limited when value is true

StockQuantity

Optional

number

"StockQuantity": 0

The quantity of item stock. If the items have variants, the value will be 0. If item stock is unlimited, the value will be 0.

ItemVariants

Optional

Array[Item Variants Object]

"ItemVariants": [
 {
   "Id": 5511,
   "ItemName":  "Nike Epic React Flynit",
   "PriceChange": 15,
   "StockLimited": false,
   "StockQuantity": 0,
   "CurrencyCode": "USD",
   "Variants": [
      {
         "Id": 4201,
         "Name": "Green",
         "VariantGroupId": 4200,
         "VariantGroupName": "Colour"
      } ,
      {
         "Id": 4301,
         "Name": "US 10",
         "VariantGroupId": 4300,
         "VariantGroupName": "Size"
      }
    ]
 },
 {
   "ID": 5512,
   "ItemName":  "Nike Epic React Flynit",
   "Price": 10,
   "StockLimited": false,
   "StockQuantity": 0,
   "CurrencyCode": "USD",
   "Variants": [
      {
         "Id": 4202,
         "Name": "Red",
         "VariantGroupId": 4200,
         "VariantGroupName": "Colour"
      } ,
      {
         "Id": 4302,
         "Name": "US 11",
         "VariantGroupId": 4300,
         "VariantGroupName": "Size"
      }
    ]
 }
]


This is a list of variant item that are related to the item. Variant will depict different options that are available for the
item.

Please refer ItemVariants properties for more information


ItemVariants Properties

Property Names Property Type Description
Id

Optional

integer

"Id": 5513

Unique identification number of the item variants.

ItemName

Optional

string

"ItemName": "Nike Epic React Flynit"

The name of the item with variants.

Price

Optional

number

"Price": 20

Item's variant combination surcharge price. Price and PriceChange have the same meaning in ItemVariants Properties.

PriceChange

Optional

number

"PriceChange": 20

Item's variant combination surcharge price. Price and PriceChange have the same meaning in ItemVariants Properties.

PriceUnit

Optional

string

"PriceUnit": "per Item"

The price unit of the item i.e 30 per hour. This is only available for Spacetime Items.

StockLimited

Optional

boolean

"StockLimited": true

The stock of the item is is limited when value is true while it is unlimited when value is false.

StockQuantity

Optional

number

"StockQuantity": 1000

The quantity of item stock. If the items have variants, the value will be 0. If item stock is unlimited, the value will be 0.

MaxQty

Optional

number

"MaxQty": 1000

MaxQty will derived its value from StockQuantity if the value of StockLimited is true. It StockLimited is false, the MaxQty will be set to 99.

This is the value in the qty selector in the item details page.  

CurrencyCode

Optional

string

"CurrencyCode": "USD"

The currency code of the item price based on ISO 4217
(https://en.wikipedia.org/wiki/ISO_4217)

ImageUrl

Optional

string

"ImageUrl": "images/items/items-limited-epicreact.jpg"

The variant item image url link.

Variants

Optional

Array[Variant Group]

"Variants": [
 {
   "Id": "4401",
   "Name": "Off-white",
   "VariantGroupId": "4400",
   "VariantGroupName": "Edition"
 }
]

The list of variant object that is related to the Item Variant

ShippingMethod Properties

Property Names Property Type Description
Id

Optional

string

"Id": 6601

Unique identification number of the shipping method.

Description

Optional

string

"Description": "Q-Express"

The name of the shipping method.

CurrencyCode

Optional

string

"CurrencyCode": "USD"

The currency code of the shipping method price based on ISO 4217
(https://en.wikipedia.org/wiki/ISO_4217)

Price

Optional

number

"Price": 4

The shipping method surcharge price.

CombinedPrice

Optional

number

"CombinedPrice": 3

The surcharge price of shipping method if it is being shipping with other item.

Please refer to https://support.arcadier.com/hc/en-us/articles/115001373274-Bulk-shipping for detailed explanation.

DeliveryType

Optional

string

"DeliveryType": "delivery"

The type of delivery method

Active

Optional

boolean

"Active": true

Status of the shipping method. If the shipping method is active, the value is true else value will be false. When value is false, it means that the shipping method is not available to be selected in the marketplace but it still exist in the marketplace database.

Pickup Method Properties

Property Names Property Type Description
Id

Optional

integer

"Id": 8010

Unique identification number of the pick up method/ address.

Active

Optional

boolean

"Active": true

Address status. Value equal to true mean it is available while false mean it is soft delete from the system. Soft delete of the address will mean that address will not be shown available in the marketplace but it still exist in the marketplace database.

Address

Optional

string

"Address": "26 Rosewood St. Malden, MA 02148"

The pick up address.

AddressName

Optional

string

"AddressName": "Tony | Jai"

For Bespoke Marketplace, the address name used for delivery receipt if it is different from the person paying for the item.The address name will shown as “Addressee First Name | Addressee Last Name”.

Line1

Optional

string

"Line1": "26 Rosewood"

Street Address Name - line 1.

Line2

Optional

string

"Line2": "St. Malden, MA"

Street Address Name - line 2.

PostCode

Optional

string

"PostCode": "02148"

Postal code or Zip code of the address.

Latitude

Optional

number

"Latitude": 42.4326041

The latitude coordinate of the address.

Longitude

Optional

number

"Longitude": -71.05571959999997

The longitude coordinate of the address.

CountryCode

Optional

string

"CountryCode": "US"

The address country code based on ISO 3166 alpha-2
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

CountryName

Optional

string

"CountryName": "United States"

The address's country name

StateName

Optional

string

"StateName": "Massachusetts"

The address's state name

Delivery

Optional

boolean

"Delivery": true

The address is use as the delivery address when the value is true else the value should be false

DeliveryDefault

Optional

boolean

"DeliveryDefault": true

We are currently not using this

Pickup

Optional

boolean

"Pickup": true

The address is use as the pickup address when the value is true else the value should be false

DeliveryType

Optional

string

"DeliveryType": "pickup"

The delivery type should be either pickup or delivery

Images Properties

Property Names Property Type Description
FileId

Optional

integer

"FileId": 4590

Unique identification number for the image file.

Image

Optional

string

"Image": "images/items/items-7781-epicreact.jpg"

The URL for the image

Was this article helpful?
0 out of 0 found this helpful