Products Last updated: 2020-06-24
A product is an item available for purchase by the customer on the online store.
What you can do with a Product:
-
GET
/api/v3/products?styleID={styleID}
Searches for Products that match a supplied query -
GET
/api/v3/products/{product_oid}
Retrieves a single Product -
GET
/api/v3/products
Lists all products for a marketAgility site -
POST
/api/v3/products
Creates a Product -
PUT
/api/v3/products/{product_oid}
Updates a Product
Product Properties
| Property | Description |
|---|---|
| Badges |
"Badges":
[ "Just In" , "BestSeller" ] A list of badges assigned to a product |
| LanguageCode |
"LanguageCode":
"ES"
The language that was used when a product was created. Note: This is only populated if the language is different from the base site language |
| OID |
"OID":
12321
The marketAgility ID for a product |
| StyleID |
"StyleID":
"ProductTest-04112023"
The marketAgility ID for the style reference of a product |
| Created |
"Created":
"2019-04-21T12:43:12"
The date and time a product was created |
| Modified |
"Modified":
"2020-05-12T08:03:00"
The date and time a product was last modified |
| Status |
"Status":
"Active"
Defines whether a product is active or inactive |
| OnlineStatus |
"OnlineStatus":
"Migrating"
The online status of a product |
| OnlineDate |
"OnlineDate":
"2020-05-05T18:03:00"
The date and time a product was last listed online |
| SiteID |
"SiteID":
1
The marketAgility ID for the site |
| Name |
"Name":
"Easter Bunnies and Chicks Ankle Socks"
The name of the product |
| UrlIdentifier |
"UrlIdentifier":
"Easter-Bunnies-and-Chicks-Ankle-Socks-EASTERBUNNIES"
A customer friendly URL Identifier for a product |
| Department |
"Department":
""
The department a product is assigned to |
| PromoText |
"PromoText":
""
The product's marketing promo text |
| ShortDescription |
"ShortDescription":
"Ankle socks with Easter Bunnies and Chicks print on the top"
A short description that describes a product |
| LongDescription |
"LongDescription":
""
A long description that describes a product |
| Keywords |
"Keywords":
",fashion,fashion,fashion,fashion"
Keywords associated with a product |
| VendorBrand |
"VendorBrand":
"Xirena"
The vendor brand associated with a product |
| Season |
"Season":
""
The season in which a product is in style for |
| Pattern |
"Pattern":
""
The type of pattern that a product displays |
| Material |
"Material":
""
The material a product is made with |
| ReferenceNumber |
"ReferenceNumber":
""
The reference number of a product |
| GoogleProductCategory |
"GoogleProductCategory":
"Apparel & Accessories > Clothing > Dresses > Day Dresses"
Used to categorize a product from Google’s product taxanomy |
| Price |
"Price":
212.0
The price of a product |
| ListPrice |
"ListPrice":
212.0
The listed price of a product |
| WholesalePrice |
"WholesalePrice":
0.0
The wholesale price of a product |
| ManufacturerPrice |
"ManufacturerPrice":
88.0
The manufacturer price of a product |
| MinPrice |
"MinPrice":
212.0
The product's minimum price |
| MinListPrice |
"MinListPrice":
212.0
The product's listed minimum price |
| MaxPrice |
"MaxPrice":
212.0
The product's maximum price |
| MaxListPrice |
"MaxListPrice":
212.0
The product's listed maximum price |
| VisibilityStartDate |
"VisibilityStartDate":
"2020-05-05T18:03:00"
The date and time a product will start being visible on the site |
| VisibilityEndDate |
"VisibilityEndDate":
"2050-05-05T18:03:00"
The date and time a product will stop being visible on the site |
| SwatchImage |
"SwatchImage":
"https://mabaseline.blob.core.windows.net/..../1_42631_SW.JPG"
The URL for the product's swatch image |
| ThumbImage |
"ThumbImage":
"https://mabaseline.blob.core.windows.net/..../1_42631_TH.JPG"
The URL for the product's thumb image |
| MediumImage |
"MediumImage":
"https://mabaseline.blob.core.windows.net/..../1_42631_MD.JPG"
The URL for the product's medium sized image |
| LargeImage |
"LargeImage":
"https://mabaseline.blob.core.windows.net/..../1_42631_FS.JPG"
The URL for the product's large sized image |
| ZoomImage |
"ZoomImage":
"https://mabaseline.blob.core.windows.net/..../1_42631_ZM.JPG"
The URL for the product's zoom image |
| AlternateSwatchImage |
"AlternateSwatchImage":
""
An alternate URL for a product's swatch image |
| AlternateThumbImage |
"AlternateThumbImage":
""
An alternate URL for a product's thumb image |
| AlternateMediumImage |
"AlternateMediumImage":
""
An alternate URL for a product's medium sized image |
| AlternateLargeImage |
"AlternateLargeImage":
""
An alternate URL for a product's zoom image |
| AlternateZoomImage |
"AlternateSwatchImage":
""
An alternate URL for a product's swatch image |
| VideoUrl |
"VideoUrl":
""
A video URL for a product |
| QuantityInStock |
"QuantityInStock":
16
The quantity of a product in stock |
| TaxCode |
"TaxCode":
""
A product's tax code |
| IsHazmat |
"IsHazmat":
false
Determines whether a product has substances or materials that may pose a risk to health, safety, property, or the environment while storing, handling or transporting |
| IsOversized |
"IsOversized":
false
Determines whether a product is oversized |
| IsPurchasable |
"IsPurchasable":
true
Determines whether a product is purchasable |
| IsFreeShipping |
"IsFreeShipping":
false
Determines whether a product has free shipping |
| IsMAPP |
"IsMAPP":
false
Determines whether a product is MAPP |
| CanGiftwrap |
"CanGiftwrap":
false
Determines whether a product can come as a gift wrap |
| CanDiscount |
"CanDiscount":
true
Determines whether a product can be discounted |
| CanReturn |
"CanReturn":
false
Determines whether a product can be returned |
| CanCustomize |
"CanCustomize":
true
Determines whether a product can be customized |
| IncludeInSearch |
"IncludeInSearch":
true
Determines whether a product can be found in the site search |
| NLA |
"NLA":
false
The NLA for a product |
| SizeChart |
"SizeChart":
"Mens"
The product's respective size chart |
| ReviewRating |
"ReviewRating":
0.0
The average review rating of a product |
| ReviewCount |
"ReviewCount":
0
How many times a product has been reviewed |
| ShipSurcharge |
"ShipSurcharge":
0.0
The total shipping surcharge for a product |
| ItemType |
"ItemType":
0
The item type of a product |
| Offers |
"Offers":
 [ ]
A list of all the offers being applied to a product |
| Bundles |
"Bundles":
 [ ]
A list of all the bundles being applied to a product |
| SKUs |
"SKUs":
 [ ]
A list of all the SKUs associated with a product |
| AltViews |
"AltViews":
 [ ]
A list of all the views associated with a product |
Search Product
Retrieves a list of products that share a common element. The following parameters are available:
| GET | /api/v3/products?styleID=EASTERBUNNIES |
|---|
| Parameter | Description |
|---|---|
| StyleID |
Type:
String
The product's given style ID |
| Sku |
Type:
String
Will return the product style that is the parent of this sku |
| UrlIdentifier |
Type:
String
The product's url identifier |
| Status |
Type:
String
When specified, only return "active" or "inactive" products |
| UpdatedSince |
Type:
DateTime
Include products modified on or after this date |
| UpdatedThrough |
Type:
DateTime
Include products modified on or before this date |
| PageRows |
Type:
Numeric
How many results do you want back (default: 25) |
| PageNumber |
Type:
Numeric
Which page of results do you want to retrieve (default: 1) |
HTTP/1.1 200 OK
[
{
"Badges": [
"Made In USA",
"Web Exclusive",
"On Sale"
],
"LanguageCode": "",
"OID": 42596,
"StyleID": "EASTERBUNNIES",
"Created": "2015-05-28T18:24:04.927",
"Modified": "2019-11-07T20:48:13.23Z",
"Status": "Active",
"OnlineStatus": "Staging",
"OnlineDate": "2015-05-26T07:00:00Z",
"SiteID": 1,
"Name": "Easter Bunnies and Chicks Ankle Socks",
"UrlIdentifier": "Easter-Bunnies-and-Chicks-Ankle-Socks-EASTERBUNNIES",
"Department": "",
"PromoText": "",
"ShortDescription": "Ankle socks with Easter Bunnies and Chicks print on the top of the sock.",
"LongDescription": "",
"Keywords": ",fashion,fashion,fashion,fashion",
"VendorBrand": "LIVING ROYAL",
"Season": "",
"Pattern": "",
"Material": "",
"ReferenceNumber": "",
"GoogleProductCategory": "Apparel & Accessories > Clothing > Underwear & Socks > Socks",
"Price": 4.99,
"ListPrice": 5.99,
"WholesalePrice": 0,
"ManufacturerPrice": 0,
"MinPrice": 4.99,
"MinListPrice": 4.99,
"MaxPrice": 8.99,
"MaxListPrice": 8.99,
"VisibilityStartDate": "2019-11-07T20:48:13.23Z",
"VisibilityEndDate": "2049-11-07T20:48:13.23Z",
"SwatchImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_SW.JPG",
"ThumbImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_TH.JPG",
"MediumImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_MD.JPG",
"LargeImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_FS.JPG",
"ZoomImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_ZM.JPG",
"AlternateSwatchImage": "",
"AlternateThumbImage": "",
"AlternateMediumImage": "",
"AlternateLargeImage": "",
"AlternateZoomImage": "",
"VideoUrl": "",
"QuantityInStock": 12,
"Taxcode": "",
"IsHazmat": false,
"IsOversized": false,
"IsPurchasable": true,
"IsFreeShipping": false,
"IsMAPP": false,
"CanGiftwrap": false,
"CanDiscount": true,
"CanReturn": false,
"CanCustomize": true,
"IncludeInSearch": true,
"NLA": false,
"SizeChart": "",
"ReviewRating": 0.0,
"ReviewCount": 0,
"ShipSurcharge": 0.0,
"ItemType": 0
}
]
Get Product
Gets a single product with Product OID
| GET | /api/v3/products/113400 |
|---|
HTTP/1.1 200 OK
{
"Badges": [
"Best Seller",
"Just In"
],
"LanguageCode": "",
"OID": 113400,
"StyleID": "Easter-Bunnies-and-Chicks-Ankle-Socks-EASTERBUNNIES",
"Created": "2020-06-11T20:51:55.817",
"Modified": "2020-06-11T20:51:55.817",
"Status": "Active",
"OnlineStatus": "Migrating",
"OnlineDate": "2020-06-11T20:51:55.783Z",
"SiteID": 1,
"Name": "Easter Bunnies and Chicks Ankle Socks",
"UrlIdentifier": "Easter-Bunnies-and-Chicks-Ankle-Socks-EASTERBUNNIES",
"Department": "",
"PromoText": "",
"ShortDescription": "",
"LongDescription": "",
"Keywords": ",fashion,fashion,fashion,fashion",
"VendorBrand": "LIVING ROYAL",
"Season": "",
"Pattern": "",
"Material": "",
"ReferenceNumber": "",
"GoogleProductCategory": "Apparel & Accessories > Clothing > Underwear & Socks > Socks",
"Price": 4.99,
"ListPrice": 5.99,
"WholesalePrice": 0,
"ManufacturerPrice": 0,
"MinPrice": 49.99,
"MinListPrice": 4.99,
"MaxPrice": 8.99,
"MaxListPrice": 8.99,
"VisibilityStartDate": "2019-11-07T20:48:13.23Z",
"VisibilityEndDate": "2049-11-07T20:48:13.23Z",
"SwatchImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_SW.JPG",
"ThumbImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_TH.JPG",
"MediumImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_MD.JPG",
"LargeImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_FS.JPG",
"ZoomImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_ZM.JPG",
"AlternateSwatchImage": "",
"AlternateThumbImage": "",
"AlternateMediumImage": "",
"AlternateLargeImage": "",
"AlternateZoomImage": "",
"VideoUrl": "",
"QuantityInStock": 12,
"Taxcode": "",
"IsHazmat": false,
"IsOversized": false,
"IsPurchasable": true,
"IsFreeShipping": false,
"IsMAPP": false,
"CanGiftwrap": false,
"CanDiscount": true,
"CanReturn": false,
"CanCustomize": true,
"IncludeInSearch": true,
"NLA": false,
"SizeChart": "",
"ReviewRating": 0.0,
"ReviewCount": 0,
"ShipSurcharge": 0.0,
"ItemType": 0
}
List Products
Retrieves a list of products for a marketAgility site.
| GET | /api/v3/products/ |
|---|
HTTP/1.1 200 OK
[
{
"Badges": [
"Made In USA",
"Web Exclusive",
"On Sale"
],
"LanguageCode": "",
"OID": 42596,
"StyleID": "EASTERBUNNIES",
"Created": "2015-05-28T18:24:04.927",
"Modified": "2019-11-07T20:48:13.23Z",
"Status": "Active",
"OnlineStatus": "Staging",
"OnlineDate": "2015-05-26T07:00:00Z",
"SiteID": 1,
"Name": "Easter Bunnies and Chicks Ankle Socks",
"UrlIdentifier": "Easter-Bunnies-and-Chicks-Ankle-Socks-EASTERBUNNIES",
"Department": "",
"PromoText": "",
"ShortDescription": "Ankle socks with Easter Bunnies and Chicks print on the top of the sock.",
"LongDescription": "",
"Keywords": ",fashion,fashion,fashion,fashion",
"VendorBrand": "LIVING ROYAL",
"Season": "",
"Pattern": "",
"Material": "",
"ReferenceNumber": "",
"GoogleProductCategory": "Apparel & Accessories > Clothing > Underwear & Socks > Socks",
"Price": 4.99,
"ListPrice": 5.99,
"WholesalePrice": 0,
"ManufacturerPrice": 0,
"MinPrice": 4.99,
"MinListPrice": 4.99,
"MaxPrice": 8.99,
"MaxListPrice": 8.99,
"VisibilityStartDate": "2019-11-07T20:48:13.23Z",
"VisibilityEndDate": "2049-11-07T20:48:13.23Z",
"SwatchImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_SW.JPG",
"ThumbImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_TH.JPG",
"MediumImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_MD.JPG",
"LargeImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_FS.JPG",
"ZoomImage": "https://mabaseline.blob.core.windows.net/images/products/1_42593_ZM.JPG",
"AlternateSwatchImage": "",
"AlternateThumbImage": "",
"AlternateMediumImage": "",
"AlternateLargeImage": "",
"AlternateZoomImage": "",
"VideoUrl": "",
"QuantityInStock": 12,
"Taxcode": "",
"IsHazmat": false,
"IsOversized": false,
"IsPurchasable": true,
"IsFreeShipping": false,
"IsMAPP": false,
"CanGiftwrap": false,
"CanDiscount": true,
"CanReturn": false,
"CanCustomize": true,
"IncludeInSearch": true,
"NLA": false,
"SizeChart": "",
"ReviewRating": 0.0,
"ReviewCount": 0,
"ShipSurcharge": 0.0,
"ItemType": 0
}
]
Create Product
Create a product for sale.
| POST | /api/v3/products/ |
|---|---|
{
"Badges": [
"Best Seller",
"Just In",
"Online Only"
],
"StyleID": "Test-Product",
"Name": "Product Name",
"Keywords": ",test1,test2,test3,test4",
"VendorBrand": "Royal Blue",
"ShortDescription" : "Test description"
}
|
|
HTTP/1.1 201 Created
{
"Badges": [
"Best Seller",
"Just In",
"Online Only"
],
"LanguageCode": "",
"OID": 113406,
"StyleID": "Test-Product",
"Created": "2020-06-19T19:27:23.1723727+00:00",
"Modified": "2020-06-19T19:27:23.1723727+00:00",
"Status": "Active",
"OnlineStatus": "Migrating",
"OnlineDate": "2020-06-19T19:27:22.9536511+00:00",
"SiteID": 1,
"Name": "Product Name",
"UrlIdentifier": null,
"Department": null,
"PromoText": null,
"ShortDescription": "Test description",
"LongDescription": null,
"Keywords": ",test1,test2,test3,test4",
"VendorBrand": "Royal Blue",
"Season": null,
"Pattern": null,
"Material": null,
"ReferenceNumber": null,
"GoogleProductCategory": null,
"Price": 0.0,
"ListPrice": 0.0,
"WholesalePrice": 0.0,
"ManufacturerPrice": 0.0,
"MinPrice": 0.0,
"MinListPrice": 0.0,
"MaxPrice": 0.0,
"MaxListPrice": 0.0,
"VisibilityStartDate": "2019-11-07T20:48:13.23Z",
"VisibilityEndDate": "2049-11-07T20:48:13.23Z",
"SwatchImage": "",
"ThumbImage": "",
"MediumImage": "",
"LargeImage": "",
"ZoomImage": "",
"AlternateSwatchImage": "",
"AlternateThumbImage": "",
"AlternateMediumImage": "",
"AlternateLargeImage": "",
"AlternateZoomImage": "",
"VideoUrl": null,
"QuantityInStock": 0,
"Taxcode": null,
"IsHazmat": false,
"IsOversized": false,
"IsPurchasable": true,
"IsFreeShipping": false,
"IsMAPP": false,
"CanGiftwrap": true,
"CanDiscount": true,
"CanReturn": true,
"CanCustomize": true,
"IncludeInSearch": true,
"NLA": false,
"SizeChart": null,
"ReviewRating": 0.0,
"ReviewCount": 0,
"ShipSurcharge": 0.0,
"ItemType": 0,
"Offers": [],
"Bundles": [],
"SKUs": [],
"AltViews": []
}
Update Product
Update an existing product
| PUT | /api/v3/products/113406 |
|---|---|
{
"Badges": [
"Online Only",
"Highest Ranked"
]
}
|
|
HTTP/1.1 204 No Content
