ProductGroups REST API
ProductGroups REST API documentation and interactive testing.
For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/productgroups/contract
Authorizations
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequiredPossible values:
EU or US depending on where your Organization Account is located
X-ObjectsGrid-RestApiVersionstringOptional
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
X-ObjectsGrid-SessionIDstringOptional
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Body
Objects Grid Product Object
idstring | null · max: 50Optional
The unique identifier for Product
at_contextany ofOptional
Schema context
string · enumOptionalPossible values:
nullOptional
at_typeany ofOptional
The object type
string · enumOptionalPossible values:
nullOptional
identifierstring | null · max: 50Optional
The unique identifier for Product
imagestring | nullOptional
image URL
urlstring | null · min: 1Optional
This Product URL
hasVariantarray | nullOptional
A pointer to a product variant
productGroupIDstring | nullOptional
The Product Group ID for the product
variesByarray | nullOptional
The property by which the product varies, e.g. "color", "size", etc.
aggregateRatingany ofOptional
The aggregate rating of the Product
or
nullOptional
asinstring | nullOptional
The Amazon Standard Identification Number (ASIN) of the product
audienceany ofOptional
The audience for the product
or
nullOptional
awardstring | nullOptional
Awards won by or for this item
brandstring | nullOptional
The brand of the product
categoryarray | nullOptional
The category of the product
colorstring | nullOptional
The color of the product
colorSwatchstring | nullOptional
Color swatch images for the product
countryOfAssemblyany ofOptional
The country where the product is assembled
string · enumOptionalPossible values:
nullOptional
countryOfLastProcessingany ofOptional
The country where the product was last processed
string · enumOptionalPossible values:
nullOptional
countryOfOriginany ofOptional
The country where the product was manufactured
string · enumOptionalPossible values:
nullOptional
depthany ofOptional
The depth of the product
or
nullOptional
fundingstring | nullOptional
A pointer to a funding source for the item
gtinstring | nullOptional
The Global Trade Item Number (GTIN) of the product
gtin12string | nullOptional
The GTIN-12 of the product
gtin13string | nullOptional
The GTIN-13 of the product
gtin14string | nullOptional
The GTIN-14 of the product
gtin8string | nullOptional
The GTIN-8 of the product
hasAdultConsiderationarray | nullOptional
Indicates whether this item is targeted at a mature audience
hasCertificationarray | nullOptional
The certifications and/or standards for the product
hasEnergyConsumptionDetailsany ofOptional
The energy consumption details for the product
or
nullOptional
hasGS1DigitalLinkstring | nullOptional
A link to the GS1 Digital Link representation of the product identifier
hasMeasurementany ofOptional
A pointer to a product measurement
or
nullOptional
hasMerchantReturnPolicyany ofOptional
The Merchant Return Policy for the product
or
nullOptional
heightany ofOptional
The height of the product
or
nullOptional
inProductGroupWithIDstring | nullOptional
The Product Group ID for the product
isAccessoryOrSparePartForarray | nullOptional
A pointer to another product (or multiple products) for which this product is an accessory or spare part
isConsumableForarray | nullOptional
A pointer to another product (or multiple products) for which this product is a consumable
isFamilyFriendlyboolean | nullOptional
Indicates whether this item is family friendly
isRelatedToarray | nullOptional
A pointer to another, somehow related product (or multiple products)
isSimilarToarray | nullOptional
A pointer to another, functionally similar product (or multiple products)
isVariantOfstring | nullOptional
A pointer to a base product (or multiple products) for which this product is a variant (e.g. in color, size, material, etc.)
itemConditionany ofOptional
The condition of the product
string · enumOptionalPossible values:
nullOptional
logostring | nullOptional
An associated logo for the product
manufacturerstring | nullOptional
The manufacturer of the product
materialarray | nullOptional
The material of the product
mobileUrlstring | nullOptional
This Product Mobile URL
modelstring | nullOptional
The model of the product
mpnstring | nullOptional
The Manufacturer Part Number (MPN) of the product
nsnstring | nullOptional
The NATO Stock Number (NSN) of the product
offersarray | nullOptional
Links to Offers to provide this item. For example, offers to sell a product, rent the DVD of a movie, or give away tickets to an event
productIDstring | nullOptional
The product identifier, such as ISBN. For example: 'isbn:123-456-789'
productionDatestring | nullOptional
The production date of the product
purchaseDatestring | nullOptional
The purchase date of the product
releaseDatestring | nullOptional
The release date of the product
reviewarray | nullOptional
Review of the item
sizeany ofOptional
The size of the product
or
nullOptional
skustring | nullRequired
The Stock Keeping Unit (SKU) of the product
weightany ofOptional
The weight of the product
or
nullOptional
widthany ofOptional
The width of the product
or
nullOptional
tagsarray | nullOptional
Object Tags
Responses
201
Successfully created the object
application/json
400
Bad request
application/json
401
Unauthorized
application/json
409
Conflict, object already exists
application/json
427
Too Many Requests - rate limited
application/json
500
Internal Server Error
application/json
post
POST /productgroups HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 3924
{
"id": null,
"at_context": "https://schema.org",
"at_type": "Product",
"identifier": null,
"image": null,
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": null,
"hasVariant": [
"https://example.com"
],
"productGroupID": null,
"variesBy": [
"https://example.com"
],
"aggregateRating": {
"at_type": "AggregateRating",
"itemReviewed": null,
"ratingCount": null,
"reviewCount": null,
"bestRating": null,
"ratingExplanation": [
{
"at_value": "text",
"at_language": "text"
}
],
"ratingValue": null,
"reviewAspect": null,
"worstRating": null
},
"asin": null,
"audience": {
"at_type": "Audience",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"audienceType": null,
"geographicArea": null
},
"award": null,
"brand": null,
"category": [
"text"
],
"color": null,
"colorSwatch": null,
"countryOfAssembly": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfLastProcessing": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfOrigin": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"depth": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"funding": null,
"gtin": null,
"gtin12": null,
"gtin13": null,
"gtin14": null,
"gtin8": null,
"hasAdultConsideration": [
"https://schema.org/AlcoholConsideration"
],
"hasCertification": [
"text"
],
"hasEnergyConsumptionDetails": {
"at_type": "EnergyConsumptionDetails",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"energyEfficiencyScaleMax": "https://schema.org/EUEnergyEfficiencyCategoryA",
"energyEfficiencyScaleMin": "https://schema.org/EUEnergyEfficiencyCategoryA",
"hasEnergyEfficiencyCategory": [
"https://schema.org/EnergyStarCertified"
]
},
"hasGS1DigitalLink": null,
"hasMeasurement": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"hasMerchantReturnPolicy": {
"at_type": "MerchantReturnPolicy",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"applicableCountry": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"inStoreReturnOffered": null,
"itemCondition": [
"https://schema.org/DamagedCondition"
],
"merchantReturnDays": null,
"refundType": [
"https://schema.org/ExchangeRefund"
],
"returnPolicyCategory": [
"https://schema.org/MerchantReturnFiniteReturnWindow"
],
"returnMethod": [
"https://schema.org/KeepProduct"
],
"returnFees": [
"https://schema.org/FreeReturn"
]
},
"height": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"inProductGroupWithID": null,
"isAccessoryOrSparePartFor": [
"https://example.com"
],
"isConsumableFor": [
"https://example.com"
],
"isFamilyFriendly": null,
"isRelatedTo": [
"https://example.com"
],
"isSimilarTo": [
"https://example.com"
],
"isVariantOf": null,
"itemCondition": "https://schema.org/DamagedCondition",
"keywords": [
{
"at_value": "text",
"at_language": "text"
}
],
"logo": null,
"manufacturer": null,
"material": [
"text"
],
"mobileUrl": null,
"model": null,
"mpn": null,
"negativeNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"nsn": null,
"offers": [
"https://example.com"
],
"pattern": [
{
"at_value": "text",
"at_language": "text"
}
],
"positiveNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"productID": null,
"productionDate": null,
"purchaseDate": null,
"releaseDate": null,
"review": [
"https://example.com"
],
"size": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"sku": null,
"slogan": [
{
"at_value": "text",
"at_language": "text"
}
],
"weight": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"width": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"tags": [
{
"name": "text",
"val": "text"
}
]
}{
"id": null,
"at_context": "https://schema.org",
"at_type": "Product",
"identifier": null,
"image": null,
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": null,
"hasVariant": [
"https://example.com"
],
"productGroupID": null,
"variesBy": [
"https://example.com"
],
"aggregateRating": {
"at_type": "AggregateRating",
"itemReviewed": null,
"ratingCount": null,
"reviewCount": null,
"bestRating": null,
"ratingExplanation": [
{
"at_value": "text",
"at_language": "text"
}
],
"ratingValue": null,
"reviewAspect": null,
"worstRating": null
},
"asin": null,
"audience": {
"at_type": "Audience",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"audienceType": null,
"geographicArea": null
},
"award": null,
"brand": null,
"category": [
"text"
],
"color": null,
"colorSwatch": null,
"countryOfAssembly": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfLastProcessing": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfOrigin": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"depth": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"funding": null,
"gtin": null,
"gtin12": null,
"gtin13": null,
"gtin14": null,
"gtin8": null,
"hasAdultConsideration": [
"https://schema.org/AlcoholConsideration"
],
"hasCertification": [
"text"
],
"hasEnergyConsumptionDetails": {
"at_type": "EnergyConsumptionDetails",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"energyEfficiencyScaleMax": "https://schema.org/EUEnergyEfficiencyCategoryA",
"energyEfficiencyScaleMin": "https://schema.org/EUEnergyEfficiencyCategoryA",
"hasEnergyEfficiencyCategory": [
"https://schema.org/EnergyStarCertified"
]
},
"hasGS1DigitalLink": null,
"hasMeasurement": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"hasMerchantReturnPolicy": {
"at_type": "MerchantReturnPolicy",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"applicableCountry": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"inStoreReturnOffered": null,
"itemCondition": [
"https://schema.org/DamagedCondition"
],
"merchantReturnDays": null,
"refundType": [
"https://schema.org/ExchangeRefund"
],
"returnPolicyCategory": [
"https://schema.org/MerchantReturnFiniteReturnWindow"
],
"returnMethod": [
"https://schema.org/KeepProduct"
],
"returnFees": [
"https://schema.org/FreeReturn"
]
},
"height": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"inProductGroupWithID": null,
"isAccessoryOrSparePartFor": [
"https://example.com"
],
"isConsumableFor": [
"https://example.com"
],
"isFamilyFriendly": null,
"isRelatedTo": [
"https://example.com"
],
"isSimilarTo": [
"https://example.com"
],
"isVariantOf": null,
"itemCondition": "https://schema.org/DamagedCondition",
"keywords": [
{
"at_value": "text",
"at_language": "text"
}
],
"logo": null,
"manufacturer": null,
"material": [
"text"
],
"mobileUrl": null,
"model": null,
"mpn": null,
"negativeNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"nsn": null,
"offers": [
"https://example.com"
],
"pattern": [
{
"at_value": "text",
"at_language": "text"
}
],
"positiveNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"productID": null,
"productionDate": null,
"purchaseDate": null,
"releaseDate": null,
"review": [
"https://example.com"
],
"size": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"sku": null,
"slogan": [
{
"at_value": "text",
"at_language": "text"
}
],
"weight": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"width": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"tags": [
{
"name": "text",
"val": "text"
}
]
}Authorizations
Path parameters
idstringRequired
ID of the object to retrieve
Query parameters
langstringOptionalExample:
BCP 47 language code
fr, de, de-AT, cy-GBHeader parameters
X-ObjectsGrid-AccessPointstring · enumRequiredPossible values:
EU or US depending on where your Organization Account is located
X-ObjectsGrid-RestApiVersionstringOptional
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
X-ObjectsGrid-SessionIDstringOptional
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Responses
200
Successfully retrieved the object
application/json
400
Bad request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
427
Too Many Requests
application/json
500
Internal server error
application/json
get
GET /productgroups/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*
{
"id": null,
"at_context": "https://schema.org",
"at_type": "Product",
"identifier": null,
"image": null,
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": null,
"hasVariant": [
"https://example.com"
],
"productGroupID": null,
"variesBy": [
"https://example.com"
],
"aggregateRating": {
"at_type": "AggregateRating",
"itemReviewed": null,
"ratingCount": null,
"reviewCount": null,
"bestRating": null,
"ratingExplanation": [
{
"at_value": "text",
"at_language": "text"
}
],
"ratingValue": null,
"reviewAspect": null,
"worstRating": null
},
"asin": null,
"audience": {
"at_type": "Audience",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"audienceType": null,
"geographicArea": null
},
"award": null,
"brand": null,
"category": [
"text"
],
"color": null,
"colorSwatch": null,
"countryOfAssembly": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfLastProcessing": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfOrigin": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"depth": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"funding": null,
"gtin": null,
"gtin12": null,
"gtin13": null,
"gtin14": null,
"gtin8": null,
"hasAdultConsideration": [
"https://schema.org/AlcoholConsideration"
],
"hasCertification": [
"text"
],
"hasEnergyConsumptionDetails": {
"at_type": "EnergyConsumptionDetails",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"energyEfficiencyScaleMax": "https://schema.org/EUEnergyEfficiencyCategoryA",
"energyEfficiencyScaleMin": "https://schema.org/EUEnergyEfficiencyCategoryA",
"hasEnergyEfficiencyCategory": [
"https://schema.org/EnergyStarCertified"
]
},
"hasGS1DigitalLink": null,
"hasMeasurement": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"hasMerchantReturnPolicy": {
"at_type": "MerchantReturnPolicy",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"applicableCountry": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"inStoreReturnOffered": null,
"itemCondition": [
"https://schema.org/DamagedCondition"
],
"merchantReturnDays": null,
"refundType": [
"https://schema.org/ExchangeRefund"
],
"returnPolicyCategory": [
"https://schema.org/MerchantReturnFiniteReturnWindow"
],
"returnMethod": [
"https://schema.org/KeepProduct"
],
"returnFees": [
"https://schema.org/FreeReturn"
]
},
"height": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"inProductGroupWithID": null,
"isAccessoryOrSparePartFor": [
"https://example.com"
],
"isConsumableFor": [
"https://example.com"
],
"isFamilyFriendly": null,
"isRelatedTo": [
"https://example.com"
],
"isSimilarTo": [
"https://example.com"
],
"isVariantOf": null,
"itemCondition": "https://schema.org/DamagedCondition",
"keywords": [
{
"at_value": "text",
"at_language": "text"
}
],
"logo": null,
"manufacturer": null,
"material": [
"text"
],
"mobileUrl": null,
"model": null,
"mpn": null,
"negativeNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"nsn": null,
"offers": [
"https://example.com"
],
"pattern": [
{
"at_value": "text",
"at_language": "text"
}
],
"positiveNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"productID": null,
"productionDate": null,
"purchaseDate": null,
"releaseDate": null,
"review": [
"https://example.com"
],
"size": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"sku": null,
"slogan": [
{
"at_value": "text",
"at_language": "text"
}
],
"weight": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"width": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"tags": [
{
"name": "text",
"val": "text"
}
]
}Authorizations
Path parameters
idstringRequired
ID of the object to update
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequiredPossible values:
EU or US depending on where your Organization Account is located
X-ObjectsGrid-RestApiVersionstringOptional
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
X-ObjectsGrid-SessionIDstringOptional
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Body
Objects Grid Product Object
idstring | null · max: 50Optional
The unique identifier for Product
at_contextany ofOptional
Schema context
string · enumOptionalPossible values:
nullOptional
at_typeany ofOptional
The object type
string · enumOptionalPossible values:
nullOptional
identifierstring | null · max: 50Optional
The unique identifier for Product
imagestring | nullOptional
image URL
urlstring | null · min: 1Optional
This Product URL
hasVariantarray | nullOptional
A pointer to a product variant
productGroupIDstring | nullOptional
The Product Group ID for the product
variesByarray | nullOptional
The property by which the product varies, e.g. "color", "size", etc.
aggregateRatingany ofOptional
The aggregate rating of the Product
or
nullOptional
asinstring | nullOptional
The Amazon Standard Identification Number (ASIN) of the product
audienceany ofOptional
The audience for the product
or
nullOptional
awardstring | nullOptional
Awards won by or for this item
brandstring | nullOptional
The brand of the product
categoryarray | nullOptional
The category of the product
colorstring | nullOptional
The color of the product
colorSwatchstring | nullOptional
Color swatch images for the product
countryOfAssemblyany ofOptional
The country where the product is assembled
string · enumOptionalPossible values:
nullOptional
countryOfLastProcessingany ofOptional
The country where the product was last processed
string · enumOptionalPossible values:
nullOptional
countryOfOriginany ofOptional
The country where the product was manufactured
string · enumOptionalPossible values:
nullOptional
depthany ofOptional
The depth of the product
or
nullOptional
fundingstring | nullOptional
A pointer to a funding source for the item
gtinstring | nullOptional
The Global Trade Item Number (GTIN) of the product
gtin12string | nullOptional
The GTIN-12 of the product
gtin13string | nullOptional
The GTIN-13 of the product
gtin14string | nullOptional
The GTIN-14 of the product
gtin8string | nullOptional
The GTIN-8 of the product
hasAdultConsiderationarray | nullOptional
Indicates whether this item is targeted at a mature audience
hasCertificationarray | nullOptional
The certifications and/or standards for the product
hasEnergyConsumptionDetailsany ofOptional
The energy consumption details for the product
or
nullOptional
hasGS1DigitalLinkstring | nullOptional
A link to the GS1 Digital Link representation of the product identifier
hasMeasurementany ofOptional
A pointer to a product measurement
or
nullOptional
hasMerchantReturnPolicyany ofOptional
The Merchant Return Policy for the product
or
nullOptional
heightany ofOptional
The height of the product
or
nullOptional
inProductGroupWithIDstring | nullOptional
The Product Group ID for the product
isAccessoryOrSparePartForarray | nullOptional
A pointer to another product (or multiple products) for which this product is an accessory or spare part
isConsumableForarray | nullOptional
A pointer to another product (or multiple products) for which this product is a consumable
isFamilyFriendlyboolean | nullOptional
Indicates whether this item is family friendly
isRelatedToarray | nullOptional
A pointer to another, somehow related product (or multiple products)
isSimilarToarray | nullOptional
A pointer to another, functionally similar product (or multiple products)
isVariantOfstring | nullOptional
A pointer to a base product (or multiple products) for which this product is a variant (e.g. in color, size, material, etc.)
itemConditionany ofOptional
The condition of the product
string · enumOptionalPossible values:
nullOptional
logostring | nullOptional
An associated logo for the product
manufacturerstring | nullOptional
The manufacturer of the product
materialarray | nullOptional
The material of the product
mobileUrlstring | nullOptional
This Product Mobile URL
modelstring | nullOptional
The model of the product
mpnstring | nullOptional
The Manufacturer Part Number (MPN) of the product
nsnstring | nullOptional
The NATO Stock Number (NSN) of the product
offersarray | nullOptional
Links to Offers to provide this item. For example, offers to sell a product, rent the DVD of a movie, or give away tickets to an event
productIDstring | nullOptional
The product identifier, such as ISBN. For example: 'isbn:123-456-789'
productionDatestring | nullOptional
The production date of the product
purchaseDatestring | nullOptional
The purchase date of the product
releaseDatestring | nullOptional
The release date of the product
reviewarray | nullOptional
Review of the item
sizeany ofOptional
The size of the product
or
nullOptional
skustring | nullRequired
The Stock Keeping Unit (SKU) of the product
weightany ofOptional
The weight of the product
or
nullOptional
widthany ofOptional
The width of the product
or
nullOptional
tagsarray | nullOptional
Object Tags
Responses
200
Successfully updated the object
application/json
400
Bad request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
427
Too Many Requests
application/json
500
Internal server error
application/json
put
PUT /productgroups/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 3924
{
"id": null,
"at_context": "https://schema.org",
"at_type": "Product",
"identifier": null,
"image": null,
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": null,
"hasVariant": [
"https://example.com"
],
"productGroupID": null,
"variesBy": [
"https://example.com"
],
"aggregateRating": {
"at_type": "AggregateRating",
"itemReviewed": null,
"ratingCount": null,
"reviewCount": null,
"bestRating": null,
"ratingExplanation": [
{
"at_value": "text",
"at_language": "text"
}
],
"ratingValue": null,
"reviewAspect": null,
"worstRating": null
},
"asin": null,
"audience": {
"at_type": "Audience",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"audienceType": null,
"geographicArea": null
},
"award": null,
"brand": null,
"category": [
"text"
],
"color": null,
"colorSwatch": null,
"countryOfAssembly": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfLastProcessing": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfOrigin": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"depth": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"funding": null,
"gtin": null,
"gtin12": null,
"gtin13": null,
"gtin14": null,
"gtin8": null,
"hasAdultConsideration": [
"https://schema.org/AlcoholConsideration"
],
"hasCertification": [
"text"
],
"hasEnergyConsumptionDetails": {
"at_type": "EnergyConsumptionDetails",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"energyEfficiencyScaleMax": "https://schema.org/EUEnergyEfficiencyCategoryA",
"energyEfficiencyScaleMin": "https://schema.org/EUEnergyEfficiencyCategoryA",
"hasEnergyEfficiencyCategory": [
"https://schema.org/EnergyStarCertified"
]
},
"hasGS1DigitalLink": null,
"hasMeasurement": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"hasMerchantReturnPolicy": {
"at_type": "MerchantReturnPolicy",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"applicableCountry": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"inStoreReturnOffered": null,
"itemCondition": [
"https://schema.org/DamagedCondition"
],
"merchantReturnDays": null,
"refundType": [
"https://schema.org/ExchangeRefund"
],
"returnPolicyCategory": [
"https://schema.org/MerchantReturnFiniteReturnWindow"
],
"returnMethod": [
"https://schema.org/KeepProduct"
],
"returnFees": [
"https://schema.org/FreeReturn"
]
},
"height": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"inProductGroupWithID": null,
"isAccessoryOrSparePartFor": [
"https://example.com"
],
"isConsumableFor": [
"https://example.com"
],
"isFamilyFriendly": null,
"isRelatedTo": [
"https://example.com"
],
"isSimilarTo": [
"https://example.com"
],
"isVariantOf": null,
"itemCondition": "https://schema.org/DamagedCondition",
"keywords": [
{
"at_value": "text",
"at_language": "text"
}
],
"logo": null,
"manufacturer": null,
"material": [
"text"
],
"mobileUrl": null,
"model": null,
"mpn": null,
"negativeNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"nsn": null,
"offers": [
"https://example.com"
],
"pattern": [
{
"at_value": "text",
"at_language": "text"
}
],
"positiveNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"productID": null,
"productionDate": null,
"purchaseDate": null,
"releaseDate": null,
"review": [
"https://example.com"
],
"size": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"sku": null,
"slogan": [
{
"at_value": "text",
"at_language": "text"
}
],
"weight": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"width": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"tags": [
{
"name": "text",
"val": "text"
}
]
}{
"id": null,
"at_context": "https://schema.org",
"at_type": "Product",
"identifier": null,
"image": null,
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": null,
"hasVariant": [
"https://example.com"
],
"productGroupID": null,
"variesBy": [
"https://example.com"
],
"aggregateRating": {
"at_type": "AggregateRating",
"itemReviewed": null,
"ratingCount": null,
"reviewCount": null,
"bestRating": null,
"ratingExplanation": [
{
"at_value": "text",
"at_language": "text"
}
],
"ratingValue": null,
"reviewAspect": null,
"worstRating": null
},
"asin": null,
"audience": {
"at_type": "Audience",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"audienceType": null,
"geographicArea": null
},
"award": null,
"brand": null,
"category": [
"text"
],
"color": null,
"colorSwatch": null,
"countryOfAssembly": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfLastProcessing": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfOrigin": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"depth": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"funding": null,
"gtin": null,
"gtin12": null,
"gtin13": null,
"gtin14": null,
"gtin8": null,
"hasAdultConsideration": [
"https://schema.org/AlcoholConsideration"
],
"hasCertification": [
"text"
],
"hasEnergyConsumptionDetails": {
"at_type": "EnergyConsumptionDetails",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"energyEfficiencyScaleMax": "https://schema.org/EUEnergyEfficiencyCategoryA",
"energyEfficiencyScaleMin": "https://schema.org/EUEnergyEfficiencyCategoryA",
"hasEnergyEfficiencyCategory": [
"https://schema.org/EnergyStarCertified"
]
},
"hasGS1DigitalLink": null,
"hasMeasurement": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"hasMerchantReturnPolicy": {
"at_type": "MerchantReturnPolicy",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"applicableCountry": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"inStoreReturnOffered": null,
"itemCondition": [
"https://schema.org/DamagedCondition"
],
"merchantReturnDays": null,
"refundType": [
"https://schema.org/ExchangeRefund"
],
"returnPolicyCategory": [
"https://schema.org/MerchantReturnFiniteReturnWindow"
],
"returnMethod": [
"https://schema.org/KeepProduct"
],
"returnFees": [
"https://schema.org/FreeReturn"
]
},
"height": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"inProductGroupWithID": null,
"isAccessoryOrSparePartFor": [
"https://example.com"
],
"isConsumableFor": [
"https://example.com"
],
"isFamilyFriendly": null,
"isRelatedTo": [
"https://example.com"
],
"isSimilarTo": [
"https://example.com"
],
"isVariantOf": null,
"itemCondition": "https://schema.org/DamagedCondition",
"keywords": [
{
"at_value": "text",
"at_language": "text"
}
],
"logo": null,
"manufacturer": null,
"material": [
"text"
],
"mobileUrl": null,
"model": null,
"mpn": null,
"negativeNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"nsn": null,
"offers": [
"https://example.com"
],
"pattern": [
{
"at_value": "text",
"at_language": "text"
}
],
"positiveNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"productID": null,
"productionDate": null,
"purchaseDate": null,
"releaseDate": null,
"review": [
"https://example.com"
],
"size": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"sku": null,
"slogan": [
{
"at_value": "text",
"at_language": "text"
}
],
"weight": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"width": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"tags": [
{
"name": "text",
"val": "text"
}
]
}Authorizations
Path parameters
idstringRequired
ID of the object to update
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequiredPossible values:
EU or US depending on where your Organization Account is located
X-ObjectsGrid-RestApiVersionstringOptional
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
X-ObjectsGrid-SessionIDstringOptional
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Body
Objects Grid Product Object
idstring | null · max: 50Optional
The unique identifier for Product
at_contextany ofOptional
Schema context
string · enumOptionalPossible values:
nullOptional
at_typeany ofOptional
The object type
string · enumOptionalPossible values:
nullOptional
identifierstring | null · max: 50Optional
The unique identifier for Product
imagestring | nullOptional
image URL
urlstring | null · min: 1Optional
This Product URL
hasVariantarray | nullOptional
A pointer to a product variant
productGroupIDstring | nullOptional
The Product Group ID for the product
variesByarray | nullOptional
The property by which the product varies, e.g. "color", "size", etc.
aggregateRatingany ofOptional
The aggregate rating of the Product
or
nullOptional
asinstring | nullOptional
The Amazon Standard Identification Number (ASIN) of the product
audienceany ofOptional
The audience for the product
or
nullOptional
awardstring | nullOptional
Awards won by or for this item
brandstring | nullOptional
The brand of the product
categoryarray | nullOptional
The category of the product
colorstring | nullOptional
The color of the product
colorSwatchstring | nullOptional
Color swatch images for the product
countryOfAssemblyany ofOptional
The country where the product is assembled
string · enumOptionalPossible values:
nullOptional
countryOfLastProcessingany ofOptional
The country where the product was last processed
string · enumOptionalPossible values:
nullOptional
countryOfOriginany ofOptional
The country where the product was manufactured
string · enumOptionalPossible values:
nullOptional
depthany ofOptional
The depth of the product
or
nullOptional
fundingstring | nullOptional
A pointer to a funding source for the item
gtinstring | nullOptional
The Global Trade Item Number (GTIN) of the product
gtin12string | nullOptional
The GTIN-12 of the product
gtin13string | nullOptional
The GTIN-13 of the product
gtin14string | nullOptional
The GTIN-14 of the product
gtin8string | nullOptional
The GTIN-8 of the product
hasAdultConsiderationarray | nullOptional
Indicates whether this item is targeted at a mature audience
hasCertificationarray | nullOptional
The certifications and/or standards for the product
hasEnergyConsumptionDetailsany ofOptional
The energy consumption details for the product
or
nullOptional
hasGS1DigitalLinkstring | nullOptional
A link to the GS1 Digital Link representation of the product identifier
hasMeasurementany ofOptional
A pointer to a product measurement
or
nullOptional
hasMerchantReturnPolicyany ofOptional
The Merchant Return Policy for the product
or
nullOptional
heightany ofOptional
The height of the product
or
nullOptional
inProductGroupWithIDstring | nullOptional
The Product Group ID for the product
isAccessoryOrSparePartForarray | nullOptional
A pointer to another product (or multiple products) for which this product is an accessory or spare part
isConsumableForarray | nullOptional
A pointer to another product (or multiple products) for which this product is a consumable
isFamilyFriendlyboolean | nullOptional
Indicates whether this item is family friendly
isRelatedToarray | nullOptional
A pointer to another, somehow related product (or multiple products)
isSimilarToarray | nullOptional
A pointer to another, functionally similar product (or multiple products)
isVariantOfstring | nullOptional
A pointer to a base product (or multiple products) for which this product is a variant (e.g. in color, size, material, etc.)
itemConditionany ofOptional
The condition of the product
string · enumOptionalPossible values:
nullOptional
logostring | nullOptional
An associated logo for the product
manufacturerstring | nullOptional
The manufacturer of the product
materialarray | nullOptional
The material of the product
mobileUrlstring | nullOptional
This Product Mobile URL
modelstring | nullOptional
The model of the product
mpnstring | nullOptional
The Manufacturer Part Number (MPN) of the product
nsnstring | nullOptional
The NATO Stock Number (NSN) of the product
offersarray | nullOptional
Links to Offers to provide this item. For example, offers to sell a product, rent the DVD of a movie, or give away tickets to an event
productIDstring | nullOptional
The product identifier, such as ISBN. For example: 'isbn:123-456-789'
productionDatestring | nullOptional
The production date of the product
purchaseDatestring | nullOptional
The purchase date of the product
releaseDatestring | nullOptional
The release date of the product
reviewarray | nullOptional
Review of the item
sizeany ofOptional
The size of the product
or
nullOptional
skustring | nullRequired
The Stock Keeping Unit (SKU) of the product
weightany ofOptional
The weight of the product
or
nullOptional
widthany ofOptional
The width of the product
or
nullOptional
tagsarray | nullOptional
Object Tags
Responses
200
Successfully patched the object
application/json
400
Bad request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
427
Too Many Requests
application/json
500
Internal server error
application/json
patch
PATCH /productgroups/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 3924
{
"id": null,
"at_context": "https://schema.org",
"at_type": "Product",
"identifier": null,
"image": null,
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": null,
"hasVariant": [
"https://example.com"
],
"productGroupID": null,
"variesBy": [
"https://example.com"
],
"aggregateRating": {
"at_type": "AggregateRating",
"itemReviewed": null,
"ratingCount": null,
"reviewCount": null,
"bestRating": null,
"ratingExplanation": [
{
"at_value": "text",
"at_language": "text"
}
],
"ratingValue": null,
"reviewAspect": null,
"worstRating": null
},
"asin": null,
"audience": {
"at_type": "Audience",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"audienceType": null,
"geographicArea": null
},
"award": null,
"brand": null,
"category": [
"text"
],
"color": null,
"colorSwatch": null,
"countryOfAssembly": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfLastProcessing": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfOrigin": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"depth": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"funding": null,
"gtin": null,
"gtin12": null,
"gtin13": null,
"gtin14": null,
"gtin8": null,
"hasAdultConsideration": [
"https://schema.org/AlcoholConsideration"
],
"hasCertification": [
"text"
],
"hasEnergyConsumptionDetails": {
"at_type": "EnergyConsumptionDetails",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"energyEfficiencyScaleMax": "https://schema.org/EUEnergyEfficiencyCategoryA",
"energyEfficiencyScaleMin": "https://schema.org/EUEnergyEfficiencyCategoryA",
"hasEnergyEfficiencyCategory": [
"https://schema.org/EnergyStarCertified"
]
},
"hasGS1DigitalLink": null,
"hasMeasurement": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"hasMerchantReturnPolicy": {
"at_type": "MerchantReturnPolicy",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"applicableCountry": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"inStoreReturnOffered": null,
"itemCondition": [
"https://schema.org/DamagedCondition"
],
"merchantReturnDays": null,
"refundType": [
"https://schema.org/ExchangeRefund"
],
"returnPolicyCategory": [
"https://schema.org/MerchantReturnFiniteReturnWindow"
],
"returnMethod": [
"https://schema.org/KeepProduct"
],
"returnFees": [
"https://schema.org/FreeReturn"
]
},
"height": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"inProductGroupWithID": null,
"isAccessoryOrSparePartFor": [
"https://example.com"
],
"isConsumableFor": [
"https://example.com"
],
"isFamilyFriendly": null,
"isRelatedTo": [
"https://example.com"
],
"isSimilarTo": [
"https://example.com"
],
"isVariantOf": null,
"itemCondition": "https://schema.org/DamagedCondition",
"keywords": [
{
"at_value": "text",
"at_language": "text"
}
],
"logo": null,
"manufacturer": null,
"material": [
"text"
],
"mobileUrl": null,
"model": null,
"mpn": null,
"negativeNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"nsn": null,
"offers": [
"https://example.com"
],
"pattern": [
{
"at_value": "text",
"at_language": "text"
}
],
"positiveNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"productID": null,
"productionDate": null,
"purchaseDate": null,
"releaseDate": null,
"review": [
"https://example.com"
],
"size": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"sku": null,
"slogan": [
{
"at_value": "text",
"at_language": "text"
}
],
"weight": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"width": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"tags": [
{
"name": "text",
"val": "text"
}
]
}{
"id": null,
"at_context": "https://schema.org",
"at_type": "Product",
"identifier": null,
"image": null,
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": null,
"hasVariant": [
"https://example.com"
],
"productGroupID": null,
"variesBy": [
"https://example.com"
],
"aggregateRating": {
"at_type": "AggregateRating",
"itemReviewed": null,
"ratingCount": null,
"reviewCount": null,
"bestRating": null,
"ratingExplanation": [
{
"at_value": "text",
"at_language": "text"
}
],
"ratingValue": null,
"reviewAspect": null,
"worstRating": null
},
"asin": null,
"audience": {
"at_type": "Audience",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"audienceType": null,
"geographicArea": null
},
"award": null,
"brand": null,
"category": [
"text"
],
"color": null,
"colorSwatch": null,
"countryOfAssembly": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfLastProcessing": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfOrigin": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"depth": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"funding": null,
"gtin": null,
"gtin12": null,
"gtin13": null,
"gtin14": null,
"gtin8": null,
"hasAdultConsideration": [
"https://schema.org/AlcoholConsideration"
],
"hasCertification": [
"text"
],
"hasEnergyConsumptionDetails": {
"at_type": "EnergyConsumptionDetails",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"energyEfficiencyScaleMax": "https://schema.org/EUEnergyEfficiencyCategoryA",
"energyEfficiencyScaleMin": "https://schema.org/EUEnergyEfficiencyCategoryA",
"hasEnergyEfficiencyCategory": [
"https://schema.org/EnergyStarCertified"
]
},
"hasGS1DigitalLink": null,
"hasMeasurement": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"hasMerchantReturnPolicy": {
"at_type": "MerchantReturnPolicy",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"applicableCountry": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"inStoreReturnOffered": null,
"itemCondition": [
"https://schema.org/DamagedCondition"
],
"merchantReturnDays": null,
"refundType": [
"https://schema.org/ExchangeRefund"
],
"returnPolicyCategory": [
"https://schema.org/MerchantReturnFiniteReturnWindow"
],
"returnMethod": [
"https://schema.org/KeepProduct"
],
"returnFees": [
"https://schema.org/FreeReturn"
]
},
"height": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"inProductGroupWithID": null,
"isAccessoryOrSparePartFor": [
"https://example.com"
],
"isConsumableFor": [
"https://example.com"
],
"isFamilyFriendly": null,
"isRelatedTo": [
"https://example.com"
],
"isSimilarTo": [
"https://example.com"
],
"isVariantOf": null,
"itemCondition": "https://schema.org/DamagedCondition",
"keywords": [
{
"at_value": "text",
"at_language": "text"
}
],
"logo": null,
"manufacturer": null,
"material": [
"text"
],
"mobileUrl": null,
"model": null,
"mpn": null,
"negativeNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"nsn": null,
"offers": [
"https://example.com"
],
"pattern": [
{
"at_value": "text",
"at_language": "text"
}
],
"positiveNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"productID": null,
"productionDate": null,
"purchaseDate": null,
"releaseDate": null,
"review": [
"https://example.com"
],
"size": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"sku": null,
"slogan": [
{
"at_value": "text",
"at_language": "text"
}
],
"weight": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"width": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"tags": [
{
"name": "text",
"val": "text"
}
]
}Authorizations
Path parameters
idstringRequired
ID of the object to delete
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequiredPossible values:
EU or US depending on where your Organization Account is located
X-ObjectsGrid-RestApiVersionstringOptional
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
X-ObjectsGrid-SessionIDstringOptional
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Responses
200
Successfully deleted the object
400
Bad request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
427
Too Many Requests
application/json
500
Internal server error
application/json
delete
DELETE /productgroups/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*
No content
This operation supports Elastic Search Query DSL query format
Authorizations
Query parameters
langstringOptionalExample:
BCP 47 language code
fr, de, de-AT, cy-GBquerystringOptionalExample:
Elastic Search Query DSL.
{ "query": { "match_all": {} } }fromintegerOptional
Defines the starting record number for retrieval.
sizeintegerOptional
Defines the number of records to retrieve.
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequiredPossible values:
EU or US depending on where your Organization Account is located
X-ObjectsGrid-RestApiVersionstringOptional
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
X-ObjectsGrid-SessionIDstringOptional
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Responses
200
Successfully listed the objects
application/json
400
Bad request
application/json
401
Unauthorized
application/json
427
Too Many Requests - rate limited
application/json
500
Internal Server Error
application/json
get
GET /productgroups HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*
[
{
"id": null,
"at_context": "https://schema.org",
"at_type": "Product",
"identifier": null,
"image": null,
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": null,
"hasVariant": [
"https://example.com"
],
"productGroupID": null,
"variesBy": [
"https://example.com"
],
"aggregateRating": {
"at_type": "AggregateRating",
"itemReviewed": null,
"ratingCount": null,
"reviewCount": null,
"bestRating": null,
"ratingExplanation": [
{
"at_value": "text",
"at_language": "text"
}
],
"ratingValue": null,
"reviewAspect": null,
"worstRating": null
},
"asin": null,
"audience": {
"at_type": "Audience",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"audienceType": null,
"geographicArea": null
},
"award": null,
"brand": null,
"category": [
"text"
],
"color": null,
"colorSwatch": null,
"countryOfAssembly": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfLastProcessing": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"countryOfOrigin": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"depth": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"funding": null,
"gtin": null,
"gtin12": null,
"gtin13": null,
"gtin14": null,
"gtin8": null,
"hasAdultConsideration": [
"https://schema.org/AlcoholConsideration"
],
"hasCertification": [
"text"
],
"hasEnergyConsumptionDetails": {
"at_type": "EnergyConsumptionDetails",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"energyEfficiencyScaleMax": "https://schema.org/EUEnergyEfficiencyCategoryA",
"energyEfficiencyScaleMin": "https://schema.org/EUEnergyEfficiencyCategoryA",
"hasEnergyEfficiencyCategory": [
"https://schema.org/EnergyStarCertified"
]
},
"hasGS1DigitalLink": null,
"hasMeasurement": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"hasMerchantReturnPolicy": {
"at_type": "MerchantReturnPolicy",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"applicableCountry": "AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX",
"inStoreReturnOffered": null,
"itemCondition": [
"https://schema.org/DamagedCondition"
],
"merchantReturnDays": null,
"refundType": [
"https://schema.org/ExchangeRefund"
],
"returnPolicyCategory": [
"https://schema.org/MerchantReturnFiniteReturnWindow"
],
"returnMethod": [
"https://schema.org/KeepProduct"
],
"returnFees": [
"https://schema.org/FreeReturn"
]
},
"height": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"inProductGroupWithID": null,
"isAccessoryOrSparePartFor": [
"https://example.com"
],
"isConsumableFor": [
"https://example.com"
],
"isFamilyFriendly": null,
"isRelatedTo": [
"https://example.com"
],
"isSimilarTo": [
"https://example.com"
],
"isVariantOf": null,
"itemCondition": "https://schema.org/DamagedCondition",
"keywords": [
{
"at_value": "text",
"at_language": "text"
}
],
"logo": null,
"manufacturer": null,
"material": [
"text"
],
"mobileUrl": null,
"model": null,
"mpn": null,
"negativeNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"nsn": null,
"offers": [
"https://example.com"
],
"pattern": [
{
"at_value": "text",
"at_language": "text"
}
],
"positiveNotes": [
{
"at_value": "text",
"at_language": "text"
}
],
"productID": null,
"productionDate": null,
"purchaseDate": null,
"releaseDate": null,
"review": [
"https://example.com"
],
"size": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"sku": null,
"slogan": [
{
"at_value": "text",
"at_language": "text"
}
],
"weight": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"width": {
"at_type": "QuantitativeValue",
"maxValue": null,
"minValue": null,
"unitCode": "text",
"unitText": "text",
"value": null
},
"tags": [
{
"name": "text",
"val": "text"
}
]
}
]Last updated
Was this helpful?