ProductGroups REST API

ProductGroups REST API documentation and interactive testing.

For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/productgroups/contract

Create object

post

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

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

application/json

Objects Grid ProductGroup Object

idstring · max: 50 · nullableOptional

The unique identifier for ProductGroup

at_contextany ofOptional

Schema context

string · enumOptionalPossible values:

or

nullOptional

at_typeany ofOptional

The object type

string · enumOptionalPossible values:

or

nullOptional

identifierstring · max: 50 · nullableOptional

The unique identifier for ProductGroup

imagestring · nullableOptional

image URL

urlstring · min: 1 · nullableOptional

This Object URL

hasVariantstring · uri[] · nullableOptional

A pointer to a product variant

productGroupIDstring · nullableOptional

The Product Group ID for the product

variesBystring · uri[] · nullableOptional

The property by which the product varies, e.g. "color", "size", etc.

aggregateRatingany ofOptional

The aggregate rating of the Product

or

nullOptional

asinstring · nullableOptional

The Amazon Standard Identification Number (ASIN) of the product

audienceany ofOptional

The audience for the product

or

nullOptional

awardstring · nullableOptional

Awards won by or for this item

brandstring · nullableOptional

The brand of the product

categorystring[] · nullableOptional

The category of the product

colorstring · nullableOptional

The color of the product

colorSwatchstring · nullableOptional

Color swatch images for the product

countryOfAssemblyany ofOptional

The country where the product is assembled

string · enumOptionalPossible values:

or

nullOptional

countryOfLastProcessingany ofOptional

The country where the product was last processed

string · enumOptionalPossible values:

or

nullOptional

countryOfOriginany ofOptional

The country where the product was manufactured

string · enumOptionalPossible values:

or

nullOptional

depthany ofOptional

The depth of the product

or

nullOptional

fundingstring · nullableOptional

A pointer to a funding source for the item

gtinstring · nullableOptional

The Global Trade Item Number (GTIN) of the product

gtin12string · nullableOptional

The GTIN-12 of the product

gtin13string · nullableOptional

The GTIN-13 of the product

gtin14string · nullableOptional

The GTIN-14 of the product

gtin8string · nullableOptional

The GTIN-8 of the product

hasCertificationstring[] · nullableOptional

The certifications and/or standards for the product

hasEnergyConsumptionDetailsany ofOptional

The energy consumption details for the product

or

nullOptional

hasGS1DigitalLinkstring · nullableOptional

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 · nullableOptional

The Product Group ID for the product

isAccessoryOrSparePartForstring · uri[] · nullableOptional

A pointer to another product (or multiple products) for which this product is an accessory or spare part

isConsumableForstring · uri[] · nullableOptional

A pointer to another product (or multiple products) for which this product is a consumable

isFamilyFriendlyboolean · nullableOptional

Indicates whether this item is family friendly

isRelatedTostring · uri[] · nullableOptional

A pointer to another, somehow related product (or multiple products)

isSimilarTostring · uri[] · nullableOptional

A pointer to another, functionally similar product (or multiple products)

isVariantOfstring · nullableOptional

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:

or

nullOptional

logostring · nullableOptional

An associated logo for the product

manufacturerstring · nullableOptional

The manufacturer of the product

materialstring[] · nullableOptional

The material of the product

mobileUrlstring · nullableOptional

This Product Mobile URL

modelstring · nullableOptional

The model of the product

mpnstring · nullableOptional

The Manufacturer Part Number (MPN) of the product

nsnstring · nullableOptional

The NATO Stock Number (NSN) of the product

offersstring · uri[] · nullableOptional

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 · nullableOptional

The product identifier, such as ISBN. For example: 'isbn:123-456-789'

productionDatestring · nullableOptional

The production date of the product

purchaseDatestring · nullableOptional

The purchase date of the product

releaseDatestring · nullableOptional

The release date of the product

reviewstring · uri[] · nullableOptional

Review of the item

sizeany ofOptional

The size of the product

or

nullOptional

skustring · nullableRequired

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

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

/productgroups

HTTPcURLJavaScriptPython

POST /productgroups HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 3929

{
  "id": null,
  "at_context": "https://schema.org",
  "at_type": "ProductGroup",
  "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": "ProductGroup",
  "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"
    }
  ]
}

Retrieve Object

get

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters

idstringRequired

ID of the object to retrieve

Query parameters

langstringOptional

BCP 47 language code

Example: fr, de, de-AT, cy-GB

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

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

/productgroups/{id}

HTTPcURLJavaScriptPython

GET /productgroups/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Accept: */*

{
  "id": null,
  "at_context": "https://schema.org",
  "at_type": "ProductGroup",
  "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"
    }
  ]
}

Update Object

put

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters

idstringRequired

ID of the object to update

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

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

application/json

Objects Grid ProductGroup Object

idstring · max: 50 · nullableOptional

The unique identifier for ProductGroup

at_contextany ofOptional

Schema context

string · enumOptionalPossible values:

or

nullOptional

at_typeany ofOptional

The object type

string · enumOptionalPossible values:

or

nullOptional

identifierstring · max: 50 · nullableOptional

The unique identifier for ProductGroup

imagestring · nullableOptional

image URL

urlstring · min: 1 · nullableOptional

This Object URL

hasVariantstring · uri[] · nullableOptional

A pointer to a product variant

productGroupIDstring · nullableOptional

The Product Group ID for the product

variesBystring · uri[] · nullableOptional

The property by which the product varies, e.g. "color", "size", etc.

aggregateRatingany ofOptional

The aggregate rating of the Product

or

nullOptional

asinstring · nullableOptional

The Amazon Standard Identification Number (ASIN) of the product

audienceany ofOptional

The audience for the product

or

nullOptional

awardstring · nullableOptional

Awards won by or for this item

brandstring · nullableOptional

The brand of the product

categorystring[] · nullableOptional

The category of the product

colorstring · nullableOptional

The color of the product

colorSwatchstring · nullableOptional

Color swatch images for the product

countryOfAssemblyany ofOptional

The country where the product is assembled

string · enumOptionalPossible values:

or

nullOptional

countryOfLastProcessingany ofOptional

The country where the product was last processed

string · enumOptionalPossible values:

or

nullOptional

countryOfOriginany ofOptional

The country where the product was manufactured

string · enumOptionalPossible values:

or

nullOptional

depthany ofOptional

The depth of the product

or

nullOptional

fundingstring · nullableOptional

A pointer to a funding source for the item

gtinstring · nullableOptional

The Global Trade Item Number (GTIN) of the product

gtin12string · nullableOptional

The GTIN-12 of the product

gtin13string · nullableOptional

The GTIN-13 of the product

gtin14string · nullableOptional

The GTIN-14 of the product

gtin8string · nullableOptional

The GTIN-8 of the product

hasCertificationstring[] · nullableOptional

The certifications and/or standards for the product

hasEnergyConsumptionDetailsany ofOptional

The energy consumption details for the product

or

nullOptional

hasGS1DigitalLinkstring · nullableOptional

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 · nullableOptional

The Product Group ID for the product

isAccessoryOrSparePartForstring · uri[] · nullableOptional

A pointer to another product (or multiple products) for which this product is an accessory or spare part

isConsumableForstring · uri[] · nullableOptional

A pointer to another product (or multiple products) for which this product is a consumable

isFamilyFriendlyboolean · nullableOptional

Indicates whether this item is family friendly

isRelatedTostring · uri[] · nullableOptional

A pointer to another, somehow related product (or multiple products)

isSimilarTostring · uri[] · nullableOptional

A pointer to another, functionally similar product (or multiple products)

isVariantOfstring · nullableOptional

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:

or

nullOptional

logostring · nullableOptional

An associated logo for the product

manufacturerstring · nullableOptional

The manufacturer of the product

materialstring[] · nullableOptional

The material of the product

mobileUrlstring · nullableOptional

This Product Mobile URL

modelstring · nullableOptional

The model of the product

mpnstring · nullableOptional

The Manufacturer Part Number (MPN) of the product

nsnstring · nullableOptional

The NATO Stock Number (NSN) of the product

offersstring · uri[] · nullableOptional

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 · nullableOptional

The product identifier, such as ISBN. For example: 'isbn:123-456-789'

productionDatestring · nullableOptional

The production date of the product

purchaseDatestring · nullableOptional

The purchase date of the product

releaseDatestring · nullableOptional

The release date of the product

reviewstring · uri[] · nullableOptional

Review of the item

sizeany ofOptional

The size of the product

or

nullOptional

skustring · nullableRequired

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

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

/productgroups/{id}

HTTPcURLJavaScriptPython

PUT /productgroups/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 3929

{
  "id": null,
  "at_context": "https://schema.org",
  "at_type": "ProductGroup",
  "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": "ProductGroup",
  "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"
    }
  ]
}

Patch Object

patch

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters

idstringRequired

ID of the object to update

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

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

application/json

Objects Grid ProductGroup Object

idstring · max: 50 · nullableOptional

The unique identifier for ProductGroup

at_contextany ofOptional

Schema context

string · enumOptionalPossible values:

or

nullOptional

at_typeany ofOptional

The object type

string · enumOptionalPossible values:

or

nullOptional

identifierstring · max: 50 · nullableOptional

The unique identifier for ProductGroup

imagestring · nullableOptional

image URL

urlstring · min: 1 · nullableOptional

This Object URL

hasVariantstring · uri[] · nullableOptional

A pointer to a product variant

productGroupIDstring · nullableOptional

The Product Group ID for the product

variesBystring · uri[] · nullableOptional

The property by which the product varies, e.g. "color", "size", etc.

aggregateRatingany ofOptional

The aggregate rating of the Product

or

nullOptional

asinstring · nullableOptional

The Amazon Standard Identification Number (ASIN) of the product

audienceany ofOptional

The audience for the product

or

nullOptional

awardstring · nullableOptional

Awards won by or for this item

brandstring · nullableOptional

The brand of the product

categorystring[] · nullableOptional

The category of the product

colorstring · nullableOptional

The color of the product

colorSwatchstring · nullableOptional

Color swatch images for the product

countryOfAssemblyany ofOptional

The country where the product is assembled

string · enumOptionalPossible values:

or

nullOptional

countryOfLastProcessingany ofOptional

The country where the product was last processed

string · enumOptionalPossible values:

or

nullOptional

countryOfOriginany ofOptional

The country where the product was manufactured

string · enumOptionalPossible values:

or

nullOptional

depthany ofOptional

The depth of the product

or

nullOptional

fundingstring · nullableOptional

A pointer to a funding source for the item

gtinstring · nullableOptional

The Global Trade Item Number (GTIN) of the product

gtin12string · nullableOptional

The GTIN-12 of the product

gtin13string · nullableOptional

The GTIN-13 of the product

gtin14string · nullableOptional

The GTIN-14 of the product

gtin8string · nullableOptional

The GTIN-8 of the product

hasCertificationstring[] · nullableOptional

The certifications and/or standards for the product

hasEnergyConsumptionDetailsany ofOptional

The energy consumption details for the product

or

nullOptional

hasGS1DigitalLinkstring · nullableOptional

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 · nullableOptional

The Product Group ID for the product

isAccessoryOrSparePartForstring · uri[] · nullableOptional

A pointer to another product (or multiple products) for which this product is an accessory or spare part

isConsumableForstring · uri[] · nullableOptional

A pointer to another product (or multiple products) for which this product is a consumable

isFamilyFriendlyboolean · nullableOptional

Indicates whether this item is family friendly

isRelatedTostring · uri[] · nullableOptional

A pointer to another, somehow related product (or multiple products)

isSimilarTostring · uri[] · nullableOptional

A pointer to another, functionally similar product (or multiple products)

isVariantOfstring · nullableOptional

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:

or

nullOptional

logostring · nullableOptional

An associated logo for the product

manufacturerstring · nullableOptional

The manufacturer of the product

materialstring[] · nullableOptional

The material of the product

mobileUrlstring · nullableOptional

This Product Mobile URL

modelstring · nullableOptional

The model of the product

mpnstring · nullableOptional

The Manufacturer Part Number (MPN) of the product

nsnstring · nullableOptional

The NATO Stock Number (NSN) of the product

offersstring · uri[] · nullableOptional

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 · nullableOptional

The product identifier, such as ISBN. For example: 'isbn:123-456-789'

productionDatestring · nullableOptional

The production date of the product

purchaseDatestring · nullableOptional

The purchase date of the product

releaseDatestring · nullableOptional

The release date of the product

reviewstring · uri[] · nullableOptional

Review of the item

sizeany ofOptional

The size of the product

or

nullOptional

skustring · nullableRequired

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

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

/productgroups/{id}

HTTPcURLJavaScriptPython

PATCH /productgroups/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 3929

{
  "id": null,
  "at_context": "https://schema.org",
  "at_type": "ProductGroup",
  "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": "ProductGroup",
  "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"
    }
  ]
}

Delete Object

delete

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters

idstringRequired

ID of the object to delete

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

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

/productgroups/{id}

HTTPcURLJavaScriptPython

DELETE /productgroups/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Accept: */*

No content

List objects

get

This operation supports Elastic Search Query DSL query format

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Query parameters

langstringOptional

BCP 47 language code

Example: fr, de, de-AT, cy-GB

querystringOptional

Elastic Search Query DSL.

Example: { "query": { "match_all": {} } }

fromintegerOptional

Defines the starting record number for retrieval.

sizeintegerOptional

Defines the number of records to retrieve.

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

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

/productgroups

HTTPcURLJavaScriptPython

GET /productgroups HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Accept: */*

[
  {
    "id": null,
    "at_context": "https://schema.org",
    "at_type": "ProductGroup",
    "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"
      }
    ]
  }
]