GET - Products
The products API gives information about a product. Certain style level information may need to be looked up using
the style API.
Resource URL:
GET https://api.ssactivewear.com/v2/products/
Request Options:
Get All |
/v2/products/ |
Returns all products |
Filter Results |
/v2/products/{product}
/v2/products/B00760004
/v2/products/81480,B00760004,00821780008137
|
Returns products matching filter condition
{product} = is a comma separated list of product identifiers
identifiers = SkuID, Sku, Gtin, YourSku
|
Filter Results By Styles |
/v2/products/?style={style}
/v2/products/?style=00760
/v2/products/?style=00760,Gildan
5000
/v2/products/?style=bella%20%2B%20canvas%203001cvc
|
Returns products matching filter condition
{style} = is a comma separated list of style identifiers
identifiers = StyleID, PartNumber, BrandName Name (When using BrandName Name, special characters and
spaces will need to be encoded.)
|
Filter Results By StyleID Or PartNumber |
/v2/products/?styleid={style}
/v2/products/?styleid=39
/v2/products/?partnumber={partnumber}
/v2/products/?partnumber=00760
|
Returns products matching filter condition
{styleid} = is a comma separated list of styleid
{partnumber} = is a comma separated list of partnumber
|
Filter Warehouses |
/v2/products/B00760003?Warehouses?{WarehouseAbbr}
/v2/products/B00760003?Warehouses=IL,KS
|
Returns only the warehouses requested
{WarehouseAbbr} = is a comma separated list of warehouseAbbr
|
Filter Fields |
/v2/products/B00760003?fields={fields}
/v2/products/B00760003?fields=Sku,Gtin,Qty,CustomerPrice
|
Returns only the fields that you request
{fields} = is a comma separated list of product object fields
|
Response Format |
/v2/products/B00760003?mediatype={mediatype}
/v2/products/B00760003?mediatype=json
|
Determines the response type
{mediatype} = json or xml (Default=json)
|
Example Request:
GET https://api.ssactivewear.com/v2/products/B00760004
Response:
[
{
"sku": "B00760004",
"gtin": "00821780001001",
"skuID_Master": 2343,
"yourSku": "",
"styleID": 39,
"brandName": "Gildan",
"styleName": "2000",
"colorName": "White",
"colorCode": "00",
"colorPriceCodeName": "White",
"colorGroup": "79",
"colorGroupName": "White",
"colorFamilyID": "1",
"colorFamily": "Neutrals",
"colorSwatchImage": "Images/ColorSwatch/7229_fm.jpg",
"colorSwatchTextColor": "#000000",
"colorFrontImage": "Images/Color/17130_f_fm.jpg",
"colorSideImage": "Images/Color/17130_fm.jpg",
"colorBackImage": "Images/Color/17130_b_fm.jpg",
"colorDirectSideImage": "",
"colorOnModelFrontImage": "",
"colorOnModelSideImage": "",
"colorOnModelBackImage": "",
"color1": "#FFFFFF",
"color2": "",
"sizeName": "M",
"sizeCode": "4",
"sizeOrder": "B2",
"sizePriceCodeName": "S-XL",
"caseQty": 72,
"unitWeight": 0.4444444444444,
"mapPrice": x.xx,
"piecePrice": x.xx,
"dozenPrice": x.xx,
"casePrice": x.xx,
"salePrice": x.xx,
"customerPrice": x.xx,
"saleExpiration": "2016-08-05T00:00:00",
"noeRetailing": false,
"caseWeight": 28,
"caseWidth": 16,
"caseLength": 23.75,
"caseHeight": 12.5,
"PolyPackQty":"24",
"qty": 19536,
"countryOfOrigin": "NI,DO,HT",
"warehouses":
[
{
"warehouseAbbr": "IL",
"skuID": 2343,
"qty": 10000,
"closeout": false,
"dropship": false,
"excludeFreeFreight": false,
"fullCaseOnly": false,
"returnable": true
},
{
"warehouseAbbr": "NV",
"skuID": 55405,
"qty": 0,
"closeout": false,
"dropship": false,
"excludeFreeFreight": false,
"fullCaseOnly": false,
"returnable": true
},
{
"warehouseAbbr": "NJ",
"skuID": 170872,
"qty": 2210,
"closeout": false,
"dropship": false,
"excludeFreeFreight": false,
"fullCaseOnly": false,
"returnable": true
},
{
"warehouseAbbr": "KS",
"skuID": 263747,
"qty": 7326,
"closeout": false,
"dropship": false,
"excludeFreeFreight": false,
"fullCaseOnly": false,
"returnable": true
}
]
}
]
Not Found Response:
HTTP Response Code: 404
{
"errors":
[
{
"field": "Identifier",
"message": "Requested item(s) were not found or have been discontinued."
}
]
}
Product Object Definition:
skuID |
Integer |
Unique ID for this sku (does not change) |
sku |
String |
Our sku number |
gtin |
String |
Industry standard identifier used by all suppliers. |
yourSku |
String |
YourSku has been set up using the CrossRef API. |
styleID |
Integer |
Unique ID for this style (Will never change) |
brandName |
String |
The brand that makes this style. |
styleName |
String |
The style's name. Style names are unique within a brand. |
colorName |
String |
The color of this product. |
colorCode |
String |
Two digit color code part of the InventoryKey. |
colorPriceCodeName |
String |
The pricing category of this color. |
colorGroup |
String |
Colors with a similar color group are considered to be a similar color. |
colorGroupName |
String |
Colors with a similar color group are considered to be a similar color. |
colorFamilyID |
Integer |
Base color the color falls under. |
colorFamily |
String |
Base color the color falls under. |
colorSwatchImage |
String |
URL to the medium swatch image for this color
- Example URL: https://www.ssactivewear.com/{Image}
- Replace "_fm" with "_fs" for the small image
|
colorSwatchTextColor |
String |
Html color code that is visible on top of the color swatch |
colorFrontImage |
String |
URL to the medium front image for this color
- Example URL: https://www.ssactivewear.com/{Image}
- Replace "_fm" with "_fl" for the large image
- Replace "_fm" with "_fs" for the small image
|
colorSideImage |
String |
URL to the medium side image for this color
- Example URL: https://www.ssactivewear.com/{Image}
- Replace "_fm" with "_fl" for the large image
- Replace "_fm" with "_fs" for the small image
|
colorBackImage |
String |
URL to the medium back image for this color
- Example URL: https://www.ssactivewear.com/{Image}
- Replace "_fm" with "_fl" for the large image
- Replace "_fm" with "_fs" for the small image
|
colorDirectSideImage |
String |
URL to the medium direct side image for this color
- Example URL: https://www.ssactivewear.com/{Image}
- Replace "_fm" with "_fl" for the large image
- Replace "_fm" with "_fs" for the small image
|
colorOnModelFrontImage |
String |
URL to the medium on model front image for this color
- Example URL: https://www.ssactivewear.com/{Image}
- Replace "_fm" with "_fl" for the large image
- Replace "_fm" with "_fs" for the small image
|
colorOnModelSideImage |
String |
URL to the medium on model side image for this color
- Example URL: https://www.ssactivewear.com/{Image}
- Replace "_fm" with "_fl" for the large image
- Replace "_fm" with "_fs" for the small image
|
colorOnModelBackImage |
String |
URL to the medium on model back image for this color
- Example URL: https://www.ssactivewear.com/{Image}
- Replace "_fm" with "_fl" for the large image
- Replace "_fm" with "_fs" for the small image
|
color1 |
String |
HTML Code for the primary color. |
color2 |
String |
HTML Code for the secondary color. |
sizeName |
String |
Size Name that the spec belongs to. |
sizeCode |
String |
One digit size code part of the InventoryKey. |
sizeOrder |
String |
Sort order for the size compared to other sizes in the style. |
sizePriceCodeName |
String |
The pricing category of this size. |
caseQty |
Integer |
Number of units in a full case from the mill. |
unitWeight |
Decimal |
Weight of a single unit. |
mapPrice |
Decimal |
Minimum Advertised Price price |
piecePrice |
Decimal |
Piece price level price |
dozenPrice |
Decimal |
Dozen price level price |
casePrice |
Decimal |
Case price level price |
salePrice |
Decimal |
Sale price level price |
customerPrice |
Decimal |
Your price |
saleExpiration |
String |
MM/DD/YYYY |
noeRetailing |
Boolean |
When true, mill prohibits the selling of products on popular eRetailing platforms such as Amazon,
Walmart, EBay.
|
caseWeight |
Decimal |
Weight of full case in pounds |
caseWidth |
Decimal |
Width of case in inches |
caseLength |
Decimal |
Length of case in inches |
caseHeight |
Decimal |
Height of case in inches |
PolyPackQty |
Integer |
Number of pieces in a poly pack |
qty |
Integer |
Combined Inventory in all of our warehouses |
countryOfOrigin |
String |
Country of manufacture for product. Provided by mills.
|
warehouses |
List of Object |
warehouseAbbr |
String |
Code identifying the Warehouse. |
skuID |
Integer |
skuID identifying the Sku and Warehouse. |
qty |
Integer |
Quantity available for sale. |
closeout |
Boolean |
Skus that are discontinued and will not be replenished. |
dropship |
Boolean |
This product does not ship from our warehouse. |
excludeFreeFreight |
Boolean |
This product does not qualify for free freight. |
fullCaseOnly |
Boolean |
This product must be ordered in full case quantities. |
expectedInventory |
String |
Current enroute quantities with expected dates of receipt and current quantity on order with
the mill.
If no dates are available, None will be returned.
|
returnable |
Boolean |
This product is eligible for return. |
|