GET | /products/{productId} | Gets a Product by Id |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductId | path | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Product | form | ProductDetailModel | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Sku | form | string | No | |
BrandId | form | int? | No | |
BrandName | form | string | No | |
Name | form | string | No | |
Description | form | string | No | |
Price | form | decimal? | No | |
ProductStatus | form | bool? | No | Product Status override value |
FinalProductStatus | form | bool | No | The "actual" (Final) Product Status |
Approval | form | bool? | No | |
Upccode | form | string | No | |
Visibility | form | int? | No | |
CreatedDate | form | DateTime? | No | |
DeletedDate | form | DateTime? | No | |
Categories | form | List<CategoryStub> | No | |
Assets | form | List<UPCAsset> | No | |
CustomFields | form | List<CustomFieldStub> | No | |
BaseSystemReferencePrice | form | decimal? | No | |
MAPCompliantPrice | form | decimal? | No | |
OverridePrice | form | decimal? | No | |
OverrideStartDate | form | DateTime? | No | |
OverrideEndDate | form | DateTime? | No | |
PriceOnApplication | form | string | No | |
POSM | form | string | No | |
UseRegularPrice | form | bool | No | |
FloorModel | form | bool | No | |
PackageComponents | form | List<PackageComponentViewModel> | No | |
Promotions | form | List<PromotionStub> | No | |
SKUAliases | form | List<string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CategoryId | form | long | No | |
Name | form | string | No | |
ParentCategoryId | form | long? | No | |
HasChildren | form | bool | No | |
ProductsUrl | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AssetType | form | string | No | |
AssetTypeRank | form | int | No | |
AssetName | form | string | No | |
AssetDescription | form | string | No | |
AssetUrl | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomFieldProductId | form | int | No | |
CustomFieldId | form | int | No | |
Name | form | string | No | |
DisplayName | form | string | No | |
FieldDataType | form | string | No | |
Value | form | string | No | |
AccountId | form | int? | No | |
CustomFieldCategoryId | form | int? | No | |
IsGlobal | form | bool? | No | |
IsValueEditable | form | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductId | form | int | No | |
Sku | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PromotionName | form | string | No | |
PromotionPrice | form | decimal? | No | |
PromotionCompliantPrice | form | decimal? | No | |
RetailStartDate | form | DateTime? | No | |
RetailEndDate | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /products/{productId} HTTP/1.1 Host: avb-pos.avbportal.com Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, product: { sku: String, brandId: 0, brandName: String, name: String, description: String, price: 0, productStatus: False, finalProductStatus: False, approval: False, upccode: String, visibility: 0, createdDate: 0001-01-01, deletedDate: 0001-01-01, categories: [ { categoryId: 0, name: String, parentCategoryId: 0, hasChildren: False, productsUrl: String } ], assets: [ { assetType: String, assetTypeRank: 0, assetName: String, assetDescription: String, assetUrl: String } ], customFields: [ { customFieldProductId: 0, customFieldId: 0, name: String, displayName: String, fieldDataType: String, value: String, accountId: 0, customFieldCategoryId: 0, isGlobal: False, isValueEditable: False } ], baseSystemReferencePrice: 0, mapCompliantPrice: 0, overridePrice: 0, overrideStartDate: 0001-01-01, overrideEndDate: 0001-01-01, priceOnApplication: String, posm: String, useRegularPrice: False, floorModel: False, packageComponents: [ { productId: 0, sku: String } ], promotions: [ { promotionName: String, promotionPrice: 0, promotionCompliantPrice: 0, retailStartDate: 0001-01-01, retailEndDate: 0001-01-01 } ], skuAliases: [ String ] } }