Offers REST API

Offers REST API documentation and interactive testing.

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

Create object

post

Authorizations

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

Implements https://schema.org/Offer

at_contextstring · enumOptional

Convention for '@context' JSON-LD compliance, convert in the frontend

Possible values:

at_typestring · enumOptional

Convention for '@type' JSON-LD compliance, convert in the frontend

Possible values:

identifierstringOptional

The Offer's ID, generated

imagestringOptional

image URL

urlstringOptional

URL reference to itself

acceptedPaymentMethodstring[]Optional

URLs to PaymentMethods, see https://schema.org/PaymentMethod for standard values.

availabilityobject · enum[]Optional

The Offer's availability, see https://schema.org/ItemAvailability for standard values.

availabilityEndsstring · date-timeOptional

The date and time when the Offer is no longer available.

availabilityStartsstring · date-timeOptional

The date and time when the Offer becomes available.

availableDeliveryMethodobject · enum[]Optional

URLs to DeliveryMethods, e.g. https://schema.org/DeliveryMethod

businessFunctionstring[]Optional

The business function of the Offer, see https://schema.org/BusinessFunction for standard values.

categorystring[]Optional

Item category(es). Greater signs or slashes can be used to informally indicate a category hierarchy.

checkoutPageURLTemplatestringOptional

URL template for the checkout page

eligibleCustomerTypestring[]Optional

The type of customer eligible for the Offer, see https://schema.org/BusinessEntityType for standard values.

eligibleQuantitynumberOptional

eligibleRegionstring[]Optional

The The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code

itemConditionobject · enumOptional

Implements https://schema.org/ItemCondition

Possible values:

itemOfferedstringOptional

URL to the item being offered, e.g. a Product or Service

offeredBystringOptional

URL to the Organization or Person offering the item

pricenumberRequired

The price of the item being offered.

priceCurrencystring · enumRequired

ISO 4217 Currency Code

Possible values:

priceValidUntilstring · date-timeOptional

The date until the Price is valid.

validFromstring · date-timeOptional

The date and time when the Offer becomes valid.

validThroughstring · date-timeOptional

The date and time when the Offer is no longer valid.

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

HTTPcURLJavaScriptPython

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

{
  "at_context": "https://schema.org",
  "at_type": "Offer",
  "identifier": "text",
  "image": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "url": "text",
  "acceptedPaymentMethod": [
    "text"
  ],
  "availability": [
    "https://schema.org/BackOrder"
  ],
  "availabilityEnds": "2025-08-26T16:43:38.135Z",
  "availabilityStarts": "2025-08-26T16:43:38.135Z",
  "availableDeliveryMethod": [
    "http://purl.org/goodrelations/v1#DeliveryModeDirectDownload"
  ],
  "businessFunction": [
    "text"
  ],
  "category": [
    "text"
  ],
  "checkoutPageURLTemplate": "text",
  "deliveryLeadTime": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleCustomerType": [
    "text"
  ],
  "eligibleDuration": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleQuantity": 1,
  "eligibleRegion": [
    "text"
  ],
  "hasMerchantReturnPolicy": {
    "at_type": "MerchantReturnPolicy",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "applicableCountry": "text",
    "inStoreReturnOffered": true,
    "itemCondition": "https://schema.org/DamagedCondition",
    "merchantReturnDays": 1,
    "refundType": [
      "https://schema.org/ExchangeRefund"
    ],
    "returnPolicyCategory": [
      "https://schema.org/MerchantReturnFiniteReturnWindow"
    ],
    "returnMethod": [
      "https://schema.org/KeepProduct"
    ],
    "returnFees": [
      "https://schema.org/FreeReturn"
    ]
  },
  "itemCondition": "https://schema.org/DamagedCondition",
  "itemOffered": "text",
  "offeredBy": "text",
  "price": 1,
  "priceCurrency": "AED",
  "priceValidUntil": "2025-08-26T16:43:38.135Z",
  "shippingDetails": {
    "at_type": "OfferShippingDetails",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "deliveryTime": {
      "at_type": "ShippingDeliveryTime",
      "businessDays": [
        "https://schema.org/Monday"
      ],
      "cutoffTime": "16:43:38",
      "handlingTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      },
      "transitTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      }
    },
    "depth": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "doesNotShip": true,
    "height": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "shippingRate": {
      "at_type": "MonetaryAmount",
      "currency": "text",
      "maxValue": 1,
      "minValue": 1,
      "value": 1
    },
    "weight": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "width": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    }
  },
  "validFrom": "2025-08-26T16:43:38.135Z",
  "validThrough": "2025-08-26T16:43:38.135Z",
  "warranty": {
    "at_type": "WarrantyPromise",
    "durationOfWarranty": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "warrantyScope": "text"
  }
}

{
  "at_context": "https://schema.org",
  "at_type": "Offer",
  "identifier": "text",
  "image": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "url": "text",
  "acceptedPaymentMethod": [
    "text"
  ],
  "availability": [
    "https://schema.org/BackOrder"
  ],
  "availabilityEnds": "2025-08-26T16:43:38.135Z",
  "availabilityStarts": "2025-08-26T16:43:38.135Z",
  "availableDeliveryMethod": [
    "http://purl.org/goodrelations/v1#DeliveryModeDirectDownload"
  ],
  "businessFunction": [
    "text"
  ],
  "category": [
    "text"
  ],
  "checkoutPageURLTemplate": "text",
  "deliveryLeadTime": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleCustomerType": [
    "text"
  ],
  "eligibleDuration": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleQuantity": 1,
  "eligibleRegion": [
    "text"
  ],
  "hasMerchantReturnPolicy": {
    "at_type": "MerchantReturnPolicy",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "applicableCountry": "text",
    "inStoreReturnOffered": true,
    "itemCondition": "https://schema.org/DamagedCondition",
    "merchantReturnDays": 1,
    "refundType": [
      "https://schema.org/ExchangeRefund"
    ],
    "returnPolicyCategory": [
      "https://schema.org/MerchantReturnFiniteReturnWindow"
    ],
    "returnMethod": [
      "https://schema.org/KeepProduct"
    ],
    "returnFees": [
      "https://schema.org/FreeReturn"
    ]
  },
  "itemCondition": "https://schema.org/DamagedCondition",
  "itemOffered": "text",
  "offeredBy": "text",
  "price": 1,
  "priceCurrency": "AED",
  "priceValidUntil": "2025-08-26T16:43:38.135Z",
  "shippingDetails": {
    "at_type": "OfferShippingDetails",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "deliveryTime": {
      "at_type": "ShippingDeliveryTime",
      "businessDays": [
        "https://schema.org/Monday"
      ],
      "cutoffTime": "16:43:38",
      "handlingTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      },
      "transitTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      }
    },
    "depth": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "doesNotShip": true,
    "height": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "shippingRate": {
      "at_type": "MonetaryAmount",
      "currency": "text",
      "maxValue": 1,
      "minValue": 1,
      "value": 1
    },
    "weight": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "width": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    }
  },
  "validFrom": "2025-08-26T16:43:38.135Z",
  "validThrough": "2025-08-26T16:43:38.135Z",
  "warranty": {
    "at_type": "WarrantyPromise",
    "durationOfWarranty": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "warrantyScope": "text"
  }
}

Retrieve Object

get

Authorizations

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

HTTPcURLJavaScriptPython

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

{
  "at_context": "https://schema.org",
  "at_type": "Offer",
  "identifier": "text",
  "image": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "url": "text",
  "acceptedPaymentMethod": [
    "text"
  ],
  "availability": [
    "https://schema.org/BackOrder"
  ],
  "availabilityEnds": "2025-08-26T16:43:38.135Z",
  "availabilityStarts": "2025-08-26T16:43:38.135Z",
  "availableDeliveryMethod": [
    "http://purl.org/goodrelations/v1#DeliveryModeDirectDownload"
  ],
  "businessFunction": [
    "text"
  ],
  "category": [
    "text"
  ],
  "checkoutPageURLTemplate": "text",
  "deliveryLeadTime": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleCustomerType": [
    "text"
  ],
  "eligibleDuration": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleQuantity": 1,
  "eligibleRegion": [
    "text"
  ],
  "hasMerchantReturnPolicy": {
    "at_type": "MerchantReturnPolicy",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "applicableCountry": "text",
    "inStoreReturnOffered": true,
    "itemCondition": "https://schema.org/DamagedCondition",
    "merchantReturnDays": 1,
    "refundType": [
      "https://schema.org/ExchangeRefund"
    ],
    "returnPolicyCategory": [
      "https://schema.org/MerchantReturnFiniteReturnWindow"
    ],
    "returnMethod": [
      "https://schema.org/KeepProduct"
    ],
    "returnFees": [
      "https://schema.org/FreeReturn"
    ]
  },
  "itemCondition": "https://schema.org/DamagedCondition",
  "itemOffered": "text",
  "offeredBy": "text",
  "price": 1,
  "priceCurrency": "AED",
  "priceValidUntil": "2025-08-26T16:43:38.135Z",
  "shippingDetails": {
    "at_type": "OfferShippingDetails",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "deliveryTime": {
      "at_type": "ShippingDeliveryTime",
      "businessDays": [
        "https://schema.org/Monday"
      ],
      "cutoffTime": "16:43:38",
      "handlingTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      },
      "transitTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      }
    },
    "depth": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "doesNotShip": true,
    "height": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "shippingRate": {
      "at_type": "MonetaryAmount",
      "currency": "text",
      "maxValue": 1,
      "minValue": 1,
      "value": 1
    },
    "weight": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "width": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    }
  },
  "validFrom": "2025-08-26T16:43:38.135Z",
  "validThrough": "2025-08-26T16:43:38.135Z",
  "warranty": {
    "at_type": "WarrantyPromise",
    "durationOfWarranty": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "warrantyScope": "text"
  }
}

Update Object

put

Authorizations

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

Implements https://schema.org/Offer

at_contextstring · enumOptional

Convention for '@context' JSON-LD compliance, convert in the frontend

Possible values:

at_typestring · enumOptional

Convention for '@type' JSON-LD compliance, convert in the frontend

Possible values:

identifierstringOptional

The Offer's ID, generated

imagestringOptional

image URL

urlstringOptional

URL reference to itself

acceptedPaymentMethodstring[]Optional

URLs to PaymentMethods, see https://schema.org/PaymentMethod for standard values.

availabilityobject · enum[]Optional

The Offer's availability, see https://schema.org/ItemAvailability for standard values.

availabilityEndsstring · date-timeOptional

The date and time when the Offer is no longer available.

availabilityStartsstring · date-timeOptional

The date and time when the Offer becomes available.

availableDeliveryMethodobject · enum[]Optional

URLs to DeliveryMethods, e.g. https://schema.org/DeliveryMethod

businessFunctionstring[]Optional

The business function of the Offer, see https://schema.org/BusinessFunction for standard values.

categorystring[]Optional

Item category(es). Greater signs or slashes can be used to informally indicate a category hierarchy.

checkoutPageURLTemplatestringOptional

URL template for the checkout page

eligibleCustomerTypestring[]Optional

The type of customer eligible for the Offer, see https://schema.org/BusinessEntityType for standard values.

eligibleQuantitynumberOptional

eligibleRegionstring[]Optional

The The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code

itemConditionobject · enumOptional

Implements https://schema.org/ItemCondition

Possible values:

itemOfferedstringOptional

URL to the item being offered, e.g. a Product or Service

offeredBystringOptional

URL to the Organization or Person offering the item

pricenumberRequired

The price of the item being offered.

priceCurrencystring · enumRequired

ISO 4217 Currency Code

Possible values:

priceValidUntilstring · date-timeOptional

The date until the Price is valid.

validFromstring · date-timeOptional

The date and time when the Offer becomes valid.

validThroughstring · date-timeOptional

The date and time when the Offer is no longer valid.

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

HTTPcURLJavaScriptPython

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

{
  "at_context": "https://schema.org",
  "at_type": "Offer",
  "identifier": "text",
  "image": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "url": "text",
  "acceptedPaymentMethod": [
    "text"
  ],
  "availability": [
    "https://schema.org/BackOrder"
  ],
  "availabilityEnds": "2025-08-26T16:43:38.135Z",
  "availabilityStarts": "2025-08-26T16:43:38.135Z",
  "availableDeliveryMethod": [
    "http://purl.org/goodrelations/v1#DeliveryModeDirectDownload"
  ],
  "businessFunction": [
    "text"
  ],
  "category": [
    "text"
  ],
  "checkoutPageURLTemplate": "text",
  "deliveryLeadTime": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleCustomerType": [
    "text"
  ],
  "eligibleDuration": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleQuantity": 1,
  "eligibleRegion": [
    "text"
  ],
  "hasMerchantReturnPolicy": {
    "at_type": "MerchantReturnPolicy",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "applicableCountry": "text",
    "inStoreReturnOffered": true,
    "itemCondition": "https://schema.org/DamagedCondition",
    "merchantReturnDays": 1,
    "refundType": [
      "https://schema.org/ExchangeRefund"
    ],
    "returnPolicyCategory": [
      "https://schema.org/MerchantReturnFiniteReturnWindow"
    ],
    "returnMethod": [
      "https://schema.org/KeepProduct"
    ],
    "returnFees": [
      "https://schema.org/FreeReturn"
    ]
  },
  "itemCondition": "https://schema.org/DamagedCondition",
  "itemOffered": "text",
  "offeredBy": "text",
  "price": 1,
  "priceCurrency": "AED",
  "priceValidUntil": "2025-08-26T16:43:38.135Z",
  "shippingDetails": {
    "at_type": "OfferShippingDetails",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "deliveryTime": {
      "at_type": "ShippingDeliveryTime",
      "businessDays": [
        "https://schema.org/Monday"
      ],
      "cutoffTime": "16:43:38",
      "handlingTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      },
      "transitTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      }
    },
    "depth": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "doesNotShip": true,
    "height": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "shippingRate": {
      "at_type": "MonetaryAmount",
      "currency": "text",
      "maxValue": 1,
      "minValue": 1,
      "value": 1
    },
    "weight": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "width": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    }
  },
  "validFrom": "2025-08-26T16:43:38.135Z",
  "validThrough": "2025-08-26T16:43:38.135Z",
  "warranty": {
    "at_type": "WarrantyPromise",
    "durationOfWarranty": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "warrantyScope": "text"
  }
}

{
  "at_context": "https://schema.org",
  "at_type": "Offer",
  "identifier": "text",
  "image": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "url": "text",
  "acceptedPaymentMethod": [
    "text"
  ],
  "availability": [
    "https://schema.org/BackOrder"
  ],
  "availabilityEnds": "2025-08-26T16:43:38.135Z",
  "availabilityStarts": "2025-08-26T16:43:38.135Z",
  "availableDeliveryMethod": [
    "http://purl.org/goodrelations/v1#DeliveryModeDirectDownload"
  ],
  "businessFunction": [
    "text"
  ],
  "category": [
    "text"
  ],
  "checkoutPageURLTemplate": "text",
  "deliveryLeadTime": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleCustomerType": [
    "text"
  ],
  "eligibleDuration": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleQuantity": 1,
  "eligibleRegion": [
    "text"
  ],
  "hasMerchantReturnPolicy": {
    "at_type": "MerchantReturnPolicy",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "applicableCountry": "text",
    "inStoreReturnOffered": true,
    "itemCondition": "https://schema.org/DamagedCondition",
    "merchantReturnDays": 1,
    "refundType": [
      "https://schema.org/ExchangeRefund"
    ],
    "returnPolicyCategory": [
      "https://schema.org/MerchantReturnFiniteReturnWindow"
    ],
    "returnMethod": [
      "https://schema.org/KeepProduct"
    ],
    "returnFees": [
      "https://schema.org/FreeReturn"
    ]
  },
  "itemCondition": "https://schema.org/DamagedCondition",
  "itemOffered": "text",
  "offeredBy": "text",
  "price": 1,
  "priceCurrency": "AED",
  "priceValidUntil": "2025-08-26T16:43:38.135Z",
  "shippingDetails": {
    "at_type": "OfferShippingDetails",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "deliveryTime": {
      "at_type": "ShippingDeliveryTime",
      "businessDays": [
        "https://schema.org/Monday"
      ],
      "cutoffTime": "16:43:38",
      "handlingTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      },
      "transitTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      }
    },
    "depth": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "doesNotShip": true,
    "height": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "shippingRate": {
      "at_type": "MonetaryAmount",
      "currency": "text",
      "maxValue": 1,
      "minValue": 1,
      "value": 1
    },
    "weight": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "width": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    }
  },
  "validFrom": "2025-08-26T16:43:38.135Z",
  "validThrough": "2025-08-26T16:43:38.135Z",
  "warranty": {
    "at_type": "WarrantyPromise",
    "durationOfWarranty": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "warrantyScope": "text"
  }
}

Patch Object

patch

Authorizations

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

Implements https://schema.org/Offer

at_contextstring · enumOptional

Convention for '@context' JSON-LD compliance, convert in the frontend

Possible values:

at_typestring · enumOptional

Convention for '@type' JSON-LD compliance, convert in the frontend

Possible values:

identifierstringOptional

The Offer's ID, generated

imagestringOptional

image URL

urlstringOptional

URL reference to itself

acceptedPaymentMethodstring[]Optional

URLs to PaymentMethods, see https://schema.org/PaymentMethod for standard values.

availabilityobject · enum[]Optional

The Offer's availability, see https://schema.org/ItemAvailability for standard values.

availabilityEndsstring · date-timeOptional

The date and time when the Offer is no longer available.

availabilityStartsstring · date-timeOptional

The date and time when the Offer becomes available.

availableDeliveryMethodobject · enum[]Optional

URLs to DeliveryMethods, e.g. https://schema.org/DeliveryMethod

businessFunctionstring[]Optional

The business function of the Offer, see https://schema.org/BusinessFunction for standard values.

categorystring[]Optional

Item category(es). Greater signs or slashes can be used to informally indicate a category hierarchy.

checkoutPageURLTemplatestringOptional

URL template for the checkout page

eligibleCustomerTypestring[]Optional

The type of customer eligible for the Offer, see https://schema.org/BusinessEntityType for standard values.

eligibleQuantitynumberOptional

eligibleRegionstring[]Optional

The The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code

itemConditionobject · enumOptional

Implements https://schema.org/ItemCondition

Possible values:

itemOfferedstringOptional

URL to the item being offered, e.g. a Product or Service

offeredBystringOptional

URL to the Organization or Person offering the item

pricenumberRequired

The price of the item being offered.

priceCurrencystring · enumRequired

ISO 4217 Currency Code

Possible values:

priceValidUntilstring · date-timeOptional

The date until the Price is valid.

validFromstring · date-timeOptional

The date and time when the Offer becomes valid.

validThroughstring · date-timeOptional

The date and time when the Offer is no longer valid.

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

HTTPcURLJavaScriptPython

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

{
  "at_context": "https://schema.org",
  "at_type": "Offer",
  "identifier": "text",
  "image": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "url": "text",
  "acceptedPaymentMethod": [
    "text"
  ],
  "availability": [
    "https://schema.org/BackOrder"
  ],
  "availabilityEnds": "2025-08-26T16:43:38.135Z",
  "availabilityStarts": "2025-08-26T16:43:38.135Z",
  "availableDeliveryMethod": [
    "http://purl.org/goodrelations/v1#DeliveryModeDirectDownload"
  ],
  "businessFunction": [
    "text"
  ],
  "category": [
    "text"
  ],
  "checkoutPageURLTemplate": "text",
  "deliveryLeadTime": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleCustomerType": [
    "text"
  ],
  "eligibleDuration": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleQuantity": 1,
  "eligibleRegion": [
    "text"
  ],
  "hasMerchantReturnPolicy": {
    "at_type": "MerchantReturnPolicy",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "applicableCountry": "text",
    "inStoreReturnOffered": true,
    "itemCondition": "https://schema.org/DamagedCondition",
    "merchantReturnDays": 1,
    "refundType": [
      "https://schema.org/ExchangeRefund"
    ],
    "returnPolicyCategory": [
      "https://schema.org/MerchantReturnFiniteReturnWindow"
    ],
    "returnMethod": [
      "https://schema.org/KeepProduct"
    ],
    "returnFees": [
      "https://schema.org/FreeReturn"
    ]
  },
  "itemCondition": "https://schema.org/DamagedCondition",
  "itemOffered": "text",
  "offeredBy": "text",
  "price": 1,
  "priceCurrency": "AED",
  "priceValidUntil": "2025-08-26T16:43:38.135Z",
  "shippingDetails": {
    "at_type": "OfferShippingDetails",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "deliveryTime": {
      "at_type": "ShippingDeliveryTime",
      "businessDays": [
        "https://schema.org/Monday"
      ],
      "cutoffTime": "16:43:38",
      "handlingTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      },
      "transitTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      }
    },
    "depth": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "doesNotShip": true,
    "height": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "shippingRate": {
      "at_type": "MonetaryAmount",
      "currency": "text",
      "maxValue": 1,
      "minValue": 1,
      "value": 1
    },
    "weight": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "width": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    }
  },
  "validFrom": "2025-08-26T16:43:38.135Z",
  "validThrough": "2025-08-26T16:43:38.135Z",
  "warranty": {
    "at_type": "WarrantyPromise",
    "durationOfWarranty": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "warrantyScope": "text"
  }
}

{
  "at_context": "https://schema.org",
  "at_type": "Offer",
  "identifier": "text",
  "image": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "url": "text",
  "acceptedPaymentMethod": [
    "text"
  ],
  "availability": [
    "https://schema.org/BackOrder"
  ],
  "availabilityEnds": "2025-08-26T16:43:38.135Z",
  "availabilityStarts": "2025-08-26T16:43:38.135Z",
  "availableDeliveryMethod": [
    "http://purl.org/goodrelations/v1#DeliveryModeDirectDownload"
  ],
  "businessFunction": [
    "text"
  ],
  "category": [
    "text"
  ],
  "checkoutPageURLTemplate": "text",
  "deliveryLeadTime": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleCustomerType": [
    "text"
  ],
  "eligibleDuration": {
    "at_type": "QuantitativeValue",
    "maxValue": 1,
    "minValue": 1,
    "unitCode": "text",
    "unitText": "text",
    "value": 1
  },
  "eligibleQuantity": 1,
  "eligibleRegion": [
    "text"
  ],
  "hasMerchantReturnPolicy": {
    "at_type": "MerchantReturnPolicy",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "applicableCountry": "text",
    "inStoreReturnOffered": true,
    "itemCondition": "https://schema.org/DamagedCondition",
    "merchantReturnDays": 1,
    "refundType": [
      "https://schema.org/ExchangeRefund"
    ],
    "returnPolicyCategory": [
      "https://schema.org/MerchantReturnFiniteReturnWindow"
    ],
    "returnMethod": [
      "https://schema.org/KeepProduct"
    ],
    "returnFees": [
      "https://schema.org/FreeReturn"
    ]
  },
  "itemCondition": "https://schema.org/DamagedCondition",
  "itemOffered": "text",
  "offeredBy": "text",
  "price": 1,
  "priceCurrency": "AED",
  "priceValidUntil": "2025-08-26T16:43:38.135Z",
  "shippingDetails": {
    "at_type": "OfferShippingDetails",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "deliveryTime": {
      "at_type": "ShippingDeliveryTime",
      "businessDays": [
        "https://schema.org/Monday"
      ],
      "cutoffTime": "16:43:38",
      "handlingTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      },
      "transitTime": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      }
    },
    "depth": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "doesNotShip": true,
    "height": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "shippingRate": {
      "at_type": "MonetaryAmount",
      "currency": "text",
      "maxValue": 1,
      "minValue": 1,
      "value": 1
    },
    "weight": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "width": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    }
  },
  "validFrom": "2025-08-26T16:43:38.135Z",
  "validThrough": "2025-08-26T16:43:38.135Z",
  "warranty": {
    "at_type": "WarrantyPromise",
    "durationOfWarranty": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "warrantyScope": "text"
  }
}

Delete Object

delete

Authorizations

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

HTTPcURLJavaScriptPython

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

No content

List objects

get

This operation supports Elastic Search Query DSL query format

Authorizations

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

HTTPcURLJavaScriptPython

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

[
  {
    "at_context": "https://schema.org",
    "at_type": "Offer",
    "identifier": "text",
    "image": "text",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "url": "text",
    "acceptedPaymentMethod": [
      "text"
    ],
    "availability": [
      "https://schema.org/BackOrder"
    ],
    "availabilityEnds": "2025-08-26T16:43:38.135Z",
    "availabilityStarts": "2025-08-26T16:43:38.135Z",
    "availableDeliveryMethod": [
      "http://purl.org/goodrelations/v1#DeliveryModeDirectDownload"
    ],
    "businessFunction": [
      "text"
    ],
    "category": [
      "text"
    ],
    "checkoutPageURLTemplate": "text",
    "deliveryLeadTime": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "eligibleCustomerType": [
      "text"
    ],
    "eligibleDuration": {
      "at_type": "QuantitativeValue",
      "maxValue": 1,
      "minValue": 1,
      "unitCode": "text",
      "unitText": "text",
      "value": 1
    },
    "eligibleQuantity": 1,
    "eligibleRegion": [
      "text"
    ],
    "hasMerchantReturnPolicy": {
      "at_type": "MerchantReturnPolicy",
      "name": [
        {
          "at_value": "text",
          "at_language": "text"
        }
      ],
      "description": [
        {
          "at_value": "text",
          "at_language": "text"
        }
      ],
      "applicableCountry": "text",
      "inStoreReturnOffered": true,
      "itemCondition": "https://schema.org/DamagedCondition",
      "merchantReturnDays": 1,
      "refundType": [
        "https://schema.org/ExchangeRefund"
      ],
      "returnPolicyCategory": [
        "https://schema.org/MerchantReturnFiniteReturnWindow"
      ],
      "returnMethod": [
        "https://schema.org/KeepProduct"
      ],
      "returnFees": [
        "https://schema.org/FreeReturn"
      ]
    },
    "itemCondition": "https://schema.org/DamagedCondition",
    "itemOffered": "text",
    "offeredBy": "text",
    "price": 1,
    "priceCurrency": "AED",
    "priceValidUntil": "2025-08-26T16:43:38.135Z",
    "shippingDetails": {
      "at_type": "OfferShippingDetails",
      "name": [
        {
          "at_value": "text",
          "at_language": "text"
        }
      ],
      "description": [
        {
          "at_value": "text",
          "at_language": "text"
        }
      ],
      "deliveryTime": {
        "at_type": "ShippingDeliveryTime",
        "businessDays": [
          "https://schema.org/Monday"
        ],
        "cutoffTime": "16:43:38",
        "handlingTime": {
          "at_type": "QuantitativeValue",
          "maxValue": 1,
          "minValue": 1,
          "unitCode": "text",
          "unitText": "text",
          "value": 1
        },
        "transitTime": {
          "at_type": "QuantitativeValue",
          "maxValue": 1,
          "minValue": 1,
          "unitCode": "text",
          "unitText": "text",
          "value": 1
        }
      },
      "depth": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      },
      "doesNotShip": true,
      "height": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      },
      "shippingRate": {
        "at_type": "MonetaryAmount",
        "currency": "text",
        "maxValue": 1,
        "minValue": 1,
        "value": 1
      },
      "weight": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      },
      "width": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      }
    },
    "validFrom": "2025-08-26T16:43:38.135Z",
    "validThrough": "2025-08-26T16:43:38.135Z",
    "warranty": {
      "at_type": "WarrantyPromise",
      "durationOfWarranty": {
        "at_type": "QuantitativeValue",
        "maxValue": 1,
        "minValue": 1,
        "unitCode": "text",
        "unitText": "text",
        "value": 1
      },
      "warrantyScope": "text"
    }
  }
]