Orders REST API

Orders REST API documentation and interactive testing.

For the OpenAPI Specificationarrow-up-right document use this link: https://apis.objectsgrid.com/orders/contractarrow-up-right

Create object

post
Authorizations
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

Objects Grid Order Object

idstring · max: 50Optional

The unique identifier

at_contextany ofOptional

Schema context

string · enumOptionalPossible values:
or
nullOptional
at_typeany ofOptional

The object type

string · enumOptionalPossible values:
or
nullOptional
identifierstring · max: 50Optional

The unique identifier

imagestring · uriOptional

image URL

urlstring · uriOptional

This Object URL

acceptedOfferstring · uri[]Required

The offer(s) -- e.g., product, price specification, or payment method -- accepted by the customer

brokerstring · uriOptional

An entity that arranges for an exchange between a buyer and a seller.

confirmationNumberstringOptional

A number that confirms the order or payment.

customerstring · uriRequired

Party placing the order or paying the invoice.

discountnumber · floatOptional

Any discount applied to the order.

discountCodestringOptional

Code used to redeem a discount.

discountCurrencystring · enumOptional

The currency (in 3-letter ISO 4217 format) of the discount.

Possible values:
isGiftbooleanOptional

Indicates whether the order is a gift.

orderDatestring · date-timeRequired

Date order was placed.

orderNumberstringOptional

The identifier of the order.

orderStatusstring · enumOptional

The current status of the order.

Possible values:
orderItemstring · uri[]Required

The item(s) included in the order.

partOfInvoicestring · uriOptional

The order is a part of the referenced invoice.

paymentDueDatestring · date-timeOptional

The date that payment is due.

paymentMethodstringOptional

The name of the payment method used (e.g. Credit Card, Cash).

paymentMethodIdstringOptional

An identifier for the method of payment used (e.g. the last 4 digits of the credit card).

paymentUrlstring · uriOptional

A URL that can be used to pay for the order.

sellerstring · uriRequired

An entity which offers (sells / leases / licenses) the services / goods.

Responses
post
/orders

Retrieve Object

get
Authorizations
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
chevron-right
200

Successfully retrieved the object

application/json
get
/orders/{id}

Update Object

put
Authorizations
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

Objects Grid Order Object

idstring · max: 50Optional

The unique identifier

at_contextany ofOptional

Schema context

string · enumOptionalPossible values:
or
nullOptional
at_typeany ofOptional

The object type

string · enumOptionalPossible values:
or
nullOptional
identifierstring · max: 50Optional

The unique identifier

imagestring · uriOptional

image URL

urlstring · uriOptional

This Object URL

acceptedOfferstring · uri[]Required

The offer(s) -- e.g., product, price specification, or payment method -- accepted by the customer

brokerstring · uriOptional

An entity that arranges for an exchange between a buyer and a seller.

confirmationNumberstringOptional

A number that confirms the order or payment.

customerstring · uriRequired

Party placing the order or paying the invoice.

discountnumber · floatOptional

Any discount applied to the order.

discountCodestringOptional

Code used to redeem a discount.

discountCurrencystring · enumOptional

The currency (in 3-letter ISO 4217 format) of the discount.

Possible values:
isGiftbooleanOptional

Indicates whether the order is a gift.

orderDatestring · date-timeRequired

Date order was placed.

orderNumberstringOptional

The identifier of the order.

orderStatusstring · enumOptional

The current status of the order.

Possible values:
orderItemstring · uri[]Required

The item(s) included in the order.

partOfInvoicestring · uriOptional

The order is a part of the referenced invoice.

paymentDueDatestring · date-timeOptional

The date that payment is due.

paymentMethodstringOptional

The name of the payment method used (e.g. Credit Card, Cash).

paymentMethodIdstringOptional

An identifier for the method of payment used (e.g. the last 4 digits of the credit card).

paymentUrlstring · uriOptional

A URL that can be used to pay for the order.

sellerstring · uriRequired

An entity which offers (sells / leases / licenses) the services / goods.

Responses
chevron-right
200

Successfully updated the object

application/json
put
/orders/{id}

Patch Object

patch
Authorizations
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

Objects Grid Order Object

idstring · max: 50Optional

The unique identifier

at_contextany ofOptional

Schema context

string · enumOptionalPossible values:
or
nullOptional
at_typeany ofOptional

The object type

string · enumOptionalPossible values:
or
nullOptional
identifierstring · max: 50Optional

The unique identifier

imagestring · uriOptional

image URL

urlstring · uriOptional

This Object URL

acceptedOfferstring · uri[]Required

The offer(s) -- e.g., product, price specification, or payment method -- accepted by the customer

brokerstring · uriOptional

An entity that arranges for an exchange between a buyer and a seller.

confirmationNumberstringOptional

A number that confirms the order or payment.

customerstring · uriRequired

Party placing the order or paying the invoice.

discountnumber · floatOptional

Any discount applied to the order.

discountCodestringOptional

Code used to redeem a discount.

discountCurrencystring · enumOptional

The currency (in 3-letter ISO 4217 format) of the discount.

Possible values:
isGiftbooleanOptional

Indicates whether the order is a gift.

orderDatestring · date-timeRequired

Date order was placed.

orderNumberstringOptional

The identifier of the order.

orderStatusstring · enumOptional

The current status of the order.

Possible values:
orderItemstring · uri[]Required

The item(s) included in the order.

partOfInvoicestring · uriOptional

The order is a part of the referenced invoice.

paymentDueDatestring · date-timeOptional

The date that payment is due.

paymentMethodstringOptional

The name of the payment method used (e.g. Credit Card, Cash).

paymentMethodIdstringOptional

An identifier for the method of payment used (e.g. the last 4 digits of the credit card).

paymentUrlstring · uriOptional

A URL that can be used to pay for the order.

sellerstring · uriRequired

An entity which offers (sells / leases / licenses) the services / goods.

Responses
chevron-right
200

Successfully patched the object

application/json
patch
/orders/{id}

Delete Object

delete
Authorizations
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
chevron-right
200

Successfully deleted the object

delete
/orders/{id}

No content

List objects

get

This operation supports Elastic Search Query DSL query format

Authorizations
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
chevron-right
200

Successfully listed the objects

application/json
get
/orders

Last updated

Was this helpful?