Skip to the main content
John Deere Logo

Develop with Deere


Operations Center - Products

Click here for more information on how to get started.

Overview

Products represent a digital copy of the physical inputs (chemicals, seed varieties, fertilizers, carriers and tank mixes) used on a farming operation. Using this API you will have the ability to view an existing product list, add products to that list and edit the products on that list. Customers will use these products throughout the year as they plan work, execute work plans in the field and analyze the results. Given how integral products are to an operation it is extremely important that customers maintain a complete and accurate product list.

Products Catalog

The table below represents the categories of products you can contribute. View the Getting Started guide to see a complete catalog.

Product CategoryDescriptionExample
Crop TypesThe output or commodity a customer is producing for that year. All Varieties must have an associated Crop Type that is included on our list of available Crop Types.CORN_WET

Note: this is displayed to the customer as “Corn” on a dropdown menu in the Display, Operations Center and Operations Center Mobile

VarietiesBranded seeds for a particular crop typeP9714R a Corn variety sold by Pioneer
ChemicalsCrop Protection products like Herbicides, Insecticides, Fungicides, Growth Stabilizers and AdditivesRound Up, an Herbicide sold by Bayer
FertilizersCrop Nutrients like Fertilizers and ManureAmmonium Sulfate 21-0-0, a fertilizer sold by Simplot
Tank MixesA grouping of one or more Chemicals or Fertilizers plus a Carrier (e.g. Water)

Where do they appear?

Products are primarily found and managed on Product Manager in Operations Center. The Product Manager Tool includes a customer’s list of Products and Tank Mixes, as well as the ability to add and edit items on those lists. Products are also found in other tools like Setup File Creator, Work Planner and Field Analyzer. Contributing an accurate and complete product list to your customer’s organization in Operations Center improves their experience before, during and after the growing season as they plan, execute and analyze work involving those Products.

product-overview

Endpoints Overview

Crop Types Endpoints

These endpoints will allow you to retrieve our list of available crop types so they can be associated with seed Varieties for an organization.

Varieties Endpoints

These endpoints will allow you create, view and edit varieties for an organization.

Chemicals Endpoints

These endpoints will allow you to create, view and edit chemicals for an organization.

Fertilizers Endpoints

These endpoints will allow you to create, view and edit fertilizers for an organization.

Tank Mixes Endpoints

These endpoints will allow you to create, view and edit tank mixes for an organization.


Getting Started

Use this guide to create your first Product that will become viewable in Operations Center along with how to update and maintain these Products.

1. REQUEST THE CUSTOMER’S EXISTING PRODUCT LIST

Before creating a Product, you’ll want to access your customer’s existing product list to make sure you don’t duplicate anything. You can do this by accessing the organization specific Chemicals, Fertilizers and Varieties endpoints.

1.1 Use the GET View varieties for an org endpoint to retrieve the seed varieties on an org’s product list.

1.2 Use the GET View chemicals for an org endpoint to retrieve the chemicals on an org’s product list.

1.3 Use the GET View fertilizers for an org endpoint to retrieve the fertilizers on an org’s product list.

A customer’s list of existing Tank Mixes can also be accessed.

1.4 Use the GET View tank mixes for an org endpoint to retrieve the chemicals on an org’s product list.

2. CREATE A PRODUCT

Our POST endpoints will allow you to add a Product to your customer’s product list and generate a unique ID for it. For consistency and to improve the experience for your customer, we recommend selecting an item from our Product Catalog (Section 2 above) whenever possible; however, if the Product is not on the list you also can add it as a custom Product.

2.1 This API endpoint will allow you to add a variety to the asset list of an organization. For further details on how to do this, follow the POST Add variety documentation.

Note: Prior to POSTing a Variety, you’ll want to access our list of available Crop Types. All Varieties must have an associated Crop Type from that list. For further details on how to do this, follow the GET Retrieve all crop types documentation.

2.2 This API endpoint will allow you to add a chemical to the asset list of an organization. For further details on how to do this, follow the POST Add chemical documentation.

2.3 This API endpoint will allow you to add a fertilizer to the asset list of an organization. For further details on how to do this, follow the POST Add fertilizer documentation.

You can also add Tank Mixes to your customer’s organization.

2.4 This API endpoint will create a tank mix. For further details on how to do this, follow the POST Create a tank mix documentation.

3. EDIT A PRODUCT

Our PUT endpoints will allow you to edit a Product on your customer’s product list. You might want to do this if you notice an error on any of the fields associated with that Product.

3.1 This endpoint allows the variety to be renamed, made active/archived, or associated to a different manufacturer or crop type. For further details on how to do this, follow the PUT Update a single variety documentation.

3.2 This endpoint allows the chemical to be updated. Material classification (once set) and Reference Id are immutable properties. For further details on how to do this, follow the PUT Update a single chemical documentation.

3.3 This endpoint allows the chemical to be updated. Material classification (once set) and Reference Id are immutable properties. For further details on how to do this, follow the PUT Update a single fertilizer documentation.

3.4 This endpoint allows to update the metadata and the composition of a tank mix. For further details on how to do this, follow the PUT Update a tank mix documentation.


Endpoints

View varieties for an org

GET

/organizations/{orgId}/varieties
This endpoint will retrieve a collection of varieties for the specified org.

OAuth Scope Required: ag2

Request URI

GET https://sandboxapi.deere.com/platform/organizations/{orgId}/varieties

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
status

string

Filters the list based on archive status. Accepted values are ARCHIVED, AVAILABLE, and ALL. The default behavior is to return only available (non-archived) varieties.

Example: AVAILABLE

Allowed Values: AVAILABLE,ARCHIVED,ALL

query

embed

array

An embeddable list of properties which are optional by default.

Allowed Values: documents,showRecordMetadata

query

FieldTypeDescription & Example
@type
string
---
Example: Variety
id
string
The primary identifier for the variety that is unique to your organization.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
links
Array of object
---
rel
string
The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value.
Example: self
uri
string
The location of the resource
Example: https://sandboxapi.deere.com/platform/
name
string
The common name of the variety.
Example: S73-Z5 - 50lb bag
category
string
---
Example: VARIETY
Allowed Values: VARIETY
cropName
string
The identifier of the crop type that this variety is associated with (see the Crop Types API).
Example: SOYBEANS
companyName
string
The brand of the variety.
Example: NK
archived
boolean
Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
referenceGuid
string
Optional. Denotes whether this product is from the global reference list.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
documents
Array of object
List of documents for the variety. For example, Tech Sheet, SDS Label.
@type
string
---
Example: Document
id
string
Primary identifier for resource.
Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
docType
string
Type of document for this product.
Example: 24(c) Registration
productId
string
The Unique id of the product.
Example: 388ab719-277d-4032-a2c3-40a297d8f482
description
string
Information about the document.
Example: CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed
fileName
string
The filename of the document.
Example: ld7OD026.pdf
expirationDate
string
---
Example: 2017-03-22
recordMetadata
object
Data structure for record metadata capturing information about the creation and last update of an entity. For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg). NOTES * Some attributes are only visible if the API Client has the required license. * Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.)
userCreationTimestamp
string
Timestamp of entity creation
Example: 2018-04-30T10:23:50.000Z
userLastModifiedTimestamp
string
Timestamp of entity modification
Example: 2018-05-01T08:11:23.000Z

Add a variety

POST

/organizations/{orgId}/varieties
This endpoint will add a custom variety into the organization. Its name+cropName must be unique within your organization. Its crop name must be a supported crop name (see /cropTypes). There are a number of crop names that are deprecated in the system. If the crop name is set to one of these, then it will be mapped to its corresponding valid crop name. Additionally, POST can be used for supporting offline creation of varieties from e.g. a mobile app, by sending a payload with an `id` generated by the client. If an `id` is present in the payload, the service checks the database for that `id`. In case no record is found, a new one is created with that `id` and the request is responded with 201. Otherwise no creation happens and the request is responded with 409 and error message that a resource with that `id` already exists.

OAuth Scope Required: ag3

Request URI

POST https://sandboxapi.deere.com/platform/organizations/{orgId}/varieties

ParameterTypeDescription & ExampleIn
organizationId

Required

integer

The identifier of the Organization.

Example: 6781

path

FieldTypeDescription & Example
@type
string
---
Example: Variety
id
string
The primary identifier for the variety that is unique to your organization.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
links
Array of object
---
rel

Required

string
The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value.
Example: self
uri

Required

string
The location of the resource
Example: https://sandboxapi.deere.com/platform/
name
string
The common name of the variety.
Example: S73-Z5 - 50lb bag
cropName
string
The identifier of the crop type that this variety is associated with (see the Crop Types API).
Example: SOYBEANS
companyName
string
The brand of the variety.
Example: NK
archived
boolean
Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
recordMetadata
object
Data structure for record metadata capturing information about the creation and last update of an entity. For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg). NOTES * Some attributes are only visible if the API Client has the required license. * Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.)
userCreationTimestamp
string
Timestamp of entity creation
Example: 2018-04-30T10:23:50.000Z
userLastModifiedTimestamp
string
Timestamp of entity modification
Example: 2018-05-01T08:11:23.000Z

View a specific variety

GET

/organizations/{orgId}/varieties/{varietyId}
This endpoint will return the variety with the specified erid.

OAuth Scope Required: ag2

Request URI

GET https://sandboxapi.deere.com/platform/organizations/{orgId}/varieties/{varietyId}

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
organizationId

Required

integer

The identifier of the Organization.

Example: 6781

path

erid

Required

string

A unique identifier for an entity formatted as a uuid.

path

embed

array

An embeddable list of properties which are optional by default.

Allowed Values: documents,showRecordMetadata

query

FieldTypeDescription & Example
@type
string
---
Example: Variety
id
string
The primary identifier for the variety that is unique to your organization.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
links
Array of object
---
rel
string
The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value.
Example: self
uri
string
The location of the resource
Example: https://sandboxapi.deere.com/platform/
name
string
The common name of the variety.
Example: S73-Z5 - 50lb bag
category
string
---
Example: VARIETY
Allowed Values: VARIETY
cropName
string
The identifier of the crop type that this variety is associated with (see the Crop Types API).
Example: SOYBEANS
companyName
string
The brand of the variety.
Example: NK
archived
boolean
Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
referenceGuid
string
Optional. Denotes whether this product is from the global reference list.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
documents
Array of object
List of documents for the variety. For example, Tech Sheet, SDS Label.
@type
string
---
Example: Document
id
string
Primary identifier for resource.
Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
docType
string
Type of document for this product.
Example: 24(c) Registration
productId
string
The Unique id of the product.
Example: 388ab719-277d-4032-a2c3-40a297d8f482
description
string
Information about the document.
Example: CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed
fileName
string
The filename of the document.
Example: ld7OD026.pdf
expirationDate
string
---
Example: 2017-03-22
recordMetadata
object
Data structure for record metadata capturing information about the creation and last update of an entity. For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg). NOTES * Some attributes are only visible if the API Client has the required license. * Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.)
userCreationTimestamp
string
Timestamp of entity creation
Example: 2018-04-30T10:23:50.000Z
userLastModifiedTimestamp
string
Timestamp of entity modification
Example: 2018-05-01T08:11:23.000Z

Update a single variety

PUT

/organizations/{orgId}/varieties/{varietyId}
This endpoint allows the variety to be renamed, made active/archived, or associated to a different manufacturer or crop type.

OAuth Scope Required: ag3

Request URI

PUT https://sandboxapi.deere.com/platform/organizations/{orgId}/varieties/{varietyId}

Content-Type: application/vnd.deere.axiom.v3+json
FieldTypeDescription & Example
@type
string
---
Example: Variety
id
string
Primary identifier for resource.
Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
links
Array of object
---
rel

Required

string
The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value.
Example: self
uri

Required

string
The location of the resource
Example: https://sandboxapi.deere.com/platform/
name
string
The common name of the variety.
Example: S73-Z5 - 50lb bag
cropName
string
The identifier of the crop type that this variety is associated with (see the Crop Types API). **NOTE:** See /cropTypes for the list of available crop types that are supported.
Example: SOYBEANS
companyName
string
The brand of the variety.
Example: NK
archived
boolean
Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
recordMetadata
object
Data structure for record metadata capturing information about the creation and last update of an entity. For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg). NOTES * Some attributes are only visible if the API Client has the required license. * Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.)
userCreationTimestamp
string
Timestamp of entity creation
Example: 2018-04-30T10:23:50.000Z
userLastModifiedTimestamp
string
Timestamp of entity modification
Example: 2018-05-01T08:11:23.000Z

Adds a single reference variety to organization

POST

/varieties/{erid}/associateToOrg/{organizationId}
This endpoint will associate a reference variety to your organization from the global reference list. The reference varieties are immutable, however, they can still be archived or made available. The response headers from the GET endpoints will include the attributes that can be overridden.

Request URI

POST https://sandboxapi.deere.com/platform/varieties/{erid}/associateToOrg/{organizationId}

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
erid

Required

string

A unique identifier for an entity formatted as a uuid.

path

organizationId

Required

integer

The identifier of the Organization.

Example: 6781

path

FieldTypeDescription & Example
overrides
Array of object
---
key

Required

string
Key for override parameter when setting overrides for a reference product
Example: isCarrier
Allowed Values: isCarrier,archived,registration (chemicals and fertilizers only)
value

Required

object
Value for override parameter, can be string, number or boolean
Example: true
recordMetadata
object
Data structure for record metadata capturing information about the creation and last update of an entity. For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg). NOTES * Some attributes are only visible if the API Client has the required license. * Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.)
userCreationTimestamp
string
Timestamp of entity creation
Example: 2018-04-30T10:23:50.000Z
userLastModifiedTimestamp
string
Timestamp of entity modification
Example: 2018-05-01T08:11:23.000Z
FieldTypeDescription & Example
key
string
Key for override parameter when setting overrides for a reference product
Example: isCarrier
Allowed Values: isCarrier,archived,registration (chemicals and fertilizers only)
success
boolean
Whether or not the override was successfully applied
Example: true
errors
object
---
@type
string
---
Example: Errors
errors
Array of object
---
@type
string
---
Example: Error
guid
string
---
Example: 9b331708-10e8-4e15-8097-a9aed7455d6d
message
string
An english description of the error.
Example: The given crop type does not exist
code
string
A string constant representing the type of error.
Example: validation_constraint_crop_type_does_not_exist
field
string
The name of the property or parameter deemed invalid.
Example: targetCrops
invalidValue
string
The value that was supplied for this field in the request.
Example: CORN_WET
otherAttributes
object
---
Example: [object Object]

Search reference catalog varieties

GET

/varieties
This endpoint searches the reference catalog for varieties that match the given search criteria. This data can be used in a subsequent request to create a variety in an organization. Results are limited to 100 items.

Request URI

GET https://sandboxapi.deere.com/platform/varieties

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
searchString

string

Performs a fuzzy search on variety and manufacturer name.

Example: venture

query

cropName

string

Filters the results by crop id (see the /cropTypes API).

Example: SOYBEANS

query

productName

string

Specifies the name of the variety from the global reference list.

Example: SH 5614 LL/STS

query

brandName

string

Specifies the product manufacturer name of the variety based on the region being used.

Example: Southern Harvest

query

sourceSystemProductId

string

Specifies the source system product id of the variety based on the country of use.

Example: 79186

query

countryCode

string

Specifies the region the variety data belongs to. Some data may not be available in certain regions and data will not be included in the response.

Example: USA

query

FieldTypeDescription & Example
@type
string
---
Example: ReferenceVariety
id
string
Primary identifier for reference variety.
Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
category
string
---
Example: VARIETY
Allowed Values: VARIETY
name
string
The common name of the reference variety.
Example: S73-Z5 - 50lb bag
companyName
string
The name of the input manufacturer.
Example: NK
cropName
string
The identifier of the crop type that this reference variety is associated with (see the Crop Types API).
Example: SOYBEANS
countryCode
string
Specifies the region the reference variety data belongs to. Some data may not be available in certain regions and data will not be included in the response.
Example: USA
sourceSystem
string
The source system for the reference variety.
Example: 3
sourceSystemProductId
string
The source system identifier for the reference variety.
Example: 905P24925

Get a single reference variety.

GET

/varieties/{erid}
Single variety from industry data sources, such as CDMS.

Request URI

GET https://sandboxapi.deere.com/platform/varieties/{erid}

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
erid

Required

string

A unique identifier for an entity formatted as a uuid.

path

FieldTypeDescription & Example
@type
string
---
Example: ReferenceVariety
id
string
Primary identifier for reference variety.
Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
category
string
---
Example: VARIETY
Allowed Values: VARIETY
name
string
The common name of the reference variety.
Example: S73-Z5 - 50lb bag
companyName
string
The name of the input manufacturer.
Example: NK
cropName
string
The identifier of the crop type that this reference variety is associated with (see the Crop Types API).
Example: SOYBEANS
countryCode
string
Specifies the region the reference variety data belongs to. Some data may not be available in certain regions and data will not be included in the response.
Example: USA
sourceSystem
string
The source system for the reference variety.
Example: 3
sourceSystemProductId
string
The source system identifier for the reference variety.
Example: 905P24925

Reference list of documents for an associated seed variety.

GET

/varieties/{erid}/documents
List of all the documents for a variety from industry data sources, such as CDMS.

Request URI

GET https://sandboxapi.deere.com/platform/varieties/{erid}/documents

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
erid

Required

string

A unique identifier for an entity formatted as a uuid.

path

FieldTypeDescription & Example
@type
string
---
Example: Document
id
string
Primary identifier for resource.
Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
docType
string
Type of document for this product.
Example: 24(c) Registration
productId
string
The Unique id of the product.
Example: 388ab719-277d-4032-a2c3-40a297d8f482
description
string
Information about the document.
Example: CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed
fileName
string
The filename of the document.
Example: ld7OD026.pdf
expirationDate
string
---
Example: 2017-03-22

Sets organizational attributes such as isCarrier, archived, registration, etc.

PATCH

/varieties/{erid}/setOverridesForOrg/{organizationId}
This endpoint will set attribute overrides while importing a reference variety to your organization. The reference varieties are immutable, however, they can still be archived or made available. The response headers from the GET endpoints will include the attributes that can be overridden.

Request URI

PATCH https://sandboxapi.deere.com/platform/varieties/{erid}/setOverridesForOrg/{organizationId}

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
erid

Required

string

A unique identifier for an entity formatted as a uuid.

path

organizationId

Required

integer

The identifier of the Organization.

Example: 6781

path

FieldTypeDescription & Example
key
string
Key for override parameter when setting overrides for a reference product
Example: isCarrier
Allowed Values: isCarrier,archived,registration (chemicals and fertilizers only)
success
boolean
Whether or not the override was successfully applied
Example: true
errors
object
---
@type
string
---
Example: Errors
errors
Array of object
---
@type
string
---
Example: Error
guid
string
---
Example: 9b331708-10e8-4e15-8097-a9aed7455d6d
message
string
An english description of the error.
Example: The given crop type does not exist
code
string
A string constant representing the type of error.
Example: validation_constraint_crop_type_does_not_exist
field
string
The name of the property or parameter deemed invalid.
Example: targetCrops
invalidValue
string
The value that was supplied for this field in the request.
Example: CORN_WET
otherAttributes
object
---
Example: [object Object]

vrTillageDepthTarget

This representation defines units allowed to specify target tillage depth for tillage operation

Units

Unit Of MeasureDigitsDecimalMin ValueMax ValueMeasurement System
in31-100.0100.0English
cm31-254.0254.0Metric
in31-100.0100.0Mixed

vrSeedRateMassTarget

This representation defines units allowed to specify target seed mass per area for seeding operation

Units

Unit Of MeasureDigitsDecimalMin ValueMax ValueMeasurement System
lb1ac-1510.099999.9English
ton1ac-1510.099999.9English
lb1[ft2]-1510.099999.9English
kg1ha-1510.099999.9Metric
t1ha-1510.099999.9Metric
kg1[m2]-1510.099999.9Metric
lb1ac-1510.099999.9Mixed
kg1[ft2]-1510.099999.9Mixed
kg1ac-1510.099999.9Mixed

vrSeedRateSeedsTarget

This representation defines units allowed to specify seeds per area for seeding operation

Units

Unit Of MeasureDigitsDecimalMin ValueMax ValueMeasurement System
seeds1ac-180099999999English
thndSeeds1ac-1610.0100000.0English
seeds1[ft2]-1410.09999.9English
seeds1ha-180099999999Metric
thndSeeds1ha-1610.0100000.0Metric
seeds1[m2]-1410.09999.9Metric
seeds1ac-180099999999Mixed
seeds1[ft2]-1410.09999.9Mixed

vrAppRateMassTarget

This representation defines units allowed to specify average target application mass rate per area

Units

Unit Of MeasureDigitsDecimalMin ValueMax ValueMeasurement System
lb1ac-1520.0099999.99English
ton1ac-1520.0099999.99English
ozm1ac-1520.0099999.99English
ozm1[ft2]-1420.009999.99English
kg1ha-1520.0099999.99Metric
t1ha-1520.0099999.99Metric
g1ha-1520.0099999.99Metric
mg1ha-1520.0099999.99Metric
dg1ha-1520.0099999.99Metric
dg1[mm2]-1510.099999.9Metric
mg1[m2]-14009999Metric
g1[m2]-14009999Metric
kg1[m2]-1520.0099999.99Metric
lb1ac-1520.0099999.99Mixed
kg1ac-1520.0099999.99Mixed
ton1ac-1520.0099999.99Mixed
ozm1ac-1520.0099999.99Mixed
t1ac-1520.0099999.99Mixed
g1ac-1520.0099999.99Mixed
mg1ac-1520.0099999.99Mixed
dg1ac-1520.0099999.99Mixed

vrAppRateVolumeTarget

This representation defines units allowed to specify average target application volume rate per area

Units

Unit Of MeasureDigitsDecimalMin ValueMax ValueMeasurement System
gal1ac-1520.0099999.99English
qt1ac-1520.0099999.99English
pt1ac-1520.0099999.99English
floz1ac-1520.0099999.99English
l1ha-1620.00935395.53Metric
ml1ha-1520.0099999.99Metric
kl1ha-1520.0099999.99Metric
ul1ha-1520.0099999.99Metric
dl1ha-1520.0099999.99Metric
[m3]1ha-1520.0099999.99Metric
gal1ac-1520.0099999.99Mixed
kl1ac-1520.0099999.99Mixed
qt1ac-1520.0099999.99Mixed
pt1ac-1520.0099999.99Mixed
floz1ac-1520.0099999.99Mixed
ul1ac-1520.0099999.99Mixed
ml1ac-1520.0099999.99Mixed
l1ac-1520.0099999.99Mixed
dl1ac-1520.0099999.99Mixed

vrSolutionRateLiquid

This representation defines units allowed to specify liquid solution rate per area

Units

Unit Of MeasureDigitsDecimalMin ValueMax ValueMeasurement System
gal1ac-1530.00099999.999English
qt1ac-1520.0099999.99English
pt1ac-1520.0099999.99English
floz1ac-1520.0099999.99English
l1ha-1530.00099999.999Metric
ml1ha-1520.0099999.99Metric
kl1ha-1520.0099999.99Metric
ul1ha-1520.0099999.99Metric
dl1ha-1520.0099999.99Metric
[m3]1ha-1520.0099999.99Metric
gal1ac-1530.00099999.999Mixed
kl1ac-1520.0099999.99Mixed
qt1ac-1520.0099999.99Mixed
pt1ac-1520.0099999.99Mixed
floz1ac-1520.0099999.99Mixed
ul1ac-1520.0099999.99Mixed
ml1ac-1520.0099999.99Mixed
l1ac-1520.0099999.99Mixed
dl1ac-1520.0099999.99Mixed

dtProjectionType

This type defines the allowed values used to specify coordinate system for a guidance line

Values

Defined type valueCalculation Method
dtiProjectionDeereDeere
dtiNonJohnDeere1BeeLine
dtiNonJohnDeere2Trimble

dtSignalType

This type defines allowed values to specify signal type used for boundary data

Values

dtiSignalTypeUnknown
dtiSignalTypeDigitized
dtiSignalTypeNoDiff
dtiSignalTypeUnknownDiff
dtiSignalTypeWAAS
dtiSignalTypeSF1
dtiSignalTypeSF2
dtiSignalTypeRTKX
dtiSignalTypeRTK
dtiSignalTypeSF3
dtiSignalTypeSFRTK
dtiSignalTypeNonJdDiff
dtiSignalTypeJdDiff


View chemicals for an org

GET

/organizations/{orgId}/chemicals
This endpoint will retrieve chemicals for an org.

OAuth Scope Required: ag2

Request URI

GET https://sandboxapi.deere.com/platform/organizations/{orgId}/chemicals

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
orgId

Required

number

The organization owning the chemicals.

Example: 123456

path

recordFilter

string

Filter results based on status

Example: active, archived, all

query

embed

string

Embeds extra information in the org chemical response

Example: activeIngredients, documents

query

x-deere-signature

GUID

x-deere-signature should be managed by the client per user per API. For a new user/new API, the first request will have a blank value for x-deere-signature. Changes can be tracked with the x-deere-signature returned in the response. If the response has not changed since the last API call, the value of x-deere-signature is not changed and the client should use the same GUID next time.

Example: 9r839261-5e4b-4e1c-9201-8026f47109bb

header

FieldTypeDescription & Example
x-deere-signature
GUID
A new x-deere-signature response header will be included if the response has changed since last api call.
Example: 3b539261-5e4b-4e1c-9201-3026f47109bb
id
string
The primary identifier for the chemical. Unique within an org context.
Example: 8e1e0920-1265-4066-8067-8ce2ce5012b2
name
string
The common name of this product.
Example: Cotoran 4L
companyName
string
The name of the input manufacturer.
Example: Makhteshim-Agan of North America,Inc.
type2
string
The type of chemical
Example: ADDITIVE
category
string
Whether this product is a chemical
Example: CHEMICAL
archived
boolean
Whether or not this product is actively used.
Example: false
modifiedTime
datetime
When the chemical was last updated within this organization.
Example: 2019-03-28T14:59:57.000Z
materialClassification1
string
The product form
Example: DRY
carrier
boolean
Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context.
Example: false
registrationId
string
Registration Id
Example: 0084229-00011-AA-0000000
200 OK
Content-Type: application/vnd.deere.axiom.v3+json
x-deere-signature: 3b539261-5e4b-4e1c-9201-3026f47109bb
{
  "links": [
    {
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals"
    }
  ],
  "total": 1,
  "values": [
    {
      "@type": "Chemical",
      "name": "Cotoran 4L",
      "type": "HERBICIDE",
      "companyName": "Makhteshim-Agan of North America,Inc.",
      "materialClassification": "DRY",
      "modifiedTime": "2018-04-26T15:13:32.890Z",
      "carrier": false,
      "archived": false,
      "id": "a50fe079-a988-4c61-86c3-17d8588606a2",
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals/a50fe079-a988-4c61-86c3-17d8588606a2"
        }
      ]
    }
  ]
}


Add chemical

POST

/organizations/{orgId}/chemicals
This API endpoint will allow to add a chemical to the asset list of an organization.

OAuth Scope Required: ag3

Request URI

POST https://sandboxapi.deere.com/platform/organizations/{orgId}/chemicals

Accept: application/vnd.deere.axiom.v3+json

Content-Type: application/vnd.deere.axiom.v3+json
ParameterTypeDescription & ExampleIn
orgId

Required

number

The organization owning the chemicals.

Example: 123456

path

FieldTypeDescription & Example
name
string
The common name of this product.
Example: Tide Propiconazole 41.8EC
companyName
string
The name of the input manufacturer.
Example: Tide International USA, Inc.turer
type2
string
The type of chemical
Example: HERBICIDE
archived
boolean
Whether or not this product is actively used.
Example: false
materialClassification1
string
Material classification of a product.
Example: DRY
carrier
boolean
Whether or not this product has been flagged for use as a tank mix carrier.
Example: false
registrationId
string
Registration Id
Example: 0084229-00011-AA-0000000
FieldTypeDescription & Example
total
integer
---
Example: 1
{
  "@type": "Chemical",
  "name": "Tide Propiconazole 41.8EC",
  "companyName": "Tide International USA, Inc.",
  "type": "HERBICIDE",
  "materialClassification": "DRY"
}

201 Created
Location: https://sandboxapi.deere.com/platform/organizations/123456/chemicals/c0dcb00a-6b6f-4508-9180-679addad23f8


View a specific chemical from an organization's asset list

GET

/organizations/{orgId}/chemicals/{chemicalId}
This endpoint will retrieve a specific chemical from an organization's asset list.

OAuth Scope Required: ag2

Request URI

GET https://sandboxapi.deere.com/platform/organizations/{orgId}/chemicals/{chemicalId}

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
orgId

Required

number

The organization owning the chemicals.

Example: 123456

path

chemicalId

Required

string

The chemical Id to find.

Example: c0dcb00a-6b6f-4508-9180-679addad23f8

path

embed

string

Embeds extra information in the org chemical response

Example: activeIngredients, documents

query

FieldTypeDescription & Example
id
string
The primary identifier for the chemical. Unique within an org context.
Example: 8e1e0920-1265-4066-8067-8ce2ce5012b2
name
string
The common name of this product.
Example: Cotoran 4L
companyName
string
The name of the input manufacturer.
Example: Makhteshim-Agan of North America,Inc.
type2
string
The type of chemical
Example: ADDITIVE
category
string
Whether this product is a chemical
Example: CHEMICAL
archived
boolean
Whether or not this product is actively used.
Example: false
modifiedTime
datetime
When the chemical was last updated within this organization.
Example: 2019-03-28T14:59:57.000Z
materialClassification1
string
The product form
Example: DRY
carrier
boolean
Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context.
Example: false
registrationId
string
Registration Id
Example: 0084229-00011-AA-0000000
200 OK
Content-Type: application/vnd.deere.axiom.v3+json
{
  "@type": "Chemical",
  "name": "Tide Propiconazole 41.8EC",
  "type": "MANURE",
  "companyName": "Tide International USA,Inc.",
  "materialClassification": "DRY",
  "modifiedTime": "2018-04-30T08:30:19.326Z",
  "carrier": false,
  "archived": false,
  "id": "40528aae-cbc0-4067-88fe-cb5859ba879a",
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals/40528aae-cbc0-4067-88fe-cb5859ba879a"
    }
  ]
}


Update a single chemical

PUT

/organizations/{orgId}/chemicals/{chemicalId}
This endpoint allows the chemical to be updated. Material classification (once set) and Reference Id are immutable properties.

OAuth Scope Required: ag3

Request URI

PUT https://sandboxapi.deere.com/platform/organizations/{orgId}/chemicals/{chemicalId}

Accept: application/vnd.deere.axiom.v3+json

Content-Type: application/vnd.deere.axiom.v3+json
ParameterTypeDescription & ExampleIn
orgId

Required

number

The organization owning the chemicals.

Example: 123456

path

chemicalId

Required

string

The chemical Id to find.

Example: c0dcb00a-6b6f-4508-9180-679addad23f8

path

FieldTypeDescription & Example
name
string
The common name of this product.
Example: Tide Propiconazole 41.8EC
companyName
string
The name of the input manufacturer.
Example: Tide International USA, Inc.turer
type2
string
The type of chemical
Example: HERBICIDE
archived
boolean
Whether or not this product is actively used.
Example: false
materialClassification1
string
The product form. This is required during updates (as it may currently be null), but cannot be changed once set.
Example: DRY
carrier
boolean
Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context.
Example: false
registrationId
string
Registration Id
Example: 0084229-00011-AA-0000000
FieldTypeDescription & Example
total
integer
---
Example: 1
{
  "@type": "Chemical",
  "name": "Tide Propiconazole 41.8EC",
  "companyName": "Tide International USA, Inc.",
  "type": "MANURE",
  "materialClassification": "GAS"
}

204 No Content


Additional Information

  1. Material Classification: LIQUID, DRY, GAS.

  2. Type: ADDITIVE, FUNGICIDE, INSECTICIDE, HERBICIDE, GROWTH_REGULATOR, NITROGEN_STABILIZER.


View fertilizers for an org

GET

/organizations/{orgId}/fertilizers
This endpoint will retrieve fertilizers for an org.

OAuth Scope Required: ag2

Request URI

GET https://sandboxapi.deere.com/platform/organizations/{orgId}/fertilizers

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
orgId

Required

number

The organization owning the fertilizers.

Example: 123456

path

recordFilter

string

Filter results based on status

Example: active, archived, all

query

embed

string

Embeds extra information in the fertilizer response.

Example: activeIngredients, documents

query

x-deere-signature

string

x-deere-signature should be managed by the client per user per API. For a new user/new API, the first request will have a blank value for x-deere-signature. Changes can be tracked with the x-deere-signature returned in the response. If the response has not changed since the last API call, the value of x-deere-signature is not changed and the client should use the same String Token next time.

Example: 9r839261-5e4b-4e1c-9201-8026f47109bb

header

FieldTypeDescription & Example
x-deere-signature
string
A new x-deere-signature response header will be included if the response has changed since last api call.
Example: 3b5392615e4b4e1c92013026f47109bb
id
string
The primary identifier for the fertilizer. Unique within an org context.
Example: 8e1e0920-1265-4066-8067-8ce2ce5012b2
name
string
The common name of this product.
Example: Tide Propiconazole 41.8EC
companyName
string
The name of the input manufacturer.
Example: Tide International USA, Inc.
type2
string
The type of fertilizer
Example: FERTILIZER
category
string
Whether this product is a fertilizer
Example: FERTILIZER
archived
boolean
Whether or not this product is actively used.
Example: false
modifiedTime
datetime
When the fertilizer was last updated within this organization.
Example: 2019-03-28T14:59:57.000Z
materialClassification1
string
The product form
Example: DRY
carrier
boolean
Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context.
Example: false
registrationId
string
Registration Id
Example: 0084229-00011-AA-0000000
200 OK
Content-Type: application/vnd.deere.axiom.v3+json
x-deere-signature: 3b539261-5e4b-4e1c-9201-3026f47109bb
{
  "links": [
    {
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fertilizers"
    }
  ],
  "total": 1,
  "values": [
    {
      "@type": "Fertilizer",
      "name": "Tide Propiconazole 41.8EC",
      "type": "MANURE",
      "companyName": "Tide International USA,Inc.",
      "materialClassification": "DRY",
      "modifiedTime": "2018-04-26T15:13:32.890Z",
      "carrier": false,
      "archived": false,
      "id": "40528aae-cbc0-4067-88fe-cb5859ba879a",
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fertilizers/40528aae-cbc0-4067-88fe-cb5859ba879a"
        }
      ]
    }
  ]
}


Add fertilizer

POST

/organizations/{orgId}/fertilizers
This API endpoint will allow to add a fertilizer to the asset list of an organization.

OAuth Scope Required: ag3

Request URI

POST https://sandboxapi.deere.com/platform/organizations/{orgId}/fertilizers

Accept: application/vnd.deere.axiom.v3+json

Content-Type: application/vnd.deere.axiom.v3+json
ParameterTypeDescription & ExampleIn
orgId

Required

number

The organization owning the fertilizers.

Example: 123456

path

FieldTypeDescription & Example
name
string
The common name of this product.
Example: Tide Propiconazole 41.8EC
companyName
string
The name of the input manufacturer.
Example: Tide International USA, Inc.
type2
string
The type of fertilizer
Example: FERTILIZER
archived
boolean
Whether or not this product is actively used.
Example: false
materialClassification1
string
Material classification of a product.
Example: DRY
carrier
boolean
Whether or not this product has been flagged for use as a tank mix carrier.
Example: false
registrationId
string
Registration Id
Example: 0084229-00011-AA-0000000
FieldTypeDescription & Example
total
integer
---
Example: 1
{
  "@type": "Fertilizer",
  "name": "Tide Propiconazole 41.8EC",
  "companyName": "Tide International USA, Inc.",
  "type": "MANURE",
  "materialClassification": "DRY"
}

201 Created
Location: https://sandboxapi.deere.com/platform/organizations/123456/fertilizers/c0dcb00a-6b6f-4508-9180-679addad23f8


View a specific fertilizer from an organization's asset list

GET

/organizations/{orgId}/fertilizers/{fertilizerId}
This endpoint will retrieve a specific fertilizer from an organization's asset list.

OAuth Scope Required: ag2

Request URI

GET https://sandboxapi.deere.com/platform/organizations/{orgId}/fertilizers/{fertilizerId}

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
orgId

Required

number

The owning organization of the product.

Example: 123456

path

fertilizerId

Required

string

The fertilizer Id to find.

Example: c0dcb00a-6b6f-4508-9180-679addad23f8

path

embed

string

Embeds extra information in the fertilizer response.

Example: activeIngredients, documents

query

FieldTypeDescription & Example
id
string
The primary identifier for the fertilizer. Unique within an org context.
Example: 8e1e0920-1265-4066-8067-8ce2ce5012b2
name
string
The common name of this product.
Example: Tide Propiconazole 41.8EC
companyName
string
The name of the input manufacturer.
Example: Tide International USA, Inc.
type2
string
The type of fertilizer
Example: FERTILIZER
category
string
Whether this product is a fertilizer
Example: FERTILIZER
archived
boolean
Whether or not this product is actively used.
Example: false
modifiedTime
datetime
When the fertilizer was last updated within this organization.
Example: 2019-03-28T14:59:57.000Z
materialClassification1
string
The product form
Example: DRY
carrier
boolean
Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context.
Example: false
registrationId
string
Registration Id
Example: 0084229-00011-AA-0000000
200 OK
Content-Type: application/vnd.deere.axiom.v3+json
{
  "@type": "Fertilizer",
  "name": "Tide Propiconazole 41.8EC",
  "type": "MANURE",
  "companyName": "Tide International USA,Inc.",
  "materialClassification": "DRY",
  "modifiedTime": "2018-04-30T08:30:19.326Z",
  "carrier": false,
  "archived": false,
  "id": "40528aae-cbc0-4067-88fe-cb5859ba879a",
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fertilizers/40528aae-cbc0-4067-88fe-cb5859ba879a"
    }
  ]
}


Update a single fertilizer

PUT

/organizations/{orgId}/fertilizers/{fertilizerId}
This endpoint allows the fertilizer to be updated. Material classification (once set) and Reference Id are immutable properties.

OAuth Scope Required: ag3

Request URI

PUT https://sandboxapi.deere.com/platform/organizations/{orgId}/fertilizers/{fertilizerId}

Accept: application/vnd.deere.axiom.v3+json

Content-Type: application/vnd.deere.axiom.v3+json
ParameterTypeDescription & ExampleIn
orgId

Required

number

The owning organization of the product.

Example: 123456

path

fertilizerId

Required

string

The fertilizer Id to find.

Example: c0dcb00a-6b6f-4508-9180-679addad23f8

path

FieldTypeDescription & Example
name
string
The common name of this product.
Example: Tide Propiconazole 41.8EC
companyName
string
The name of the input manufacturer.
Example: Tide International USA, Inc.
type2
string
The type of fertilizer
Example: FERTILIZER
archived
boolean
Whether or not this product is actively used.
Example: false
materialClassification1
string
The product form. This is required during updates (as it may currently be null), but cannot be changed once set.
Example: DRY
carrier
boolean
Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context.
Example: false
registrationId
string
Registration Id
Example: 0084229-00011-AA-0000000
FieldTypeDescription & Example
total
integer
---
Example: 1
{
  "@type": "Fertilizer",
  "name": "Tide Propiconazole 41.8EC",
  "companyName": "Tide International USA, Inc.",
  "type": "MANURE",
  "materialClassification": "GAS"
}

204 No Content


Additional Information

  1. Material Classification: LIQUID, DRY, GAS.

  2. Type: FERTILIZER, MANURE.


View product companies for an org

GET

/organizations/{orgId}/productCompanies
This endpoint will retrieve the list of companies which contains both custom companies and companies from the reference list.

OAuth Scope Required: ag1

Request URI

GET https://sandboxapi.deere.com/platform/organizations/{orgId}/productCompanies

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
orgId

Required

number

The organization owning the product company.

Example: 876542

path

FieldTypeDescription & Example
companyName
string
The name of the input manufacturer.
Example: Mosaic
200 OK
Content-Type: application/vnd.deere.axiom.v3+json
{
  "links": [
    {
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/876542/productCompanies"
    },
    {
      "rel": "",
      "uri": "https://sandboxapi.deere.com/platform/organizations/876542/productCompanies;start=10;count=10"
    }
  ],
  "total": 1439,
  "values": [
    {
      "@type": "ProductCompany",
      "companyName": "Mosaic",
      "links": []
    },
    {
      "@type": "ProductCompany",
      "companyName": "Howard Fertilizer",
      "links": []
    },
    {
      "@type": "ProductCompany",
      "companyName": "Citizens LLC",
      "links": []
    },
    {
      "@type": "ProductCompany",
      "companyName": "Diamond K",
      "links": []
    },
    {
      "@type": "ProductCompany",
      "companyName": "The JC Smith Co",
      "links": []
    },
    {
      "@type": "ProductCompany",
      "companyName": "BH Hybrids",
      "links": []
    },
    {
      "@type": "ProductCompany",
      "companyName": "Garlic Research Labs",
      "links": []
    },
    {
      "@type": "ProductCompany",
      "companyName": "Atlantic - Pacific Agricultural Co., Inc.",
      "links": []
    },
    {
      "@type": "ProductCompany",
      "companyName": "Crites Seeds Inc",
      "links": []
    },
    {
      "@type": "ProductCompany",
      "companyName": "Quality Borate Company",
      "links": []
    }
  ]
}


Retrieve tank mixes for an org

GET

/organizations/{orgId}/tankMixes

OAuth Scope Required: ag2

Request URI

GET https://sandboxapi.deere.com/platform/organizations/{orgId}/tankMixes

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
embed

array

The list of Rels, for which objects should be included in the response payload.

Allowed Values: chemical,showRecordMetadatag

query

FieldTypeDescription & Example
@type
string
---
Example: Variety
id
string
The primary identifier for the variety that is unique to your organization.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
links
Array of object
---
rel
string8
The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value.
Example: self
uri
string
The location of the resource
Example: https://sandboxapi.deere.com/platform/
name
string
The common name of the variety.
Example: S73-Z5 - 50lb bag
category
string
---
Example: VARIETY
Allowed Values: VARIETY
cropName
string
The identifier of the crop type that this variety is associated with (see the Crop Types API).
Example: SOYBEANS
companyName
string
The brand of the variety.
Example: NK
archived
boolean
Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
referenceGuid
string
Optional. Denotes whether this product is from the global reference list.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
documents
Array of object
List of documents for the variety. For example, Tech Sheet, SDS Label.
@type
string
---
Example: Document
id
string
Primary identifier for resource.
Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
productId
string
The Unique id of the product.
Example: 388ab719-277d-4032-a2c3-40a297d8f482
docType
string
Type of document for this product.
Example: 24(c) Registration
description
string
Information about the document.
Example: CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed
fileName
string
The filename of the document.
Example: ld7OD026.pdf
expirationDate
string
---
Example: 2017-03-22
recordMetadata
object
Data structure for record metadata capturing information about the creation and last update of an entity. For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg). NOTES * Some attributes are only visible if the API Client has the required license. * Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.)
userCreationTimestamp
string
Timestamp of entity creation
Example: 2018-04-30T10:23:50.000Z
userLastModifiedTimestamp
string
Timestamp of entity modification
Example: 2018-05-01T08:11:23.000Z

Create a tank mix

POST

/organizations/{orgId}/tankMixes
Add a tank mix to the asset list of an organization. Any chemicals or fertilizers in the tank mix must exist in the organization before the tank mix is persisted. The name of the tank mix must be unique in your organization. Additionally, POST can be used for supporting offline creation of tank mixes from e.g. a mobile app, by sending a payload with an `orgUniqueErid` generated by the client. If an `orgUniqueErid` is present in the payload, the service checks the database for that `orgUniqueErid`. In case no record is found, a new one is created with that `orgUniqueErid` and the request is responded with 201. Otherwise no creation happens and the request is responded with 409 and error message that a resource with that `orgUniqueErid` already exists.

OAuth Scope Required: ag3

Request URI

POST https://sandboxapi.deere.com/platform/organizations/{orgId}/tankMixes

ParameterTypeDescription & ExampleIn
organizationId

Required

integer

The identifier of the Organization.

Example: 6781

path

FieldTypeDescription & Example
@type
string
---
Example: Variety
id
string
The primary identifier for the variety that is unique to your organization.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
links
Array of object
---
rel

Required

string8
The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value.
Example: self
uri

Required

string
The location of the resource
Example: https://sandboxapi.deere.com/platform/
name
string
The common name of the variety.
Example: S73-Z5 - 50lb bag
category
string
---
Example: VARIETY
Allowed Values: VARIETY
cropName
string
The identifier of the crop type that this variety is associated with (see the Crop Types API).
Example: SOYBEANS
companyName
string
The brand of the variety.
Example: NK
archived
boolean
Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
referenceGuid
string
Optional. Denotes whether this product is from the global reference list.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
documents
Array of object
List of documents for the variety. For example, Tech Sheet, SDS Label.
@type

Required

string
---
Example: Document
id
string
Primary identifier for resource.
Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
productId

Required

string
The Unique id of the product.
Example: 388ab719-277d-4032-a2c3-40a297d8f482
docType

Required

string
Type of document for this product.
Example: 24(c) Registration
description

Required

string
Information about the document.
Example: CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed
fileName

Required

string
The filename of the document.
Example: ld7OD026.pdf
expirationDate
string
---
Example: 2017-03-22
recordMetadata
object
Data structure for record metadata capturing information about the creation and last update of an entity. For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg). NOTES * Some attributes are only visible if the API Client has the required license. * Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.)
userCreationTimestamp
string
Timestamp of entity creation
Example: 2018-04-30T10:23:50.000Z
userLastModifiedTimestamp
string
Timestamp of entity modification
Example: 2018-05-01T08:11:23.000Z

Retrieves a specific tank mix

GET

/organizations/{orgId}/tankMixes/{id}

OAuth Scope Required: ag2

Request URI

GET https://sandboxapi.deere.com/platform/organizations/{orgId}/tankMixes/{id}

Accept: application/vnd.deere.axiom.v3+json

ParameterTypeDescription & ExampleIn
organizationId

Required

integer

The identifier of the Organization.

Example: 6781

path

FieldTypeDescription & Example
@type
string
---
Example: Variety
id
string
The primary identifier for the variety that is unique to your organization.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
links
Array of object
---
rel
string8
The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value.
Example: self
uri
string
The location of the resource
Example: https://sandboxapi.deere.com/platform/
name
string
The common name of the variety.
Example: S73-Z5 - 50lb bag
category
string
---
Example: VARIETY
Allowed Values: VARIETY
cropName
string
The identifier of the crop type that this variety is associated with (see the Crop Types API).
Example: SOYBEANS
companyName
string
The brand of the variety.
Example: NK
archived
boolean
Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
referenceGuid
string
Optional. Denotes whether this product is from the global reference list.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
documents
Array of object
List of documents for the variety. For example, Tech Sheet, SDS Label.
@type
string
---
Example: Document
id
string
Primary identifier for resource.
Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
productId
string
The Unique id of the product.
Example: 388ab719-277d-4032-a2c3-40a297d8f482
docType
string
Type of document for this product.
Example: 24(c) Registration
description
string
Information about the document.
Example: CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed
fileName
string
The filename of the document.
Example: ld7OD026.pdf
expirationDate
string
---
Example: 2017-03-22
recordMetadata
object
Data structure for record metadata capturing information about the creation and last update of an entity. For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg). NOTES * Some attributes are only visible if the API Client has the required license. * Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.)
userCreationTimestamp
string
Timestamp of entity creation
Example: 2018-04-30T10:23:50.000Z
userLastModifiedTimestamp
string
Timestamp of entity modification
Example: 2018-05-01T08:11:23.000Z

Update a tank mix

PUT

/organizations/{orgId}/tankMixes/{id}
Allows updates to be made to the name, archival status, and components of a tank mix.

OAuth Scope Required: ag3

Request URI

PUT https://sandboxapi.deere.com/platform/organizations/{orgId}/tankMixes/{id}

FieldTypeDescription & Example
@type
string
---
Example: Variety
id
string
The primary identifier for the variety that is unique to your organization.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
links
Array of object
---
rel

Required

string8
The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value.
Example: self
uri

Required

string
The location of the resource
Example: https://sandboxapi.deere.com/platform/
name
string
The common name of the variety.
Example: S73-Z5 - 50lb bag
category
string
---
Example: VARIETY
Allowed Values: VARIETY
cropName
string
The identifier of the crop type that this variety is associated with (see the Crop Types API).
Example: SOYBEANS
companyName
string
The brand of the variety.
Example: NK
archived
boolean
Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
referenceGuid
string
Optional. Denotes whether this product is from the global reference list.
Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
documents
Array of object
List of documents for the variety. For example, Tech Sheet, SDS Label.
@type

Required

string
---
Example: Document
id
string
Primary identifier for resource.
Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
productId

Required

string
The Unique id of the product.
Example: 388ab719-277d-4032-a2c3-40a297d8f482
docType

Required

string
Type of document for this product.
Example: 24(c) Registration
description

Required

string
Information about the document.
Example: CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed
fileName

Required

string
The filename of the document.
Example: ld7OD026.pdf
expirationDate
string
---
Example: 2017-03-22
recordMetadata
object
Data structure for record metadata capturing information about the creation and last update of an entity. For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg). NOTES * Some attributes are only visible if the API Client has the required license. * Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.)
userCreationTimestamp
string
Timestamp of entity creation
Example: 2018-04-30T10:23:50.000Z
userLastModifiedTimestamp
string
Timestamp of entity modification
Example: 2018-05-01T08:11:23.000Z

Additional Information

  1. Material Classification: LIQUID, DRY, GAS.

  2. Units: The unit format that looks like [floz1ac-2] is from ADAPT. Positive numbers follow the unit in the numerator, whereas negative numbers follow the denominator. The value of the positive or negative numbers in the unit indicate the power. floz1ac-2 = fluid ounces per acre squared; gal1ac-1 = gallons per acre. Please refer this link for all possible values of unit.

  3. Value as Double: Please refer to this link for possible formats of these rates.


Authentication (OAuth 2)

The John Deere Precision Tech API endpoints use OAuth 2.0 for authentication. OAuth is an open protocol, and these APIs currently only support the authorization code grant type for external applications.

You can also see our sample code for examples of navigating our OAuth 2 authentication code flow.

  1. Create an Application on Developer.Deere.com

    You must be a validated John Deere user to create an application on developer.deere.com. If you do not have a John Deere username and password, you can create one using the Create an Account option on our digital tools home page here: https://www.deere.com/en/digital-tools/. You must be able to sign into the developer.deere.com to use the Create Application option in the My Applications section of the website. Please follow the steps of the Create Application workflow on the website before proceeding to the next steps.

    Once your application is created, the Security section of the application Details will provide you with the Application ID and Secret necessary for the next steps to sign your API token requests.

    A note on Redirect URIs (Callback URLs):

    During the creation of the application (or found after creation in the application Details/Security section) you will need to define one or any number of Redirect URIs (Callback URLs). These are required for the OAuth 2 authentication flow. If you do not have this when creating the application, there is an example given in that section when creating the application that you may use for now which is http://localhost:9090/callback

    If Redirect URIs are not added to your application properly or used in the authentication process in a different format than listed in the application details (for example encoded vs non-encoded), your users will experience a 400 Bad Redirect error during authentication.

  2. Call the OAuth 2 well-known URL

    With your application client or a web browser window, make a GET request to https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/.well-known/oauth-authorization-server. This URL contains the authorization and token endpoints, as well as the available scopes mentioned in the steps below.

    {
        "issuer": "https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7",
        "authorization_endpoint": "https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/authorize",
        "token_endpoint": "https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/token",
        "registration_endpoint": "https://signin.johndeere.com/oauth2/v1/clients",
        "jwks_uri": "https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/keys",
        "response_types_supported": [
            "code",
            "token",
            "id_token",
            "code id_token",
            "code token",
            "id_token token",
            "code id_token token"
        ],
        "response_modes_supported": [
            "query",
            "fragment",
            "form_post",
            "okta_post_message"
        ],
        "grant_types_supported": [
            "authorization_code",
            "implicit",
            "refresh_token",
            "password",
            "client_credentials",
            "urn:ietf:params:oauth:grant-type:device_code"
        ],
        "subject_types_supported": [
            "public"
        ],
        "scopes_supported": [
            "ag1",
            "ag2",
            "ag3",
            "eq1",
            "eq2",
            "files",
            "finance1",
            "finance2",
            "org1",
            "org2",
            "work1",
            "work2",
            "openid",
            "profile",
            "email",
            "address",
            "phone",
            "offline_access",
            "device_sso"
        ],
        "token_endpoint_auth_methods_supported": [
            "client_secret_basic",
            "client_secret_post",
            "client_secret_jwt",
            "private_key_jwt",
            "none"
        ],
        "claims_supported": [
            "ver",
            "jti",
            "iss",
            "aud",
            "iat",
            "exp",
            "cid",
            "uid",
            "scp",
            "sub"
        ],
        "code_challenge_methods_supported": [
            "S256"
        ],
        "introspection_endpoint": "https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/introspect",
        "introspection_endpoint_auth_methods_supported": [
            "client_secret_basic",
            "client_secret_post",
            "client_secret_jwt",
            "private_key_jwt",
            "none"
        ],
        "revocation_endpoint": "https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/revoke",
        "revocation_endpoint_auth_methods_supported": [
            "client_secret_basic",
            "client_secret_post",
            "client_secret_jwt",
            "private_key_jwt",
            "none"
        ],
        "end_session_endpoint": "https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/logout",
        "request_parameter_supported": true,
        "request_object_signing_alg_values_supported": [
            "HS256",
            "HS384",
            "HS512",
            "RS256",
            "RS384",
            "RS512",
            "ES256",
            "ES384",
            "ES512"
        ],
        "device_authorization_endpoint": "https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/device/authorize",
        "dpop_signing_alg_values_supported": [
            "RS256",
            "RS384",
            "RS512",
            "ES256",
            "ES384",
            "ES512"
        ]
    }
  3. Acquire an authorization code

    The authorization code is obtained by using the authorization server as an intermediary between the client and resource owner. The client directs the resource owner to an authorization server, and once authorized the server redirects the resource owner back to the client with the authorization code. Along with the GET request to the authorization server URL, you will need to send a response type code parameter, along with OAuth scopes, client ID, state, and redirect URI.

    auth_code_1

    The authorization URL for the user to follow (in a web browser) should look like this:

    GET

    'https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/authorize?response_type=code&scope={scopes}&client_id={clientId}&state={state}&redirect_uri={redirect_uri}

    A note on OAuth Scopes and Data Permissions:

    In the  Dev Docs API sections, the required OAuth scopes will be referenced for each method and endpoint. For the OAuth access token, you must request the required scopes for each endpoint your application will be using. DO NOT request all scopes available on our authorization server as not all are required for your application, and your users should be prompted to only accept scopes (permissions) necessary for the API calls you will be making.

    The OAuth scopes your application requests initially for a user access token will directly relate to the permissions granted when the user makes the organization connection to your application. Please refer to the scopes table below. These scopes directly relate to user, partner, and Connected Software Company data access permissions referenced in Team Manager.

    Note: If the user has less permissions in their own organization(s) or their partner organization(s) than the scopes you are requesting initially, only the user’s permission set will be assumed in the connection from the selected organization to your application. We will not grant more permissions to your application than the connecting user has.

    Once the connection from the user’s organization is made to your application, you may request a higher-level scope or new scopes for the user access token, however, the connection permissions must also be adjusted by the user in https://connections.deere.com for the requesting application. Before adjusting those permission levels in the Connections website, the user must have obtained those permissions in their own organization or must be shared by the partner organizations that are currently connected.

    Scope

    User/Connection Permission

    Description

    org1

    Organization Management Access Level 1

    View Staff, Operators, and Partners

    org2

    Organization Management Access Level 1

    Organization Management Access Level 2

    View Staff, Operators, and Partners

    Modify Staff, Operators, and Partners

    eq1

    Equipment Access Level 1

    RDA

    Setup & WDT

    View Equipment

    Remote Display Access

    Setup File Creator, Products, and Wireless Data Transfer

    eq2

    Equipment Access Level 1

    Equipment Access Level 2

    Equipment Access Level 3

    RDA

    Setup & WDT

    View Equipment

    Edit Equipment (also View Detailed Machine Measurements)

    Manage Equipment

    Remote Display Access

    Setup File Creator, Products, and Wireless Data Transfer

    ag1

    Locations Access Level 1

    View Locations (Clients, Farms, Fields and Associated Data)

    ag2

    Locations Access Level 1

    Locations Access Level 2

    View Locations (Clients, Farms, Fields and Associated Data)

    Analyze Production Data (Website Access Only)

    ag3

    Locations Access Level 1

    Locations Access Level 2

    Locations Access Level 3

    View Locations (Clients, Farms, Fields and Associated Data)

    Analyze Production Data (Website Access Only)

    Manage Locations & Production Data (Website and API Access)

    files

    Files API Access

    Equipment Access Level 3

    Setup & WDT

    Files API Access (ag3 scope also required for most file types)

    Manage Equipment

    Setup File Creator, Products, and Wireless Data Transfer

    finance1

    Financial Access Level 1

    View Financials

    finance2

    Financial Access Level 1

    Financial Access Level 2

    View Financials

    Manage Financials

    work1

    Work and Crop Plans Access Level 1

    View Work and Crop Plans

    work2

    Work and Crop Plans Access Level 1

    Work and Crop Plans Access Level 2

    View Work and Crop Plans

    View Work and Crop Plans

    offline_access

    API Authentication Only

    Request a Refresh Token

    To summarize the Authorization Code steps:

    1. The customer initiates a request for data from a client application, and the client sends an OAuth request to the authorization server with the proper headers.

    2. The customer is redirected to the John Deere sign-in page.

    3. The customer signs into John Deere, and the request is redirected back to the authorization server.

    4. The customer is then presented with the scope allowance screen. (During first token request, or with modified scopes)

    5. Scope acceptance is sent back to the OAuth server, and the customer is then redirected back to the client application with the authorization code.

  4. Acquire an Access Token

    Once the application has the authorization code, the client then requests an access token from the token server by sending a grant type authorization_code parameter, along with the authorization code, a redirect URI, and the client credentials. The authorization server authenticates the client and issues an access token and a refresh token (only if offline_access scope was requested in the previous step). The access token will expire after 12 hours after which it must be refreshed (see the last step).

    auth_code_1

    POST

    https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/token

    Content-Type: application/x-www-form-urlencoded

    • grant_type=authorization_code

    • code={auth_code_from_authorize_call_response}

    • redirect_uri={redirect_uri}

    • client_id={client_id}

    • client_secret={client_secret}

  5. Post authorization redirect to enable organization access

    Once the client obtains a valid access token, there is an additional step required to enable organization data access for your client application. If this step is skipped, the client will receive a 403 Forbidden response when trying the access data for any organization to which the user has access

    auth_code_1
    1. Make a call to GET /organizations. If you see a ‘connections’ link in the response, your client has not granted access to that organization.

      Note: A user may have access to multiple organizations but may not enable access to all of them. A ‘connections’ may always be returned for an organization the user chooses not to allow your application access to.

      Example Response:

      [
        {
          "@type": "Organization",
          "name": "Spahn Ranch",
          "type": "customer",
          "member": true,
          "internal": false,
          "id": "283480",
          "links": [
            {
              "@type": "Link",
              "rel": "self",
              "uri": "https://apiqa.tal.deere.com/platform/organizations/283480"
            },
            {
              "@type": "Link",
              "rel": "connections",
              "uri": "https://connections.deere.com/connections/deere-sld8shg8ee0o8ns8nhdh88hn/select-organizations"
            }
          ]
        }
      ]
    2. Redirect the user to Operations Center (in a web browser) using the URI provided in the ‘connections’ link. You can also provide a redirect_uri query parameter so the user will be redirected back to your application after the organization selection process is completed. The redirect_uri that is provided must match one of the Redirect URIs listed in your application profile. The redirect_uri must also be URL encoded (i.e. “https://example.client.com/callback” should be passed as “https%3A%2F%2Fexample.client.com%2Fcallback”).

      Example URI: https://connections.deere.com/connections/{clientId}/select-organizations?redirect_uri={redirectUri}

    3. The user selects the organization(s) to which your client can have access.

      auth_code_1

    4. Once the organization selection is complete, the user will be redirected back to your application based on the redirect_uri query parameter that was provided. If the redirect_uri query parameter is not provided or is invalid, then the user will remain on the Connections application in Operations Center.

      Additionally, the GET /organizations endpoint will no longer include the ‘connections’ link and instead will include a ‘manage_connections’ link. This will link into the management modal in Connections for the application in the organization. Having the ‘manage_connections’ link implies that a connection between an application and organization is fully established.

      Example Response:

      [
        {
          "@type": "Organization",
          "name": "Spahn Ranch",
          "type": "customer",
          "member": true,
          "internal": false,
          "id": "283480",
          "links": [
            {
              "@type": "Link",
              "rel": "self",
              "uri": "https://apiqa.tal.deere.com/platform/organizations/283480"
            },
            {
              "@type": "Link",
              "rel": "manage_connections",
              "uri": "https://connections-qual.deere.com/connections/deere-sld8shg8ee0o8ns8nhdh88hn/connections-dialog?orgId=283480"
            }
          ]
        }
      ]
    5. Avoid getting into a redirect loop and only perform the connections redirect one time per user session. There are a few scenarios in Operations Center when a user either decides not to or is unable to complete the organization selection step. If your application does not have access to an organization after completing the connections redirect, we suggest that you inform the user that the connection was not completed and they may need to login to Operations Center to modify the Connection manually.

  6. Use the access token to call API resource

    Once the client obtains the valid access token and the user has enabled organization access for the client, they can use this token to call the appropriate resource server (API) to obtain the data needed.

    auth_code_1

    For API call structure, parameters, and headers, refer to the Dev Docs section.

    All your API calls should include an Authorization: Bearer {token} utilizing the obtained token.

  7. Setup Token Refresh Process

    The client application will need to pass a refresh token to the authorization (token) server to obtain a new access token before the access token expires (12 hours). For this you will pass through a refresh_token grant type parameter, along with the refresh_token to the token server.

    Even if the customer did not request a resource call, the client would need to initiate a periodic refresh of this token to keep it 'hot'. The refresh token will expire after 365 days if it is not used. If the refresh token expires, the customer will need to re-authenticate. As long as you continue to refresh the access token with this refresh token, it will remain active indefinitely (unless the customer removes all organization connections on https://connections.deere.com to your application).

    POST

    https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/token

    Accept: application/json

    Content-Type: application/x-www-form-urlencoded

    • grant_type=refresh_token

    • refresh_token={refresh_token}

    • redirect_uri={redirect_uri}

    • scope={scopes}

    • client_id={client_id}

    • client_secret={client_secret}


Using Postman to call the MyJohnDeere API (OAuth 2)

Postman is a third-party API client, which you can use to test your John Deere API calls. You may use the Postman website or the desktop application for calling APIs while in Sandbox to see and follow REST API responses. Other API test clients may work for this as well. The below instructions will provide the initial setup steps to get Postman configured and obtain an OAuth 2 token.

  1. Download and install Postman on your computer (link above), or you may use the web version.

  2. Open Postman, click on Settings at the top, and in General settings turn off all of the Headers options.

  3. In the top nav section of the Postman client application, you can hit the + sign to add a new request to your console.

  4. In the Auth section of that new request tab, there is a dropdown to select the type of authorization you’ll be using. Select the OAuth2 option.

  5. The screen will change, and you will see Type is set as OAuth 2.0.

  6. Add auth data to should be set as Request Headers.

  7. Header Prefix should be set as Bearer.

  8. Within the Configure New Token section, you will need to add values to each of the fields or configure the options before selecting the Get New Access Token button (or it will error out).

    1. Add a Token Name (can be anything).

    2. Leave the Grant Type as Authorization Code.

    3. The Callback URL for redirecting the authorization code back to Postman is https://www.getpostman.com/oauth2/callback. The Callback URL can be set to anything in this example. Remember that if you will be using this Postman callback URL, it (and any other Callback URL you use) will need to be synced with your OAuth client. See step 2 in this document for help in syncing this Callback URL with your application.

    4. The Auth URL and Access Token URL can be found with opening a new Postman request window and doing a GET on this URL https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/.well-known/oauth-authorization-server. No Auth is needed for this GET request. You can also open this URL in any internet browser window.

    5. For the Client ID and Client Secret Developer.Deere.com, login, and access your application profile in the "My Applications" section.

    6. In the Details window, under the Security section, you will find this information. What Postman calls the Client ID is called "Application Id" in this window. What Postman calls the Client Secret is called "Secret" in this window. Copy the necessary information into the Postman token section.

    7. The Scope box should be populated with only the scopes require for the API calls you are making (space delimited). The scopes required for your API calls can be found in the Dev Docs section of every API under each endpoint’s documentation.

    8. State is an opaque value to prevent cross-site forgery. Enter any unique string in this box (ex. 12345).

    9. For Client Authentication, this option should be set to Send client credentials in body for this example. (not selecting this option will result in an error)

  9. Once the steps above are complete, press the Get New Access Token button to proceed to the John Deere sign in page where a valid Operations Center user can sign in. If this is the first time the user is obtaining an API token for your application, they will be presented with the scopes acceptance screen, to which they must choose Allow Access (Don’t Allow will result in a token with no assigned scopes).

  10. In the Details window, the first two pieces of information that OAuth requires are found in the Application Details section (illustration below). What Postman calls the Client ID is called "Application Id" in this window. What Postman calls the Client Secret is called "Secret" in this window. Copy the necessary information into the Postman token section.

  11. Once the token is obtained and shown in the Postman screen, select the Use Token button to apply the token to your current API call. (you do not need to configure Authorization headers on the API call, as Postman will do this for you)

  12. The next step is to enter the URL of the API call and configure an Accept header. To test, please configure the API URL to be GET https://sandboxapi.deere.com/platform/organizations. In the Headers section, please configure an Accept header with a value of application/vnd.deere.axiom.v3+json. (you may leave the default Postman headers in the request, if applicable)

  13. Only once all the steps above are completed, can you hit the Send button in the API request to make the API call and receive a 200 OK response and response body.

  14. If you can’t complete this process or have any questions, please feel free to use the Support button in the top navigation of the page to contact us.



eTags

If your client will be making frequent/regular calls to some API to check for updates, you can use Deere's eTag implementation to limit the response to newly modified data. This feature is available for most APIs that return a list through MyJohnDeere API. To use this function:

  1. Include x-deere-signature as a request header.

  2. The response header will include a String Token. Send the request again with this String Token as the value for the x-deere-signature header

  3. If there are no changes to the list, then the resource will return 304 Not Modified. If there are changes to the list, it will return only the changed data, along with a new String Token. You must use this new String Token in your next request.

  4. While using eTags,pagination is skipped and the complete response, which include all the changes since last API call, is returned.

String Tokens should be stored as string data types.

eTags are retained by John Deere for forty-five days. If an eTag is no longer retained, the response will include the whole list. The same will occur if the signature used is not found.

GET https://sandboxapi.deere.com/platform/organizations/1234/files

Accept: application / vnd.deere.axiom.v3 + json
x - deere - signature:
Authorization: Bearer {token}
200 OK

pragma: no - cache
date: Tue, 05 May 2015 19:37:58 GMT
server: Apache - Coyote / 1.1
x - deere - handling - server: ldxctc1
x - deere - elapsed - ms: 225
x - frame - options: SAMEORIGIN
x - deere - signature: 520122365ebb4870a344784570d202c7
content - language: en - US
cache - control: no - cache, no-store, max-age=0
transfer - encoding: chunked
connection: Keep - Alive
content - type: application / vnd.deere.axiom.v3 + json;charset=UTF-8
keep - alive: timeout = 5, max=100
expires: Thu, 01 Jan 1970 00:00:00 GMT
GET https://sandboxapi.deere.com/platform/organizations/1234/files

Accept: application / vnd.deere.axiom.v3 + json
x - deere - signature: 520122365ebb4870a344784570d202c7
Authorization: Bearer {token}
304 Not Modified

date: Tue, 05 May 2015 19:53:00 GMT
cache - control: no - cache, no-store, max-age=0
server: Apache - Coyote / 1.1
connection: Keep - Alive
keep - alive: timeout = 5, max=100
expires: Thu, 01 Jan 1970 00:00:00 GMT

Links

Links is John Deere’s implementation of HATEOS. They are handy for discovering additional actions and endpoints. Please note that we do not show or hide returned links in a response based on client API access granted, but we do make efforts to return only those links that a user or application has access to based on data permissions. In summary, not all returned links will be accessible to your application as some APIs are not public facing and you may not have access to that endpoint, and not all returned links will allow every action (GET, PUT, POST, DELETE).

Due to our large number of API's, the number of links can become overwhelming. For some base resources, links can account for the majority of the response payload. You can optionally disable links by specifying a showLinks=none query parameter on any API call. You can also request specific links. For example, showLinks=field,clients will only show links if they have a 'rel' value of 'fields', or 'clients'.

Some Examples:

"links": [
  {
    "rel": "self",
    "uri": "https://sandboxapi.deere.com/platform/organizations/1234/farms/14e69520-34b2-4e67-b5f1-fffaf49531de"
  },
  {
    "rel": "fields",
    "uri": "https://sandboxapi.deere.com/platform/organizations/1234/farms/14e69520-34b2-4e67-b5f1-fffaf49531de/fields"
  },
  {
    "rel": "clients",
    "uri": "https://sandboxapi.deere.com/platform/organizations/1234/farms/14e69520-34b2-4e67-b5f1-fffaf49531de/clients"
  },
  {
    "rel": "owningOrganization",
    "uri": "https://sandboxapi.deere.com/platform/organizations/1234"
  }
]

How are these links helpful?

  • Links help to identify and discover additional API's and actions.

  • If you do not have access to a link, it will return a 403 response to your application.

  • Only those returned links that relate to the public APIs visible in https://developer.deere.com are accessible to external applications.


Common Error Codes

When a client application is making requests to John Deere APIs, it will encounter HTTP response errors that should be handled appropriately. Below you will find most of these errors and instructions on handling them.

400 Bad Request

HTTP Code: 400
Response code: Bad Request

This error means that either the POST/PUT body used in the request is incorrect, or if this error is seen in the OAuth 2 POST /token request, it means the refresh token is invalid. Before contacting API Support, please attempt to update the request body or get a valid token for the user. Please see the OAuth 2 documentation here.

401 Unauthorized

HTTP Code: 401
Response code: Server Authorization Failed

This error means that either the application does not have a license for the endpoint, or the user token is expired. Before contacting API Support, please attempt to get a valid token for the user, or use the refresh token process to get a new access token. Please see the OAuth 2 documentation here. Information about what APIs a client application can call by default are listed here, and all other APIs listed on the website are only accessible via a given license.

403 Forbidden

HTTP Code: 403
Response code: Access Denied

This error pertains to the user not having access to this resource. You should only request resources found while navigating the REST endpoints for the user. If the client calls for a resource the user does not have access to, the request will be denied. You can prevent this error by beginning your calls with /platform, and following the returned links to discover resource IDs available to the user (most are found under the /organizations link).

HTTP Code: 403
Response: The client does not have a proper access for this API

This error relates to missing OAuth 2 scopes for the user token. Along with this error code, you will see the client ID, license needed, and read/write/delete scopes needed for that license to make the corresponding requests.

HTTP Code: 403
Response: Requested org is in a restricted state

This error relates to our updates Orgs Terms & Conditions process. We have a guide for handling these requests here.

404 Not Found

HTTP Code: 404
Response code: The requested resource was not found

This error means that the resource ID requested is not valid. All resource IDs should be parsed from API responses immediately before requesting access to it. If IDs are stored for long periods of time, user access to that resource could change or be removed.

429 Too Many Requests

HTTP Code: 429
Response code: HTTP_TOO_MANY_REQUESTS

When the John Deere Servers are overwhelmed by requests, clients may receive a HTTP 429 response. That response may include a "Retry-After" header with a numeric value indicating the number of seconds the client should wait before trying again. When you receive a 429 response with that header, you have to wait at least for the specified time before retrying the request. If a customer is actively waiting for the result, you may need to return an error instead of waiting. If your application is fully asynchronous, always wait the Retry-After amount.

503 Service Unavailable

HTTP Code: 503
Response code: : HTTP_SERVICE_UNAVAILABLE

When John Deere Servers have a backend or server problem, they MAY return a corresponding Retry-After header along with a 503 response. If a 503 is returned without a Retry-After header then John Deere Servers cannot estimate a reasonable recovery time. Your application should enter an exponential back-off loop or return an error in this case. If a Retry-After header is returned, wait the number of seconds given and try again

For all other possible status codes, please refer to this resource that is publicly available (provided by Wikipedia).


Markdown

Markdown is a simple and easy-to-use markup language with broad industry adoption. There are readily available tutorials and reference materials if you’d like an introduction.

We do not support everything Markdown offers. The supported Markdown is listed below.

Supported Markdown

Map Layer Summary POST

Markdown is supported on the text field of Map Layer Summaries. View Map Layer Summary POST documentation

A *description* of a **Map Layer Summary** showing Markdown support.
***
an ordered list:
1. first item 
2. second item 
3. third item 
***
an unordered list:
- first item 
- second item 
- third item 
More examples can be found at this [link](https://en.wikipedia.org/wiki/Markdown).
markdown

Asset Location POST

AssetLocation has a property named measurementData, which supports Markdown on its name attribute. Please note that only links are supported here; no other Markdown will be rendered. View Asset Location POST documentation

"measurementData" : [
    {
        "@type" : "BasicMeasurement",
        <span class="spanText">"name" : "[Leaf Wetness](https://www.example.com)",</span>
        "value" : "1.3",
        "unit" : "u1"
    }
]
markdown2


Required Customer Action (RCA) Events

A Required Customer Action (RCA) event is a change or addition to the customer‘s organization flow that requires the user to take action before further account activity is allowed. This includes API calls on behalf of a customer.

Example: User must accept new terms and conditions to verify their account information.

What does it look like?

  • The client’s API calls will result in a 403 Forbidden response.

  • X-Deere-Warning header will indicate a more specific error message.

  • Example: "Requested Org is in a restricted state."

  • X-Deere-Terms-Location header will include a redirect URL where the user can take action.

  • Example: "https://teammanager.deere.com/organizations/{OrgId}/terms."

  • The response payload will indicate a short description of required user action.

{
  "@type": "Errors",
  "errors": [
    {
      "@type": "Error",
      "guid": "19f7b283-d383-4990-9e14-1b3ee0f7b63d",
      "message": "Requested Org is in a restricted state."
    }
  ],
  "otherAttributes": {}
}

How should your app handle these RCAs?

  • If possible, navigate the user to the URL supplied in the 403 response X-Deere-Terms-Location header.

  • Implement a way to notify the customer that action is required. Supply a 403 response message and X-Deere-Terms-Location URL as instructions to resolve.

Consider RCA Event handling as a best practice moving forward. Your application should take steps to handle these events now.