Orders REST API
Orders REST API documentation and interactive testing.
For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/orders/contract
EU or US depending on where your Organization Account is located
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'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Objects Grid Order Object
The unique identifier
Schema context
The object type
The unique identifier
image URL
This Object URL
The offer(s) -- e.g., product, price specification, or payment method -- accepted by the customer
An entity that arranges for an exchange between a buyer and a seller.
A number that confirms the order or payment.
Party placing the order or paying the invoice.
Any discount applied to the order.
Code used to redeem a discount.
The currency (in 3-letter ISO 4217 format) of the discount.
Indicates whether the order is a gift.
Date order was placed.
The identifier of the order.
The current status of the order.
The item(s) included in the order.
The order is a part of the referenced invoice.
The date that payment is due.
The name of the payment method used (e.g. Credit Card, Cash).
An identifier for the method of payment used (e.g. the last 4 digits of the credit card).
A URL that can be used to pay for the order.
An entity which offers (sells / leases / licenses) the services / goods.
Successfully created the object
Bad request
Unauthorized
Conflict, object already exists
Too Many Requests - rate limited
Internal Server Error
POST /orders HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 1273
{
"id": "text",
"at_context": "https://schema.org",
"at_type": "Order",
"identifier": "text",
"image": "https://example.com",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": "https://example.com",
"acceptedOffer": [
"https://example.com"
],
"billingAddress": {
"at_type": "PostalAddress",
"addressCountry": "text",
"addressLocality": "text",
"addressRegion": "text",
"extendedAddress": "text",
"postOfficeBoxNumber": "text",
"postalCode": "text",
"streetAddress": "text"
},
"broker": "https://example.com",
"confirmationNumber": "text",
"customer": "https://example.com",
"discount": 1,
"discountCode": "text",
"discountCurrency": "AED",
"isGift": true,
"orderDate": "2025-10-05T17:59:35.489Z",
"orderNumber": "text",
"orderStatus": "https://schema.org/OrderCancelled",
"orderItem": [
"https://example.com"
],
"partOfInvoice": "https://example.com",
"paymentDueDate": "2025-10-05T17:59:35.489Z",
"paymentMethod": "text",
"paymentMethodId": "text",
"paymentUrl": "https://example.com",
"seller": "https://example.com",
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-10-05T17:59:35.489Z",
"createdBy": "text",
"lastUpdatedAt": "2025-10-05T17:59:35.489Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
{
"id": "text",
"at_context": "https://schema.org",
"at_type": "Order",
"identifier": "text",
"image": "https://example.com",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": "https://example.com",
"acceptedOffer": [
"https://example.com"
],
"billingAddress": {
"at_type": "PostalAddress",
"addressCountry": "text",
"addressLocality": "text",
"addressRegion": "text",
"extendedAddress": "text",
"postOfficeBoxNumber": "text",
"postalCode": "text",
"streetAddress": "text"
},
"broker": "https://example.com",
"confirmationNumber": "text",
"customer": "https://example.com",
"discount": 1,
"discountCode": "text",
"discountCurrency": "AED",
"isGift": true,
"orderDate": "2025-10-05T17:59:35.489Z",
"orderNumber": "text",
"orderStatus": "https://schema.org/OrderCancelled",
"orderItem": [
"https://example.com"
],
"partOfInvoice": "https://example.com",
"paymentDueDate": "2025-10-05T17:59:35.489Z",
"paymentMethod": "text",
"paymentMethodId": "text",
"paymentUrl": "https://example.com",
"seller": "https://example.com",
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-10-05T17:59:35.489Z",
"createdBy": "text",
"lastUpdatedAt": "2025-10-05T17:59:35.489Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
ID of the object to retrieve
BCP 47 language code
fr, de, de-AT, cy-GB
EU or US depending on where your Organization Account is located
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'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Successfully retrieved the object
Bad request
Unauthorized
Not Found
Too Many Requests
Internal server error
GET /orders/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Accept: */*
{
"id": "text",
"at_context": "https://schema.org",
"at_type": "Order",
"identifier": "text",
"image": "https://example.com",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": "https://example.com",
"acceptedOffer": [
"https://example.com"
],
"billingAddress": {
"at_type": "PostalAddress",
"addressCountry": "text",
"addressLocality": "text",
"addressRegion": "text",
"extendedAddress": "text",
"postOfficeBoxNumber": "text",
"postalCode": "text",
"streetAddress": "text"
},
"broker": "https://example.com",
"confirmationNumber": "text",
"customer": "https://example.com",
"discount": 1,
"discountCode": "text",
"discountCurrency": "AED",
"isGift": true,
"orderDate": "2025-10-05T17:59:35.489Z",
"orderNumber": "text",
"orderStatus": "https://schema.org/OrderCancelled",
"orderItem": [
"https://example.com"
],
"partOfInvoice": "https://example.com",
"paymentDueDate": "2025-10-05T17:59:35.489Z",
"paymentMethod": "text",
"paymentMethodId": "text",
"paymentUrl": "https://example.com",
"seller": "https://example.com",
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-10-05T17:59:35.489Z",
"createdBy": "text",
"lastUpdatedAt": "2025-10-05T17:59:35.489Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
ID of the object to update
EU or US depending on where your Organization Account is located
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'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Objects Grid Order Object
The unique identifier
Schema context
The object type
The unique identifier
image URL
This Object URL
The offer(s) -- e.g., product, price specification, or payment method -- accepted by the customer
An entity that arranges for an exchange between a buyer and a seller.
A number that confirms the order or payment.
Party placing the order or paying the invoice.
Any discount applied to the order.
Code used to redeem a discount.
The currency (in 3-letter ISO 4217 format) of the discount.
Indicates whether the order is a gift.
Date order was placed.
The identifier of the order.
The current status of the order.
The item(s) included in the order.
The order is a part of the referenced invoice.
The date that payment is due.
The name of the payment method used (e.g. Credit Card, Cash).
An identifier for the method of payment used (e.g. the last 4 digits of the credit card).
A URL that can be used to pay for the order.
An entity which offers (sells / leases / licenses) the services / goods.
Successfully updated the object
Bad request
Unauthorized
Not Found
Too Many Requests
Internal server error
PUT /orders/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 1273
{
"id": "text",
"at_context": "https://schema.org",
"at_type": "Order",
"identifier": "text",
"image": "https://example.com",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": "https://example.com",
"acceptedOffer": [
"https://example.com"
],
"billingAddress": {
"at_type": "PostalAddress",
"addressCountry": "text",
"addressLocality": "text",
"addressRegion": "text",
"extendedAddress": "text",
"postOfficeBoxNumber": "text",
"postalCode": "text",
"streetAddress": "text"
},
"broker": "https://example.com",
"confirmationNumber": "text",
"customer": "https://example.com",
"discount": 1,
"discountCode": "text",
"discountCurrency": "AED",
"isGift": true,
"orderDate": "2025-10-05T17:59:35.489Z",
"orderNumber": "text",
"orderStatus": "https://schema.org/OrderCancelled",
"orderItem": [
"https://example.com"
],
"partOfInvoice": "https://example.com",
"paymentDueDate": "2025-10-05T17:59:35.489Z",
"paymentMethod": "text",
"paymentMethodId": "text",
"paymentUrl": "https://example.com",
"seller": "https://example.com",
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-10-05T17:59:35.489Z",
"createdBy": "text",
"lastUpdatedAt": "2025-10-05T17:59:35.489Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
{
"id": "text",
"at_context": "https://schema.org",
"at_type": "Order",
"identifier": "text",
"image": "https://example.com",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": "https://example.com",
"acceptedOffer": [
"https://example.com"
],
"billingAddress": {
"at_type": "PostalAddress",
"addressCountry": "text",
"addressLocality": "text",
"addressRegion": "text",
"extendedAddress": "text",
"postOfficeBoxNumber": "text",
"postalCode": "text",
"streetAddress": "text"
},
"broker": "https://example.com",
"confirmationNumber": "text",
"customer": "https://example.com",
"discount": 1,
"discountCode": "text",
"discountCurrency": "AED",
"isGift": true,
"orderDate": "2025-10-05T17:59:35.489Z",
"orderNumber": "text",
"orderStatus": "https://schema.org/OrderCancelled",
"orderItem": [
"https://example.com"
],
"partOfInvoice": "https://example.com",
"paymentDueDate": "2025-10-05T17:59:35.489Z",
"paymentMethod": "text",
"paymentMethodId": "text",
"paymentUrl": "https://example.com",
"seller": "https://example.com",
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-10-05T17:59:35.489Z",
"createdBy": "text",
"lastUpdatedAt": "2025-10-05T17:59:35.489Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
ID of the object to update
EU or US depending on where your Organization Account is located
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'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Objects Grid Order Object
The unique identifier
Schema context
The object type
The unique identifier
image URL
This Object URL
The offer(s) -- e.g., product, price specification, or payment method -- accepted by the customer
An entity that arranges for an exchange between a buyer and a seller.
A number that confirms the order or payment.
Party placing the order or paying the invoice.
Any discount applied to the order.
Code used to redeem a discount.
The currency (in 3-letter ISO 4217 format) of the discount.
Indicates whether the order is a gift.
Date order was placed.
The identifier of the order.
The current status of the order.
The item(s) included in the order.
The order is a part of the referenced invoice.
The date that payment is due.
The name of the payment method used (e.g. Credit Card, Cash).
An identifier for the method of payment used (e.g. the last 4 digits of the credit card).
A URL that can be used to pay for the order.
An entity which offers (sells / leases / licenses) the services / goods.
Successfully patched the object
Bad request
Unauthorized
Not Found
Too Many Requests
Internal server error
PATCH /orders/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 1273
{
"id": "text",
"at_context": "https://schema.org",
"at_type": "Order",
"identifier": "text",
"image": "https://example.com",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": "https://example.com",
"acceptedOffer": [
"https://example.com"
],
"billingAddress": {
"at_type": "PostalAddress",
"addressCountry": "text",
"addressLocality": "text",
"addressRegion": "text",
"extendedAddress": "text",
"postOfficeBoxNumber": "text",
"postalCode": "text",
"streetAddress": "text"
},
"broker": "https://example.com",
"confirmationNumber": "text",
"customer": "https://example.com",
"discount": 1,
"discountCode": "text",
"discountCurrency": "AED",
"isGift": true,
"orderDate": "2025-10-05T17:59:35.489Z",
"orderNumber": "text",
"orderStatus": "https://schema.org/OrderCancelled",
"orderItem": [
"https://example.com"
],
"partOfInvoice": "https://example.com",
"paymentDueDate": "2025-10-05T17:59:35.489Z",
"paymentMethod": "text",
"paymentMethodId": "text",
"paymentUrl": "https://example.com",
"seller": "https://example.com",
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-10-05T17:59:35.489Z",
"createdBy": "text",
"lastUpdatedAt": "2025-10-05T17:59:35.489Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
{
"id": "text",
"at_context": "https://schema.org",
"at_type": "Order",
"identifier": "text",
"image": "https://example.com",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": "https://example.com",
"acceptedOffer": [
"https://example.com"
],
"billingAddress": {
"at_type": "PostalAddress",
"addressCountry": "text",
"addressLocality": "text",
"addressRegion": "text",
"extendedAddress": "text",
"postOfficeBoxNumber": "text",
"postalCode": "text",
"streetAddress": "text"
},
"broker": "https://example.com",
"confirmationNumber": "text",
"customer": "https://example.com",
"discount": 1,
"discountCode": "text",
"discountCurrency": "AED",
"isGift": true,
"orderDate": "2025-10-05T17:59:35.489Z",
"orderNumber": "text",
"orderStatus": "https://schema.org/OrderCancelled",
"orderItem": [
"https://example.com"
],
"partOfInvoice": "https://example.com",
"paymentDueDate": "2025-10-05T17:59:35.489Z",
"paymentMethod": "text",
"paymentMethodId": "text",
"paymentUrl": "https://example.com",
"seller": "https://example.com",
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-10-05T17:59:35.489Z",
"createdBy": "text",
"lastUpdatedAt": "2025-10-05T17:59:35.489Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
ID of the object to delete
EU or US depending on where your Organization Account is located
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'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Successfully deleted the object
Bad request
Unauthorized
Not Found
Too Many Requests
Internal server error
DELETE /orders/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Accept: */*
No content
This operation supports Elastic Search Query DSL query format
BCP 47 language code
fr, de, de-AT, cy-GB
Elastic Search Query DSL.
{ "query": { "match_all": {} } }
Defines the starting record number for retrieval.
Defines the number of records to retrieve.
EU or US depending on where your Organization Account is located
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'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Successfully listed the objects
Bad request
Unauthorized
Too Many Requests - rate limited
Internal Server Error
GET /orders HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Accept: */*
[
{
"id": "text",
"at_context": "https://schema.org",
"at_type": "Order",
"identifier": "text",
"image": "https://example.com",
"name": [
{
"at_value": "text",
"at_language": "text"
}
],
"description": [
{
"at_value": "text",
"at_language": "text"
}
],
"url": "https://example.com",
"acceptedOffer": [
"https://example.com"
],
"billingAddress": {
"at_type": "PostalAddress",
"addressCountry": "text",
"addressLocality": "text",
"addressRegion": "text",
"extendedAddress": "text",
"postOfficeBoxNumber": "text",
"postalCode": "text",
"streetAddress": "text"
},
"broker": "https://example.com",
"confirmationNumber": "text",
"customer": "https://example.com",
"discount": 1,
"discountCode": "text",
"discountCurrency": "AED",
"isGift": true,
"orderDate": "2025-10-05T17:59:35.489Z",
"orderNumber": "text",
"orderStatus": "https://schema.org/OrderCancelled",
"orderItem": [
"https://example.com"
],
"partOfInvoice": "https://example.com",
"paymentDueDate": "2025-10-05T17:59:35.489Z",
"paymentMethod": "text",
"paymentMethodId": "text",
"paymentUrl": "https://example.com",
"seller": "https://example.com",
"tags": [
{
"name": "text",
"val": "text"
}
],
"meta": {
"objectVersion": 1,
"objectType": "text",
"namespace": "text",
"createdAt": "2025-10-05T17:59:35.489Z",
"createdBy": "text",
"lastUpdatedAt": "2025-10-05T17:59:35.489Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}
]
Last updated
Was this helpful?